blob: 665beecb327b713ba4f4e624fcdea6418427ab29 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Ronald Cronad8c17b2022-06-10 17:18:09 +020061#if defined(MBEDTLS_TEST_HOOKS)
62static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
63
64void mbedtls_ssl_set_chk_buf_ptr_fail_args(
65 const uint8_t *cur, const uint8_t *end, size_t need )
66{
67 chk_buf_ptr_fail_args.cur = cur;
68 chk_buf_ptr_fail_args.end = end;
69 chk_buf_ptr_fail_args.need = need;
70}
71
72void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void )
73{
74 memset( &chk_buf_ptr_fail_args, 0, sizeof( chk_buf_ptr_fail_args ) );
75}
76
77int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args )
78{
79 return( ( chk_buf_ptr_fail_args.cur != args->cur ) ||
80 ( chk_buf_ptr_fail_args.end != args->end ) ||
81 ( chk_buf_ptr_fail_args.need != args->need ) );
82}
83#endif /* MBEDTLS_TEST_HOOKS */
84
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010086
Hanno Beckera0e20d02019-05-15 14:03:01 +010087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010088/* Top-level Connection ID API */
89
Hanno Becker8367ccc2019-05-14 11:30:10 +010090int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
91 size_t len,
92 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010093{
94 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
95 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
96
Hanno Becker611ac772019-05-14 11:45:26 +010097 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
98 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
99 {
100 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
101 }
102
103 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100104 conf->cid_len = len;
105 return( 0 );
106}
107
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100108int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
109 int enable,
110 unsigned char const *own_cid,
111 size_t own_cid_len )
112{
Hanno Becker76a79ab2019-05-03 14:38:32 +0100113 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
114 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
115
Hanno Beckerca092242019-04-25 16:01:49 +0100116 ssl->negotiate_cid = enable;
117 if( enable == MBEDTLS_SSL_CID_DISABLED )
118 {
119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
120 return( 0 );
121 }
122 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +0100123 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Hanno Beckerad4a1372019-05-03 13:06:44 +0100125 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100126 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100127 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
128 (unsigned) own_cid_len,
129 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100130 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
131 }
132
133 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100134 /* Truncation is not an issue here because
135 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
136 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100137
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100138 return( 0 );
139}
140
Paul Elliott0113cf12022-03-11 20:26:47 +0000141int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
142 int *enabled,
143 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
144 size_t *own_cid_len )
145{
146 *enabled = MBEDTLS_SSL_CID_DISABLED;
147
148 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
149 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
150
151 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
152 * zero as this is indistinguishable from not requesting to use
153 * the CID extension. */
154 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
155 return( 0 );
156
157 if( own_cid_len != NULL )
158 {
159 *own_cid_len = ssl->own_cid_len;
160 if( own_cid != NULL )
161 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
162 }
163
164 *enabled = MBEDTLS_SSL_CID_ENABLED;
165
166 return( 0 );
167}
168
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100169int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
170 int *enabled,
171 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
172 size_t *peer_cid_len )
173{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100174 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100175
Hanno Becker76a79ab2019-05-03 14:38:32 +0100176 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000177 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100178 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100179 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100180 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181
Hanno Beckerc5f24222019-05-03 12:54:52 +0100182 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
183 * were used, but client and server requested the empty CID.
184 * This is indistinguishable from not using the CID extension
185 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186 if( ssl->transform_in->in_cid_len == 0 &&
187 ssl->transform_in->out_cid_len == 0 )
188 {
189 return( 0 );
190 }
191
Hanno Becker615ef172019-05-22 16:50:35 +0100192 if( peer_cid_len != NULL )
193 {
194 *peer_cid_len = ssl->transform_in->out_cid_len;
195 if( peer_cid != NULL )
196 {
197 memcpy( peer_cid, ssl->transform_in->out_cid,
198 ssl->transform_in->out_cid_len );
199 }
200 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100201
202 *enabled = MBEDTLS_SSL_CID_ENABLED;
203
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100204 return( 0 );
205}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100206#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200211/*
212 * Convert max_fragment_length codes to length.
213 * RFC 6066 says:
214 * enum{
215 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
216 * } MaxFragmentLength;
217 * and we add 0 -> extension unused
218 */
Angus Grattond8213d02016-05-25 20:56:48 +1000219static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200220{
Angus Grattond8213d02016-05-25 20:56:48 +1000221 switch( mfl )
222 {
223 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
224 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
225 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
226 return 512;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
228 return 1024;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
230 return 2048;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
232 return 4096;
233 default:
234 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
235 }
236}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200238
Hanno Becker52055ae2019-02-06 14:30:46 +0000239int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
240 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200241{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 mbedtls_ssl_session_free( dst );
243 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200244
吴敬辉0b716112021-11-29 10:46:35 +0800245#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
246 dst->ticket = NULL;
247#endif
248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000250
251#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252 if( src->peer_cert != NULL )
253 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200255
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200256 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200257 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200258 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200263 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200266 dst->peer_cert = NULL;
267 return( ret );
268 }
269 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000270#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 if( src->peer_cert_digest != NULL )
272 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000274 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000275 if( dst->peer_cert_digest == NULL )
276 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
277
278 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
279 src->peer_cert_digest_len );
280 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000281 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 }
283#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200287#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288 if( src->ticket != NULL )
289 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200290 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200291 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200292 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200293
294 memcpy( dst->ticket, src->ticket, src->ticket_len );
295 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200296#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297
298 return( 0 );
299}
300
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500301#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200302MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
304{
305 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
306 if( resized_buffer == NULL )
307 return -1;
308
309 /* We want to copy len_new bytes when downsizing the buffer, and
310 * len_old bytes when upsizing, so we choose the smaller of two sizes,
311 * to fit one buffer into another. Size checks, ensuring that no data is
312 * lost, are done outside of this function. */
313 memcpy( resized_buffer, *buffer,
314 ( len_new < *len_old ) ? len_new : *len_old );
315 mbedtls_platform_zeroize( *buffer, *len_old );
316 mbedtls_free( *buffer );
317
318 *buffer = resized_buffer;
319 *len_old = len_new;
320
321 return 0;
322}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323
324static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500325 size_t in_buf_new_len,
326 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200327{
328 int modified = 0;
329 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
330 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
331 if( ssl->in_buf != NULL )
332 {
333 written_in = ssl->in_msg - ssl->in_buf;
334 iv_offset_in = ssl->in_iv - ssl->in_buf;
335 len_offset_in = ssl->in_len - ssl->in_buf;
336 if( downsizing ?
337 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
338 ssl->in_buf_len < in_buf_new_len )
339 {
340 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
341 {
342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
343 }
344 else
345 {
Paul Elliottb7449902021-03-10 18:14:58 +0000346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
347 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200348 modified = 1;
349 }
350 }
351 }
352
353 if( ssl->out_buf != NULL )
354 {
355 written_out = ssl->out_msg - ssl->out_buf;
356 iv_offset_out = ssl->out_iv - ssl->out_buf;
357 len_offset_out = ssl->out_len - ssl->out_buf;
358 if( downsizing ?
359 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
360 ssl->out_buf_len < out_buf_new_len )
361 {
362 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
363 {
364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
365 }
366 else
367 {
Paul Elliottb7449902021-03-10 18:14:58 +0000368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
369 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 modified = 1;
371 }
372 }
373 }
374 if( modified )
375 {
376 /* Update pointers here to avoid doing it twice. */
377 mbedtls_ssl_reset_in_out_pointers( ssl );
378 /* Fields below might not be properly updated with record
379 * splitting or with CID, so they are manually updated here. */
380 ssl->out_msg = ssl->out_buf + written_out;
381 ssl->out_len = ssl->out_buf + len_offset_out;
382 ssl->out_iv = ssl->out_buf + iv_offset_out;
383
384 ssl->in_msg = ssl->in_buf + written_in;
385 ssl->in_len = ssl->in_buf + len_offset_in;
386 ssl->in_iv = ssl->in_buf + iv_offset_in;
387 }
388}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500389#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
390
Jerry Yudb8c48a2022-01-27 14:54:54 +0800391#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
394typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
395 const char *label,
396 const unsigned char *random, size_t rlen,
397 unsigned char *dstbuf, size_t dlen );
398
399static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
400
401#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
402
403/* Type for the TLS PRF */
404typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
405 const unsigned char *, size_t,
406 unsigned char *, size_t);
407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200408MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800409static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
410 int ciphersuite,
411 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800415 ssl_tls_prf_t tls_prf,
416 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400417 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800418 unsigned endpoint,
419 const mbedtls_ssl_context *ssl );
420
421#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800423static int tls_prf_sha256( const unsigned char *secret, size_t slen,
424 const char *label,
425 const unsigned char *random, size_t rlen,
426 unsigned char *dstbuf, size_t dlen );
427static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
428static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
429
430#endif /* MBEDTLS_SHA256_C */
431
432#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200433MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800434static int tls_prf_sha384( const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen );
438
439static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
440static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
441#endif /* MBEDTLS_SHA384_C */
442
Jerry Yu438ddd82022-07-07 06:55:50 +0000443static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800444 unsigned char *buf,
445 size_t buf_len );
Jerry Yu251a12e2022-07-13 15:15:48 +0800446
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200447MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +0000448static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800449 const unsigned char *buf,
450 size_t len );
451#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
452
Jerry Yu53d23e22022-02-09 16:25:09 +0800453static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
454
Jerry Yudb8c48a2022-01-27 14:54:54 +0800455#if defined(MBEDTLS_SHA256_C)
456static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800457#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800458
459#if defined(MBEDTLS_SHA384_C)
460static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800461#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000462
Ron Eldor51d3ab52019-05-12 14:54:30 +0300463int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
464 const unsigned char *secret, size_t slen,
465 const char *label,
466 const unsigned char *random, size_t rlen,
467 unsigned char *dstbuf, size_t dlen )
468{
469 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
470
471 switch( prf )
472 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300473#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200474#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300475 case MBEDTLS_SSL_TLS_PRF_SHA384:
476 tls_prf = tls_prf_sha384;
477 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200478#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300479#if defined(MBEDTLS_SHA256_C)
480 case MBEDTLS_SSL_TLS_PRF_SHA256:
481 tls_prf = tls_prf_sha256;
482 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300483#endif /* MBEDTLS_SHA256_C */
484#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300485 default:
486 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
487 }
488
489 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
490}
491
Jerry Yuc73c6182022-02-08 20:29:25 +0800492#if defined(MBEDTLS_X509_CRT_PARSE_C)
493static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
494{
495#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
496 if( session->peer_cert != NULL )
497 {
498 mbedtls_x509_crt_free( session->peer_cert );
499 mbedtls_free( session->peer_cert );
500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
503 if( session->peer_cert_digest != NULL )
504 {
505 /* Zeroization is not necessary. */
506 mbedtls_free( session->peer_cert_digest );
507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
515void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
516 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
517{
518 ((void) ciphersuite_info);
519
520#if defined(MBEDTLS_SHA384_C)
521 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
522 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
523 else
524#endif
525#if defined(MBEDTLS_SHA256_C)
526 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
527 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
528 else
529#endif
530 {
531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
532 return;
533 }
534}
535
XiaokangQianadab9a62022-07-18 07:41:26 +0000536void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
537 unsigned hs_type,
538 size_t total_hs_len )
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100539{
540 unsigned char hs_hdr[4];
541
542 /* Build HS header for checksum update. */
543 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
544 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
545 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
546 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
547
548 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
549}
550
551void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
552 unsigned hs_type,
553 unsigned char const *msg,
554 size_t msg_len )
555{
556 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
557 ssl->handshake->update_checksum( ssl, msg, msg_len );
558}
559
Jerry Yuc73c6182022-02-08 20:29:25 +0800560void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
561{
562 ((void) ssl);
563#if defined(MBEDTLS_SHA256_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
566 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
567#else
568 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
569#endif
570#endif
571#if defined(MBEDTLS_SHA384_C)
572#if defined(MBEDTLS_USE_PSA_CRYPTO)
573 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
574 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
575#else
576 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
577#endif
578#endif
579}
580
581static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
582 const unsigned char *buf, size_t len )
583{
584#if defined(MBEDTLS_SHA256_C)
585#if defined(MBEDTLS_USE_PSA_CRYPTO)
586 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
587#else
588 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
589#endif
590#endif
591#if defined(MBEDTLS_SHA384_C)
592#if defined(MBEDTLS_USE_PSA_CRYPTO)
593 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
594#else
595 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
596#endif
597#endif
598}
599
600#if defined(MBEDTLS_SHA256_C)
601static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
602 const unsigned char *buf, size_t len )
603{
604#if defined(MBEDTLS_USE_PSA_CRYPTO)
605 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
606#else
607 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
608#endif
609}
610#endif
611
612#if defined(MBEDTLS_SHA384_C)
613static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
614 const unsigned char *buf, size_t len )
615{
616#if defined(MBEDTLS_USE_PSA_CRYPTO)
617 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
618#else
619 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
620#endif
621}
622#endif
623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500629#if defined(MBEDTLS_USE_PSA_CRYPTO)
630 handshake->fin_sha256_psa = psa_hash_operation_init();
631 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
632#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200634 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200635#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500636#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200637#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500638#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500639 handshake->fin_sha384_psa = psa_hash_operation_init();
640 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500641#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200643 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200644#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500645#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200646
647 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649#if defined(MBEDTLS_DHM_C)
650 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200651#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200652#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200654#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200655#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200656 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200657#if defined(MBEDTLS_SSL_CLI_C)
658 handshake->ecjpake_cache = NULL;
659 handshake->ecjpake_cache_len = 0;
660#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200661#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200662
Gilles Peskineeccd8882020-03-10 12:19:08 +0100663#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200664 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200665#endif
666
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200667#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
668 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
669#endif
Hanno Becker75173122019-02-06 16:18:31 +0000670
671#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
672 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
673 mbedtls_pk_init( &handshake->peer_pubkey );
674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Hanno Beckera18d1322018-01-03 14:27:32 +0000677void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200680
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100681#if defined(MBEDTLS_USE_PSA_CRYPTO)
682 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
683 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100684#else
685 mbedtls_cipher_init( &transform->cipher_ctx_enc );
686 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100687#endif
688
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100690#if defined(MBEDTLS_USE_PSA_CRYPTO)
691 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
692 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100693#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 mbedtls_md_init( &transform->md_ctx_enc );
695 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000696#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100697#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200698}
699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200703}
704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200705MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000707{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200708 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000709 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200711 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200713 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200714 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715
716 /*
717 * Either the pointers are now NULL or cleared properly and can be freed.
718 * Now allocate missing structures.
719 */
720 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200721 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200722 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200723 }
Paul Bakker48916f92012-09-16 19:57:18 +0000724
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200726 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200727 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200728 }
Paul Bakker48916f92012-09-16 19:57:18 +0000729
Paul Bakker82788fb2014-10-20 13:59:19 +0200730 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200731 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200732 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200733 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500734#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
735 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400736
Andrzej Kurek4a063792020-10-21 15:08:44 +0200737 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
738 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500739#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000740
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200741 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000742 if( ssl->handshake == NULL ||
743 ssl->transform_negotiate == NULL ||
744 ssl->session_negotiate == NULL )
745 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 mbedtls_free( ssl->handshake );
749 mbedtls_free( ssl->transform_negotiate );
750 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200751
752 ssl->handshake = NULL;
753 ssl->transform_negotiate = NULL;
754 ssl->session_negotiate = NULL;
755
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200756 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000757 }
758
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200759 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000761 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200762 ssl_handshake_params_init( ssl->handshake );
763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200765 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
766 {
767 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200768
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200769 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
770 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
771 else
772 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200773
Hanno Becker0f57a652020-02-05 10:37:26 +0000774 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200775 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200776#endif
777
Brett Warrene0edc842021-08-17 09:53:13 +0100778/*
779 * curve_list is translated to IANA TLS group identifiers here because
780 * mbedtls_ssl_conf_curves returns void and so can't return
781 * any error codes.
782 */
783#if defined(MBEDTLS_ECP_C)
784#if !defined(MBEDTLS_DEPRECATED_REMOVED)
785 /* Heap allocate and translate curve_list from internal to IANA group ids */
786 if ( ssl->conf->curve_list != NULL )
787 {
788 size_t length;
789 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
790
791 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
792 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
793
794 /* Leave room for zero termination */
795 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
796 if ( group_list == NULL )
797 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
798
799 for( size_t i = 0; i < length; i++ )
800 {
801 const mbedtls_ecp_curve_info *info =
802 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
803 if ( info == NULL )
804 {
805 mbedtls_free( group_list );
806 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
807 }
808 group_list[i] = info->tls_id;
809 }
810
811 group_list[length] = 0;
812
813 ssl->handshake->group_list = group_list;
814 ssl->handshake->group_list_heap_allocated = 1;
815 }
816 else
817 {
818 ssl->handshake->group_list = ssl->conf->group_list;
819 ssl->handshake->group_list_heap_allocated = 0;
820 }
821#endif /* MBEDTLS_DEPRECATED_REMOVED */
822#endif /* MBEDTLS_ECP_C */
823
Jerry Yuf017ee42022-01-12 15:49:48 +0800824#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
825#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800826#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800827 /* Heap allocate and translate sig_hashes from internal hash identifiers to
828 signature algorithms IANA identifiers. */
829 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 ssl->conf->sig_hashes != NULL )
831 {
832 const int *md;
833 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800834 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 uint16_t *p;
836
Jerry Yub476a442022-01-21 18:14:45 +0800837#if defined(static_assert)
838 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
839 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
840 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800841#endif
842
Jerry Yuf017ee42022-01-12 15:49:48 +0800843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
846 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800847#if defined(MBEDTLS_ECDSA_C)
848 sig_algs_len += sizeof( uint16_t );
849#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800850
Jerry Yub476a442022-01-21 18:14:45 +0800851#if defined(MBEDTLS_RSA_C)
852 sig_algs_len += sizeof( uint16_t );
853#endif
854 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
855 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857
Jerry Yub476a442022-01-21 18:14:45 +0800858 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800859 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
860
Jerry Yub476a442022-01-21 18:14:45 +0800861 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
862 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800863 if( ssl->handshake->sig_algs == NULL )
864 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
865
866 p = (uint16_t *)ssl->handshake->sig_algs;
867 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
868 {
869 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
870 if( hash == MBEDTLS_SSL_HASH_NONE )
871 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800872#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800873 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
874 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800875#endif
876#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800877 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
878 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800879#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800880 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200881 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800882 ssl->handshake->sig_algs_heap_allocated = 1;
883 }
884 else
Jerry Yua69269a2022-01-17 21:06:01 +0800885#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800886 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800887 ssl->handshake->sig_algs_heap_allocated = 0;
888 }
Jerry Yucc539102022-06-27 16:27:35 +0800889#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800890#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000891 return( 0 );
892}
893
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200894#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200896MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897static int ssl_cookie_write_dummy( void *ctx,
898 unsigned char **p, unsigned char *end,
899 const unsigned char *cli_id, size_t cli_id_len )
900{
901 ((void) ctx);
902 ((void) p);
903 ((void) end);
904 ((void) cli_id);
905 ((void) cli_id_len);
906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200908}
909
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200910MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200911static int ssl_cookie_check_dummy( void *ctx,
912 const unsigned char *cookie, size_t cookie_len,
913 const unsigned char *cli_id, size_t cli_id_len )
914{
915 ((void) ctx);
916 ((void) cookie);
917 ((void) cookie_len);
918 ((void) cli_id);
919 ((void) cli_id_len);
920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200922}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200923#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200924
Paul Bakker5121ce52009-01-03 21:22:43 +0000925/*
926 * Initialize an SSL context
927 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200928void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
929{
930 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
931}
932
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200933MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800934static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
935{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100936 const mbedtls_ssl_config *conf = ssl->conf;
937
Ronald Cron6f135e12021-12-08 16:57:54 +0100938#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100939 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
940 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000941 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
Jerry Yu60835a82021-08-04 10:13:52 +0800947 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
948 return( 0 );
949 }
950#endif
951
952#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100953 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800954 {
955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
956 return( 0 );
957 }
958#endif
959
Ronald Cron6f135e12021-12-08 16:57:54 +0100960#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100961 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800962 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
964 {
965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
966 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
967 }
968
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000969 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
970 {
971 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
972 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
973 }
974
975
Ronald Crone1d3f062022-02-10 14:50:54 +0100976 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
977 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800978 }
979#endif
980
981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
982 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
983}
984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200985MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800986static int ssl_conf_check(const mbedtls_ssl_context *ssl)
987{
988 int ret;
989 ret = ssl_conf_version_check( ssl );
990 if( ret != 0 )
991 return( ret );
992
993 /* Space for further checks */
994
995 return( 0 );
996}
997
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200998/*
999 * Setup an SSL context
1000 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001001
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001002int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001003 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004{
Janos Follath865b3eb2019-12-16 11:46:15 +00001005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001006 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1007 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001008
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001009 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001010
Jerry Yu60835a82021-08-04 10:13:52 +08001011 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1012 return( ret );
1013
Paul Bakker62f2dee2012-09-28 07:31:51 +00001014 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001015 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001016 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001017
1018 /* Set to NULL in case of an error condition */
1019 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001020
Darryl Greenb33cc762019-11-28 14:29:44 +00001021#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1022 ssl->in_buf_len = in_buf_len;
1023#endif
1024 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001025 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001028 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001030 }
1031
Darryl Greenb33cc762019-11-28 14:29:44 +00001032#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1033 ssl->out_buf_len = out_buf_len;
1034#endif
1035 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001036 if( ssl->out_buf == NULL )
1037 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001039 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001040 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001041 }
1042
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001043 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001044
Johan Pascalb62bb512015-12-03 21:56:45 +01001045#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001046 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001047#endif
1048
Paul Bakker48916f92012-09-16 19:57:18 +00001049 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001050 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001051
1052 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001053
1054error:
1055 mbedtls_free( ssl->in_buf );
1056 mbedtls_free( ssl->out_buf );
1057
1058 ssl->conf = NULL;
1059
Darryl Greenb33cc762019-11-28 14:29:44 +00001060#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1061 ssl->in_buf_len = 0;
1062 ssl->out_buf_len = 0;
1063#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001064 ssl->in_buf = NULL;
1065 ssl->out_buf = NULL;
1066
1067 ssl->in_hdr = NULL;
1068 ssl->in_ctr = NULL;
1069 ssl->in_len = NULL;
1070 ssl->in_iv = NULL;
1071 ssl->in_msg = NULL;
1072
1073 ssl->out_hdr = NULL;
1074 ssl->out_ctr = NULL;
1075 ssl->out_len = NULL;
1076 ssl->out_iv = NULL;
1077 ssl->out_msg = NULL;
1078
k-stachowiak9f7798e2018-07-31 16:52:32 +02001079 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001080}
1081
1082/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001083 * Reset an initialized and used SSL context for re-use while retaining
1084 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001085 *
1086 * If partial is non-zero, keep data in the input buffer and client ID.
1087 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001088 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001089void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1090 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001091{
Darryl Greenb33cc762019-11-28 14:29:44 +00001092#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1093 size_t in_buf_len = ssl->in_buf_len;
1094 size_t out_buf_len = ssl->out_buf_len;
1095#else
1096 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1097 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1098#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001099
Hanno Beckerb0302c42021-08-03 09:39:42 +01001100#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1101 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001102#endif
1103
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001104 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001105 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001106
Hanno Beckerb0302c42021-08-03 09:39:42 +01001107 mbedtls_ssl_reset_in_out_pointers( ssl );
1108
1109 /* Reset incoming message parsing */
1110 ssl->in_offt = NULL;
1111 ssl->nb_zero = 0;
1112 ssl->in_msgtype = 0;
1113 ssl->in_msglen = 0;
1114 ssl->in_hslen = 0;
1115 ssl->keep_current_message = 0;
1116 ssl->transform_in = NULL;
1117
1118#if defined(MBEDTLS_SSL_PROTO_DTLS)
1119 ssl->next_record_offset = 0;
1120 ssl->in_epoch = 0;
1121#endif
1122
1123 /* Keep current datagram if partial == 1 */
1124 if( partial == 0 )
1125 {
1126 ssl->in_left = 0;
1127 memset( ssl->in_buf, 0, in_buf_len );
1128 }
1129
Ronald Cronad8c17b2022-06-10 17:18:09 +02001130 ssl->send_alert = 0;
1131
Hanno Beckerb0302c42021-08-03 09:39:42 +01001132 /* Reset outgoing message writing */
1133 ssl->out_msgtype = 0;
1134 ssl->out_msglen = 0;
1135 ssl->out_left = 0;
1136 memset( ssl->out_buf, 0, out_buf_len );
1137 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1138 ssl->transform_out = NULL;
1139
1140#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1141 mbedtls_ssl_dtls_replay_reset( ssl );
1142#endif
1143
XiaokangQian2b01dc32022-01-21 02:53:13 +00001144#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001145 if( ssl->transform )
1146 {
1147 mbedtls_ssl_transform_free( ssl->transform );
1148 mbedtls_free( ssl->transform );
1149 ssl->transform = NULL;
1150 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001151#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1152
XiaokangQian2b01dc32022-01-21 02:53:13 +00001153#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1154 mbedtls_ssl_transform_free( ssl->transform_application );
1155 mbedtls_free( ssl->transform_application );
1156 ssl->transform_application = NULL;
1157
1158 if( ssl->handshake != NULL )
1159 {
1160 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1161 mbedtls_free( ssl->handshake->transform_earlydata );
1162 ssl->handshake->transform_earlydata = NULL;
1163
1164 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1165 mbedtls_free( ssl->handshake->transform_handshake );
1166 ssl->handshake->transform_handshake = NULL;
1167 }
1168
XiaokangQian2b01dc32022-01-21 02:53:13 +00001169#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001170}
1171
1172int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1173{
1174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1175
1176 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1177
XiaokangQian78b1fa72022-01-19 06:56:30 +00001178 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001179
1180 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#if defined(MBEDTLS_SSL_RENEGOTIATION)
1182 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001183 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001184
1185 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1187 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001188#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001190
Hanno Beckerb0302c42021-08-03 09:39:42 +01001191 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001192 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001193 if( ssl->session )
1194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195 mbedtls_ssl_session_free( ssl->session );
1196 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001197 ssl->session = NULL;
1198 }
1199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001201 ssl->alpn_chosen = NULL;
1202#endif
1203
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001204#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001205#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001206 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001207#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001208 {
1209 mbedtls_free( ssl->cli_id );
1210 ssl->cli_id = NULL;
1211 ssl->cli_id_len = 0;
1212 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001213#endif
1214
Paul Bakker48916f92012-09-16 19:57:18 +00001215 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1216 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001217
1218 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001219}
1220
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001221/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001222 * Reset an initialized and used SSL context for re-use while retaining
1223 * all application-set variables, function pointers and data.
1224 */
1225int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1226{
Hanno Becker43aefe22020-02-05 10:44:56 +00001227 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001228}
1229
1230/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001231 * SSL set accessors
1232 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001233void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001236}
1237
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001238void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001239{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001240 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001241}
1242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001244void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001245{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001246 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001247}
1248#endif
1249
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001250void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001251{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001252 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001253}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001256
Hanno Becker1841b0a2018-08-24 11:13:57 +01001257void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1258 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001259{
1260 ssl->disable_datagram_packing = !allow_packing;
1261}
1262
1263void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1264 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001265{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001266 conf->hs_timeout_min = min;
1267 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001268}
1269#endif
1270
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001271void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001272{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001273 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001274}
1275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001277void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001278 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001279 void *p_vrfy )
1280{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001281 conf->f_vrfy = f_vrfy;
1282 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001283}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001285
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001286void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001287 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001288 void *p_rng )
1289{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001290 conf->f_rng = f_rng;
1291 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001292}
1293
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001294void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001295 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001296 void *p_dbg )
1297{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001298 conf->f_dbg = f_dbg;
1299 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001300}
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001303 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_send_t *f_send,
1305 mbedtls_ssl_recv_t *f_recv,
1306 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001307{
1308 ssl->p_bio = p_bio;
1309 ssl->f_send = f_send;
1310 ssl->f_recv = f_recv;
1311 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001312}
1313
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001314#if defined(MBEDTLS_SSL_PROTO_DTLS)
1315void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1316{
1317 ssl->mtu = mtu;
1318}
1319#endif
1320
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001321void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001322{
1323 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001324}
1325
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001326void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1327 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001328 mbedtls_ssl_set_timer_t *f_set_timer,
1329 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001330{
1331 ssl->p_timer = p_timer;
1332 ssl->f_set_timer = f_set_timer;
1333 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001334
1335 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001336 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001337}
1338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001340void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001341 void *p_cache,
1342 mbedtls_ssl_cache_get_t *f_get_cache,
1343 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001344{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001345 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001346 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001347 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001348}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#if defined(MBEDTLS_SSL_CLI_C)
1352int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001353{
Janos Follath865b3eb2019-12-16 11:46:15 +00001354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001355
1356 if( ssl == NULL ||
1357 session == NULL ||
1358 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001359 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001362 }
1363
Hanno Beckere810bbc2021-05-14 16:01:05 +01001364 if( ssl->handshake->resume == 1 )
1365 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1366
Hanno Becker52055ae2019-02-06 14:30:46 +00001367 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1368 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001369 return( ret );
1370
Paul Bakker0a597072012-09-25 21:55:46 +00001371 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001372
1373 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001376
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001377void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1378 const int *ciphersuites )
1379{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001380 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001381}
1382
Ronald Cron6f135e12021-12-08 16:57:54 +01001383#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001384void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001385 const int kex_modes )
1386{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001387 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001388}
Ronald Cron6f135e12021-12-08 16:57:54 +01001389#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001392void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001393 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001394{
1395 conf->cert_profile = profile;
1396}
1397
Glenn Strauss36872db2022-01-22 05:06:31 -05001398static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1399{
1400 mbedtls_ssl_key_cert *cur = key_cert, *next;
1401
1402 while( cur != NULL )
1403 {
1404 next = cur->next;
1405 mbedtls_free( cur );
1406 cur = next;
1407 }
1408}
1409
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001411MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001412static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1413 mbedtls_x509_crt *cert,
1414 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415{
niisato8ee24222018-06-25 19:05:48 +09001416 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417
Glenn Strauss36872db2022-01-22 05:06:31 -05001418 if( cert == NULL )
1419 {
1420 /* Free list if cert is null */
1421 ssl_key_cert_free( *head );
1422 *head = NULL;
1423 return( 0 );
1424 }
1425
niisato8ee24222018-06-25 19:05:48 +09001426 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1427 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001428 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001429
niisato8ee24222018-06-25 19:05:48 +09001430 new_cert->cert = cert;
1431 new_cert->key = key;
1432 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001433
Glenn Strauss36872db2022-01-22 05:06:31 -05001434 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001435 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001436 {
niisato8ee24222018-06-25 19:05:48 +09001437 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001438 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001439 else
1440 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001441 mbedtls_ssl_key_cert *cur = *head;
1442 while( cur->next != NULL )
1443 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001444 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001445 }
1446
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001447 return( 0 );
1448}
1449
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001450int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001451 mbedtls_x509_crt *own_cert,
1452 mbedtls_pk_context *pk_key )
1453{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001454 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001455}
1456
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001457void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001458 mbedtls_x509_crt *ca_chain,
1459 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001460{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001461 conf->ca_chain = ca_chain;
1462 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001463
1464#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1465 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1466 * cannot be used together. */
1467 conf->f_ca_cb = NULL;
1468 conf->p_ca_cb = NULL;
1469#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001470}
Hanno Becker5adaad92019-03-27 16:54:37 +00001471
1472#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1473void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001474 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001475 void *p_ca_cb )
1476{
1477 conf->f_ca_cb = f_ca_cb;
1478 conf->p_ca_cb = p_ca_cb;
1479
1480 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1481 * cannot be used together. */
1482 conf->ca_chain = NULL;
1483 conf->ca_crl = NULL;
1484}
1485#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001487
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001488#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001489const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1490 size_t *name_len )
1491{
1492 *name_len = ssl->handshake->sni_name_len;
1493 return( ssl->handshake->sni_name );
1494}
1495
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001496int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1497 mbedtls_x509_crt *own_cert,
1498 mbedtls_pk_context *pk_key )
1499{
1500 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1501 own_cert, pk_key ) );
1502}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001503
1504void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1505 mbedtls_x509_crt *ca_chain,
1506 mbedtls_x509_crl *ca_crl )
1507{
1508 ssl->handshake->sni_ca_chain = ca_chain;
1509 ssl->handshake->sni_ca_crl = ca_crl;
1510}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001511
Glenn Strauss999ef702022-03-11 01:37:23 -05001512#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1513void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1514 const mbedtls_x509_crt *crt)
1515{
1516 ssl->handshake->dn_hints = crt;
1517}
1518#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1519
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001520void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1521 int authmode )
1522{
1523 ssl->handshake->sni_authmode = authmode;
1524}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001525#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1526
Hanno Becker8927c832019-04-03 12:52:50 +01001527#if defined(MBEDTLS_X509_CRT_PARSE_C)
1528void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1529 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1530 void *p_vrfy )
1531{
1532 ssl->f_vrfy = f_vrfy;
1533 ssl->p_vrfy = p_vrfy;
1534}
1535#endif
1536
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001537#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001538/*
1539 * Set EC J-PAKE password for current handshake
1540 */
1541int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1542 const unsigned char *pw,
1543 size_t pw_len )
1544{
1545 mbedtls_ecjpake_role role;
1546
Janos Follath8eb64132016-06-03 15:40:57 +01001547 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001548 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1549
1550 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1551 role = MBEDTLS_ECJPAKE_SERVER;
1552 else
1553 role = MBEDTLS_ECJPAKE_CLIENT;
1554
1555 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1556 role,
1557 MBEDTLS_MD_SHA256,
1558 MBEDTLS_ECP_DP_SECP256R1,
1559 pw, pw_len ) );
1560}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001561#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001562
Gilles Peskineeccd8882020-03-10 12:19:08 +01001563#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001564
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001565MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001566static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1567{
1568#if defined(MBEDTLS_USE_PSA_CRYPTO)
1569 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1570 return( 1 );
1571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001572 if( conf->psk != NULL )
1573 return( 1 );
1574
1575 return( 0 );
1576}
1577
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001578static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1579{
1580 /* Remove reference to existing PSK, if any. */
1581#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001582 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001583 {
1584 /* The maintenance of the PSK key slot is the
1585 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001586 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001587 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001588#endif /* MBEDTLS_USE_PSA_CRYPTO */
1589 if( conf->psk != NULL )
1590 {
1591 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1592
1593 mbedtls_free( conf->psk );
1594 conf->psk = NULL;
1595 conf->psk_len = 0;
1596 }
1597
1598 /* Remove reference to PSK identity, if any. */
1599 if( conf->psk_identity != NULL )
1600 {
1601 mbedtls_free( conf->psk_identity );
1602 conf->psk_identity = NULL;
1603 conf->psk_identity_len = 0;
1604 }
1605}
1606
Hanno Becker7390c712018-11-15 13:33:04 +00001607/* This function assumes that PSK identity in the SSL config is unset.
1608 * It checks that the provided identity is well-formed and attempts
1609 * to make a copy of it in the SSL config.
1610 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001611MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001612static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1613 unsigned char const *psk_identity,
1614 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001615{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001616 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001617 if( psk_identity == NULL ||
1618 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001619 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001620 {
1621 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1622 }
1623
Hanno Becker7390c712018-11-15 13:33:04 +00001624 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1625 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001626 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001627
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001628 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001629 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001630
1631 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001632}
1633
Hanno Becker7390c712018-11-15 13:33:04 +00001634int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1635 const unsigned char *psk, size_t psk_len,
1636 const unsigned char *psk_identity, size_t psk_identity_len )
1637{
Janos Follath865b3eb2019-12-16 11:46:15 +00001638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001639
1640 /* We currently only support one PSK, raw or opaque. */
1641 if( ssl_conf_psk_is_configured( conf ) )
1642 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001643
1644 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001645 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001647 if( psk_len == 0 )
1648 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1649 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1651
Hanno Becker7390c712018-11-15 13:33:04 +00001652 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1653 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1654 conf->psk_len = psk_len;
1655 memcpy( conf->psk, psk, conf->psk_len );
1656
1657 /* Check and set PSK Identity */
1658 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1659 if( ret != 0 )
1660 ssl_conf_remove_psk( conf );
1661
1662 return( ret );
1663}
1664
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001665static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1666{
1667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001668 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001669 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001670 /* The maintenance of the external PSK key slot is the
1671 * user's responsibility. */
1672 if( ssl->handshake->psk_opaque_is_internal )
1673 {
1674 psa_destroy_key( ssl->handshake->psk_opaque );
1675 ssl->handshake->psk_opaque_is_internal = 0;
1676 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001677 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001678 }
Neil Armstronge952a302022-05-03 10:22:14 +02001679#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680 if( ssl->handshake->psk != NULL )
1681 {
1682 mbedtls_platform_zeroize( ssl->handshake->psk,
1683 ssl->handshake->psk_len );
1684 mbedtls_free( ssl->handshake->psk );
1685 ssl->handshake->psk_len = 0;
1686 }
Neil Armstronge952a302022-05-03 10:22:14 +02001687#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001688}
1689
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001690int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1691 const unsigned char *psk, size_t psk_len )
1692{
Neil Armstrong501c9322022-05-03 09:35:09 +02001693#if defined(MBEDTLS_USE_PSA_CRYPTO)
1694 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1695 psa_status_t status;
1696 psa_algorithm_t alg;
1697 mbedtls_svc_key_id_t key;
1698#endif /* MBEDTLS_USE_PSA_CRYPTO */
1699
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001700 if( psk == NULL || ssl->handshake == NULL )
1701 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1702
1703 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1705
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001707
Neil Armstrong501c9322022-05-03 09:35:09 +02001708#if defined(MBEDTLS_USE_PSA_CRYPTO)
1709 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1710 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1711 else
1712 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1713
Jerry Yu568ec252022-07-22 21:27:34 +08001714#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1c105562022-07-10 06:32:38 +00001715 psa_set_key_usage_flags( &key_attributes,
1716 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
Jerry Yu568ec252022-07-22 21:27:34 +08001717#else
Neil Armstrong501c9322022-05-03 09:35:09 +02001718 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
Jerry Yu568ec252022-07-22 21:27:34 +08001719#endif
Neil Armstrong501c9322022-05-03 09:35:09 +02001720 psa_set_key_algorithm( &key_attributes, alg );
1721 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1722
1723 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1724 if( status != PSA_SUCCESS )
1725 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1726
1727 /* Allow calling psa_destroy_key() on psk remove */
1728 ssl->handshake->psk_opaque_is_internal = 1;
1729 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1730#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001731 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001733
1734 ssl->handshake->psk_len = psk_len;
1735 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1736
1737 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001738#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001739}
1740
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001741#if defined(MBEDTLS_USE_PSA_CRYPTO)
1742int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001743 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001744 const unsigned char *psk_identity,
1745 size_t psk_identity_len )
1746{
Janos Follath865b3eb2019-12-16 11:46:15 +00001747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001748
1749 /* We currently only support one PSK, raw or opaque. */
1750 if( ssl_conf_psk_is_configured( conf ) )
1751 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001752
Hanno Becker7390c712018-11-15 13:33:04 +00001753 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001754 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001756 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001757
1758 /* Check and set PSK Identity */
1759 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1760 psk_identity_len );
1761 if( ret != 0 )
1762 ssl_conf_remove_psk( conf );
1763
1764 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001765}
1766
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001767int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1768 mbedtls_svc_key_id_t psk )
1769{
1770 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1771 ( ssl->handshake == NULL ) )
1772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1773
1774 ssl_remove_psk( ssl );
1775 ssl->handshake->psk_opaque = psk;
1776 return( 0 );
1777}
1778#endif /* MBEDTLS_USE_PSA_CRYPTO */
1779
1780void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1781 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1782 size_t),
1783 void *p_psk )
1784{
1785 conf->f_psk = f_psk;
1786 conf->p_psk = p_psk;
1787}
1788#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1789
1790#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001791static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1792 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001793{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001794#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001795 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001796 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001797#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001798 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001799 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001800 return( MBEDTLS_SSL_MODE_STREAM );
1801}
1802
1803#else /* MBEDTLS_USE_PSA_CRYPTO */
1804
1805static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1806 mbedtls_cipher_mode_t mode )
1807{
1808#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1809 if( mode == MBEDTLS_MODE_CBC )
1810 return( MBEDTLS_SSL_MODE_CBC );
1811#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1812
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001813#if defined(MBEDTLS_GCM_C) || \
1814 defined(MBEDTLS_CCM_C) || \
1815 defined(MBEDTLS_CHACHAPOLY_C)
1816 if( mode == MBEDTLS_MODE_GCM ||
1817 mode == MBEDTLS_MODE_CCM ||
1818 mode == MBEDTLS_MODE_CHACHAPOLY )
1819 return( MBEDTLS_SSL_MODE_AEAD );
1820#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001821
1822 return( MBEDTLS_SSL_MODE_STREAM );
1823}
Gilles Peskine301711e2022-04-26 16:57:05 +02001824#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001825
Gilles Peskinee108d982022-04-26 16:50:40 +02001826static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1827 mbedtls_ssl_mode_t base_mode,
1828 int encrypt_then_mac )
1829{
1830#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1831 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1832 base_mode == MBEDTLS_SSL_MODE_CBC )
1833 {
1834 return( MBEDTLS_SSL_MODE_CBC_ETM );
1835 }
1836#else
1837 (void) encrypt_then_mac;
1838#endif
1839 return( base_mode );
1840}
1841
Neil Armstrongab555e02022-04-04 11:07:59 +02001842mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001843 const mbedtls_ssl_transform *transform )
1844{
Gilles Peskinee108d982022-04-26 16:50:40 +02001845 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001846#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001847 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001848#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001849 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1850#endif
1851 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001852
Gilles Peskinee108d982022-04-26 16:50:40 +02001853 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001854#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001855 encrypt_then_mac = transform->encrypt_then_mac;
1856#endif
1857 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001858}
1859
Neil Armstrongab555e02022-04-04 11:07:59 +02001860mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001861#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001862 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001863#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001864 const mbedtls_ssl_ciphersuite_t *suite )
1865{
Gilles Peskinee108d982022-04-26 16:50:40 +02001866 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1867
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001868#if defined(MBEDTLS_USE_PSA_CRYPTO)
1869 psa_status_t status;
1870 psa_algorithm_t alg;
1871 psa_key_type_t type;
1872 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001873 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1874 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001875 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001876#else
1877 const mbedtls_cipher_info_t *cipher =
1878 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001879 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001880 {
1881 base_mode =
1882 mbedtls_ssl_get_base_mode(
1883 mbedtls_cipher_info_get_mode( cipher ) );
1884 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001885#endif /* MBEDTLS_USE_PSA_CRYPTO */
1886
Gilles Peskinee108d982022-04-26 16:50:40 +02001887#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1888 int encrypt_then_mac = 0;
1889#endif
1890 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001891}
1892
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001893#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001894
1895#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00001896/* Serialization of TLS 1.3 sessions:
1897 *
1898 * struct {
1899 * uint64 ticket_received;
1900 * uint32 ticket_lifetime;
1901 * opaque ticket<0..2^16>;
1902 * } ClientOnlyData;
1903 *
1904 * struct {
1905 * uint8 endpoint;
1906 * uint8 ciphersuite[2];
1907 * uint32 ticket_age_add;
1908 * uint8 ticket_flags;
1909 * opaque resumption_key<0..255>;
1910 * select ( endpoint ) {
1911 * case client: ClientOnlyData;
1912 * case server: uint64 start_time;
1913 * };
1914 * } serialized_session_tls13;
1915 *
1916 */
1917#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1918static size_t ssl_tls13_session_save( const mbedtls_ssl_session *session,
1919 unsigned char *buf,
1920 size_t buf_len )
1921{
1922 unsigned char *p = buf;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001923 size_t needed = 1 /* endpoint */
1924 + 2 /* ciphersuite */
1925 + 4 /* ticket_age_add */
1926 + 2 /* resumption_key length */
1927 + session->resumption_key_len; /* resumption_key */
Jerry Yu438ddd82022-07-07 06:55:50 +00001928
1929#if defined(MBEDTLS_HAVE_TIME)
1930 needed += 8; /* start_time or ticket_received */
1931#endif
1932
1933#if defined(MBEDTLS_SSL_CLI_C)
1934 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1935 {
1936 needed += 4 /* ticket_lifetime */
1937 + 2 /* ticket_len */
1938 + session->ticket_len; /* ticket */
1939 }
1940#endif /* MBEDTLS_SSL_CLI_C */
1941
1942 if( needed > buf_len )
1943 return( needed );
1944
1945 p[0] = session->endpoint;
1946 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
1947 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
1948 p[7] = session->ticket_flags;
1949
1950 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08001951 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001952 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001953 memcpy( p, session->resumption_key, session->resumption_key_len );
1954 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001955
1956#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
1957 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
1958 {
1959 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
1960 p += 8;
1961 }
1962#endif /* MBEDTLS_HAVE_TIME */
1963
1964#if defined(MBEDTLS_SSL_CLI_C)
1965 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1966 {
1967#if defined(MBEDTLS_HAVE_TIME)
1968 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
1969 p += 8;
1970#endif
1971 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
1972 p += 4;
1973
1974 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
1975 p += 2;
1976 if( session->ticket_len > 0 )
1977 {
1978 memcpy( p, session->ticket, session->ticket_len );
1979 p += session->ticket_len;
1980 }
1981 }
1982#endif /* MBEDTLS_SSL_CLI_C */
1983 return( needed );
1984}
1985
1986MBEDTLS_CHECK_RETURN_CRITICAL
1987static int ssl_tls13_session_load( mbedtls_ssl_session *session,
1988 const unsigned char *buf,
1989 size_t len )
1990{
1991 const unsigned char *p = buf;
1992 const unsigned char *end = buf + len;
1993
1994 if( end - p < 9 )
1995 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1996 session->endpoint = p[0];
1997 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
1998 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
1999 session->ticket_flags = p[7];
2000
2001 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002002 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002003 p += 9;
2004
Jerry Yubc7c1a42022-07-21 22:57:37 +08002005 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002006 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2007
Jerry Yubc7c1a42022-07-21 22:57:37 +08002008 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002009 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002010 memcpy( session->resumption_key, p, session->resumption_key_len );
2011 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002012
2013#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2014 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2015 {
2016 if( end - p < 8 )
2017 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2018 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2019 p += 8;
2020 }
2021#endif /* MBEDTLS_HAVE_TIME */
2022
2023#if defined(MBEDTLS_SSL_CLI_C)
2024 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2025 {
2026#if defined(MBEDTLS_HAVE_TIME)
2027 if( end - p < 8 )
2028 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2029 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2030 p += 8;
2031#endif
2032 if( end - p < 4 )
2033 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2034 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2035 p += 4;
2036
2037 if( end - p < 2 )
2038 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2039 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2040 p += 2;
2041
2042 if( end - p < ( long int )session->ticket_len )
2043 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2044 if( session->ticket_len > 0 )
2045 {
2046 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2047 if( session->ticket == NULL )
2048 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2049 memcpy( session->ticket, p, session->ticket_len );
2050 p += session->ticket_len;
2051 }
2052 }
2053#endif /* MBEDTLS_SSL_CLI_C */
2054
2055 return( 0 );
2056
2057}
2058#else /* MBEDTLS_SSL_SESSION_TICKETS */
2059static size_t ssl_tls13_session_save( const mbedtls_ssl_session *session,
Jerry Yu251a12e2022-07-13 15:15:48 +08002060 unsigned char *buf,
2061 size_t buf_len )
2062{
2063 ((void) session);
2064 ((void) buf);
2065 ((void) buf_len);
2066 return( 0 );
2067}
Jerry Yu438ddd82022-07-07 06:55:50 +00002068
2069static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2070 unsigned char *buf,
2071 size_t buf_len )
2072{
2073 ((void) session);
2074 ((void) buf);
2075 ((void) buf_len);
2076 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2077}
2078#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002079#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2080
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002081psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002082 size_t taglen,
2083 psa_algorithm_t *alg,
2084 psa_key_type_t *key_type,
2085 size_t *key_size )
2086{
2087 switch ( mbedtls_cipher_type )
2088 {
2089 case MBEDTLS_CIPHER_AES_128_CBC:
2090 *alg = PSA_ALG_CBC_NO_PADDING;
2091 *key_type = PSA_KEY_TYPE_AES;
2092 *key_size = 128;
2093 break;
2094 case MBEDTLS_CIPHER_AES_128_CCM:
2095 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2096 *key_type = PSA_KEY_TYPE_AES;
2097 *key_size = 128;
2098 break;
2099 case MBEDTLS_CIPHER_AES_128_GCM:
2100 *alg = PSA_ALG_GCM;
2101 *key_type = PSA_KEY_TYPE_AES;
2102 *key_size = 128;
2103 break;
2104 case MBEDTLS_CIPHER_AES_192_CCM:
2105 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2106 *key_type = PSA_KEY_TYPE_AES;
2107 *key_size = 192;
2108 break;
2109 case MBEDTLS_CIPHER_AES_192_GCM:
2110 *alg = PSA_ALG_GCM;
2111 *key_type = PSA_KEY_TYPE_AES;
2112 *key_size = 192;
2113 break;
2114 case MBEDTLS_CIPHER_AES_256_CBC:
2115 *alg = PSA_ALG_CBC_NO_PADDING;
2116 *key_type = PSA_KEY_TYPE_AES;
2117 *key_size = 256;
2118 break;
2119 case MBEDTLS_CIPHER_AES_256_CCM:
2120 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2121 *key_type = PSA_KEY_TYPE_AES;
2122 *key_size = 256;
2123 break;
2124 case MBEDTLS_CIPHER_AES_256_GCM:
2125 *alg = PSA_ALG_GCM;
2126 *key_type = PSA_KEY_TYPE_AES;
2127 *key_size = 256;
2128 break;
2129 case MBEDTLS_CIPHER_ARIA_128_CBC:
2130 *alg = PSA_ALG_CBC_NO_PADDING;
2131 *key_type = PSA_KEY_TYPE_ARIA;
2132 *key_size = 128;
2133 break;
2134 case MBEDTLS_CIPHER_ARIA_128_CCM:
2135 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2136 *key_type = PSA_KEY_TYPE_ARIA;
2137 *key_size = 128;
2138 break;
2139 case MBEDTLS_CIPHER_ARIA_128_GCM:
2140 *alg = PSA_ALG_GCM;
2141 *key_type = PSA_KEY_TYPE_ARIA;
2142 *key_size = 128;
2143 break;
2144 case MBEDTLS_CIPHER_ARIA_192_CCM:
2145 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2146 *key_type = PSA_KEY_TYPE_ARIA;
2147 *key_size = 192;
2148 break;
2149 case MBEDTLS_CIPHER_ARIA_192_GCM:
2150 *alg = PSA_ALG_GCM;
2151 *key_type = PSA_KEY_TYPE_ARIA;
2152 *key_size = 192;
2153 break;
2154 case MBEDTLS_CIPHER_ARIA_256_CBC:
2155 *alg = PSA_ALG_CBC_NO_PADDING;
2156 *key_type = PSA_KEY_TYPE_ARIA;
2157 *key_size = 256;
2158 break;
2159 case MBEDTLS_CIPHER_ARIA_256_CCM:
2160 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2161 *key_type = PSA_KEY_TYPE_ARIA;
2162 *key_size = 256;
2163 break;
2164 case MBEDTLS_CIPHER_ARIA_256_GCM:
2165 *alg = PSA_ALG_GCM;
2166 *key_type = PSA_KEY_TYPE_ARIA;
2167 *key_size = 256;
2168 break;
2169 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2170 *alg = PSA_ALG_CBC_NO_PADDING;
2171 *key_type = PSA_KEY_TYPE_CAMELLIA;
2172 *key_size = 128;
2173 break;
2174 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2175 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2176 *key_type = PSA_KEY_TYPE_CAMELLIA;
2177 *key_size = 128;
2178 break;
2179 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2180 *alg = PSA_ALG_GCM;
2181 *key_type = PSA_KEY_TYPE_CAMELLIA;
2182 *key_size = 128;
2183 break;
2184 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2185 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2186 *key_type = PSA_KEY_TYPE_CAMELLIA;
2187 *key_size = 192;
2188 break;
2189 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2190 *alg = PSA_ALG_GCM;
2191 *key_type = PSA_KEY_TYPE_CAMELLIA;
2192 *key_size = 192;
2193 break;
2194 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2195 *alg = PSA_ALG_CBC_NO_PADDING;
2196 *key_type = PSA_KEY_TYPE_CAMELLIA;
2197 *key_size = 256;
2198 break;
2199 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2200 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2201 *key_type = PSA_KEY_TYPE_CAMELLIA;
2202 *key_size = 256;
2203 break;
2204 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2205 *alg = PSA_ALG_GCM;
2206 *key_type = PSA_KEY_TYPE_CAMELLIA;
2207 *key_size = 256;
2208 break;
2209 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2210 *alg = PSA_ALG_CHACHA20_POLY1305;
2211 *key_type = PSA_KEY_TYPE_CHACHA20;
2212 *key_size = 256;
2213 break;
2214 case MBEDTLS_CIPHER_NULL:
2215 *alg = MBEDTLS_SSL_NULL_CIPHER;
2216 *key_type = 0;
2217 *key_size = 0;
2218 break;
2219 default:
2220 return PSA_ERROR_NOT_SUPPORTED;
2221 }
2222
2223 return PSA_SUCCESS;
2224}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002225#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002226
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002227#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002228int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2229 const unsigned char *dhm_P, size_t P_len,
2230 const unsigned char *dhm_G, size_t G_len )
2231{
Janos Follath865b3eb2019-12-16 11:46:15 +00002232 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002233
Glenn Strausscee11292021-12-20 01:43:17 -05002234 mbedtls_mpi_free( &conf->dhm_P );
2235 mbedtls_mpi_free( &conf->dhm_G );
2236
Hanno Beckera90658f2017-10-04 15:29:08 +01002237 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2238 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2239 {
2240 mbedtls_mpi_free( &conf->dhm_P );
2241 mbedtls_mpi_free( &conf->dhm_G );
2242 return( ret );
2243 }
2244
2245 return( 0 );
2246}
Paul Bakker5121ce52009-01-03 21:22:43 +00002247
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002248int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002249{
Janos Follath865b3eb2019-12-16 11:46:15 +00002250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002251
Glenn Strausscee11292021-12-20 01:43:17 -05002252 mbedtls_mpi_free( &conf->dhm_P );
2253 mbedtls_mpi_free( &conf->dhm_G );
2254
Gilles Peskinee5702482021-06-11 21:59:08 +02002255 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2256 &conf->dhm_P ) ) != 0 ||
2257 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2258 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002259 {
2260 mbedtls_mpi_free( &conf->dhm_P );
2261 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002262 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002263 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002264
2265 return( 0 );
2266}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002267#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002268
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002269#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2270/*
2271 * Set the minimum length for Diffie-Hellman parameters
2272 */
2273void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2274 unsigned int bitlen )
2275{
2276 conf->dhm_min_bitlen = bitlen;
2277}
2278#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2279
Gilles Peskineeccd8882020-03-10 12:19:08 +01002280#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002281#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002282/*
2283 * Set allowed/preferred hashes for handshake signatures
2284 */
2285void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2286 const int *hashes )
2287{
2288 conf->sig_hashes = hashes;
2289}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002290#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002291
Jerry Yuf017ee42022-01-12 15:49:48 +08002292/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002293void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2294 const uint16_t* sig_algs )
2295{
Jerry Yuf017ee42022-01-12 15:49:48 +08002296#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2297 conf->sig_hashes = NULL;
2298#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2299 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002300}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002301#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002302
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002303#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002304#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002305/*
2306 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002307 *
2308 * mbedtls_ssl_setup() takes the provided list
2309 * and translates it to a list of IANA TLS group identifiers,
2310 * stored in ssl->handshake->group_list.
2311 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002312 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002313void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002314 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002315{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002316 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002317 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002318}
Brett Warrene0edc842021-08-17 09:53:13 +01002319#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002320#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002321
Brett Warrene0edc842021-08-17 09:53:13 +01002322/*
2323 * Set the allowed groups
2324 */
2325void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2326 const uint16_t *group_list )
2327{
2328#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2329 conf->curve_list = NULL;
2330#endif
2331 conf->group_list = group_list;
2332}
2333
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002334#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002336{
Hanno Becker947194e2017-04-07 13:25:49 +01002337 /* Initialize to suppress unnecessary compiler warning */
2338 size_t hostname_len = 0;
2339
2340 /* Check if new hostname is valid before
2341 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002342 if( hostname != NULL )
2343 {
2344 hostname_len = strlen( hostname );
2345
2346 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2347 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2348 }
2349
2350 /* Now it's clear that we will overwrite the old hostname,
2351 * so we can free it safely */
2352
2353 if( ssl->hostname != NULL )
2354 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002355 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002356 mbedtls_free( ssl->hostname );
2357 }
2358
2359 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002360
Paul Bakker5121ce52009-01-03 21:22:43 +00002361 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002362 {
2363 ssl->hostname = NULL;
2364 }
2365 else
2366 {
2367 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002368 if( ssl->hostname == NULL )
2369 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002370
Hanno Becker947194e2017-04-07 13:25:49 +01002371 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002372
Hanno Becker947194e2017-04-07 13:25:49 +01002373 ssl->hostname[hostname_len] = '\0';
2374 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002375
2376 return( 0 );
2377}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002378#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002379
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002380#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002381void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002383 const unsigned char *, size_t),
2384 void *p_sni )
2385{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002386 conf->f_sni = f_sni;
2387 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002388}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002392int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002393{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002394 size_t cur_len, tot_len;
2395 const char **p;
2396
2397 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002398 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2399 * MUST NOT be truncated."
2400 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002401 */
2402 tot_len = 0;
2403 for( p = protos; *p != NULL; p++ )
2404 {
2405 cur_len = strlen( *p );
2406 tot_len += cur_len;
2407
Ronald Cron8216dd32020-04-23 16:41:44 +02002408 if( ( cur_len == 0 ) ||
2409 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2410 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002411 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002412 }
2413
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002414 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002415
2416 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002417}
2418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002420{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002421 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002422}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002424
Johan Pascalb62bb512015-12-03 21:56:45 +01002425#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002426void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2427 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002428{
2429 conf->dtls_srtp_mki_support = support_mki_value;
2430}
2431
Ron Eldoref72faf2018-07-12 11:54:20 +03002432int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2433 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002434 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002435{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002436 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002437 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002438 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002439 }
Ron Eldor591f1622018-01-22 12:30:04 +02002440
2441 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002442 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002443 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002444 }
Ron Eldor591f1622018-01-22 12:30:04 +02002445
2446 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2447 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002448 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002449}
2450
Ron Eldoref72faf2018-07-12 11:54:20 +03002451int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002452 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002453{
Johan Pascal253d0262020-09-22 13:04:45 +02002454 const mbedtls_ssl_srtp_profile *p;
2455 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002456
Johan Pascal253d0262020-09-22 13:04:45 +02002457 /* check the profiles list: all entry must be valid,
2458 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002459 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2460 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2461 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002462 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002463 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002464 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002465 list_size++;
2466 }
2467 else
2468 {
2469 /* unsupported value, stop parsing and set the size to an error value */
2470 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002471 }
2472 }
2473
Johan Pascal5ef72d22020-10-28 17:05:47 +01002474 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002475 {
Johan Pascal253d0262020-09-22 13:04:45 +02002476 conf->dtls_srtp_profile_list = NULL;
2477 conf->dtls_srtp_profile_list_len = 0;
2478 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2479 }
2480
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002481 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002482 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002483
2484 return( 0 );
2485}
2486
Johan Pascal5ef72d22020-10-28 17:05:47 +01002487void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2488 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002489{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002490 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2491 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002492 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002493 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002494 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002495 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002496 else
2497 {
2498 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002499 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2500 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002501 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002502}
Johan Pascalb62bb512015-12-03 21:56:45 +01002503#endif /* MBEDTLS_SSL_DTLS_SRTP */
2504
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302505#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002506void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002507{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002508 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002509}
2510
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002511void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002512{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002513 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002514}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302515#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002516
Janos Follath088ce432017-04-10 12:42:31 +01002517#if defined(MBEDTLS_SSL_SRV_C)
2518void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2519 char cert_req_ca_list )
2520{
2521 conf->cert_req_ca_list = cert_req_ca_list;
2522}
2523#endif
2524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002526void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002527{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002528 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002529}
2530#endif
2531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002533void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002534{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002535 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002536}
2537#endif
2538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002540int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002541{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002543 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002544 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002546 }
2547
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002548 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002549
2550 return( 0 );
2551}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002553
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002554void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002555{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002556 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002557}
2558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002560void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002561{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002562 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002563}
2564
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002565void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002566{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002567 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002568}
2569
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002570void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002571 const unsigned char period[8] )
2572{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002573 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002574}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002578#if defined(MBEDTLS_SSL_CLI_C)
2579void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002580{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002581 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002582}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002583#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002584
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002585#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002586void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2587 mbedtls_ssl_ticket_write_t *f_ticket_write,
2588 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2589 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002590{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002591 conf->f_ticket_write = f_ticket_write;
2592 conf->f_ticket_parse = f_ticket_parse;
2593 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002594}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002595#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002597
Hanno Becker7e6c1782021-06-08 09:24:55 +01002598void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2599 mbedtls_ssl_export_keys_t *f_export_keys,
2600 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002601{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002602 ssl->f_export_keys = f_export_keys;
2603 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002604}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002605
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002606#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002607void mbedtls_ssl_conf_async_private_cb(
2608 mbedtls_ssl_config *conf,
2609 mbedtls_ssl_async_sign_t *f_async_sign,
2610 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2611 mbedtls_ssl_async_resume_t *f_async_resume,
2612 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002613 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002614{
2615 conf->f_async_sign_start = f_async_sign;
2616 conf->f_async_decrypt_start = f_async_decrypt;
2617 conf->f_async_resume = f_async_resume;
2618 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002619 conf->p_async_config_data = async_config_data;
2620}
2621
Gilles Peskine8f97af72018-04-26 11:46:10 +02002622void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2623{
2624 return( conf->p_async_config_data );
2625}
2626
Gilles Peskine1febfef2018-04-30 11:54:39 +02002627void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002628{
2629 if( ssl->handshake == NULL )
2630 return( NULL );
2631 else
2632 return( ssl->handshake->user_async_ctx );
2633}
2634
Gilles Peskine1febfef2018-04-30 11:54:39 +02002635void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002636 void *ctx )
2637{
2638 if( ssl->handshake != NULL )
2639 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002640}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002641#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002642
Paul Bakker5121ce52009-01-03 21:22:43 +00002643/*
2644 * SSL get accessors
2645 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002646uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002647{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002648 if( ssl->session != NULL )
2649 return( ssl->session->verify_result );
2650
2651 if( ssl->session_negotiate != NULL )
2652 return( ssl->session_negotiate->verify_result );
2653
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002654 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002655}
2656
Glenn Strauss8f526902022-01-13 00:04:49 -05002657int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2658{
2659 if( ssl == NULL || ssl->session == NULL )
2660 return( 0 );
2661
2662 return( ssl->session->ciphersuite );
2663}
2664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002666{
Paul Bakker926c8e42013-03-06 10:23:34 +01002667 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002668 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002671}
2672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002674{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002676 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002677 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002678 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002679 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002680 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002681 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002682 default:
2683 return( "unknown (DTLS)" );
2684 }
2685 }
2686#endif
2687
Glenn Strauss60bfe602022-03-14 19:04:24 -04002688 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002689 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002690 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002691 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002692 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002693 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002694 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002695 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002696 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002697}
2698
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002699#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002700size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2701{
David Horstmann95d516f2021-05-04 18:36:56 +01002702 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002703 size_t read_mfl;
2704
2705 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2706 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2707 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2708 {
2709 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2710 }
2711
2712 /* Check if a smaller max length was negotiated */
2713 if( ssl->session_out != NULL )
2714 {
2715 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2716 if( read_mfl < max_len )
2717 {
2718 max_len = read_mfl;
2719 }
2720 }
2721
2722 // During a handshake, use the value being negotiated
2723 if( ssl->session_negotiate != NULL )
2724 {
2725 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2726 if( read_mfl < max_len )
2727 {
2728 max_len = read_mfl;
2729 }
2730 }
2731
2732 return( max_len );
2733}
2734
2735size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002736{
2737 size_t max_len;
2738
2739 /*
2740 * Assume mfl_code is correct since it was checked when set
2741 */
Angus Grattond8213d02016-05-25 20:56:48 +10002742 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002743
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002744 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002745 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002746 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002747 {
Angus Grattond8213d02016-05-25 20:56:48 +10002748 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002749 }
2750
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002751 /* During a handshake, use the value being negotiated */
2752 if( ssl->session_negotiate != NULL &&
2753 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2754 {
2755 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2756 }
2757
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002758 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002759}
2760#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2761
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002762#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002763size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002764{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002765 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2766 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2767 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2768 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2769 return ( 0 );
2770
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002771 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2772 return( ssl->mtu );
2773
2774 if( ssl->mtu == 0 )
2775 return( ssl->handshake->mtu );
2776
2777 return( ssl->mtu < ssl->handshake->mtu ?
2778 ssl->mtu : ssl->handshake->mtu );
2779}
2780#endif /* MBEDTLS_SSL_PROTO_DTLS */
2781
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002782int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2783{
2784 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2785
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002786#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2787 !defined(MBEDTLS_SSL_PROTO_DTLS)
2788 (void) ssl;
2789#endif
2790
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002791#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002792 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002793
2794 if( max_len > mfl )
2795 max_len = mfl;
2796#endif
2797
2798#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002799 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002800 {
Hanno Becker89490712020-02-05 10:50:12 +00002801 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002802 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2803 const size_t overhead = (size_t) ret;
2804
2805 if( ret < 0 )
2806 return( ret );
2807
2808 if( mtu <= overhead )
2809 {
2810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2811 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2812 }
2813
2814 if( max_len > mtu - overhead )
2815 max_len = mtu - overhead;
2816 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002817#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002818
Hanno Becker0defedb2018-08-10 12:35:02 +01002819#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2820 !defined(MBEDTLS_SSL_PROTO_DTLS)
2821 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002822#endif
2823
2824 return( (int) max_len );
2825}
2826
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002827int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2828{
2829 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2830
2831#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2832 (void) ssl;
2833#endif
2834
2835#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2836 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2837
2838 if( max_len > mfl )
2839 max_len = mfl;
2840#endif
2841
2842 return( (int) max_len );
2843}
2844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845#if defined(MBEDTLS_X509_CRT_PARSE_C)
2846const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002847{
2848 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002849 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002850
Hanno Beckere6824572019-02-07 13:18:46 +00002851#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002852 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002853#else
2854 return( NULL );
2855#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002856}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002860int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2861 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002862{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002863 int ret;
2864
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002865 if( ssl == NULL ||
2866 dst == NULL ||
2867 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002868 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002869 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002871 }
2872
Hanno Beckere810bbc2021-05-14 16:01:05 +01002873 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2874 * idempotent: Each session can only be exported once.
2875 *
2876 * (This is in preparation for TLS 1.3 support where we will
2877 * need the ability to export multiple sessions (aka tickets),
2878 * which will be achieved by calling mbedtls_ssl_get_session()
2879 * multiple times until it fails.)
2880 *
2881 * Check whether we have already exported the current session,
2882 * and fail if so.
2883 */
2884 if( ssl->session->exported == 1 )
2885 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2886
2887 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2888 if( ret != 0 )
2889 return( ret );
2890
2891 /* Remember that we've exported the session. */
2892 ssl->session->exported = 1;
2893 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002894}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002896
Paul Bakker5121ce52009-01-03 21:22:43 +00002897/*
Hanno Beckera835da52019-05-16 12:39:07 +01002898 * Define ticket header determining Mbed TLS version
2899 * and structure of the ticket.
2900 */
2901
Hanno Becker94ef3b32019-05-16 12:50:45 +01002902/*
Hanno Becker50b59662019-05-28 14:30:45 +01002903 * Define bitflag determining compile-time settings influencing
2904 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002905 */
2906
Hanno Becker50b59662019-05-28 14:30:45 +01002907#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002908#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002909#else
Hanno Becker3e088662019-05-29 11:10:18 +01002910#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002911#endif /* MBEDTLS_HAVE_TIME */
2912
2913#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002914#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002915#else
Hanno Becker3e088662019-05-29 11:10:18 +01002916#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002917#endif /* MBEDTLS_X509_CRT_PARSE_C */
2918
2919#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002920#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002921#else
Hanno Becker3e088662019-05-29 11:10:18 +01002922#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002923#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2924
2925#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002926#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002927#else
Hanno Becker3e088662019-05-29 11:10:18 +01002928#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002929#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2930
Hanno Becker94ef3b32019-05-16 12:50:45 +01002931#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002932#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002933#else
Hanno Becker3e088662019-05-29 11:10:18 +01002934#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002935#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2936
Hanno Becker94ef3b32019-05-16 12:50:45 +01002937#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2938#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2939#else
2940#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2941#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2942
Hanno Becker3e088662019-05-29 11:10:18 +01002943#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2944#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2945#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2946#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002947#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2948#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002949
Hanno Becker50b59662019-05-28 14:30:45 +01002950#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002951 ( (uint16_t) ( \
2952 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2953 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2954 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2955 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002956 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002957 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002958
Hanno Beckerf8787072019-05-16 12:41:07 +01002959static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002960 MBEDTLS_VERSION_MAJOR,
2961 MBEDTLS_VERSION_MINOR,
2962 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002963 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2964 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002965};
Hanno Beckera835da52019-05-16 12:39:07 +01002966
2967/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002968 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002969 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002970 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002971 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002972 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002973 * opaque mbedtls_version[3]; // library version: major, minor, patch
2974 * opaque session_format[2]; // library-version specific 16-bit field
2975 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002976 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002977 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002978 * Note: When updating the format, remember to keep
2979 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002980 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002981 * // In this version, `session_format` determines
2982 * // the setting of those compile-time
2983 * // configuration options which influence
2984 * // the structure of mbedtls_ssl_session.
2985 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002986 * uint8_t minor_ver; // Protocol minor version. Possible values:
2987 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002988 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002989 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002990 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002991 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002992 * serialized_session_tls12 data;
2993 *
2994 * };
2995 *
2996 * } serialized_session;
2997 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002998 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002999
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003000MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003001static int ssl_session_save( const mbedtls_ssl_session *session,
3002 unsigned char omit_header,
3003 unsigned char *buf,
3004 size_t buf_len,
3005 size_t *olen )
3006{
3007 unsigned char *p = buf;
3008 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003009 size_t remaining_len;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003010
Jerry Yu438ddd82022-07-07 06:55:50 +00003011 if( session == NULL )
3012 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3013
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003014 if( !omit_header )
3015 {
3016 /*
3017 * Add Mbed TLS version identifier
3018 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003019 used += sizeof( ssl_serialized_session_header );
3020
3021 if( used <= buf_len )
3022 {
3023 memcpy( p, ssl_serialized_session_header,
3024 sizeof( ssl_serialized_session_header ) );
3025 p += sizeof( ssl_serialized_session_header );
3026 }
3027 }
3028
3029 /*
3030 * TLS version identifier
3031 */
3032 used += 1;
3033 if( used <= buf_len )
3034 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003035 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003036 }
3037
3038 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003039 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003040 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003041 {
3042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003043 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003044 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003045 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3047
Jerry Yu251a12e2022-07-13 15:15:48 +08003048#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3049 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yu438ddd82022-07-07 06:55:50 +00003050 used += ssl_tls13_session_save( session, p, remaining_len );
Jerry Yu251a12e2022-07-13 15:15:48 +08003051 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003052#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3053
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003054 default:
3055 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3056 }
3057
3058 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003059 if( used > buf_len )
3060 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003061
3062 return( 0 );
3063}
3064
3065/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003066 * Public wrapper for ssl_session_save()
3067 */
3068int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3069 unsigned char *buf,
3070 size_t buf_len,
3071 size_t *olen )
3072{
3073 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3074}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003075
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003076/*
3077 * Deserialize session, see mbedtls_ssl_session_save() for format.
3078 *
3079 * This internal version is wrapped by a public function that cleans up in
3080 * case of error, and has an extra option omit_header.
3081 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003082MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003083static int ssl_session_load( mbedtls_ssl_session *session,
3084 unsigned char omit_header,
3085 const unsigned char *buf,
3086 size_t len )
3087{
3088 const unsigned char *p = buf;
3089 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003090 size_t remaining_len;
3091
3092
3093 if( session == NULL )
3094 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003095
3096 if( !omit_header )
3097 {
3098 /*
3099 * Check Mbed TLS version identifier
3100 */
3101
3102 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3103 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3104
3105 if( memcmp( p, ssl_serialized_session_header,
3106 sizeof( ssl_serialized_session_header ) ) != 0 )
3107 {
3108 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3109 }
3110 p += sizeof( ssl_serialized_session_header );
3111 }
3112
3113 /*
3114 * TLS version identifier
3115 */
3116 if( 1 > (size_t)( end - p ) )
3117 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003118 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003119
3120 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003121 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003122 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003123 {
3124#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003125 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003126 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003127#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3128
Jerry Yu438ddd82022-07-07 06:55:50 +00003129#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3130 case MBEDTLS_SSL_VERSION_TLS1_3:
3131 return( ssl_tls13_session_load( session, p, remaining_len ) );
3132#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3133
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003134 default:
3135 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3136 }
3137}
3138
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003139/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003140 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003141 */
3142int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3143 const unsigned char *buf,
3144 size_t len )
3145{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003146 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003147
3148 if( ret != 0 )
3149 mbedtls_ssl_session_free( session );
3150
3151 return( ret );
3152}
3153
3154/*
Paul Bakker1961b702013-01-25 14:49:24 +01003155 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003156 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003157MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003158static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3159{
3160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3161
Ronald Cron66dbf912022-02-02 15:33:46 +01003162 /*
3163 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003164 * that were written into the output buffer by the previous handshake step,
3165 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003166 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3167 * We proceed to the next handshake step only when all data from the
3168 * previous one have been sent to the peer, thus we make sure that this is
3169 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3170 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3171 * we have to wait before to go ahead.
3172 * In the case of TLS 1.3, handshake step handlers do not send data to the
3173 * peer. Data are only sent here and through
3174 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003175 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003176 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003177 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3178 return( ret );
3179
3180#if defined(MBEDTLS_SSL_PROTO_DTLS)
3181 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3182 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3183 {
3184 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3185 return( ret );
3186 }
3187#endif /* MBEDTLS_SSL_PROTO_DTLS */
3188
3189 return( ret );
3190}
3191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003193{
Hanno Becker41934dd2021-08-07 19:13:43 +01003194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003195
Hanno Becker41934dd2021-08-07 19:13:43 +01003196 if( ssl == NULL ||
3197 ssl->conf == NULL ||
3198 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003199 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003200 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003201 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003202 }
3203
3204 ret = ssl_prepare_handshake_step( ssl );
3205 if( ret != 0 )
3206 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003207
Jerry Yue7047812021-09-13 19:26:39 +08003208 ret = mbedtls_ssl_handle_pending_alert( ssl );
3209 if( ret != 0 )
3210 goto cleanup;
3211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003213 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003214 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003215 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3216 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003217
Ronald Cron9f0fba32022-02-10 16:45:15 +01003218 switch( ssl->state )
3219 {
3220 case MBEDTLS_SSL_HELLO_REQUEST:
3221 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3222 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003223
Ronald Cron9f0fba32022-02-10 16:45:15 +01003224 case MBEDTLS_SSL_CLIENT_HELLO:
3225 ret = mbedtls_ssl_write_client_hello( ssl );
3226 break;
3227
3228 default:
3229#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003230 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003231 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3232 else
3233 ret = mbedtls_ssl_handshake_client_step( ssl );
3234#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3235 ret = mbedtls_ssl_handshake_client_step( ssl );
3236#else
3237 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3238#endif
3239 }
Jerry Yub9930e72021-08-06 17:11:51 +08003240 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003241#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003243 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003244 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003246 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003247 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003248#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003249
3250#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3251 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3252 ret = mbedtls_ssl_handshake_server_step( ssl );
3253#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3254 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003255#endif
3256
Jerry Yue7047812021-09-13 19:26:39 +08003257 if( ret != 0 )
3258 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003259 /* handshake_step return error. And it is same
3260 * with alert_reason.
3261 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003262 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003263 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003264 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003265 goto cleanup;
3266 }
3267 }
3268
3269cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003270 return( ret );
3271}
3272
3273/*
3274 * Perform the SSL handshake
3275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003276int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003277{
3278 int ret = 0;
3279
Hanno Beckera817ea42020-10-20 15:20:23 +01003280 /* Sanity checks */
3281
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003282 if( ssl == NULL || ssl->conf == NULL )
3283 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3284
Hanno Beckera817ea42020-10-20 15:20:23 +01003285#if defined(MBEDTLS_SSL_PROTO_DTLS)
3286 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3287 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3288 {
3289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3290 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3291 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3292 }
3293#endif /* MBEDTLS_SSL_PROTO_DTLS */
3294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003296
Hanno Beckera817ea42020-10-20 15:20:23 +01003297 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003298 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003299 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003301
3302 if( ret != 0 )
3303 break;
3304 }
3305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003307
3308 return( ret );
3309}
3310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311#if defined(MBEDTLS_SSL_RENEGOTIATION)
3312#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003313/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003314 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003315 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003316MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003318{
Janos Follath865b3eb2019-12-16 11:46:15 +00003319 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003322
3323 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3325 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003326
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003327 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003328 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003329 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003330 return( ret );
3331 }
3332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003334
3335 return( 0 );
3336}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003338
3339/*
3340 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341 * - any side: calling mbedtls_ssl_renegotiate(),
3342 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3343 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003344 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003345 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003347 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003348int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003349{
Janos Follath865b3eb2019-12-16 11:46:15 +00003350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003353
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003354 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3355 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003356
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003357 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3358 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003360 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003362 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003363 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003364 ssl->handshake->out_msg_seq = 1;
3365 else
3366 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003367 }
3368#endif
3369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3371 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003374 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003376 return( ret );
3377 }
3378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003380
3381 return( 0 );
3382}
3383
3384/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003385 * Renegotiate current connection on client,
3386 * or request renegotiation on server
3387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003389{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003391
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003392 if( ssl == NULL || ssl->conf == NULL )
3393 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003396 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003397 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003398 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003399 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003403
3404 /* Did we already try/start sending HelloRequest? */
3405 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003407
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003408 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003409 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003413 /*
3414 * On client, either start the renegotiation process or,
3415 * if already in progress, continue the handshake
3416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003418 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003419 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003421
Hanno Becker40cdaa12020-02-05 10:48:27 +00003422 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003423 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003424 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003425 return( ret );
3426 }
3427 }
3428 else
3429 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003433 return( ret );
3434 }
3435 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003437
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003438 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003439}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003441
Gilles Peskine9b562d52018-04-25 20:32:43 +02003442void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003443{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003444 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3445
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003446 if( handshake == NULL )
3447 return;
3448
Brett Warrene0edc842021-08-17 09:53:13 +01003449#if defined(MBEDTLS_ECP_C)
3450#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3451 if ( ssl->handshake->group_list_heap_allocated )
3452 mbedtls_free( (void*) handshake->group_list );
3453 handshake->group_list = NULL;
3454#endif /* MBEDTLS_DEPRECATED_REMOVED */
3455#endif /* MBEDTLS_ECP_C */
3456
Jerry Yuf017ee42022-01-12 15:49:48 +08003457#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3458#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3459 if ( ssl->handshake->sig_algs_heap_allocated )
3460 mbedtls_free( (void*) handshake->sig_algs );
3461 handshake->sig_algs = NULL;
3462#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003463#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3464 if( ssl->handshake->certificate_request_context )
3465 {
3466 mbedtls_free( (void*) handshake->certificate_request_context );
3467 }
3468#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003469#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3470
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003471#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3472 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3473 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003474 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003475 handshake->async_in_progress = 0;
3476 }
3477#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3478
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003479#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003480#if defined(MBEDTLS_USE_PSA_CRYPTO)
3481 psa_hash_abort( &handshake->fin_sha256_psa );
3482#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003483 mbedtls_sha256_free( &handshake->fin_sha256 );
3484#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003485#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003486#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003487#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003488 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003489#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003490 mbedtls_sha512_free( &handshake->fin_sha512 );
3491#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003492#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#if defined(MBEDTLS_DHM_C)
3495 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003496#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003497#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003499#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003500#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003501 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003502#if defined(MBEDTLS_SSL_CLI_C)
3503 mbedtls_free( handshake->ecjpake_cache );
3504 handshake->ecjpake_cache = NULL;
3505 handshake->ecjpake_cache_len = 0;
3506#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003507#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003508
Janos Follath4ae5c292016-02-10 11:27:43 +00003509#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3510 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003511 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003513#endif
3514
Gilles Peskineeccd8882020-03-10 12:19:08 +01003515#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003516#if defined(MBEDTLS_USE_PSA_CRYPTO)
3517 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3518 {
3519 /* The maintenance of the external PSK key slot is the
3520 * user's responsibility. */
3521 if( ssl->handshake->psk_opaque_is_internal )
3522 {
3523 psa_destroy_key( ssl->handshake->psk_opaque );
3524 ssl->handshake->psk_opaque_is_internal = 0;
3525 }
3526 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3527 }
Neil Armstronge952a302022-05-03 10:22:14 +02003528#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003529 if( handshake->psk != NULL )
3530 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003531 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003532 mbedtls_free( handshake->psk );
3533 }
Neil Armstronge952a302022-05-03 10:22:14 +02003534#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003535#endif
3536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3538 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003539 /*
3540 * Free only the linked list wrapper, not the keys themselves
3541 * since the belong to the SNI callback
3542 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003543 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003545
Gilles Peskineeccd8882020-03-10 12:19:08 +01003546#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003547 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003548 if( handshake->ecrs_peer_cert != NULL )
3549 {
3550 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3551 mbedtls_free( handshake->ecrs_peer_cert );
3552 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003553#endif
3554
Hanno Becker75173122019-02-06 16:18:31 +00003555#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3556 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3557 mbedtls_pk_free( &handshake->peer_pubkey );
3558#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3559
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003560#if defined(MBEDTLS_SSL_CLI_C) && \
3561 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3562 mbedtls_free( handshake->cookie );
3563#endif /* MBEDTLS_SSL_CLI_C &&
3564 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003565
3566#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003567 mbedtls_ssl_flight_free( handshake->flight );
3568 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003569#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003570
Ronald Cronf12b81d2022-03-15 10:42:41 +01003571#if defined(MBEDTLS_ECDH_C) && \
3572 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003573 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003574 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003575#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3576
Ronald Cron6f135e12021-12-08 16:57:54 +01003577#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003578 mbedtls_ssl_transform_free( handshake->transform_handshake );
3579 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003580 mbedtls_free( handshake->transform_earlydata );
3581 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003582#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003583
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003584
3585#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3586 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3587 * processes datagrams and the fact that a datagram is allowed to have
3588 * several records in it, it is possible that the I/O buffers are not
3589 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003590 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3591 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003592#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003593
Jerry Yuba9c7272021-10-30 11:54:10 +08003594 /* mbedtls_platform_zeroize MUST be last one in this function */
3595 mbedtls_platform_zeroize( handshake,
3596 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003597}
3598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003600{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003601 if( session == NULL )
3602 return;
3603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003605 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003606#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003607
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003608#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003609 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003610#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003611
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003612 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003613}
3614
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003615#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003616
3617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3618#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3619#else
3620#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3621#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3622
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003623#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003624
3625#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3626#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3627#else
3628#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3629#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3630
3631#if defined(MBEDTLS_SSL_ALPN)
3632#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3633#else
3634#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3635#endif /* MBEDTLS_SSL_ALPN */
3636
3637#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3638#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3639#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3640#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3641
3642#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3643 ( (uint32_t) ( \
3644 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3645 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3646 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3647 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3648 0u ) )
3649
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003650static unsigned char ssl_serialized_context_header[] = {
3651 MBEDTLS_VERSION_MAJOR,
3652 MBEDTLS_VERSION_MINOR,
3653 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003654 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3655 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3656 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3657 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3658 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003659};
3660
Paul Bakker5121ce52009-01-03 21:22:43 +00003661/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003662 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003663 *
3664 * The format of the serialized data is:
3665 * (in the presentation language of TLS, RFC 8446 section 3)
3666 *
3667 * // header
3668 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003669 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003670 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003671 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003672 * Note: When updating the format, remember to keep these
3673 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003674 *
3675 * // session sub-structure
3676 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3677 * // transform sub-structure
3678 * uint8 random[64]; // ServerHello.random+ClientHello.random
3679 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3680 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3681 * // fields from ssl_context
3682 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3683 * uint64 in_window_top; // DTLS: last validated record seq_num
3684 * uint64 in_window; // DTLS: bitmask for replay protection
3685 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3686 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3687 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3688 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3689 *
3690 * Note that many fields of the ssl_context or sub-structures are not
3691 * serialized, as they fall in one of the following categories:
3692 *
3693 * 1. forced value (eg in_left must be 0)
3694 * 2. pointer to dynamically-allocated memory (eg session, transform)
3695 * 3. value can be re-derived from other data (eg session keys from MS)
3696 * 4. value was temporary (eg content of input buffer)
3697 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003698 */
3699int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3700 unsigned char *buf,
3701 size_t buf_len,
3702 size_t *olen )
3703{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003704 unsigned char *p = buf;
3705 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003706 size_t session_len;
3707 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003708
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003709 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003710 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3711 * this function's documentation.
3712 *
3713 * These are due to assumptions/limitations in the implementation. Some of
3714 * them are likely to stay (no handshake in progress) some might go away
3715 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003716 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003717 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003718 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003719 {
3720 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003721 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003722 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003723 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003724 {
3725 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003726 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003727 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003728 /* Double-check that sub-structures are indeed ready */
3729 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003730 {
3731 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003733 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003734 /* There must be no pending incoming or outgoing data */
3735 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003736 {
3737 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003738 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003739 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003740 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003741 {
3742 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003743 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003744 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003745 /* Protocol must be DLTS, not TLS */
3746 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003747 {
3748 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003749 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003750 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003751 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003752 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003753 {
3754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003756 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003757 /* We must be using an AEAD ciphersuite */
3758 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003759 {
3760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003762 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003763 /* Renegotiation must not be enabled */
3764#if defined(MBEDTLS_SSL_RENEGOTIATION)
3765 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003766 {
3767 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003768 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003769 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003770#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003771
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003772 /*
3773 * Version and format identifier
3774 */
3775 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003776
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003777 if( used <= buf_len )
3778 {
3779 memcpy( p, ssl_serialized_context_header,
3780 sizeof( ssl_serialized_context_header ) );
3781 p += sizeof( ssl_serialized_context_header );
3782 }
3783
3784 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003785 * Session (length + data)
3786 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003787 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003788 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3789 return( ret );
3790
3791 used += 4 + session_len;
3792 if( used <= buf_len )
3793 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003794 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3795 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003796
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003797 ret = ssl_session_save( ssl->session, 1,
3798 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003799 if( ret != 0 )
3800 return( ret );
3801
3802 p += session_len;
3803 }
3804
3805 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003806 * Transform
3807 */
3808 used += sizeof( ssl->transform->randbytes );
3809 if( used <= buf_len )
3810 {
3811 memcpy( p, ssl->transform->randbytes,
3812 sizeof( ssl->transform->randbytes ) );
3813 p += sizeof( ssl->transform->randbytes );
3814 }
3815
3816#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3817 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3818 if( used <= buf_len )
3819 {
3820 *p++ = ssl->transform->in_cid_len;
3821 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3822 p += ssl->transform->in_cid_len;
3823
3824 *p++ = ssl->transform->out_cid_len;
3825 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3826 p += ssl->transform->out_cid_len;
3827 }
3828#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3829
3830 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003831 * Saved fields from top-level ssl_context structure
3832 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003833 used += 4;
3834 if( used <= buf_len )
3835 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003836 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3837 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003838 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003839
3840#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3841 used += 16;
3842 if( used <= buf_len )
3843 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003844 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3845 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003846
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003847 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3848 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003849 }
3850#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3851
3852#if defined(MBEDTLS_SSL_PROTO_DTLS)
3853 used += 1;
3854 if( used <= buf_len )
3855 {
3856 *p++ = ssl->disable_datagram_packing;
3857 }
3858#endif /* MBEDTLS_SSL_PROTO_DTLS */
3859
Jerry Yuae0b2e22021-10-08 15:21:19 +08003860 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003861 if( used <= buf_len )
3862 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003863 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3864 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003865 }
3866
3867#if defined(MBEDTLS_SSL_PROTO_DTLS)
3868 used += 2;
3869 if( used <= buf_len )
3870 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003871 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3872 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003873 }
3874#endif /* MBEDTLS_SSL_PROTO_DTLS */
3875
3876#if defined(MBEDTLS_SSL_ALPN)
3877 {
3878 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003879 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003880 : 0;
3881
3882 used += 1 + alpn_len;
3883 if( used <= buf_len )
3884 {
3885 *p++ = alpn_len;
3886
3887 if( ssl->alpn_chosen != NULL )
3888 {
3889 memcpy( p, ssl->alpn_chosen, alpn_len );
3890 p += alpn_len;
3891 }
3892 }
3893 }
3894#endif /* MBEDTLS_SSL_ALPN */
3895
3896 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003897 * Done
3898 */
3899 *olen = used;
3900
3901 if( used > buf_len )
3902 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003903
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003904 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3905
Hanno Becker43aefe22020-02-05 10:44:56 +00003906 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003907}
3908
3909/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003910 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003911 *
3912 * This internal version is wrapped by a public function that cleans up in
3913 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003914 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003915MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003916static int ssl_context_load( mbedtls_ssl_context *ssl,
3917 const unsigned char *buf,
3918 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003919{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003920 const unsigned char *p = buf;
3921 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003922 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003923 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003924
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003925 /*
3926 * The context should have been freshly setup or reset.
3927 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003928 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003929 * renegotiating, or if the user mistakenly loaded a session first.)
3930 */
3931 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3932 ssl->session != NULL )
3933 {
3934 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3935 }
3936
3937 /*
3938 * We can't check that the config matches the initial one, but we can at
3939 * least check it matches the requirements for serializing.
3940 */
3941 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003942 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3943 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003944#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003945 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003946#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003947 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003948 {
3949 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3950 }
3951
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003952 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3953
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003954 /*
3955 * Check version identifier
3956 */
3957 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3958 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3959
3960 if( memcmp( p, ssl_serialized_context_header,
3961 sizeof( ssl_serialized_context_header ) ) != 0 )
3962 {
3963 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3964 }
3965 p += sizeof( ssl_serialized_context_header );
3966
3967 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003968 * Session
3969 */
3970 if( (size_t)( end - p ) < 4 )
3971 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3972
3973 session_len = ( (size_t) p[0] << 24 ) |
3974 ( (size_t) p[1] << 16 ) |
3975 ( (size_t) p[2] << 8 ) |
3976 ( (size_t) p[3] );
3977 p += 4;
3978
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003979 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003980 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003981 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003982 ssl->session_in = ssl->session;
3983 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003984 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003985
3986 if( (size_t)( end - p ) < session_len )
3987 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3988
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003989 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003990 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003991 {
3992 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003993 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003994 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003995
3996 p += session_len;
3997
3998 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003999 * Transform
4000 */
4001
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004002 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004003 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004004 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004005 ssl->transform_in = ssl->transform;
4006 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004007 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004008
4009 /* Read random bytes and populate structure */
4010 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4011 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004012#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004013 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004014 ssl->session->ciphersuite,
4015 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004016#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004017 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004018#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004019 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4020 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004021 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004022 ssl->conf->endpoint,
4023 ssl );
4024 if( ret != 0 )
4025 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004026#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004027 p += sizeof( ssl->transform->randbytes );
4028
4029#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4030 /* Read connection IDs and store them */
4031 if( (size_t)( end - p ) < 1 )
4032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4033
4034 ssl->transform->in_cid_len = *p++;
4035
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004036 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004037 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4038
4039 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4040 p += ssl->transform->in_cid_len;
4041
4042 ssl->transform->out_cid_len = *p++;
4043
4044 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4045 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4046
4047 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4048 p += ssl->transform->out_cid_len;
4049#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4050
4051 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004052 * Saved fields from top-level ssl_context structure
4053 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004054 if( (size_t)( end - p ) < 4 )
4055 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4056
4057 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4058 ( (uint32_t) p[1] << 16 ) |
4059 ( (uint32_t) p[2] << 8 ) |
4060 ( (uint32_t) p[3] );
4061 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004062
4063#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4064 if( (size_t)( end - p ) < 16 )
4065 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4066
4067 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4068 ( (uint64_t) p[1] << 48 ) |
4069 ( (uint64_t) p[2] << 40 ) |
4070 ( (uint64_t) p[3] << 32 ) |
4071 ( (uint64_t) p[4] << 24 ) |
4072 ( (uint64_t) p[5] << 16 ) |
4073 ( (uint64_t) p[6] << 8 ) |
4074 ( (uint64_t) p[7] );
4075 p += 8;
4076
4077 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4078 ( (uint64_t) p[1] << 48 ) |
4079 ( (uint64_t) p[2] << 40 ) |
4080 ( (uint64_t) p[3] << 32 ) |
4081 ( (uint64_t) p[4] << 24 ) |
4082 ( (uint64_t) p[5] << 16 ) |
4083 ( (uint64_t) p[6] << 8 ) |
4084 ( (uint64_t) p[7] );
4085 p += 8;
4086#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4087
4088#if defined(MBEDTLS_SSL_PROTO_DTLS)
4089 if( (size_t)( end - p ) < 1 )
4090 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4091
4092 ssl->disable_datagram_packing = *p++;
4093#endif /* MBEDTLS_SSL_PROTO_DTLS */
4094
Jerry Yud9a94fe2021-09-28 18:58:59 +08004095 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004096 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004097 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4098 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004099
4100#if defined(MBEDTLS_SSL_PROTO_DTLS)
4101 if( (size_t)( end - p ) < 2 )
4102 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4103
4104 ssl->mtu = ( p[0] << 8 ) | p[1];
4105 p += 2;
4106#endif /* MBEDTLS_SSL_PROTO_DTLS */
4107
4108#if defined(MBEDTLS_SSL_ALPN)
4109 {
4110 uint8_t alpn_len;
4111 const char **cur;
4112
4113 if( (size_t)( end - p ) < 1 )
4114 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4115
4116 alpn_len = *p++;
4117
4118 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4119 {
4120 /* alpn_chosen should point to an item in the configured list */
4121 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4122 {
4123 if( strlen( *cur ) == alpn_len &&
4124 memcmp( p, cur, alpn_len ) == 0 )
4125 {
4126 ssl->alpn_chosen = *cur;
4127 break;
4128 }
4129 }
4130 }
4131
4132 /* can only happen on conf mismatch */
4133 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4134 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4135
4136 p += alpn_len;
4137 }
4138#endif /* MBEDTLS_SSL_ALPN */
4139
4140 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004141 * Forced fields from top-level ssl_context structure
4142 *
4143 * Most of them already set to the correct value by mbedtls_ssl_init() and
4144 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4145 */
4146 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004147 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004148
Hanno Becker361b10d2019-08-30 10:42:49 +01004149 /* Adjust pointers for header fields of outgoing records to
4150 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004151 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004152
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004153#if defined(MBEDTLS_SSL_PROTO_DTLS)
4154 ssl->in_epoch = 1;
4155#endif
4156
4157 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4158 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004159 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4160 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004161 if( ssl->handshake != NULL )
4162 {
4163 mbedtls_ssl_handshake_free( ssl );
4164 mbedtls_free( ssl->handshake );
4165 ssl->handshake = NULL;
4166 }
4167
4168 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004169 * Done - should have consumed entire buffer
4170 */
4171 if( p != end )
4172 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004173
4174 return( 0 );
4175}
4176
4177/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004178 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004179 */
4180int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4181 const unsigned char *buf,
4182 size_t len )
4183{
4184 int ret = ssl_context_load( context, buf, len );
4185
4186 if( ret != 0 )
4187 mbedtls_ssl_free( context );
4188
4189 return( ret );
4190}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004191#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004192
4193/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004194 * Free an SSL context
4195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004196void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004197{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004198 if( ssl == NULL )
4199 return;
4200
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004202
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004203 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004204 {
sander-visserb8aa2072020-05-06 22:05:13 +02004205#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4206 size_t out_buf_len = ssl->out_buf_len;
4207#else
4208 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4209#endif
4210
Darryl Greenb33cc762019-11-28 14:29:44 +00004211 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004212 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004213 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004214 }
4215
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004216 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004217 {
sander-visserb8aa2072020-05-06 22:05:13 +02004218#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4219 size_t in_buf_len = ssl->in_buf_len;
4220#else
4221 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4222#endif
4223
Darryl Greenb33cc762019-11-28 14:29:44 +00004224 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004225 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004226 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004227 }
4228
Paul Bakker48916f92012-09-16 19:57:18 +00004229 if( ssl->transform )
4230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004231 mbedtls_ssl_transform_free( ssl->transform );
4232 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004233 }
4234
4235 if( ssl->handshake )
4236 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004237 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004238 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4239 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004241 mbedtls_free( ssl->handshake );
4242 mbedtls_free( ssl->transform_negotiate );
4243 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004244 }
4245
Ronald Cron6f135e12021-12-08 16:57:54 +01004246#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004247 mbedtls_ssl_transform_free( ssl->transform_application );
4248 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004249#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004250
Paul Bakkerc0463502013-02-14 11:19:38 +01004251 if( ssl->session )
4252 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004253 mbedtls_ssl_session_free( ssl->session );
4254 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004255 }
4256
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004257#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004258 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004259 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004260 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004261 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004262 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004263#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004264
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004265#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004266 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004267#endif
4268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004269 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004270
Paul Bakker86f04f42013-02-14 11:20:09 +01004271 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004272 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004273}
4274
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004275/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004276 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004277 */
4278void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4279{
4280 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4281}
4282
Gilles Peskineae270bf2021-06-02 00:05:29 +02004283/* The selection should be the same as mbedtls_x509_crt_profile_default in
4284 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004285 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004286 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004287 * about this list.
4288 */
Brett Warrene0edc842021-08-17 09:53:13 +01004289static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004290#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004291 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004292#endif
4293#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004294 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004295#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004296#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004297 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004298#endif
4299#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004300 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004301#endif
4302#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004303 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004304#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004305#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004306 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004307#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004308#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004309 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004310#endif
4311#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004312 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004313#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004314 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004315};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004316
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004317static int ssl_preset_suiteb_ciphersuites[] = {
4318 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4319 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4320 0
4321};
4322
Gilles Peskineeccd8882020-03-10 12:19:08 +01004323#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004324
Jerry Yu909df7b2022-01-22 11:56:27 +08004325/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004326 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004327 * rules SHOULD be upheld.
4328 * - No duplicate entries.
4329 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004330 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004331 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004332 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004333static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004334
Jerry Yued5e9f42022-01-26 11:21:34 +08004335#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4336 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4337 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4338#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4339 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004340
Jerry Yu909df7b2022-01-22 11:56:27 +08004341#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4342 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4343 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4344#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4345 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4346
Jerry Yued5e9f42022-01-26 11:21:34 +08004347#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4348 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4349 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4350#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4351 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004352
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004353#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4354 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4355#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4356
4357#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4358 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4359#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4360
4361#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4362 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4363#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4364
Jerry Yu693a47a2022-06-23 14:02:28 +08004365#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4366 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4367#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4368
4369#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4370 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4371#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4372
4373#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4374 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4375#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4376
Gabor Mezei15b95a62022-05-09 16:37:58 +02004377 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004378};
4379
4380/* NOTICE: see above */
4381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4382static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004383#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004384#if defined(MBEDTLS_ECDSA_C)
4385 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004386#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004387#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4388 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4389#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004390#if defined(MBEDTLS_RSA_C)
4391 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4392#endif
4393#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004394#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004395#if defined(MBEDTLS_ECDSA_C)
4396 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004397#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004398#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4399 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4400#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004401#if defined(MBEDTLS_RSA_C)
4402 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4403#endif
4404#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004405#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004406#if defined(MBEDTLS_ECDSA_C)
4407 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004408#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004409#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4410 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4411#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004412#if defined(MBEDTLS_RSA_C)
4413 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4414#endif
4415#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004416 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004417};
4418#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4419/* NOTICE: see above */
4420static uint16_t ssl_preset_suiteb_sig_algs[] = {
4421
Jerry Yu909df7b2022-01-22 11:56:27 +08004422#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4423 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4424 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4425#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4426 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4427
Jerry Yu53037892022-01-25 11:02:06 +08004428#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4429 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4430 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4431#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4432 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004433
4434#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4435 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4436#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004437
Jerry Yu53037892022-01-25 11:02:06 +08004438#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4439 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4440#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4441
Gabor Mezei15b95a62022-05-09 16:37:58 +02004442 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004443};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004444
Jerry Yu909df7b2022-01-22 11:56:27 +08004445/* NOTICE: see above */
4446#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4447static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004448#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004449#if defined(MBEDTLS_ECDSA_C)
4450 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004451#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004452#if defined(MBEDTLS_RSA_C)
4453 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4454#endif
4455#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004456#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004457#if defined(MBEDTLS_ECDSA_C)
4458 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004459#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004460#if defined(MBEDTLS_RSA_C)
4461 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4462#endif
4463#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004464 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004465};
Jerry Yu909df7b2022-01-22 11:56:27 +08004466#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4467
Jerry Yu1a8b4812022-01-20 17:56:50 +08004468#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004469
Brett Warrene0edc842021-08-17 09:53:13 +01004470static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004471#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004472 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004473#endif
4474#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004475 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004476#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004477 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004478};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004479
Jerry Yu1a8b4812022-01-20 17:56:50 +08004480#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004481/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004482 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004483MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004484static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004485{
4486 size_t i, j;
4487 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004488
Gabor Mezei15b95a62022-05-09 16:37:58 +02004489 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004490 {
Jerry Yuf377d642022-01-25 10:43:59 +08004491 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004492 {
Jerry Yuf377d642022-01-25 10:43:59 +08004493 if( sig_algs[i] != sig_algs[j] )
4494 continue;
4495 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4496 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4497 sig_algs[i], j, i );
4498 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004499 }
4500 }
4501 return( ret );
4502}
4503
4504#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4505
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004506/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004507 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004508 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004509int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004510 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004511{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004512#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004514#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004515
Jerry Yu1a8b4812022-01-20 17:56:50 +08004516#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004517 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004518 {
4519 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4520 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4521 }
4522
Jerry Yuf377d642022-01-25 10:43:59 +08004523 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004524 {
4525 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4526 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4527 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004528
4529#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004530 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004531 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004532 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004533 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4534 }
4535
Jerry Yuf377d642022-01-25 10:43:59 +08004536 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004537 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004538 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004539 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4540 }
4541#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004542#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4543
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004544 /* Use the functions here so that they are covered in tests,
4545 * but otherwise access member directly for efficiency */
4546 mbedtls_ssl_conf_endpoint( conf, endpoint );
4547 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004548
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004549 /*
4550 * Things that are common to all presets
4551 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004552#if defined(MBEDTLS_SSL_CLI_C)
4553 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4554 {
4555 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4556#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4557 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4558#endif
4559 }
4560#endif
4561
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004562#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4563 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4564#endif
4565
4566#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4567 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4568#endif
4569
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004570#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004571 conf->f_cookie_write = ssl_cookie_write_dummy;
4572 conf->f_cookie_check = ssl_cookie_check_dummy;
4573#endif
4574
4575#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4576 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4577#endif
4578
Janos Follath088ce432017-04-10 12:42:31 +01004579#if defined(MBEDTLS_SSL_SRV_C)
4580 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004581 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004582#endif
4583
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004584#if defined(MBEDTLS_SSL_PROTO_DTLS)
4585 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4586 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4587#endif
4588
4589#if defined(MBEDTLS_SSL_RENEGOTIATION)
4590 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004591 memset( conf->renego_period, 0x00, 2 );
4592 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004593#endif
4594
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004595#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004596 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4597 {
4598 const unsigned char dhm_p[] =
4599 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4600 const unsigned char dhm_g[] =
4601 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004602
Hanno Beckere2defad2021-07-24 05:59:17 +01004603 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4604 dhm_p, sizeof( dhm_p ),
4605 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4606 {
4607 return( ret );
4608 }
4609 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004610#endif
4611
Ronald Cron6f135e12021-12-08 16:57:54 +01004612#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004613 /*
4614 * Allow all TLS 1.3 key exchange modes by default.
4615 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004616 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004617#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004618
XiaokangQian4d3a6042022-04-21 13:46:17 +00004619 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4620 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004621#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004622 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004623 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004624#else
XiaokangQian060d8672022-04-21 09:24:56 +00004625 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004626#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004627 }
4628 else
4629 {
4630#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4631 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4632 {
4633 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4634 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4635 }
4636 else
4637 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4638 {
4639 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4640 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4641 }
4642#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4643 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4644 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4645#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4646 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4647 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4648#else
4649 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4650#endif
4651 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004652
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004653 /*
4654 * Preset-specific defaults
4655 */
4656 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004657 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004658 /*
4659 * NSA Suite B
4660 */
4661 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004662
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004663 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004664
4665#if defined(MBEDTLS_X509_CRT_PARSE_C)
4666 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004667#endif
4668
Gilles Peskineeccd8882020-03-10 12:19:08 +01004669#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004670#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4671 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4672 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4673 else
4674#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4675 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004676#endif
4677
Brett Warrene0edc842021-08-17 09:53:13 +01004678#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4679 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004680#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004681 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004682 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004683
4684 /*
4685 * Default
4686 */
4687 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004688
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004689 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004690
4691#if defined(MBEDTLS_X509_CRT_PARSE_C)
4692 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4693#endif
4694
Gilles Peskineeccd8882020-03-10 12:19:08 +01004695#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004696#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4697 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4698 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4699 else
4700#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4701 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004702#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004703
Brett Warrene0edc842021-08-17 09:53:13 +01004704#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4705 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004706#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004707 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004708
4709#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4710 conf->dhm_min_bitlen = 1024;
4711#endif
4712 }
4713
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004714 return( 0 );
4715}
4716
4717/*
4718 * Free mbedtls_ssl_config
4719 */
4720void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4721{
4722#if defined(MBEDTLS_DHM_C)
4723 mbedtls_mpi_free( &conf->dhm_P );
4724 mbedtls_mpi_free( &conf->dhm_G );
4725#endif
4726
Gilles Peskineeccd8882020-03-10 12:19:08 +01004727#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004728#if defined(MBEDTLS_USE_PSA_CRYPTO)
4729 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4730 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004731 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4732 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004733#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004734 if( conf->psk != NULL )
4735 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004736 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004737 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004738 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004739 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004740 }
4741
4742 if( conf->psk_identity != NULL )
4743 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004744 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004745 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004746 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004747 conf->psk_identity_len = 0;
4748 }
4749#endif
4750
4751#if defined(MBEDTLS_X509_CRT_PARSE_C)
4752 ssl_key_cert_free( conf->key_cert );
4753#endif
4754
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004755 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004756}
4757
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004758#if defined(MBEDTLS_PK_C) && \
4759 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004760/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004762 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004763unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004764{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765#if defined(MBEDTLS_RSA_C)
4766 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4767 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004768#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769#if defined(MBEDTLS_ECDSA_C)
4770 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4771 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004772#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004773 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004774}
4775
Hanno Becker7e5437a2017-04-28 17:15:26 +01004776unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4777{
4778 switch( type ) {
4779 case MBEDTLS_PK_RSA:
4780 return( MBEDTLS_SSL_SIG_RSA );
4781 case MBEDTLS_PK_ECDSA:
4782 case MBEDTLS_PK_ECKEY:
4783 return( MBEDTLS_SSL_SIG_ECDSA );
4784 default:
4785 return( MBEDTLS_SSL_SIG_ANON );
4786 }
4787}
4788
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004790{
4791 switch( sig )
4792 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004793#if defined(MBEDTLS_RSA_C)
4794 case MBEDTLS_SSL_SIG_RSA:
4795 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004796#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797#if defined(MBEDTLS_ECDSA_C)
4798 case MBEDTLS_SSL_SIG_ECDSA:
4799 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004800#endif
4801 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004803 }
4804}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004805#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004806
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004807/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004808 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004810mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004811{
4812 switch( hash )
4813 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814#if defined(MBEDTLS_MD5_C)
4815 case MBEDTLS_SSL_HASH_MD5:
4816 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004817#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818#if defined(MBEDTLS_SHA1_C)
4819 case MBEDTLS_SSL_HASH_SHA1:
4820 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004821#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004822#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823 case MBEDTLS_SSL_HASH_SHA224:
4824 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004825#endif
4826#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827 case MBEDTLS_SSL_HASH_SHA256:
4828 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004829#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004830#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 case MBEDTLS_SSL_HASH_SHA384:
4832 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004833#endif
4834#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 case MBEDTLS_SSL_HASH_SHA512:
4836 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004837#endif
4838 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004839 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004840 }
4841}
4842
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004843/*
4844 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4845 */
4846unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4847{
4848 switch( md )
4849 {
4850#if defined(MBEDTLS_MD5_C)
4851 case MBEDTLS_MD_MD5:
4852 return( MBEDTLS_SSL_HASH_MD5 );
4853#endif
4854#if defined(MBEDTLS_SHA1_C)
4855 case MBEDTLS_MD_SHA1:
4856 return( MBEDTLS_SSL_HASH_SHA1 );
4857#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004858#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004859 case MBEDTLS_MD_SHA224:
4860 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004861#endif
4862#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004863 case MBEDTLS_MD_SHA256:
4864 return( MBEDTLS_SSL_HASH_SHA256 );
4865#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004866#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004867 case MBEDTLS_MD_SHA384:
4868 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004869#endif
4870#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004871 case MBEDTLS_MD_SHA512:
4872 return( MBEDTLS_SSL_HASH_SHA512 );
4873#endif
4874 default:
4875 return( MBEDTLS_SSL_HASH_NONE );
4876 }
4877}
4878
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004879/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004880 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004881 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004882 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004883int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004884{
Brett Warrene0edc842021-08-17 09:53:13 +01004885 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004886
Brett Warrene0edc842021-08-17 09:53:13 +01004887 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004888 return( -1 );
4889
Brett Warrene0edc842021-08-17 09:53:13 +01004890 for( ; *group_list != 0; group_list++ )
4891 {
4892 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004893 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004894 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004895
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004896 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004897}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004898
4899#if defined(MBEDTLS_ECP_C)
4900/*
4901 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4902 */
4903int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4904{
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004905 const mbedtls_ecp_curve_info *grp_info =
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004906 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004907
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004908 if ( grp_info == NULL )
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004909 return -1;
4910
4911 uint16_t tls_id = grp_info->tls_id;
4912
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004913 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4914}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004915#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004916
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004917#if defined(MBEDTLS_X509_CRT_PARSE_C)
4918int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4919 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004920 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004921 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004922{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004923 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004924 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004925 const char *ext_oid;
4926 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004928 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004929 {
4930 /* Server part of the key exchange */
4931 switch( ciphersuite->key_exchange )
4932 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004933 case MBEDTLS_KEY_EXCHANGE_RSA:
4934 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004935 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004936 break;
4937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004938 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4939 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4940 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4941 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004942 break;
4943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004944 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4945 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004946 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004947 break;
4948
4949 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004950 case MBEDTLS_KEY_EXCHANGE_NONE:
4951 case MBEDTLS_KEY_EXCHANGE_PSK:
4952 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4953 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004954 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004955 usage = 0;
4956 }
4957 }
4958 else
4959 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4961 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004962 }
4963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004964 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004965 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004966 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004967 ret = -1;
4968 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004970 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004971 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4973 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004974 }
4975 else
4976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004977 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4978 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004979 }
4980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004981 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004982 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004983 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004984 ret = -1;
4985 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004986
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004987 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004988}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004989#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004990
Jerry Yu148165c2021-09-24 23:20:59 +08004991#if defined(MBEDTLS_USE_PSA_CRYPTO)
4992int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4993 const mbedtls_md_type_t md,
4994 unsigned char *dst,
4995 size_t dst_len,
4996 size_t *olen )
4997{
Ronald Cronf6893e12022-01-07 22:09:01 +01004998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4999 psa_hash_operation_t *hash_operation_to_clone;
5000 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5001
Jerry Yu148165c2021-09-24 23:20:59 +08005002 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005003
5004 switch( md )
5005 {
5006#if defined(MBEDTLS_SHA384_C)
5007 case MBEDTLS_MD_SHA384:
5008 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5009 break;
5010#endif
5011
5012#if defined(MBEDTLS_SHA256_C)
5013 case MBEDTLS_MD_SHA256:
5014 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5015 break;
5016#endif
5017
5018 default:
5019 goto exit;
5020 }
5021
5022 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5023 if( status != PSA_SUCCESS )
5024 goto exit;
5025
5026 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5027 if( status != PSA_SUCCESS )
5028 goto exit;
5029
5030exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005031 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005032}
5033#else /* MBEDTLS_USE_PSA_CRYPTO */
5034
Jerry Yu24c0ec32021-09-09 14:21:07 +08005035#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005036MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005037static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5038 unsigned char *dst,
5039 size_t dst_len,
5040 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005041{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005042 int ret;
5043 mbedtls_sha512_context sha512;
5044
5045 if( dst_len < 48 )
5046 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5047
5048 mbedtls_sha512_init( &sha512 );
5049 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5050
5051 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5052 {
5053 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5054 goto exit;
5055 }
5056
5057 *olen = 48;
5058
5059exit:
5060
5061 mbedtls_sha512_free( &sha512 );
5062 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005063}
5064#endif /* MBEDTLS_SHA384_C */
5065
5066#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005067MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005068static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5069 unsigned char *dst,
5070 size_t dst_len,
5071 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005072{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005073 int ret;
5074 mbedtls_sha256_context sha256;
5075
5076 if( dst_len < 32 )
5077 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5078
5079 mbedtls_sha256_init( &sha256 );
5080 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005081
Jerry Yu24c0ec32021-09-09 14:21:07 +08005082 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5083 {
5084 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5085 goto exit;
5086 }
5087
5088 *olen = 32;
5089
5090exit:
5091
5092 mbedtls_sha256_free( &sha256 );
5093 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005094}
5095#endif /* MBEDTLS_SHA256_C */
5096
Jerry Yu000f9762021-09-14 11:12:51 +08005097int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5098 const mbedtls_md_type_t md,
5099 unsigned char *dst,
5100 size_t dst_len,
5101 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005102{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005103 switch( md )
5104 {
5105
Jerry Yu24c0ec32021-09-09 14:21:07 +08005106#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005107 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005108 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005109#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005110
Jerry Yu24c0ec32021-09-09 14:21:07 +08005111#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005112 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005113 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005114#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005115
5116 default:
5117 break;
5118 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005119 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005120}
XiaokangQian647719a2021-12-07 09:16:29 +00005121
Jerry Yu148165c2021-09-24 23:20:59 +08005122#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005123
Gabor Mezei078e8032022-04-27 21:17:56 +02005124#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5125/* mbedtls_ssl_parse_sig_alg_ext()
5126 *
5127 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5128 * value (TLS 1.3 RFC8446):
5129 * enum {
5130 * ....
5131 * ecdsa_secp256r1_sha256( 0x0403 ),
5132 * ecdsa_secp384r1_sha384( 0x0503 ),
5133 * ecdsa_secp521r1_sha512( 0x0603 ),
5134 * ....
5135 * } SignatureScheme;
5136 *
5137 * struct {
5138 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5139 * } SignatureSchemeList;
5140 *
5141 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5142 * value (TLS 1.2 RFC5246):
5143 * enum {
5144 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5145 * sha512(6), (255)
5146 * } HashAlgorithm;
5147 *
5148 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5149 * SignatureAlgorithm;
5150 *
5151 * struct {
5152 * HashAlgorithm hash;
5153 * SignatureAlgorithm signature;
5154 * } SignatureAndHashAlgorithm;
5155 *
5156 * SignatureAndHashAlgorithm
5157 * supported_signature_algorithms<2..2^16-2>;
5158 *
5159 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5160 * generalization of the TLS 1.2 signature algorithm extension.
5161 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5162 * `SignatureScheme` field of TLS 1.3
5163 *
5164 */
5165int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5166 const unsigned char *buf,
5167 const unsigned char *end )
5168{
5169 const unsigned char *p = buf;
5170 size_t supported_sig_algs_len = 0;
5171 const unsigned char *supported_sig_algs_end;
5172 uint16_t sig_alg;
5173 uint32_t common_idx = 0;
5174
5175 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5176 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5177 p += 2;
5178
5179 memset( ssl->handshake->received_sig_algs, 0,
5180 sizeof(ssl->handshake->received_sig_algs) );
5181
5182 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5183 supported_sig_algs_end = p + supported_sig_algs_len;
5184 while( p < supported_sig_algs_end )
5185 {
5186 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5187 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5188 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005189 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5190 sig_alg,
5191 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005192#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005193 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005194 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5195 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5196 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005197 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005198 }
5199#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005200
Jerry Yuf3b46b52022-06-19 16:52:27 +08005201 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5202 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005203
5204 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5205 {
5206 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5207 common_idx += 1;
5208 }
5209 }
5210 /* Check that we consumed all the message. */
5211 if( p != end )
5212 {
5213 MBEDTLS_SSL_DEBUG_MSG( 1,
5214 ( "Signature algorithms extension length misaligned" ) );
5215 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5216 MBEDTLS_ERR_SSL_DECODE_ERROR );
5217 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5218 }
5219
5220 if( common_idx == 0 )
5221 {
5222 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5223 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5224 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5225 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5226 }
5227
Gabor Mezei15b95a62022-05-09 16:37:58 +02005228 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005229 return( 0 );
5230}
5231
5232#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5233
Jerry Yudc7bd172022-02-17 13:44:15 +08005234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5235
5236#if defined(MBEDTLS_USE_PSA_CRYPTO)
5237
5238static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5239 mbedtls_svc_key_id_t key,
5240 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005241 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005242 const unsigned char* seed, size_t seed_length,
5243 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005244 const unsigned char* other_secret,
5245 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005246 size_t capacity )
5247{
5248 psa_status_t status;
5249
5250 status = psa_key_derivation_setup( derivation, alg );
5251 if( status != PSA_SUCCESS )
5252 return( status );
5253
5254 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5255 {
5256 status = psa_key_derivation_input_bytes( derivation,
5257 PSA_KEY_DERIVATION_INPUT_SEED,
5258 seed, seed_length );
5259 if( status != PSA_SUCCESS )
5260 return( status );
5261
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005262 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005263 {
5264 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005265 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5266 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005267 if( status != PSA_SUCCESS )
5268 return( status );
5269 }
5270
Jerry Yudc7bd172022-02-17 13:44:15 +08005271 if( mbedtls_svc_key_id_is_null( key ) )
5272 {
5273 status = psa_key_derivation_input_bytes(
5274 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005275 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005276 }
5277 else
5278 {
5279 status = psa_key_derivation_input_key(
5280 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5281 }
5282 if( status != PSA_SUCCESS )
5283 return( status );
5284
5285 status = psa_key_derivation_input_bytes( derivation,
5286 PSA_KEY_DERIVATION_INPUT_LABEL,
5287 label, label_length );
5288 if( status != PSA_SUCCESS )
5289 return( status );
5290 }
5291 else
5292 {
5293 return( PSA_ERROR_NOT_SUPPORTED );
5294 }
5295
5296 status = psa_key_derivation_set_capacity( derivation, capacity );
5297 if( status != PSA_SUCCESS )
5298 return( status );
5299
5300 return( PSA_SUCCESS );
5301}
5302
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005303MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005304static int tls_prf_generic( mbedtls_md_type_t md_type,
5305 const unsigned char *secret, size_t slen,
5306 const char *label,
5307 const unsigned char *random, size_t rlen,
5308 unsigned char *dstbuf, size_t dlen )
5309{
5310 psa_status_t status;
5311 psa_algorithm_t alg;
5312 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5313 psa_key_derivation_operation_t derivation =
5314 PSA_KEY_DERIVATION_OPERATION_INIT;
5315
5316 if( md_type == MBEDTLS_MD_SHA384 )
5317 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5318 else
5319 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5320
5321 /* Normally a "secret" should be long enough to be impossible to
5322 * find by brute force, and in particular should not be empty. But
5323 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5324 * and for this use case it makes sense to have a 0-length "secret".
5325 * Since the key API doesn't allow importing a key of length 0,
5326 * keep master_key=0, which setup_psa_key_derivation() understands
5327 * to mean a 0-length "secret" input. */
5328 if( slen != 0 )
5329 {
5330 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5331 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5332 psa_set_key_algorithm( &key_attributes, alg );
5333 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5334
5335 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5336 if( status != PSA_SUCCESS )
5337 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5338 }
5339
5340 status = setup_psa_key_derivation( &derivation,
5341 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005342 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005343 random, rlen,
5344 (unsigned char const *) label,
5345 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005346 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005347 dlen );
5348 if( status != PSA_SUCCESS )
5349 {
5350 psa_key_derivation_abort( &derivation );
5351 psa_destroy_key( master_key );
5352 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5353 }
5354
5355 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5356 if( status != PSA_SUCCESS )
5357 {
5358 psa_key_derivation_abort( &derivation );
5359 psa_destroy_key( master_key );
5360 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5361 }
5362
5363 status = psa_key_derivation_abort( &derivation );
5364 if( status != PSA_SUCCESS )
5365 {
5366 psa_destroy_key( master_key );
5367 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5368 }
5369
5370 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5371 status = psa_destroy_key( master_key );
5372 if( status != PSA_SUCCESS )
5373 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5374
5375 return( 0 );
5376}
5377
5378#else /* MBEDTLS_USE_PSA_CRYPTO */
5379
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005380MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005381static int tls_prf_generic( mbedtls_md_type_t md_type,
5382 const unsigned char *secret, size_t slen,
5383 const char *label,
5384 const unsigned char *random, size_t rlen,
5385 unsigned char *dstbuf, size_t dlen )
5386{
5387 size_t nb;
5388 size_t i, j, k, md_len;
5389 unsigned char *tmp;
5390 size_t tmp_len = 0;
5391 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5392 const mbedtls_md_info_t *md_info;
5393 mbedtls_md_context_t md_ctx;
5394 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5395
5396 mbedtls_md_init( &md_ctx );
5397
5398 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5399 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5400
5401 md_len = mbedtls_md_get_size( md_info );
5402
5403 tmp_len = md_len + strlen( label ) + rlen;
5404 tmp = mbedtls_calloc( 1, tmp_len );
5405 if( tmp == NULL )
5406 {
5407 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5408 goto exit;
5409 }
5410
5411 nb = strlen( label );
5412 memcpy( tmp + md_len, label, nb );
5413 memcpy( tmp + md_len + nb, random, rlen );
5414 nb += rlen;
5415
5416 /*
5417 * Compute P_<hash>(secret, label + random)[0..dlen]
5418 */
5419 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5420 goto exit;
5421
5422 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5423 if( ret != 0 )
5424 goto exit;
5425 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5426 if( ret != 0 )
5427 goto exit;
5428 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5429 if( ret != 0 )
5430 goto exit;
5431
5432 for( i = 0; i < dlen; i += md_len )
5433 {
5434 ret = mbedtls_md_hmac_reset ( &md_ctx );
5435 if( ret != 0 )
5436 goto exit;
5437 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5438 if( ret != 0 )
5439 goto exit;
5440 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5441 if( ret != 0 )
5442 goto exit;
5443
5444 ret = mbedtls_md_hmac_reset ( &md_ctx );
5445 if( ret != 0 )
5446 goto exit;
5447 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5448 if( ret != 0 )
5449 goto exit;
5450 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5451 if( ret != 0 )
5452 goto exit;
5453
5454 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5455
5456 for( j = 0; j < k; j++ )
5457 dstbuf[i + j] = h_i[j];
5458 }
5459
5460exit:
5461 mbedtls_md_free( &md_ctx );
5462
5463 mbedtls_platform_zeroize( tmp, tmp_len );
5464 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5465
5466 mbedtls_free( tmp );
5467
5468 return( ret );
5469}
5470#endif /* MBEDTLS_USE_PSA_CRYPTO */
5471
5472#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005473MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005474static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5475 const char *label,
5476 const unsigned char *random, size_t rlen,
5477 unsigned char *dstbuf, size_t dlen )
5478{
5479 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5480 label, random, rlen, dstbuf, dlen ) );
5481}
5482#endif /* MBEDTLS_SHA256_C */
5483
5484#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005485MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005486static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5487 const char *label,
5488 const unsigned char *random, size_t rlen,
5489 unsigned char *dstbuf, size_t dlen )
5490{
5491 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5492 label, random, rlen, dstbuf, dlen ) );
5493}
5494#endif /* MBEDTLS_SHA384_C */
5495
Jerry Yuf009d862022-02-17 14:01:37 +08005496/*
5497 * Set appropriate PRF function and other SSL / TLS1.2 functions
5498 *
5499 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005500 * - hash associated with the ciphersuite (only used by TLS 1.2)
5501 *
5502 * Outputs:
5503 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5504 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005505MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005506static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005507 mbedtls_md_type_t hash )
5508{
Jerry Yuf009d862022-02-17 14:01:37 +08005509#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005510 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005511 {
5512 handshake->tls_prf = tls_prf_sha384;
5513 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5514 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5515 }
5516 else
5517#endif
5518#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005519 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005520 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005521 handshake->tls_prf = tls_prf_sha256;
5522 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5523 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5524 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005525#else
Jerry Yuf009d862022-02-17 14:01:37 +08005526 {
Jerry Yuf009d862022-02-17 14:01:37 +08005527 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005528 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005529 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5530 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005531#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005532
5533 return( 0 );
5534}
Jerry Yud6ab2352022-02-17 14:03:43 +08005535
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005536/*
5537 * Compute master secret if needed
5538 *
5539 * Parameters:
5540 * [in/out] handshake
5541 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5542 * (PSA-PSK) ciphersuite_info, psk_opaque
5543 * [out] premaster (cleared)
5544 * [out] master
5545 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5546 * debug: conf->f_dbg, conf->p_dbg
5547 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005548 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005549 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005550MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005551static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5552 unsigned char *master,
5553 const mbedtls_ssl_context *ssl )
5554{
5555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5556
5557 /* cf. RFC 5246, Section 8.1:
5558 * "The master secret is always exactly 48 bytes in length." */
5559 size_t const master_secret_len = 48;
5560
5561#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5562 unsigned char session_hash[48];
5563#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5564
5565 /* The label for the KDF used for key expansion.
5566 * This is either "master secret" or "extended master secret"
5567 * depending on whether the Extended Master Secret extension
5568 * is used. */
5569 char const *lbl = "master secret";
5570
Przemek Stekielae4ed302022-04-05 17:15:55 +02005571 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005572 * - If the Extended Master Secret extension is not used,
5573 * this is ClientHello.Random + ServerHello.Random
5574 * (see Sect. 8.1 in RFC 5246).
5575 * - If the Extended Master Secret extension is used,
5576 * this is the transcript of the handshake so far.
5577 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005578 unsigned char const *seed = handshake->randbytes;
5579 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005580
5581#if !defined(MBEDTLS_DEBUG_C) && \
5582 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5583 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5584 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5585 ssl = NULL; /* make sure we don't use it except for those cases */
5586 (void) ssl;
5587#endif
5588
5589 if( handshake->resume != 0 )
5590 {
5591 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5592 return( 0 );
5593 }
5594
5595#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5596 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5597 {
5598 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005599 seed = session_hash;
5600 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005601
5602 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005603 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005604 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005605#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005606
Przemek Stekiel99114f32022-04-22 11:20:09 +02005607#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005608 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005609 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005610 {
5611 /* Perform PSK-to-MS expansion in a single step. */
5612 psa_status_t status;
5613 psa_algorithm_t alg;
5614 mbedtls_svc_key_id_t psk;
5615 psa_key_derivation_operation_t derivation =
5616 PSA_KEY_DERIVATION_OPERATION_INIT;
5617 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5618
5619 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5620
5621 psk = mbedtls_ssl_get_opaque_psk( ssl );
5622
5623 if( hash_alg == MBEDTLS_MD_SHA384 )
5624 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5625 else
5626 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5627
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005628 size_t other_secret_len = 0;
5629 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005630
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005631 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005632 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005633 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005634 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005635 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005636 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005637 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005638 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005639 other_secret_len = 48;
5640 other_secret = handshake->premaster + 2;
5641 break;
5642 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005643 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005644 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5645 other_secret = handshake->premaster + 2;
5646 break;
5647 default:
5648 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005649 }
5650
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005651 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005652 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005653 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005654 (unsigned char const *) lbl,
5655 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005656 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005657 master_secret_len );
5658 if( status != PSA_SUCCESS )
5659 {
5660 psa_key_derivation_abort( &derivation );
5661 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5662 }
5663
5664 status = psa_key_derivation_output_bytes( &derivation,
5665 master,
5666 master_secret_len );
5667 if( status != PSA_SUCCESS )
5668 {
5669 psa_key_derivation_abort( &derivation );
5670 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5671 }
5672
5673 status = psa_key_derivation_abort( &derivation );
5674 if( status != PSA_SUCCESS )
5675 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5676 }
5677 else
5678#endif
5679 {
5680 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005681 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005682 master,
5683 master_secret_len );
5684 if( ret != 0 )
5685 {
5686 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5687 return( ret );
5688 }
5689
5690 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5691 handshake->premaster,
5692 handshake->pmslen );
5693
5694 mbedtls_platform_zeroize( handshake->premaster,
5695 sizeof(handshake->premaster) );
5696 }
5697
5698 return( 0 );
5699}
5700
Jerry Yud62f87e2022-02-17 14:09:02 +08005701int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5702{
5703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5704 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5705 ssl->handshake->ciphersuite_info;
5706
5707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5708
5709 /* Set PRF, calc_verify and calc_finished function pointers */
5710 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005711 ciphersuite_info->mac );
5712 if( ret != 0 )
5713 {
5714 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5715 return( ret );
5716 }
5717
5718 /* Compute master secret if needed */
5719 ret = ssl_compute_master( ssl->handshake,
5720 ssl->session_negotiate->master,
5721 ssl );
5722 if( ret != 0 )
5723 {
5724 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5725 return( ret );
5726 }
5727
5728 /* Swap the client and server random values:
5729 * - MS derivation wanted client+server (RFC 5246 8.1)
5730 * - key derivation wants server+client (RFC 5246 6.3) */
5731 {
5732 unsigned char tmp[64];
5733 memcpy( tmp, ssl->handshake->randbytes, 64 );
5734 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5735 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5736 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5737 }
5738
5739 /* Populate transform structure */
5740 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5741 ssl->session_negotiate->ciphersuite,
5742 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005743#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005744 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005745#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005746 ssl->handshake->tls_prf,
5747 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005748 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005749 ssl->conf->endpoint,
5750 ssl );
5751 if( ret != 0 )
5752 {
5753 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5754 return( ret );
5755 }
5756
5757 /* We no longer need Server/ClientHello.random values */
5758 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5759 sizeof( ssl->handshake->randbytes ) );
5760
5761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5762
5763 return( 0 );
5764}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005765
Ronald Cron4dcbca92022-03-07 10:21:40 +01005766int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5767{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005768 switch( md )
5769 {
5770#if defined(MBEDTLS_SHA384_C)
5771 case MBEDTLS_SSL_HASH_SHA384:
5772 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5773 break;
5774#endif
5775#if defined(MBEDTLS_SHA256_C)
5776 case MBEDTLS_SSL_HASH_SHA256:
5777 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5778 break;
5779#endif
5780 default:
5781 return( -1 );
5782 }
5783
Ronald Cronc2f13a02022-03-07 10:25:24 +01005784 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005785}
5786
Jerry Yu8392e0d2022-02-17 14:10:24 +08005787#if defined(MBEDTLS_SHA256_C)
5788void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5789 unsigned char *hash,
5790 size_t *hlen )
5791{
5792#if defined(MBEDTLS_USE_PSA_CRYPTO)
5793 size_t hash_size;
5794 psa_status_t status;
5795 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5796
5797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5798 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5799 if( status != PSA_SUCCESS )
5800 {
5801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5802 return;
5803 }
5804
5805 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5806 if( status != PSA_SUCCESS )
5807 {
5808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5809 return;
5810 }
5811
5812 *hlen = 32;
5813 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5814 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5815#else
5816 mbedtls_sha256_context sha256;
5817
5818 mbedtls_sha256_init( &sha256 );
5819
5820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5821
5822 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5823 mbedtls_sha256_finish( &sha256, hash );
5824
5825 *hlen = 32;
5826
5827 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5828 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5829
5830 mbedtls_sha256_free( &sha256 );
5831#endif /* MBEDTLS_USE_PSA_CRYPTO */
5832 return;
5833}
5834#endif /* MBEDTLS_SHA256_C */
5835
Jerry Yuc1cb3842022-02-17 14:13:48 +08005836#if defined(MBEDTLS_SHA384_C)
5837void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5838 unsigned char *hash,
5839 size_t *hlen )
5840{
5841#if defined(MBEDTLS_USE_PSA_CRYPTO)
5842 size_t hash_size;
5843 psa_status_t status;
5844 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5845
5846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5847 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5848 if( status != PSA_SUCCESS )
5849 {
5850 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5851 return;
5852 }
5853
5854 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5855 if( status != PSA_SUCCESS )
5856 {
5857 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5858 return;
5859 }
5860
5861 *hlen = 48;
5862 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5864#else
5865 mbedtls_sha512_context sha512;
5866
5867 mbedtls_sha512_init( &sha512 );
5868
5869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5870
5871 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5872 mbedtls_sha512_finish( &sha512, hash );
5873
5874 *hlen = 48;
5875
5876 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5877 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5878
5879 mbedtls_sha512_free( &sha512 );
5880#endif /* MBEDTLS_USE_PSA_CRYPTO */
5881 return;
5882}
5883#endif /* MBEDTLS_SHA384_C */
5884
Neil Armstrong80f6f322022-05-03 17:56:38 +02005885#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5886 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005887int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5888{
5889 unsigned char *p = ssl->handshake->premaster;
5890 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5891 const unsigned char *psk = NULL;
5892 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005893 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005894
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005895 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005896 {
5897 /*
5898 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005899 * checked before calling this function.
5900 *
5901 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005902 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005903 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005904 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5905 {
5906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5907 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5908 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005909 }
5910
5911 /*
5912 * PMS = struct {
5913 * opaque other_secret<0..2^16-1>;
5914 * opaque psk<0..2^16-1>;
5915 * };
5916 * with "other_secret" depending on the particular key exchange
5917 */
5918#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5919 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5920 {
5921 if( end - p < 2 )
5922 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5923
5924 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5925 p += 2;
5926
5927 if( end < p || (size_t)( end - p ) < psk_len )
5928 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5929
5930 memset( p, 0, psk_len );
5931 p += psk_len;
5932 }
5933 else
5934#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5935#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5936 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5937 {
5938 /*
5939 * other_secret already set by the ClientKeyExchange message,
5940 * and is 48 bytes long
5941 */
5942 if( end - p < 2 )
5943 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5944
5945 *p++ = 0;
5946 *p++ = 48;
5947 p += 48;
5948 }
5949 else
5950#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5951#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5952 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5953 {
5954 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5955 size_t len;
5956
5957 /* Write length only when we know the actual value */
5958 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5959 p + 2, end - ( p + 2 ), &len,
5960 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5961 {
5962 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5963 return( ret );
5964 }
5965 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5966 p += 2 + len;
5967
5968 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5969 }
5970 else
5971#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005972#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005973 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5974 {
5975 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5976 size_t zlen;
5977
5978 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5979 p + 2, end - ( p + 2 ),
5980 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5981 {
5982 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5983 return( ret );
5984 }
5985
5986 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5987 p += 2 + zlen;
5988
5989 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5990 MBEDTLS_DEBUG_ECDH_Z );
5991 }
5992 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005993#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005994 {
5995 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5996 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5997 }
5998
5999 /* opaque psk<0..2^16-1>; */
6000 if( end - p < 2 )
6001 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6002
6003 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6004 p += 2;
6005
6006 if( end < p || (size_t)( end - p ) < psk_len )
6007 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6008
6009 memcpy( p, psk, psk_len );
6010 p += psk_len;
6011
6012 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6013
6014 return( 0 );
6015}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006016#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006017
6018#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006019MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006020static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6021
6022#if defined(MBEDTLS_SSL_PROTO_DTLS)
6023int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6024{
6025 /* If renegotiation is not enforced, retransmit until we would reach max
6026 * timeout if we were using the usual handshake doubling scheme */
6027 if( ssl->conf->renego_max_records < 0 )
6028 {
6029 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6030 unsigned char doublings = 1;
6031
6032 while( ratio != 0 )
6033 {
6034 ++doublings;
6035 ratio >>= 1;
6036 }
6037
6038 if( ++ssl->renego_records_seen > doublings )
6039 {
6040 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6041 return( 0 );
6042 }
6043 }
6044
6045 return( ssl_write_hello_request( ssl ) );
6046}
6047#endif
6048#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006049
Jerry Yud9526692022-02-17 14:23:47 +08006050/*
6051 * Handshake functions
6052 */
6053#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6054/* No certificate support -> dummy functions */
6055int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6056{
6057 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6058 ssl->handshake->ciphersuite_info;
6059
6060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6061
6062 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6063 {
6064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6065 ssl->state++;
6066 return( 0 );
6067 }
6068
6069 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6070 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6071}
6072
6073int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6074{
6075 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6076 ssl->handshake->ciphersuite_info;
6077
6078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6079
6080 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6081 {
6082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6083 ssl->state++;
6084 return( 0 );
6085 }
6086
6087 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6088 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6089}
6090
6091#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6092/* Some certificate support -> implement write and parse */
6093
6094int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6095{
6096 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6097 size_t i, n;
6098 const mbedtls_x509_crt *crt;
6099 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6100 ssl->handshake->ciphersuite_info;
6101
6102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6103
6104 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6105 {
6106 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6107 ssl->state++;
6108 return( 0 );
6109 }
6110
6111#if defined(MBEDTLS_SSL_CLI_C)
6112 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6113 {
6114 if( ssl->handshake->client_auth == 0 )
6115 {
6116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6117 ssl->state++;
6118 return( 0 );
6119 }
6120 }
6121#endif /* MBEDTLS_SSL_CLI_C */
6122#if defined(MBEDTLS_SSL_SRV_C)
6123 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6124 {
6125 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6126 {
6127 /* Should never happen because we shouldn't have picked the
6128 * ciphersuite if we don't have a certificate. */
6129 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6130 }
6131 }
6132#endif
6133
6134 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6135
6136 /*
6137 * 0 . 0 handshake type
6138 * 1 . 3 handshake length
6139 * 4 . 6 length of all certs
6140 * 7 . 9 length of cert. 1
6141 * 10 . n-1 peer certificate
6142 * n . n+2 length of cert. 2
6143 * n+3 . ... upper level cert, etc.
6144 */
6145 i = 7;
6146 crt = mbedtls_ssl_own_cert( ssl );
6147
6148 while( crt != NULL )
6149 {
6150 n = crt->raw.len;
6151 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6152 {
6153 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6154 " > %" MBEDTLS_PRINTF_SIZET,
6155 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6156 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6157 }
6158
6159 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6160 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6161 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6162
6163 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6164 i += n; crt = crt->next;
6165 }
6166
6167 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6168 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6169 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6170
6171 ssl->out_msglen = i;
6172 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6173 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6174
6175 ssl->state++;
6176
6177 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6178 {
6179 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6180 return( ret );
6181 }
6182
6183 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6184
6185 return( ret );
6186}
6187
6188#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6189
6190#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006191MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006192static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6193 unsigned char *crt_buf,
6194 size_t crt_buf_len )
6195{
6196 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6197
6198 if( peer_crt == NULL )
6199 return( -1 );
6200
6201 if( peer_crt->raw.len != crt_buf_len )
6202 return( -1 );
6203
6204 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6205}
6206#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006207MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006208static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6209 unsigned char *crt_buf,
6210 size_t crt_buf_len )
6211{
6212 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6213 unsigned char const * const peer_cert_digest =
6214 ssl->session->peer_cert_digest;
6215 mbedtls_md_type_t const peer_cert_digest_type =
6216 ssl->session->peer_cert_digest_type;
6217 mbedtls_md_info_t const * const digest_info =
6218 mbedtls_md_info_from_type( peer_cert_digest_type );
6219 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6220 size_t digest_len;
6221
6222 if( peer_cert_digest == NULL || digest_info == NULL )
6223 return( -1 );
6224
6225 digest_len = mbedtls_md_get_size( digest_info );
6226 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6227 return( -1 );
6228
6229 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6230 if( ret != 0 )
6231 return( -1 );
6232
6233 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6234}
6235#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6236#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6237
6238/*
6239 * Once the certificate message is read, parse it into a cert chain and
6240 * perform basic checks, but leave actual verification to the caller
6241 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006242MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006243static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6244 mbedtls_x509_crt *chain )
6245{
6246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6247#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6248 int crt_cnt=0;
6249#endif
6250 size_t i, n;
6251 uint8_t alert;
6252
6253 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6254 {
6255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6256 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6257 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6258 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6259 }
6260
6261 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6262 {
6263 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6264 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6265 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6266 }
6267
6268 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6269 {
6270 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6271 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6272 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6273 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6274 }
6275
6276 i = mbedtls_ssl_hs_hdr_len( ssl );
6277
6278 /*
6279 * Same message structure as in mbedtls_ssl_write_certificate()
6280 */
6281 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6282
6283 if( ssl->in_msg[i] != 0 ||
6284 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6285 {
6286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6287 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6288 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6289 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6290 }
6291
6292 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6293 i += 3;
6294
6295 /* Iterate through and parse the CRTs in the provided chain. */
6296 while( i < ssl->in_hslen )
6297 {
6298 /* Check that there's room for the next CRT's length fields. */
6299 if ( i + 3 > ssl->in_hslen ) {
6300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6301 mbedtls_ssl_send_alert_message( ssl,
6302 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6303 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6304 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6305 }
6306 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6307 * anything beyond 2**16 ~ 64K. */
6308 if( ssl->in_msg[i] != 0 )
6309 {
6310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6311 mbedtls_ssl_send_alert_message( ssl,
6312 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6313 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6314 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6315 }
6316
6317 /* Read length of the next CRT in the chain. */
6318 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6319 | (unsigned int) ssl->in_msg[i + 2];
6320 i += 3;
6321
6322 if( n < 128 || i + n > ssl->in_hslen )
6323 {
6324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6325 mbedtls_ssl_send_alert_message( ssl,
6326 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6327 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6328 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6329 }
6330
6331 /* Check if we're handling the first CRT in the chain. */
6332#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6333 if( crt_cnt++ == 0 &&
6334 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6335 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6336 {
6337 /* During client-side renegotiation, check that the server's
6338 * end-CRTs hasn't changed compared to the initial handshake,
6339 * mitigating the triple handshake attack. On success, reuse
6340 * the original end-CRT instead of parsing it again. */
6341 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6342 if( ssl_check_peer_crt_unchanged( ssl,
6343 &ssl->in_msg[i],
6344 n ) != 0 )
6345 {
6346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6347 mbedtls_ssl_send_alert_message( ssl,
6348 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6349 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6350 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6351 }
6352
6353 /* Now we can safely free the original chain. */
6354 ssl_clear_peer_cert( ssl->session );
6355 }
6356#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6357
6358 /* Parse the next certificate in the chain. */
6359#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6360 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6361#else
6362 /* If we don't need to store the CRT chain permanently, parse
6363 * it in-place from the input buffer instead of making a copy. */
6364 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6365#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6366 switch( ret )
6367 {
6368 case 0: /*ok*/
6369 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6370 /* Ignore certificate with an unknown algorithm: maybe a
6371 prior certificate was already trusted. */
6372 break;
6373
6374 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6375 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6376 goto crt_parse_der_failed;
6377
6378 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6379 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6380 goto crt_parse_der_failed;
6381
6382 default:
6383 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6384 crt_parse_der_failed:
6385 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6386 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6387 return( ret );
6388 }
6389
6390 i += n;
6391 }
6392
6393 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6394 return( 0 );
6395}
6396
6397#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006398MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006399static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6400{
6401 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6402 return( -1 );
6403
6404 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6405 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6406 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6407 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6408 {
Ronald Cron19385882022-06-15 16:26:13 +02006409 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006410 return( 0 );
6411 }
6412 return( -1 );
6413}
6414#endif /* MBEDTLS_SSL_SRV_C */
6415
6416/* Check if a certificate message is expected.
6417 * Return either
6418 * - SSL_CERTIFICATE_EXPECTED, or
6419 * - SSL_CERTIFICATE_SKIP
6420 * indicating whether a Certificate message is expected or not.
6421 */
6422#define SSL_CERTIFICATE_EXPECTED 0
6423#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006424MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006425static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6426 int authmode )
6427{
6428 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6429 ssl->handshake->ciphersuite_info;
6430
6431 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6432 return( SSL_CERTIFICATE_SKIP );
6433
6434#if defined(MBEDTLS_SSL_SRV_C)
6435 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6436 {
6437 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6438 return( SSL_CERTIFICATE_SKIP );
6439
6440 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6441 {
6442 ssl->session_negotiate->verify_result =
6443 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6444 return( SSL_CERTIFICATE_SKIP );
6445 }
6446 }
6447#else
6448 ((void) authmode);
6449#endif /* MBEDTLS_SSL_SRV_C */
6450
6451 return( SSL_CERTIFICATE_EXPECTED );
6452}
6453
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006454MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006455static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6456 int authmode,
6457 mbedtls_x509_crt *chain,
6458 void *rs_ctx )
6459{
6460 int ret = 0;
6461 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6462 ssl->handshake->ciphersuite_info;
6463 int have_ca_chain = 0;
6464
6465 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6466 void *p_vrfy;
6467
6468 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6469 return( 0 );
6470
6471 if( ssl->f_vrfy != NULL )
6472 {
6473 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6474 f_vrfy = ssl->f_vrfy;
6475 p_vrfy = ssl->p_vrfy;
6476 }
6477 else
6478 {
6479 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6480 f_vrfy = ssl->conf->f_vrfy;
6481 p_vrfy = ssl->conf->p_vrfy;
6482 }
6483
6484 /*
6485 * Main check: verify certificate
6486 */
6487#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6488 if( ssl->conf->f_ca_cb != NULL )
6489 {
6490 ((void) rs_ctx);
6491 have_ca_chain = 1;
6492
6493 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6494 ret = mbedtls_x509_crt_verify_with_ca_cb(
6495 chain,
6496 ssl->conf->f_ca_cb,
6497 ssl->conf->p_ca_cb,
6498 ssl->conf->cert_profile,
6499 ssl->hostname,
6500 &ssl->session_negotiate->verify_result,
6501 f_vrfy, p_vrfy );
6502 }
6503 else
6504#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6505 {
6506 mbedtls_x509_crt *ca_chain;
6507 mbedtls_x509_crl *ca_crl;
6508
6509#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6510 if( ssl->handshake->sni_ca_chain != NULL )
6511 {
6512 ca_chain = ssl->handshake->sni_ca_chain;
6513 ca_crl = ssl->handshake->sni_ca_crl;
6514 }
6515 else
6516#endif
6517 {
6518 ca_chain = ssl->conf->ca_chain;
6519 ca_crl = ssl->conf->ca_crl;
6520 }
6521
6522 if( ca_chain != NULL )
6523 have_ca_chain = 1;
6524
6525 ret = mbedtls_x509_crt_verify_restartable(
6526 chain,
6527 ca_chain, ca_crl,
6528 ssl->conf->cert_profile,
6529 ssl->hostname,
6530 &ssl->session_negotiate->verify_result,
6531 f_vrfy, p_vrfy, rs_ctx );
6532 }
6533
6534 if( ret != 0 )
6535 {
6536 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6537 }
6538
6539#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6540 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6541 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6542#endif
6543
6544 /*
6545 * Secondary checks: always done, but change 'ret' only if it was 0
6546 */
6547
6548#if defined(MBEDTLS_ECP_C)
6549 {
6550 const mbedtls_pk_context *pk = &chain->pk;
6551
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006552 /* If certificate uses an EC key, make sure the curve is OK.
6553 * This is a public key, so it can't be opaque, so can_do() is a good
6554 * enough check to ensure pk_ec() is safe to use here. */
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006555 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) )
Jerry Yud9526692022-02-17 14:23:47 +08006556 {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006557 /* and in the unlikely case the above assumption no longer holds
6558 * we are making sure that pk_ec() here does not return a NULL
6559 */
6560 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *pk );
6561 if( ec == NULL )
6562 {
Tom Cosgrove20c11372022-08-24 15:06:13 +01006563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_pk_ec() returned NULL" ) );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006564 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6565 }
Jerry Yud9526692022-02-17 14:23:47 +08006566
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006567 if( mbedtls_ssl_check_curve( ssl, ec->grp.id ) != 0 )
6568 {
6569 ssl->session_negotiate->verify_result |=
6570 MBEDTLS_X509_BADCERT_BAD_KEY;
6571
6572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6573 if( ret == 0 )
6574 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6575 }
Jerry Yud9526692022-02-17 14:23:47 +08006576 }
6577 }
6578#endif /* MBEDTLS_ECP_C */
6579
6580 if( mbedtls_ssl_check_cert_usage( chain,
6581 ciphersuite_info,
6582 ! ssl->conf->endpoint,
6583 &ssl->session_negotiate->verify_result ) != 0 )
6584 {
6585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6586 if( ret == 0 )
6587 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6588 }
6589
6590 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6591 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6592 * with details encoded in the verification flags. All other kinds
6593 * of error codes, including those from the user provided f_vrfy
6594 * functions, are treated as fatal and lead to a failure of
6595 * ssl_parse_certificate even if verification was optional. */
6596 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6597 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6598 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6599 {
6600 ret = 0;
6601 }
6602
6603 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6604 {
6605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6606 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6607 }
6608
6609 if( ret != 0 )
6610 {
6611 uint8_t alert;
6612
6613 /* The certificate may have been rejected for several reasons.
6614 Pick one and send the corresponding alert. Which alert to send
6615 may be a subject of debate in some cases. */
6616 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6617 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6618 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6619 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6620 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6621 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6622 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6623 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6624 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6625 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6626 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6627 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6628 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6629 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6630 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6631 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6632 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6633 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6634 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6635 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6636 else
6637 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6638 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6639 alert );
6640 }
6641
6642#if defined(MBEDTLS_DEBUG_C)
6643 if( ssl->session_negotiate->verify_result != 0 )
6644 {
6645 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6646 (unsigned int) ssl->session_negotiate->verify_result ) );
6647 }
6648 else
6649 {
6650 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6651 }
6652#endif /* MBEDTLS_DEBUG_C */
6653
6654 return( ret );
6655}
6656
6657#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006658MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006659static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6660 unsigned char *start, size_t len )
6661{
6662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6663 /* Remember digest of the peer's end-CRT. */
6664 ssl->session_negotiate->peer_cert_digest =
6665 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6666 if( ssl->session_negotiate->peer_cert_digest == NULL )
6667 {
6668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6669 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6670 mbedtls_ssl_send_alert_message( ssl,
6671 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6672 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6673
6674 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6675 }
6676
6677 ret = mbedtls_md( mbedtls_md_info_from_type(
6678 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6679 start, len,
6680 ssl->session_negotiate->peer_cert_digest );
6681
6682 ssl->session_negotiate->peer_cert_digest_type =
6683 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6684 ssl->session_negotiate->peer_cert_digest_len =
6685 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6686
6687 return( ret );
6688}
6689
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006690MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006691static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6692 unsigned char *start, size_t len )
6693{
6694 unsigned char *end = start + len;
6695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6696
6697 /* Make a copy of the peer's raw public key. */
6698 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6699 ret = mbedtls_pk_parse_subpubkey( &start, end,
6700 &ssl->handshake->peer_pubkey );
6701 if( ret != 0 )
6702 {
6703 /* We should have parsed the public key before. */
6704 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6705 }
6706
6707 return( 0 );
6708}
6709#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6710
6711int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6712{
6713 int ret = 0;
6714 int crt_expected;
6715#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6716 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6717 ? ssl->handshake->sni_authmode
6718 : ssl->conf->authmode;
6719#else
6720 const int authmode = ssl->conf->authmode;
6721#endif
6722 void *rs_ctx = NULL;
6723 mbedtls_x509_crt *chain = NULL;
6724
6725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6726
6727 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6728 if( crt_expected == SSL_CERTIFICATE_SKIP )
6729 {
6730 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6731 goto exit;
6732 }
6733
6734#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6735 if( ssl->handshake->ecrs_enabled &&
6736 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6737 {
6738 chain = ssl->handshake->ecrs_peer_cert;
6739 ssl->handshake->ecrs_peer_cert = NULL;
6740 goto crt_verify;
6741 }
6742#endif
6743
6744 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6745 {
6746 /* mbedtls_ssl_read_record may have sent an alert already. We
6747 let it decide whether to alert. */
6748 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6749 goto exit;
6750 }
6751
6752#if defined(MBEDTLS_SSL_SRV_C)
6753 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6754 {
6755 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6756
6757 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6758 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6759
6760 goto exit;
6761 }
6762#endif /* MBEDTLS_SSL_SRV_C */
6763
6764 /* Clear existing peer CRT structure in case we tried to
6765 * reuse a session but it failed, and allocate a new one. */
6766 ssl_clear_peer_cert( ssl->session_negotiate );
6767
6768 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6769 if( chain == NULL )
6770 {
6771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6772 sizeof( mbedtls_x509_crt ) ) );
6773 mbedtls_ssl_send_alert_message( ssl,
6774 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6775 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6776
6777 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6778 goto exit;
6779 }
6780 mbedtls_x509_crt_init( chain );
6781
6782 ret = ssl_parse_certificate_chain( ssl, chain );
6783 if( ret != 0 )
6784 goto exit;
6785
6786#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6787 if( ssl->handshake->ecrs_enabled)
6788 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6789
6790crt_verify:
6791 if( ssl->handshake->ecrs_enabled)
6792 rs_ctx = &ssl->handshake->ecrs_ctx;
6793#endif
6794
6795 ret = ssl_parse_certificate_verify( ssl, authmode,
6796 chain, rs_ctx );
6797 if( ret != 0 )
6798 goto exit;
6799
6800#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6801 {
6802 unsigned char *crt_start, *pk_start;
6803 size_t crt_len, pk_len;
6804
6805 /* We parse the CRT chain without copying, so
6806 * these pointers point into the input buffer,
6807 * and are hence still valid after freeing the
6808 * CRT chain. */
6809
6810 crt_start = chain->raw.p;
6811 crt_len = chain->raw.len;
6812
6813 pk_start = chain->pk_raw.p;
6814 pk_len = chain->pk_raw.len;
6815
6816 /* Free the CRT structures before computing
6817 * digest and copying the peer's public key. */
6818 mbedtls_x509_crt_free( chain );
6819 mbedtls_free( chain );
6820 chain = NULL;
6821
6822 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6823 if( ret != 0 )
6824 goto exit;
6825
6826 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6827 if( ret != 0 )
6828 goto exit;
6829 }
6830#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6831 /* Pass ownership to session structure. */
6832 ssl->session_negotiate->peer_cert = chain;
6833 chain = NULL;
6834#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6835
6836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6837
6838exit:
6839
6840 if( ret == 0 )
6841 ssl->state++;
6842
6843#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6844 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6845 {
6846 ssl->handshake->ecrs_peer_cert = chain;
6847 chain = NULL;
6848 }
6849#endif
6850
6851 if( chain != NULL )
6852 {
6853 mbedtls_x509_crt_free( chain );
6854 mbedtls_free( chain );
6855 }
6856
6857 return( ret );
6858}
6859#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6860
Jerry Yu615bd6f2022-02-17 14:25:15 +08006861#if defined(MBEDTLS_SHA256_C)
6862static void ssl_calc_finished_tls_sha256(
6863 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6864{
6865 int len = 12;
6866 const char *sender;
6867 unsigned char padbuf[32];
6868#if defined(MBEDTLS_USE_PSA_CRYPTO)
6869 size_t hash_size;
6870 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6871 psa_status_t status;
6872#else
6873 mbedtls_sha256_context sha256;
6874#endif
6875
6876 mbedtls_ssl_session *session = ssl->session_negotiate;
6877 if( !session )
6878 session = ssl->session;
6879
6880 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6881 ? "client finished"
6882 : "server finished";
6883
6884#if defined(MBEDTLS_USE_PSA_CRYPTO)
6885 sha256_psa = psa_hash_operation_init();
6886
6887 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6888
6889 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6890 if( status != PSA_SUCCESS )
6891 {
6892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6893 return;
6894 }
6895
6896 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6897 if( status != PSA_SUCCESS )
6898 {
6899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6900 return;
6901 }
6902 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6903#else
6904
6905 mbedtls_sha256_init( &sha256 );
6906
6907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6908
6909 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6910
6911 /*
6912 * TLSv1.2:
6913 * hash = PRF( master, finished_label,
6914 * Hash( handshake ) )[0.11]
6915 */
6916
6917#if !defined(MBEDTLS_SHA256_ALT)
6918 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6919 sha256.state, sizeof( sha256.state ) );
6920#endif
6921
6922 mbedtls_sha256_finish( &sha256, padbuf );
6923 mbedtls_sha256_free( &sha256 );
6924#endif /* MBEDTLS_USE_PSA_CRYPTO */
6925
6926 ssl->handshake->tls_prf( session->master, 48, sender,
6927 padbuf, 32, buf, len );
6928
6929 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6930
6931 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6932
6933 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6934}
6935#endif /* MBEDTLS_SHA256_C */
6936
Jerry Yub7ba49e2022-02-17 14:25:53 +08006937
6938#if defined(MBEDTLS_SHA384_C)
6939
6940static void ssl_calc_finished_tls_sha384(
6941 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6942{
6943 int len = 12;
6944 const char *sender;
6945 unsigned char padbuf[48];
6946#if defined(MBEDTLS_USE_PSA_CRYPTO)
6947 size_t hash_size;
6948 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6949 psa_status_t status;
6950#else
6951 mbedtls_sha512_context sha512;
6952#endif
6953
6954 mbedtls_ssl_session *session = ssl->session_negotiate;
6955 if( !session )
6956 session = ssl->session;
6957
6958 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6959 ? "client finished"
6960 : "server finished";
6961
6962#if defined(MBEDTLS_USE_PSA_CRYPTO)
6963 sha384_psa = psa_hash_operation_init();
6964
6965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6966
6967 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6968 if( status != PSA_SUCCESS )
6969 {
6970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6971 return;
6972 }
6973
6974 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6975 if( status != PSA_SUCCESS )
6976 {
6977 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6978 return;
6979 }
6980 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6981#else
6982 mbedtls_sha512_init( &sha512 );
6983
6984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6985
6986 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6987
6988 /*
6989 * TLSv1.2:
6990 * hash = PRF( master, finished_label,
6991 * Hash( handshake ) )[0.11]
6992 */
6993
6994#if !defined(MBEDTLS_SHA512_ALT)
6995 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6996 sha512.state, sizeof( sha512.state ) );
6997#endif
6998 mbedtls_sha512_finish( &sha512, padbuf );
6999
7000 mbedtls_sha512_free( &sha512 );
7001#endif
7002
7003 ssl->handshake->tls_prf( session->master, 48, sender,
7004 padbuf, 48, buf, len );
7005
7006 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7007
7008 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7009
7010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7011}
7012#endif /* MBEDTLS_SHA384_C */
7013
Jerry Yuaef00152022-02-17 14:27:31 +08007014void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7015{
7016 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7017
7018 /*
7019 * Free our handshake params
7020 */
7021 mbedtls_ssl_handshake_free( ssl );
7022 mbedtls_free( ssl->handshake );
7023 ssl->handshake = NULL;
7024
7025 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007026 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007027 */
7028 if( ssl->transform )
7029 {
7030 mbedtls_ssl_transform_free( ssl->transform );
7031 mbedtls_free( ssl->transform );
7032 }
7033 ssl->transform = ssl->transform_negotiate;
7034 ssl->transform_negotiate = NULL;
7035
7036 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7037}
7038
Jerry Yu2a9fff52022-02-17 14:28:51 +08007039void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7040{
7041 int resume = ssl->handshake->resume;
7042
7043 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7044
7045#if defined(MBEDTLS_SSL_RENEGOTIATION)
7046 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7047 {
7048 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7049 ssl->renego_records_seen = 0;
7050 }
7051#endif
7052
7053 /*
7054 * Free the previous session and switch in the current one
7055 */
7056 if( ssl->session )
7057 {
7058#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7059 /* RFC 7366 3.1: keep the EtM state */
7060 ssl->session_negotiate->encrypt_then_mac =
7061 ssl->session->encrypt_then_mac;
7062#endif
7063
7064 mbedtls_ssl_session_free( ssl->session );
7065 mbedtls_free( ssl->session );
7066 }
7067 ssl->session = ssl->session_negotiate;
7068 ssl->session_negotiate = NULL;
7069
7070 /*
7071 * Add cache entry
7072 */
7073 if( ssl->conf->f_set_cache != NULL &&
7074 ssl->session->id_len != 0 &&
7075 resume == 0 )
7076 {
7077 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7078 ssl->session->id,
7079 ssl->session->id_len,
7080 ssl->session ) != 0 )
7081 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7082 }
7083
7084#if defined(MBEDTLS_SSL_PROTO_DTLS)
7085 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7086 ssl->handshake->flight != NULL )
7087 {
7088 /* Cancel handshake timer */
7089 mbedtls_ssl_set_timer( ssl, 0 );
7090
7091 /* Keep last flight around in case we need to resend it:
7092 * we need the handshake and transform structures for that */
7093 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7094 }
7095 else
7096#endif
7097 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7098
7099 ssl->state++;
7100
7101 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7102}
7103
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007104int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7105{
7106 int ret, hash_len;
7107
7108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7109
7110 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7111
7112 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7113
7114 /*
7115 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7116 * may define some other value. Currently (early 2016), no defined
7117 * ciphersuite does this (and this is unlikely to change as activity has
7118 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7119 */
7120 hash_len = 12;
7121
7122#if defined(MBEDTLS_SSL_RENEGOTIATION)
7123 ssl->verify_data_len = hash_len;
7124 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7125#endif
7126
7127 ssl->out_msglen = 4 + hash_len;
7128 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7129 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7130
7131 /*
7132 * In case of session resuming, invert the client and server
7133 * ChangeCipherSpec messages order.
7134 */
7135 if( ssl->handshake->resume != 0 )
7136 {
7137#if defined(MBEDTLS_SSL_CLI_C)
7138 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7139 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7140#endif
7141#if defined(MBEDTLS_SSL_SRV_C)
7142 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7143 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7144#endif
7145 }
7146 else
7147 ssl->state++;
7148
7149 /*
7150 * Switch to our negotiated transform and session parameters for outbound
7151 * data.
7152 */
7153 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7154
7155#if defined(MBEDTLS_SSL_PROTO_DTLS)
7156 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7157 {
7158 unsigned char i;
7159
7160 /* Remember current epoch settings for resending */
7161 ssl->handshake->alt_transform_out = ssl->transform_out;
7162 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7163 sizeof( ssl->handshake->alt_out_ctr ) );
7164
7165 /* Set sequence_number to zero */
7166 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7167
7168
7169 /* Increment epoch */
7170 for( i = 2; i > 0; i-- )
7171 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7172 break;
7173
7174 /* The loop goes to its end iff the counter is wrapping */
7175 if( i == 0 )
7176 {
7177 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7178 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7179 }
7180 }
7181 else
7182#endif /* MBEDTLS_SSL_PROTO_DTLS */
7183 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7184
7185 ssl->transform_out = ssl->transform_negotiate;
7186 ssl->session_out = ssl->session_negotiate;
7187
7188#if defined(MBEDTLS_SSL_PROTO_DTLS)
7189 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7190 mbedtls_ssl_send_flight_completed( ssl );
7191#endif
7192
7193 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7194 {
7195 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7196 return( ret );
7197 }
7198
7199#if defined(MBEDTLS_SSL_PROTO_DTLS)
7200 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7201 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7202 {
7203 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7204 return( ret );
7205 }
7206#endif
7207
7208 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7209
7210 return( 0 );
7211}
7212
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007213#define SSL_MAX_HASH_LEN 12
7214
7215int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7216{
7217 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7218 unsigned int hash_len = 12;
7219 unsigned char buf[SSL_MAX_HASH_LEN];
7220
7221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7222
7223 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7224
7225 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7226 {
7227 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7228 goto exit;
7229 }
7230
7231 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7232 {
7233 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7234 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7235 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7236 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7237 goto exit;
7238 }
7239
7240 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7241 {
7242 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7243 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7244 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7245 goto exit;
7246 }
7247
7248 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7249 {
7250 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7251 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7252 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7253 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7254 goto exit;
7255 }
7256
7257 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7258 buf, hash_len ) != 0 )
7259 {
7260 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7261 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7262 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7263 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7264 goto exit;
7265 }
7266
7267#if defined(MBEDTLS_SSL_RENEGOTIATION)
7268 ssl->verify_data_len = hash_len;
7269 memcpy( ssl->peer_verify_data, buf, hash_len );
7270#endif
7271
7272 if( ssl->handshake->resume != 0 )
7273 {
7274#if defined(MBEDTLS_SSL_CLI_C)
7275 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7276 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7277#endif
7278#if defined(MBEDTLS_SSL_SRV_C)
7279 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7280 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7281#endif
7282 }
7283 else
7284 ssl->state++;
7285
7286#if defined(MBEDTLS_SSL_PROTO_DTLS)
7287 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7288 mbedtls_ssl_recv_flight_completed( ssl );
7289#endif
7290
7291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7292
7293exit:
7294 mbedtls_platform_zeroize( buf, hash_len );
7295 return( ret );
7296}
7297
Jerry Yu392112c2022-02-17 14:34:10 +08007298#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7299/*
7300 * Helper to get TLS 1.2 PRF from ciphersuite
7301 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7302 */
7303static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7304{
7305#if defined(MBEDTLS_SHA384_C)
7306 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7307 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7308
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007309 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007310 return( tls_prf_sha384 );
7311#else
7312 (void) ciphersuite_id;
7313#endif
7314 return( tls_prf_sha256 );
7315}
7316#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007317
7318static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7319{
7320 ((void) tls_prf);
7321#if defined(MBEDTLS_SHA384_C)
7322 if( tls_prf == tls_prf_sha384 )
7323 {
7324 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7325 }
7326 else
7327#endif
7328#if defined(MBEDTLS_SHA256_C)
7329 if( tls_prf == tls_prf_sha256 )
7330 {
7331 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7332 }
7333 else
7334#endif
7335 return( MBEDTLS_SSL_TLS_PRF_NONE );
7336}
7337
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007338/*
7339 * Populate a transform structure with session keys and all the other
7340 * necessary information.
7341 *
7342 * Parameters:
7343 * - [in/out]: transform: structure to populate
7344 * [in] must be just initialised with mbedtls_ssl_transform_init()
7345 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7346 * - [in] ciphersuite
7347 * - [in] master
7348 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007349 * - [in] tls_prf: pointer to PRF to use for key derivation
7350 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007351 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007352 * - [in] endpoint: client or server
7353 * - [in] ssl: used for:
7354 * - ssl->conf->{f,p}_export_keys
7355 * [in] optionally used for:
7356 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7357 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007358MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007359static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7360 int ciphersuite,
7361 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007362#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007363 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007364#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007365 ssl_tls_prf_t tls_prf,
7366 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007367 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007368 unsigned endpoint,
7369 const mbedtls_ssl_context *ssl )
7370{
7371 int ret = 0;
7372 unsigned char keyblk[256];
7373 unsigned char *key1;
7374 unsigned char *key2;
7375 unsigned char *mac_enc;
7376 unsigned char *mac_dec;
7377 size_t mac_key_len = 0;
7378 size_t iv_copy_len;
7379 size_t keylen;
7380 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007381 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007382#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007383 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007384 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007385#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007386
7387#if defined(MBEDTLS_USE_PSA_CRYPTO)
7388 psa_key_type_t key_type;
7389 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7390 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007391 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007392 size_t key_bits;
7393 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7394#endif
7395
7396#if !defined(MBEDTLS_DEBUG_C) && \
7397 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7398 if( ssl->f_export_keys == NULL )
7399 {
7400 ssl = NULL; /* make sure we don't use it except for these cases */
7401 (void) ssl;
7402 }
7403#endif
7404
7405 /*
7406 * Some data just needs copying into the structure
7407 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007408#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007409 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007410#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007411 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007412
7413#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7414 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7415#endif
7416
7417#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007418 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007419 {
7420 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7421 * generation separate. This should never happen. */
7422 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7423 }
7424#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7425
7426 /*
7427 * Get various info structures
7428 */
7429 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7430 if( ciphersuite_info == NULL )
7431 {
7432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7433 ciphersuite ) );
7434 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7435 }
7436
Neil Armstrongab555e02022-04-04 11:07:59 +02007437 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007438#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007439 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007440#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007441 ciphersuite_info );
7442
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007443 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7444 transform->taglen =
7445 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7446
7447#if defined(MBEDTLS_USE_PSA_CRYPTO)
7448 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7449 transform->taglen,
7450 &alg,
7451 &key_type,
7452 &key_bits ) ) != PSA_SUCCESS )
7453 {
7454 ret = psa_ssl_status_to_mbedtls( status );
7455 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7456 goto end;
7457 }
7458#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007459 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7460 if( cipher_info == NULL )
7461 {
7462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7463 ciphersuite_info->cipher ) );
7464 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7465 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007466#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007467
Neil Armstronge4512952022-03-08 09:08:22 +01007468#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007469 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007470 if( mac_alg == 0 )
7471 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007472 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007473 (unsigned) ciphersuite_info->mac ) );
7474 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7475 }
7476#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007477 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7478 if( md_info == NULL )
7479 {
7480 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7481 (unsigned) ciphersuite_info->mac ) );
7482 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7483 }
Neil Armstronge4512952022-03-08 09:08:22 +01007484#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007485
7486#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7487 /* Copy own and peer's CID if the use of the CID
7488 * extension has been negotiated. */
7489 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7490 {
7491 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7492
7493 transform->in_cid_len = ssl->own_cid_len;
7494 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7495 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7496 transform->in_cid_len );
7497
7498 transform->out_cid_len = ssl->handshake->peer_cid_len;
7499 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7500 ssl->handshake->peer_cid_len );
7501 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7502 transform->out_cid_len );
7503 }
7504#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7505
7506 /*
7507 * Compute key block using the PRF
7508 */
7509 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7510 if( ret != 0 )
7511 {
7512 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7513 return( ret );
7514 }
7515
7516 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7517 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7518 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7519 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7520 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7521
7522 /*
7523 * Determine the appropriate key, IV and MAC length.
7524 */
7525
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007526#if defined(MBEDTLS_USE_PSA_CRYPTO)
7527 keylen = PSA_BITS_TO_BYTES(key_bits);
7528#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007529 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007530#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007531
7532#if defined(MBEDTLS_GCM_C) || \
7533 defined(MBEDTLS_CCM_C) || \
7534 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007535 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007536 {
7537 size_t explicit_ivlen;
7538
7539 transform->maclen = 0;
7540 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007541
7542 /* All modes haves 96-bit IVs, but the length of the static parts vary
7543 * with mode and version:
7544 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7545 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7546 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7547 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7548 * sequence number).
7549 */
7550 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007551#if defined(MBEDTLS_USE_PSA_CRYPTO)
7552 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7553#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007554 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007555#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007556 transform->fixed_ivlen = 12;
7557 else
7558 transform->fixed_ivlen = 4;
7559
7560 /* Minimum length of encrypted record */
7561 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7562 transform->minlen = explicit_ivlen + transform->taglen;
7563 }
7564 else
7565#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7566#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007567 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7568 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7569 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007570 {
Neil Armstronge4512952022-03-08 09:08:22 +01007571#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007572 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007573#else
7574 size_t block_size = cipher_info->block_size;
7575#endif /* MBEDTLS_USE_PSA_CRYPTO */
7576
7577#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007578 /* Get MAC length */
7579 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7580#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007581 /* Initialize HMAC contexts */
7582 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7583 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7584 {
7585 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7586 goto end;
7587 }
7588
7589 /* Get MAC length */
7590 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007591#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007592 transform->maclen = mac_key_len;
7593
7594 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007595#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007596 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007597#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007598 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007599#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007600
7601 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007602 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007603 transform->minlen = transform->maclen;
7604 else
7605 {
7606 /*
7607 * GenericBlockCipher:
7608 * 1. if EtM is in use: one block plus MAC
7609 * otherwise: * first multiple of blocklen greater than maclen
7610 * 2. IV
7611 */
7612#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007613 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007614 {
7615 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007616 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007617 }
7618 else
7619#endif
7620 {
7621 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007622 + block_size
7623 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007624 }
7625
Glenn Strauss07c64162022-03-14 12:34:51 -04007626 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007627 {
7628 transform->minlen += transform->ivlen;
7629 }
7630 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007631 {
7632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7633 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7634 goto end;
7635 }
7636 }
7637 }
7638 else
7639#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7640 {
7641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7642 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7643 }
7644
7645 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7646 (unsigned) keylen,
7647 (unsigned) transform->minlen,
7648 (unsigned) transform->ivlen,
7649 (unsigned) transform->maclen ) );
7650
7651 /*
7652 * Finally setup the cipher contexts, IVs and MAC secrets.
7653 */
7654#if defined(MBEDTLS_SSL_CLI_C)
7655 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7656 {
7657 key1 = keyblk + mac_key_len * 2;
7658 key2 = keyblk + mac_key_len * 2 + keylen;
7659
7660 mac_enc = keyblk;
7661 mac_dec = keyblk + mac_key_len;
7662
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007663 iv_copy_len = ( transform->fixed_ivlen ) ?
7664 transform->fixed_ivlen : transform->ivlen;
7665 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7666 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7667 iv_copy_len );
7668 }
7669 else
7670#endif /* MBEDTLS_SSL_CLI_C */
7671#if defined(MBEDTLS_SSL_SRV_C)
7672 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7673 {
7674 key1 = keyblk + mac_key_len * 2 + keylen;
7675 key2 = keyblk + mac_key_len * 2;
7676
7677 mac_enc = keyblk + mac_key_len;
7678 mac_dec = keyblk;
7679
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007680 iv_copy_len = ( transform->fixed_ivlen ) ?
7681 transform->fixed_ivlen : transform->ivlen;
7682 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7683 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7684 iv_copy_len );
7685 }
7686 else
7687#endif /* MBEDTLS_SSL_SRV_C */
7688 {
7689 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7690 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7691 goto end;
7692 }
7693
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007694 if( ssl != NULL && ssl->f_export_keys != NULL )
7695 {
7696 ssl->f_export_keys( ssl->p_export_keys,
7697 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7698 master, 48,
7699 randbytes + 32,
7700 randbytes,
7701 tls_prf_get_type( tls_prf ) );
7702 }
7703
7704#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007705 transform->psa_alg = alg;
7706
7707 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7708 {
7709 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7710 psa_set_key_algorithm( &attributes, alg );
7711 psa_set_key_type( &attributes, key_type );
7712
7713 if( ( status = psa_import_key( &attributes,
7714 key1,
7715 PSA_BITS_TO_BYTES( key_bits ),
7716 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7717 {
7718 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7719 ret = psa_ssl_status_to_mbedtls( status );
7720 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7721 goto end;
7722 }
7723
7724 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7725
7726 if( ( status = psa_import_key( &attributes,
7727 key2,
7728 PSA_BITS_TO_BYTES( key_bits ),
7729 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7730 {
7731 ret = psa_ssl_status_to_mbedtls( status );
7732 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7733 goto end;
7734 }
7735 }
7736#else
7737 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7738 cipher_info ) ) != 0 )
7739 {
7740 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7741 goto end;
7742 }
7743
7744 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7745 cipher_info ) ) != 0 )
7746 {
7747 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7748 goto end;
7749 }
7750
7751 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7752 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7753 MBEDTLS_ENCRYPT ) ) != 0 )
7754 {
7755 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7756 goto end;
7757 }
7758
7759 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7760 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7761 MBEDTLS_DECRYPT ) ) != 0 )
7762 {
7763 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7764 goto end;
7765 }
7766
7767#if defined(MBEDTLS_CIPHER_MODE_CBC)
7768 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7769 {
7770 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7771 MBEDTLS_PADDING_NONE ) ) != 0 )
7772 {
7773 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7774 goto end;
7775 }
7776
7777 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7778 MBEDTLS_PADDING_NONE ) ) != 0 )
7779 {
7780 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7781 goto end;
7782 }
7783 }
7784#endif /* MBEDTLS_CIPHER_MODE_CBC */
7785#endif /* MBEDTLS_USE_PSA_CRYPTO */
7786
Neil Armstrong29c0c042022-03-17 17:47:28 +01007787#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7788 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7789 For AEAD-based ciphersuites, there is nothing to do here. */
7790 if( mac_key_len != 0 )
7791 {
7792#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007793 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007794
7795 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007796 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007797 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7798
7799 if( ( status = psa_import_key( &attributes,
7800 mac_enc, mac_key_len,
7801 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7802 {
7803 ret = psa_ssl_status_to_mbedtls( status );
7804 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7805 goto end;
7806 }
7807
Ronald Cronfb39f152022-03-25 14:36:28 +01007808 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7809 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7810 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007811 /* mbedtls_ct_hmac() requires the key to be exportable */
7812 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7813 PSA_KEY_USAGE_VERIFY_HASH );
7814 else
7815 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7816
7817 if( ( status = psa_import_key( &attributes,
7818 mac_dec, mac_key_len,
7819 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7820 {
7821 ret = psa_ssl_status_to_mbedtls( status );
7822 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7823 goto end;
7824 }
7825#else
7826 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7827 if( ret != 0 )
7828 goto end;
7829 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7830 if( ret != 0 )
7831 goto end;
7832#endif /* MBEDTLS_USE_PSA_CRYPTO */
7833 }
7834#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7835
7836 ((void) mac_dec);
7837 ((void) mac_enc);
7838
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007839end:
7840 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7841 return( ret );
7842}
7843
Jerry Yuee40f9d2022-02-17 14:55:16 +08007844#if defined(MBEDTLS_USE_PSA_CRYPTO)
7845int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7846 unsigned char *hash, size_t *hashlen,
7847 unsigned char *data, size_t data_len,
7848 mbedtls_md_type_t md_alg )
7849{
7850 psa_status_t status;
7851 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007852 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007853
7854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7855
7856 if( ( status = psa_hash_setup( &hash_operation,
7857 hash_alg ) ) != PSA_SUCCESS )
7858 {
7859 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7860 goto exit;
7861 }
7862
7863 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7864 64 ) ) != PSA_SUCCESS )
7865 {
7866 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7867 goto exit;
7868 }
7869
7870 if( ( status = psa_hash_update( &hash_operation,
7871 data, data_len ) ) != PSA_SUCCESS )
7872 {
7873 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7874 goto exit;
7875 }
7876
7877 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7878 hashlen ) ) != PSA_SUCCESS )
7879 {
7880 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7881 goto exit;
7882 }
7883
7884exit:
7885 if( status != PSA_SUCCESS )
7886 {
7887 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7888 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7889 switch( status )
7890 {
7891 case PSA_ERROR_NOT_SUPPORTED:
7892 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7893 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7894 case PSA_ERROR_BUFFER_TOO_SMALL:
7895 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7896 case PSA_ERROR_INSUFFICIENT_MEMORY:
7897 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7898 default:
7899 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7900 }
7901 }
7902 return( 0 );
7903}
7904
7905#else
7906
7907int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7908 unsigned char *hash, size_t *hashlen,
7909 unsigned char *data, size_t data_len,
7910 mbedtls_md_type_t md_alg )
7911{
7912 int ret = 0;
7913 mbedtls_md_context_t ctx;
7914 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7915 *hashlen = mbedtls_md_get_size( md_info );
7916
7917 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7918
7919 mbedtls_md_init( &ctx );
7920
7921 /*
7922 * digitally-signed struct {
7923 * opaque client_random[32];
7924 * opaque server_random[32];
7925 * ServerDHParams params;
7926 * };
7927 */
7928 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7929 {
7930 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7931 goto exit;
7932 }
7933 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7934 {
7935 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7936 goto exit;
7937 }
7938 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7939 {
7940 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7941 goto exit;
7942 }
7943 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7944 {
7945 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7946 goto exit;
7947 }
7948 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7949 {
7950 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7951 goto exit;
7952 }
7953
7954exit:
7955 mbedtls_md_free( &ctx );
7956
7957 if( ret != 0 )
7958 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7959 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7960
7961 return( ret );
7962}
7963#endif /* MBEDTLS_USE_PSA_CRYPTO */
7964
Jerry Yud9d91da2022-02-17 14:57:06 +08007965#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7966
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007967/* Find the preferred hash for a given signature algorithm. */
7968unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7969 mbedtls_ssl_context *ssl,
7970 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007971{
Gabor Mezei078e8032022-04-27 21:17:56 +02007972 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007973 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007974
7975 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007976 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007977
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007978 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007979 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007980 unsigned int hash_alg_received =
7981 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7982 received_sig_algs[i] );
7983 unsigned int sig_alg_received =
7984 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7985 received_sig_algs[i] );
7986
7987 if( sig_alg == sig_alg_received )
7988 {
7989#if defined(MBEDTLS_USE_PSA_CRYPTO)
7990 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7991 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007992 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007993 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007994
Neil Armstrong96eceb82022-06-30 18:05:05 +02007995 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7996 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7997 PSA_ALG_ECDSA( psa_hash_alg ),
7998 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007999 continue;
8000
Neil Armstrong96eceb82022-06-30 18:05:05 +02008001 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008002 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8003 PSA_ALG_RSA_PKCS1V15_SIGN(
8004 psa_hash_alg ),
8005 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008006 continue;
8007 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008008#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008009
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008010 return( hash_alg_received );
8011 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008012 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008013
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008014 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008015}
8016
8017#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8018
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008019/* Serialization of TLS 1.2 sessions:
8020 *
8021 * struct {
8022 * uint64 start_time;
8023 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008024 * uint8 session_id_len; // at most 32
8025 * opaque session_id[32];
8026 * opaque master[48]; // fixed length in the standard
8027 * uint32 verify_result;
8028 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8029 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8030 * uint32 ticket_lifetime;
8031 * uint8 mfl_code; // up to 255 according to standard
8032 * uint8 encrypt_then_mac; // 0 or 1
8033 * } serialized_session_tls12;
8034 *
8035 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008036static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008037 unsigned char *buf,
8038 size_t buf_len )
8039{
8040 unsigned char *p = buf;
8041 size_t used = 0;
8042
8043#if defined(MBEDTLS_HAVE_TIME)
8044 uint64_t start;
8045#endif
8046#if defined(MBEDTLS_X509_CRT_PARSE_C)
8047#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8048 size_t cert_len;
8049#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8050#endif /* MBEDTLS_X509_CRT_PARSE_C */
8051
8052 /*
8053 * Time
8054 */
8055#if defined(MBEDTLS_HAVE_TIME)
8056 used += 8;
8057
8058 if( used <= buf_len )
8059 {
8060 start = (uint64_t) session->start;
8061
8062 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8063 p += 8;
8064 }
8065#endif /* MBEDTLS_HAVE_TIME */
8066
8067 /*
8068 * Basic mandatory fields
8069 */
8070 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008071 + 1 /* id_len */
8072 + sizeof( session->id )
8073 + sizeof( session->master )
8074 + 4; /* verify_result */
8075
8076 if( used <= buf_len )
8077 {
8078 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8079 p += 2;
8080
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008081 *p++ = MBEDTLS_BYTE_0( session->id_len );
8082 memcpy( p, session->id, 32 );
8083 p += 32;
8084
8085 memcpy( p, session->master, 48 );
8086 p += 48;
8087
8088 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8089 p += 4;
8090 }
8091
8092 /*
8093 * Peer's end-entity certificate
8094 */
8095#if defined(MBEDTLS_X509_CRT_PARSE_C)
8096#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8097 if( session->peer_cert == NULL )
8098 cert_len = 0;
8099 else
8100 cert_len = session->peer_cert->raw.len;
8101
8102 used += 3 + cert_len;
8103
8104 if( used <= buf_len )
8105 {
8106 *p++ = MBEDTLS_BYTE_2( cert_len );
8107 *p++ = MBEDTLS_BYTE_1( cert_len );
8108 *p++ = MBEDTLS_BYTE_0( cert_len );
8109
8110 if( session->peer_cert != NULL )
8111 {
8112 memcpy( p, session->peer_cert->raw.p, cert_len );
8113 p += cert_len;
8114 }
8115 }
8116#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8117 if( session->peer_cert_digest != NULL )
8118 {
8119 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8120 if( used <= buf_len )
8121 {
8122 *p++ = (unsigned char) session->peer_cert_digest_type;
8123 *p++ = (unsigned char) session->peer_cert_digest_len;
8124 memcpy( p, session->peer_cert_digest,
8125 session->peer_cert_digest_len );
8126 p += session->peer_cert_digest_len;
8127 }
8128 }
8129 else
8130 {
8131 used += 2;
8132 if( used <= buf_len )
8133 {
8134 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8135 *p++ = 0;
8136 }
8137 }
8138#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8139#endif /* MBEDTLS_X509_CRT_PARSE_C */
8140
8141 /*
8142 * Session ticket if any, plus associated data
8143 */
8144#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8145 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8146
8147 if( used <= buf_len )
8148 {
8149 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8150 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8151 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8152
8153 if( session->ticket != NULL )
8154 {
8155 memcpy( p, session->ticket, session->ticket_len );
8156 p += session->ticket_len;
8157 }
8158
8159 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8160 p += 4;
8161 }
8162#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8163
8164 /*
8165 * Misc extension-related info
8166 */
8167#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8168 used += 1;
8169
8170 if( used <= buf_len )
8171 *p++ = session->mfl_code;
8172#endif
8173
8174#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8175 used += 1;
8176
8177 if( used <= buf_len )
8178 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8179#endif
8180
8181 return( used );
8182}
8183
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008184MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008185static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008186 const unsigned char *buf,
8187 size_t len )
8188{
8189#if defined(MBEDTLS_HAVE_TIME)
8190 uint64_t start;
8191#endif
8192#if defined(MBEDTLS_X509_CRT_PARSE_C)
8193#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8194 size_t cert_len;
8195#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8196#endif /* MBEDTLS_X509_CRT_PARSE_C */
8197
8198 const unsigned char *p = buf;
8199 const unsigned char * const end = buf + len;
8200
8201 /*
8202 * Time
8203 */
8204#if defined(MBEDTLS_HAVE_TIME)
8205 if( 8 > (size_t)( end - p ) )
8206 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8207
8208 start = ( (uint64_t) p[0] << 56 ) |
8209 ( (uint64_t) p[1] << 48 ) |
8210 ( (uint64_t) p[2] << 40 ) |
8211 ( (uint64_t) p[3] << 32 ) |
8212 ( (uint64_t) p[4] << 24 ) |
8213 ( (uint64_t) p[5] << 16 ) |
8214 ( (uint64_t) p[6] << 8 ) |
8215 ( (uint64_t) p[7] );
8216 p += 8;
8217
8218 session->start = (time_t) start;
8219#endif /* MBEDTLS_HAVE_TIME */
8220
8221 /*
8222 * Basic mandatory fields
8223 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008224 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008225 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8226
8227 session->ciphersuite = ( p[0] << 8 ) | p[1];
8228 p += 2;
8229
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008230 session->id_len = *p++;
8231 memcpy( session->id, p, 32 );
8232 p += 32;
8233
8234 memcpy( session->master, p, 48 );
8235 p += 48;
8236
8237 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8238 ( (uint32_t) p[1] << 16 ) |
8239 ( (uint32_t) p[2] << 8 ) |
8240 ( (uint32_t) p[3] );
8241 p += 4;
8242
8243 /* Immediately clear invalid pointer values that have been read, in case
8244 * we exit early before we replaced them with valid ones. */
8245#if defined(MBEDTLS_X509_CRT_PARSE_C)
8246#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8247 session->peer_cert = NULL;
8248#else
8249 session->peer_cert_digest = NULL;
8250#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8251#endif /* MBEDTLS_X509_CRT_PARSE_C */
8252#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8253 session->ticket = NULL;
8254#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8255
8256 /*
8257 * Peer certificate
8258 */
8259#if defined(MBEDTLS_X509_CRT_PARSE_C)
8260#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8261 /* Deserialize CRT from the end of the ticket. */
8262 if( 3 > (size_t)( end - p ) )
8263 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8264
8265 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8266 p += 3;
8267
8268 if( cert_len != 0 )
8269 {
8270 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8271
8272 if( cert_len > (size_t)( end - p ) )
8273 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8274
8275 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8276
8277 if( session->peer_cert == NULL )
8278 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8279
8280 mbedtls_x509_crt_init( session->peer_cert );
8281
8282 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8283 p, cert_len ) ) != 0 )
8284 {
8285 mbedtls_x509_crt_free( session->peer_cert );
8286 mbedtls_free( session->peer_cert );
8287 session->peer_cert = NULL;
8288 return( ret );
8289 }
8290
8291 p += cert_len;
8292 }
8293#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8294 /* Deserialize CRT digest from the end of the ticket. */
8295 if( 2 > (size_t)( end - p ) )
8296 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8297
8298 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8299 session->peer_cert_digest_len = (size_t) *p++;
8300
8301 if( session->peer_cert_digest_len != 0 )
8302 {
8303 const mbedtls_md_info_t *md_info =
8304 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8305 if( md_info == NULL )
8306 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8307 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8308 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8309
8310 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8311 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8312
8313 session->peer_cert_digest =
8314 mbedtls_calloc( 1, session->peer_cert_digest_len );
8315 if( session->peer_cert_digest == NULL )
8316 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8317
8318 memcpy( session->peer_cert_digest, p,
8319 session->peer_cert_digest_len );
8320 p += session->peer_cert_digest_len;
8321 }
8322#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8323#endif /* MBEDTLS_X509_CRT_PARSE_C */
8324
8325 /*
8326 * Session ticket and associated data
8327 */
8328#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8329 if( 3 > (size_t)( end - p ) )
8330 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8331
8332 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8333 p += 3;
8334
8335 if( session->ticket_len != 0 )
8336 {
8337 if( session->ticket_len > (size_t)( end - p ) )
8338 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8339
8340 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8341 if( session->ticket == NULL )
8342 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8343
8344 memcpy( session->ticket, p, session->ticket_len );
8345 p += session->ticket_len;
8346 }
8347
8348 if( 4 > (size_t)( end - p ) )
8349 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8350
8351 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8352 ( (uint32_t) p[1] << 16 ) |
8353 ( (uint32_t) p[2] << 8 ) |
8354 ( (uint32_t) p[3] );
8355 p += 4;
8356#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8357
8358 /*
8359 * Misc extension-related info
8360 */
8361#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8362 if( 1 > (size_t)( end - p ) )
8363 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8364
8365 session->mfl_code = *p++;
8366#endif
8367
8368#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8369 if( 1 > (size_t)( end - p ) )
8370 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8371
8372 session->encrypt_then_mac = *p++;
8373#endif
8374
8375 /* Done, should have consumed entire buffer */
8376 if( p != end )
8377 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8378
8379 return( 0 );
8380}
Jerry Yudc7bd172022-02-17 13:44:15 +08008381#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8382
XiaokangQian75d40ef2022-04-20 11:05:24 +00008383int mbedtls_ssl_validate_ciphersuite(
8384 const mbedtls_ssl_context *ssl,
8385 const mbedtls_ssl_ciphersuite_t *suite_info,
8386 mbedtls_ssl_protocol_version min_tls_version,
8387 mbedtls_ssl_protocol_version max_tls_version )
8388{
8389 (void) ssl;
8390
8391 if( suite_info == NULL )
8392 return( -1 );
8393
8394 if( ( suite_info->min_tls_version > max_tls_version ) ||
8395 ( suite_info->max_tls_version < min_tls_version ) )
8396 {
8397 return( -1 );
8398 }
8399
XiaokangQian060d8672022-04-21 09:24:56 +00008400#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008401#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8402 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8403 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8404 {
8405 return( -1 );
8406 }
8407#endif
8408
8409 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8410#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8411 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8412 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8413 {
8414 return( -1 );
8415 }
8416#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8417#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8418
8419 return( 0 );
8420}
8421
XiaokangQianeaf36512022-04-24 09:07:44 +00008422#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8423/*
8424 * Function for writing a signature algorithm extension.
8425 *
8426 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8427 * value (TLS 1.3 RFC8446):
8428 * enum {
8429 * ....
8430 * ecdsa_secp256r1_sha256( 0x0403 ),
8431 * ecdsa_secp384r1_sha384( 0x0503 ),
8432 * ecdsa_secp521r1_sha512( 0x0603 ),
8433 * ....
8434 * } SignatureScheme;
8435 *
8436 * struct {
8437 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8438 * } SignatureSchemeList;
8439 *
8440 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8441 * value (TLS 1.2 RFC5246):
8442 * enum {
8443 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8444 * sha512(6), (255)
8445 * } HashAlgorithm;
8446 *
8447 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8448 * SignatureAlgorithm;
8449 *
8450 * struct {
8451 * HashAlgorithm hash;
8452 * SignatureAlgorithm signature;
8453 * } SignatureAndHashAlgorithm;
8454 *
8455 * SignatureAndHashAlgorithm
8456 * supported_signature_algorithms<2..2^16-2>;
8457 *
8458 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8459 * generalization of the TLS 1.2 signature algorithm extension.
8460 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8461 * `SignatureScheme` field of TLS 1.3
8462 *
8463 */
8464int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8465 const unsigned char *end, size_t *out_len )
8466{
8467 unsigned char *p = buf;
8468 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8469 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8470
8471 *out_len = 0;
8472
8473 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8474
8475 /* Check if we have space for header and length field:
8476 * - extension_type (2 bytes)
8477 * - extension_data_length (2 bytes)
8478 * - supported_signature_algorithms_length (2 bytes)
8479 */
8480 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8481 p += 6;
8482
8483 /*
8484 * Write supported_signature_algorithms
8485 */
8486 supported_sig_alg = p;
8487 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8488 if( sig_alg == NULL )
8489 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8490
8491 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8492 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008493 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8494 *sig_alg,
8495 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008496 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8497 continue;
8498 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8499 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8500 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008501 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008502 *sig_alg,
8503 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008504 }
8505
8506 /* Length of supported_signature_algorithms */
8507 supported_sig_alg_len = p - supported_sig_alg;
8508 if( supported_sig_alg_len == 0 )
8509 {
8510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8511 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8512 }
8513
XiaokangQianeaf36512022-04-24 09:07:44 +00008514 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008515 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008516 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8517
XiaokangQianeaf36512022-04-24 09:07:44 +00008518 *out_len = p - buf;
8519
8520#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8521 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8522#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8523 return( 0 );
8524}
8525#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8526
XiaokangQian40a35232022-05-07 09:02:40 +00008527#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008528/*
8529 * mbedtls_ssl_parse_server_name_ext
8530 *
8531 * Structure of server_name extension:
8532 *
8533 * enum {
8534 * host_name(0), (255)
8535 * } NameType;
8536 * opaque HostName<1..2^16-1>;
8537 *
8538 * struct {
8539 * NameType name_type;
8540 * select (name_type) {
8541 * case host_name: HostName;
8542 * } name;
8543 * } ServerName;
8544 * struct {
8545 * ServerName server_name_list<1..2^16-1>
8546 * } ServerNameList;
8547 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008548MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008549int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8550 const unsigned char *buf,
8551 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008552{
8553 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8554 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008555 size_t server_name_list_len, hostname_len;
8556 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008557
XiaokangQianf2a94202022-05-20 06:44:24 +00008558 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008559
8560 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008561 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008562 p += 2;
8563
XiaokangQian9b2b7712022-05-17 02:57:00 +00008564 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8565 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008566 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008567 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008568 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008569 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008570 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8571 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008572
8573 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8574 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008575 /* sni_name is intended to be used only during the parsing of the
8576 * ClientHello message (it is reset to NULL before the end of
8577 * the message parsing). Thus it is ok to just point to the
8578 * reception buffer and not make a copy of it.
8579 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008580 ssl->handshake->sni_name = p + 3;
8581 ssl->handshake->sni_name_len = hostname_len;
8582 if( ssl->conf->f_sni == NULL )
8583 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008584 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008585 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008586 if( ret != 0 )
8587 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008588 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008589 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8590 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008591 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8592 }
8593 return( 0 );
8594 }
8595
8596 p += hostname_len + 3;
8597 }
8598
8599 return( 0 );
8600}
8601#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8602
XiaokangQianacb39922022-06-17 10:18:48 +00008603#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008604MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008605int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8606 const unsigned char *buf,
8607 const unsigned char *end )
8608{
8609 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008610 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008611 const unsigned char *protocol_name_list;
8612 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008613 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008614
8615 /* If ALPN not configured, just ignore the extension */
8616 if( ssl->conf->alpn_list == NULL )
8617 return( 0 );
8618
8619 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008620 * RFC7301, section 3.1
8621 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008622 *
XiaokangQianc7403452022-06-23 03:24:12 +00008623 * struct {
8624 * ProtocolName protocol_name_list<2..2^16-1>
8625 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008626 */
8627
XiaokangQianc7403452022-06-23 03:24:12 +00008628 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008629 * protocol_name_list_len 2 bytes
8630 * protocol_name_len 1 bytes
8631 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008632 */
XiaokangQianacb39922022-06-17 10:18:48 +00008633 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8634
XiaokangQianc7403452022-06-23 03:24:12 +00008635 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008636 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008637 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008638 protocol_name_list = p;
8639 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008640
8641 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008642 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008643 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008644 protocol_name_len = *p++;
8645 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8646 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008647 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008648 {
8649 MBEDTLS_SSL_PEND_FATAL_ALERT(
8650 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8651 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008652 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008653 }
8654
8655 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008656 }
8657
8658 /* Use our order of preference */
8659 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8660 {
8661 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008662 p = protocol_name_list;
8663 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008664 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008665 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008666 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008667 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008668 {
8669 ssl->alpn_chosen = *alpn;
8670 return( 0 );
8671 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008672
8673 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008674 }
8675 }
8676
XiaokangQian95d5f542022-06-24 02:29:26 +00008677 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008678 MBEDTLS_SSL_PEND_FATAL_ALERT(
8679 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8680 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8681 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8682}
8683
8684int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8685 unsigned char *buf,
8686 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008687 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008688{
8689 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008690 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008691 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008692
8693 if( ssl->alpn_chosen == NULL )
8694 {
8695 return( 0 );
8696 }
8697
XiaokangQian95d5f542022-06-24 02:29:26 +00008698 protocol_name_len = strlen( ssl->alpn_chosen );
8699 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008700
8701 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8702 /*
8703 * 0 . 1 ext identifier
8704 * 2 . 3 ext length
8705 * 4 . 5 protocol list length
8706 * 6 . 6 protocol name length
8707 * 7 . 7+n protocol name
8708 */
8709 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8710
XiaokangQian95d5f542022-06-24 02:29:26 +00008711 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008712
XiaokangQian95d5f542022-06-24 02:29:26 +00008713 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8714 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008715 /* Note: the length of the chosen protocol has been checked to be less
8716 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8717 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008718 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008719
XiaokangQian95d5f542022-06-24 02:29:26 +00008720 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008721 return ( 0 );
8722}
8723#endif /* MBEDTLS_SSL_ALPN */
8724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008725#endif /* MBEDTLS_SSL_TLS_C */