blob: 1cda3a7444ab75217e0315a68b186df6ac120058 [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
Jerry Yu5c28e7a2022-07-30 23:22:08 +08001665void mbedtls_ssl_remove_psk( mbedtls_ssl_context *ssl )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001666{
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 );
Jerry Yu5c28e7a2022-07-30 23:22:08 +08001685 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001686 ssl->handshake->psk_len = 0;
1687 }
Neil Armstronge952a302022-05-03 10:22:14 +02001688#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001689}
1690
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001691int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1692 const unsigned char *psk, size_t psk_len )
1693{
Neil Armstrong501c9322022-05-03 09:35:09 +02001694#if defined(MBEDTLS_USE_PSA_CRYPTO)
1695 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1696 psa_status_t status;
Jerry Yuccc68a42022-07-26 16:39:20 +08001697 psa_algorithm_t alg = PSA_ALG_ANY_HASH;
Neil Armstrong501c9322022-05-03 09:35:09 +02001698 mbedtls_svc_key_id_t key;
1699#endif /* MBEDTLS_USE_PSA_CRYPTO */
1700
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001701 if( psk == NULL || ssl->handshake == NULL )
1702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1703
1704 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1706
Jerry Yu5c28e7a2022-07-30 23:22:08 +08001707 mbedtls_ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001708
Neil Armstrong501c9322022-05-03 09:35:09 +02001709#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08001710#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1711 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
1712 {
1713 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1714 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_384 );
1715 else
1716 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_256 );
1717 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1718 }
1719#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02001720
Jerry Yu568ec252022-07-22 21:27:34 +08001721#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yuccc68a42022-07-26 16:39:20 +08001722 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
1723 {
1724 alg = PSA_ALG_HKDF_EXTRACT( PSA_ALG_ANY_HASH );
1725 psa_set_key_usage_flags( &key_attributes,
1726 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
1727 }
1728#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1729
Neil Armstrong501c9322022-05-03 09:35:09 +02001730 psa_set_key_algorithm( &key_attributes, alg );
1731 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1732
1733 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1734 if( status != PSA_SUCCESS )
1735 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1736
1737 /* Allow calling psa_destroy_key() on psk remove */
1738 ssl->handshake->psk_opaque_is_internal = 1;
1739 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1740#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001741 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001742 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001743
1744 ssl->handshake->psk_len = psk_len;
1745 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1746
1747 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001748#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001749}
1750
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001751#if defined(MBEDTLS_USE_PSA_CRYPTO)
1752int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001753 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001754 const unsigned char *psk_identity,
1755 size_t psk_identity_len )
1756{
Janos Follath865b3eb2019-12-16 11:46:15 +00001757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001758
1759 /* We currently only support one PSK, raw or opaque. */
1760 if( ssl_conf_psk_is_configured( conf ) )
1761 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001762
Hanno Becker7390c712018-11-15 13:33:04 +00001763 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001764 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001765 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001766 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001767
1768 /* Check and set PSK Identity */
1769 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1770 psk_identity_len );
1771 if( ret != 0 )
1772 ssl_conf_remove_psk( conf );
1773
1774 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001775}
1776
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001777int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1778 mbedtls_svc_key_id_t psk )
1779{
1780 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1781 ( ssl->handshake == NULL ) )
1782 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1783
Jerry Yu5c28e7a2022-07-30 23:22:08 +08001784 mbedtls_ssl_remove_psk( ssl );
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001785 ssl->handshake->psk_opaque = psk;
1786 return( 0 );
1787}
1788#endif /* MBEDTLS_USE_PSA_CRYPTO */
1789
1790void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1791 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1792 size_t),
1793 void *p_psk )
1794{
1795 conf->f_psk = f_psk;
1796 conf->p_psk = p_psk;
1797}
1798#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1799
1800#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001801static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1802 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001803{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001804#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001805 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001806 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001807#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001808 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001809 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001810 return( MBEDTLS_SSL_MODE_STREAM );
1811}
1812
1813#else /* MBEDTLS_USE_PSA_CRYPTO */
1814
1815static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1816 mbedtls_cipher_mode_t mode )
1817{
1818#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1819 if( mode == MBEDTLS_MODE_CBC )
1820 return( MBEDTLS_SSL_MODE_CBC );
1821#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1822
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001823#if defined(MBEDTLS_GCM_C) || \
1824 defined(MBEDTLS_CCM_C) || \
1825 defined(MBEDTLS_CHACHAPOLY_C)
1826 if( mode == MBEDTLS_MODE_GCM ||
1827 mode == MBEDTLS_MODE_CCM ||
1828 mode == MBEDTLS_MODE_CHACHAPOLY )
1829 return( MBEDTLS_SSL_MODE_AEAD );
1830#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001831
1832 return( MBEDTLS_SSL_MODE_STREAM );
1833}
Gilles Peskine301711e2022-04-26 16:57:05 +02001834#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001835
Gilles Peskinee108d982022-04-26 16:50:40 +02001836static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1837 mbedtls_ssl_mode_t base_mode,
1838 int encrypt_then_mac )
1839{
1840#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1841 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1842 base_mode == MBEDTLS_SSL_MODE_CBC )
1843 {
1844 return( MBEDTLS_SSL_MODE_CBC_ETM );
1845 }
1846#else
1847 (void) encrypt_then_mac;
1848#endif
1849 return( base_mode );
1850}
1851
Neil Armstrongab555e02022-04-04 11:07:59 +02001852mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001853 const mbedtls_ssl_transform *transform )
1854{
Gilles Peskinee108d982022-04-26 16:50:40 +02001855 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001856#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001857 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001858#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001859 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1860#endif
1861 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001862
Gilles Peskinee108d982022-04-26 16:50:40 +02001863 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001864#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001865 encrypt_then_mac = transform->encrypt_then_mac;
1866#endif
1867 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001868}
1869
Neil Armstrongab555e02022-04-04 11:07:59 +02001870mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001871#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001872 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001873#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001874 const mbedtls_ssl_ciphersuite_t *suite )
1875{
Gilles Peskinee108d982022-04-26 16:50:40 +02001876 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1877
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001878#if defined(MBEDTLS_USE_PSA_CRYPTO)
1879 psa_status_t status;
1880 psa_algorithm_t alg;
1881 psa_key_type_t type;
1882 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001883 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1884 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001885 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001886#else
1887 const mbedtls_cipher_info_t *cipher =
1888 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001889 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001890 {
1891 base_mode =
1892 mbedtls_ssl_get_base_mode(
1893 mbedtls_cipher_info_get_mode( cipher ) );
1894 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001895#endif /* MBEDTLS_USE_PSA_CRYPTO */
1896
Gilles Peskinee108d982022-04-26 16:50:40 +02001897#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1898 int encrypt_then_mac = 0;
1899#endif
1900 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001901}
1902
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001903#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001904
1905#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00001906/* Serialization of TLS 1.3 sessions:
1907 *
1908 * struct {
1909 * uint64 ticket_received;
1910 * uint32 ticket_lifetime;
1911 * opaque ticket<0..2^16>;
1912 * } ClientOnlyData;
1913 *
1914 * struct {
1915 * uint8 endpoint;
1916 * uint8 ciphersuite[2];
1917 * uint32 ticket_age_add;
1918 * uint8 ticket_flags;
1919 * opaque resumption_key<0..255>;
1920 * select ( endpoint ) {
1921 * case client: ClientOnlyData;
1922 * case server: uint64 start_time;
1923 * };
1924 * } serialized_session_tls13;
1925 *
1926 */
1927#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1928static size_t ssl_tls13_session_save( const mbedtls_ssl_session *session,
1929 unsigned char *buf,
1930 size_t buf_len )
1931{
1932 unsigned char *p = buf;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001933 size_t needed = 1 /* endpoint */
1934 + 2 /* ciphersuite */
1935 + 4 /* ticket_age_add */
1936 + 2 /* resumption_key length */
1937 + session->resumption_key_len; /* resumption_key */
Jerry Yu438ddd82022-07-07 06:55:50 +00001938
1939#if defined(MBEDTLS_HAVE_TIME)
1940 needed += 8; /* start_time or ticket_received */
1941#endif
1942
1943#if defined(MBEDTLS_SSL_CLI_C)
1944 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1945 {
1946 needed += 4 /* ticket_lifetime */
1947 + 2 /* ticket_len */
1948 + session->ticket_len; /* ticket */
1949 }
1950#endif /* MBEDTLS_SSL_CLI_C */
1951
1952 if( needed > buf_len )
1953 return( needed );
1954
1955 p[0] = session->endpoint;
1956 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
1957 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
1958 p[7] = session->ticket_flags;
1959
1960 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08001961 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001962 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001963 memcpy( p, session->resumption_key, session->resumption_key_len );
1964 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001965
1966#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
1967 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
1968 {
1969 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
1970 p += 8;
1971 }
1972#endif /* MBEDTLS_HAVE_TIME */
1973
1974#if defined(MBEDTLS_SSL_CLI_C)
1975 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1976 {
1977#if defined(MBEDTLS_HAVE_TIME)
1978 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
1979 p += 8;
1980#endif
1981 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
1982 p += 4;
1983
1984 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
1985 p += 2;
1986 if( session->ticket_len > 0 )
1987 {
1988 memcpy( p, session->ticket, session->ticket_len );
1989 p += session->ticket_len;
1990 }
1991 }
1992#endif /* MBEDTLS_SSL_CLI_C */
1993 return( needed );
1994}
1995
1996MBEDTLS_CHECK_RETURN_CRITICAL
1997static int ssl_tls13_session_load( mbedtls_ssl_session *session,
1998 const unsigned char *buf,
1999 size_t len )
2000{
2001 const unsigned char *p = buf;
2002 const unsigned char *end = buf + len;
2003
2004 if( end - p < 9 )
2005 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2006 session->endpoint = p[0];
2007 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2008 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2009 session->ticket_flags = p[7];
2010
2011 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002012 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002013 p += 9;
2014
Jerry Yubc7c1a42022-07-21 22:57:37 +08002015 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002016 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2017
Jerry Yubc7c1a42022-07-21 22:57:37 +08002018 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002019 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002020 memcpy( session->resumption_key, p, session->resumption_key_len );
2021 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002022
2023#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2024 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2025 {
2026 if( end - p < 8 )
2027 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2028 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2029 p += 8;
2030 }
2031#endif /* MBEDTLS_HAVE_TIME */
2032
2033#if defined(MBEDTLS_SSL_CLI_C)
2034 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2035 {
2036#if defined(MBEDTLS_HAVE_TIME)
2037 if( end - p < 8 )
2038 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2039 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2040 p += 8;
2041#endif
2042 if( end - p < 4 )
2043 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2044 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2045 p += 4;
2046
2047 if( end - p < 2 )
2048 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2049 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2050 p += 2;
2051
2052 if( end - p < ( long int )session->ticket_len )
2053 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2054 if( session->ticket_len > 0 )
2055 {
2056 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2057 if( session->ticket == NULL )
2058 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2059 memcpy( session->ticket, p, session->ticket_len );
2060 p += session->ticket_len;
2061 }
2062 }
2063#endif /* MBEDTLS_SSL_CLI_C */
2064
2065 return( 0 );
2066
2067}
2068#else /* MBEDTLS_SSL_SESSION_TICKETS */
2069static size_t ssl_tls13_session_save( const mbedtls_ssl_session *session,
Jerry Yu251a12e2022-07-13 15:15:48 +08002070 unsigned char *buf,
2071 size_t buf_len )
2072{
2073 ((void) session);
2074 ((void) buf);
2075 ((void) buf_len);
2076 return( 0 );
2077}
Jerry Yu438ddd82022-07-07 06:55:50 +00002078
2079static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2080 unsigned char *buf,
2081 size_t buf_len )
2082{
2083 ((void) session);
2084 ((void) buf);
2085 ((void) buf_len);
2086 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2087}
2088#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002089#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2090
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002091psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002092 size_t taglen,
2093 psa_algorithm_t *alg,
2094 psa_key_type_t *key_type,
2095 size_t *key_size )
2096{
2097 switch ( mbedtls_cipher_type )
2098 {
2099 case MBEDTLS_CIPHER_AES_128_CBC:
2100 *alg = PSA_ALG_CBC_NO_PADDING;
2101 *key_type = PSA_KEY_TYPE_AES;
2102 *key_size = 128;
2103 break;
2104 case MBEDTLS_CIPHER_AES_128_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 = 128;
2108 break;
2109 case MBEDTLS_CIPHER_AES_128_GCM:
2110 *alg = PSA_ALG_GCM;
2111 *key_type = PSA_KEY_TYPE_AES;
2112 *key_size = 128;
2113 break;
2114 case MBEDTLS_CIPHER_AES_192_CCM:
2115 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2116 *key_type = PSA_KEY_TYPE_AES;
2117 *key_size = 192;
2118 break;
2119 case MBEDTLS_CIPHER_AES_192_GCM:
2120 *alg = PSA_ALG_GCM;
2121 *key_type = PSA_KEY_TYPE_AES;
2122 *key_size = 192;
2123 break;
2124 case MBEDTLS_CIPHER_AES_256_CBC:
2125 *alg = PSA_ALG_CBC_NO_PADDING;
2126 *key_type = PSA_KEY_TYPE_AES;
2127 *key_size = 256;
2128 break;
2129 case MBEDTLS_CIPHER_AES_256_CCM:
2130 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2131 *key_type = PSA_KEY_TYPE_AES;
2132 *key_size = 256;
2133 break;
2134 case MBEDTLS_CIPHER_AES_256_GCM:
2135 *alg = PSA_ALG_GCM;
2136 *key_type = PSA_KEY_TYPE_AES;
2137 *key_size = 256;
2138 break;
2139 case MBEDTLS_CIPHER_ARIA_128_CBC:
2140 *alg = PSA_ALG_CBC_NO_PADDING;
2141 *key_type = PSA_KEY_TYPE_ARIA;
2142 *key_size = 128;
2143 break;
2144 case MBEDTLS_CIPHER_ARIA_128_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 = 128;
2148 break;
2149 case MBEDTLS_CIPHER_ARIA_128_GCM:
2150 *alg = PSA_ALG_GCM;
2151 *key_type = PSA_KEY_TYPE_ARIA;
2152 *key_size = 128;
2153 break;
2154 case MBEDTLS_CIPHER_ARIA_192_CCM:
2155 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2156 *key_type = PSA_KEY_TYPE_ARIA;
2157 *key_size = 192;
2158 break;
2159 case MBEDTLS_CIPHER_ARIA_192_GCM:
2160 *alg = PSA_ALG_GCM;
2161 *key_type = PSA_KEY_TYPE_ARIA;
2162 *key_size = 192;
2163 break;
2164 case MBEDTLS_CIPHER_ARIA_256_CBC:
2165 *alg = PSA_ALG_CBC_NO_PADDING;
2166 *key_type = PSA_KEY_TYPE_ARIA;
2167 *key_size = 256;
2168 break;
2169 case MBEDTLS_CIPHER_ARIA_256_CCM:
2170 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2171 *key_type = PSA_KEY_TYPE_ARIA;
2172 *key_size = 256;
2173 break;
2174 case MBEDTLS_CIPHER_ARIA_256_GCM:
2175 *alg = PSA_ALG_GCM;
2176 *key_type = PSA_KEY_TYPE_ARIA;
2177 *key_size = 256;
2178 break;
2179 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2180 *alg = PSA_ALG_CBC_NO_PADDING;
2181 *key_type = PSA_KEY_TYPE_CAMELLIA;
2182 *key_size = 128;
2183 break;
2184 case MBEDTLS_CIPHER_CAMELLIA_128_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 = 128;
2188 break;
2189 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2190 *alg = PSA_ALG_GCM;
2191 *key_type = PSA_KEY_TYPE_CAMELLIA;
2192 *key_size = 128;
2193 break;
2194 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2195 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2196 *key_type = PSA_KEY_TYPE_CAMELLIA;
2197 *key_size = 192;
2198 break;
2199 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2200 *alg = PSA_ALG_GCM;
2201 *key_type = PSA_KEY_TYPE_CAMELLIA;
2202 *key_size = 192;
2203 break;
2204 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2205 *alg = PSA_ALG_CBC_NO_PADDING;
2206 *key_type = PSA_KEY_TYPE_CAMELLIA;
2207 *key_size = 256;
2208 break;
2209 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2210 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2211 *key_type = PSA_KEY_TYPE_CAMELLIA;
2212 *key_size = 256;
2213 break;
2214 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2215 *alg = PSA_ALG_GCM;
2216 *key_type = PSA_KEY_TYPE_CAMELLIA;
2217 *key_size = 256;
2218 break;
2219 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2220 *alg = PSA_ALG_CHACHA20_POLY1305;
2221 *key_type = PSA_KEY_TYPE_CHACHA20;
2222 *key_size = 256;
2223 break;
2224 case MBEDTLS_CIPHER_NULL:
2225 *alg = MBEDTLS_SSL_NULL_CIPHER;
2226 *key_type = 0;
2227 *key_size = 0;
2228 break;
2229 default:
2230 return PSA_ERROR_NOT_SUPPORTED;
2231 }
2232
2233 return PSA_SUCCESS;
2234}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002235#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002236
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002237#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002238int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2239 const unsigned char *dhm_P, size_t P_len,
2240 const unsigned char *dhm_G, size_t G_len )
2241{
Janos Follath865b3eb2019-12-16 11:46:15 +00002242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002243
Glenn Strausscee11292021-12-20 01:43:17 -05002244 mbedtls_mpi_free( &conf->dhm_P );
2245 mbedtls_mpi_free( &conf->dhm_G );
2246
Hanno Beckera90658f2017-10-04 15:29:08 +01002247 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2248 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2249 {
2250 mbedtls_mpi_free( &conf->dhm_P );
2251 mbedtls_mpi_free( &conf->dhm_G );
2252 return( ret );
2253 }
2254
2255 return( 0 );
2256}
Paul Bakker5121ce52009-01-03 21:22:43 +00002257
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002258int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002259{
Janos Follath865b3eb2019-12-16 11:46:15 +00002260 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002261
Glenn Strausscee11292021-12-20 01:43:17 -05002262 mbedtls_mpi_free( &conf->dhm_P );
2263 mbedtls_mpi_free( &conf->dhm_G );
2264
Gilles Peskinee5702482021-06-11 21:59:08 +02002265 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2266 &conf->dhm_P ) ) != 0 ||
2267 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2268 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002269 {
2270 mbedtls_mpi_free( &conf->dhm_P );
2271 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002272 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002273 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002274
2275 return( 0 );
2276}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002277#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002278
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002279#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2280/*
2281 * Set the minimum length for Diffie-Hellman parameters
2282 */
2283void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2284 unsigned int bitlen )
2285{
2286 conf->dhm_min_bitlen = bitlen;
2287}
2288#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2289
Gilles Peskineeccd8882020-03-10 12:19:08 +01002290#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002291#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002292/*
2293 * Set allowed/preferred hashes for handshake signatures
2294 */
2295void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2296 const int *hashes )
2297{
2298 conf->sig_hashes = hashes;
2299}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002300#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002301
Jerry Yuf017ee42022-01-12 15:49:48 +08002302/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002303void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2304 const uint16_t* sig_algs )
2305{
Jerry Yuf017ee42022-01-12 15:49:48 +08002306#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2307 conf->sig_hashes = NULL;
2308#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2309 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002310}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002311#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002312
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002313#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002314#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002315/*
2316 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002317 *
2318 * mbedtls_ssl_setup() takes the provided list
2319 * and translates it to a list of IANA TLS group identifiers,
2320 * stored in ssl->handshake->group_list.
2321 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002322 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002323void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002324 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002325{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002326 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002327 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002328}
Brett Warrene0edc842021-08-17 09:53:13 +01002329#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002330#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002331
Brett Warrene0edc842021-08-17 09:53:13 +01002332/*
2333 * Set the allowed groups
2334 */
2335void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2336 const uint16_t *group_list )
2337{
2338#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2339 conf->curve_list = NULL;
2340#endif
2341 conf->group_list = group_list;
2342}
2343
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002344#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002346{
Hanno Becker947194e2017-04-07 13:25:49 +01002347 /* Initialize to suppress unnecessary compiler warning */
2348 size_t hostname_len = 0;
2349
2350 /* Check if new hostname is valid before
2351 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002352 if( hostname != NULL )
2353 {
2354 hostname_len = strlen( hostname );
2355
2356 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2357 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2358 }
2359
2360 /* Now it's clear that we will overwrite the old hostname,
2361 * so we can free it safely */
2362
2363 if( ssl->hostname != NULL )
2364 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002365 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002366 mbedtls_free( ssl->hostname );
2367 }
2368
2369 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002370
Paul Bakker5121ce52009-01-03 21:22:43 +00002371 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002372 {
2373 ssl->hostname = NULL;
2374 }
2375 else
2376 {
2377 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002378 if( ssl->hostname == NULL )
2379 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002380
Hanno Becker947194e2017-04-07 13:25:49 +01002381 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002382
Hanno Becker947194e2017-04-07 13:25:49 +01002383 ssl->hostname[hostname_len] = '\0';
2384 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002385
2386 return( 0 );
2387}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002388#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002389
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002390#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002391void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002392 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002393 const unsigned char *, size_t),
2394 void *p_sni )
2395{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002396 conf->f_sni = f_sni;
2397 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002398}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002402int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002403{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002404 size_t cur_len, tot_len;
2405 const char **p;
2406
2407 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002408 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2409 * MUST NOT be truncated."
2410 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002411 */
2412 tot_len = 0;
2413 for( p = protos; *p != NULL; p++ )
2414 {
2415 cur_len = strlen( *p );
2416 tot_len += cur_len;
2417
Ronald Cron8216dd32020-04-23 16:41:44 +02002418 if( ( cur_len == 0 ) ||
2419 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2420 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002422 }
2423
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002424 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002425
2426 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002427}
2428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002430{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002431 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002432}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002434
Johan Pascalb62bb512015-12-03 21:56:45 +01002435#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002436void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2437 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002438{
2439 conf->dtls_srtp_mki_support = support_mki_value;
2440}
2441
Ron Eldoref72faf2018-07-12 11:54:20 +03002442int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2443 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002444 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002445{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002446 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002447 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002448 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002449 }
Ron Eldor591f1622018-01-22 12:30:04 +02002450
2451 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002452 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002453 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002454 }
Ron Eldor591f1622018-01-22 12:30:04 +02002455
2456 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2457 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002458 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002459}
2460
Ron Eldoref72faf2018-07-12 11:54:20 +03002461int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002462 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002463{
Johan Pascal253d0262020-09-22 13:04:45 +02002464 const mbedtls_ssl_srtp_profile *p;
2465 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002466
Johan Pascal253d0262020-09-22 13:04:45 +02002467 /* check the profiles list: all entry must be valid,
2468 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002469 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2470 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2471 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002472 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002473 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002474 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002475 list_size++;
2476 }
2477 else
2478 {
2479 /* unsupported value, stop parsing and set the size to an error value */
2480 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002481 }
2482 }
2483
Johan Pascal5ef72d22020-10-28 17:05:47 +01002484 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002485 {
Johan Pascal253d0262020-09-22 13:04:45 +02002486 conf->dtls_srtp_profile_list = NULL;
2487 conf->dtls_srtp_profile_list_len = 0;
2488 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2489 }
2490
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002491 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002492 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002493
2494 return( 0 );
2495}
2496
Johan Pascal5ef72d22020-10-28 17:05:47 +01002497void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2498 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002499{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002500 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2501 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002502 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002503 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002504 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002505 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002506 else
2507 {
2508 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002509 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2510 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002511 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002512}
Johan Pascalb62bb512015-12-03 21:56:45 +01002513#endif /* MBEDTLS_SSL_DTLS_SRTP */
2514
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302515#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002516void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002517{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002518 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002519}
2520
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002521void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002522{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002523 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002524}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302525#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002526
Janos Follath088ce432017-04-10 12:42:31 +01002527#if defined(MBEDTLS_SSL_SRV_C)
2528void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2529 char cert_req_ca_list )
2530{
2531 conf->cert_req_ca_list = cert_req_ca_list;
2532}
2533#endif
2534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002536void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002537{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002538 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002539}
2540#endif
2541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002543void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002544{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002545 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002546}
2547#endif
2548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002550int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002551{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002553 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002554 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002556 }
2557
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002558 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002559
2560 return( 0 );
2561}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002563
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002564void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002565{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002566 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002567}
2568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002570void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002571{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002572 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002573}
2574
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002575void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002576{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002577 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002578}
2579
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002580void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002581 const unsigned char period[8] )
2582{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002583 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002584}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002588#if defined(MBEDTLS_SSL_CLI_C)
2589void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002590{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002591 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002592}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002593#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002594
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002595#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002596void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2597 mbedtls_ssl_ticket_write_t *f_ticket_write,
2598 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2599 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002600{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002601 conf->f_ticket_write = f_ticket_write;
2602 conf->f_ticket_parse = f_ticket_parse;
2603 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002604}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002605#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002607
Hanno Becker7e6c1782021-06-08 09:24:55 +01002608void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2609 mbedtls_ssl_export_keys_t *f_export_keys,
2610 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002611{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002612 ssl->f_export_keys = f_export_keys;
2613 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002614}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002615
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002616#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002617void mbedtls_ssl_conf_async_private_cb(
2618 mbedtls_ssl_config *conf,
2619 mbedtls_ssl_async_sign_t *f_async_sign,
2620 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2621 mbedtls_ssl_async_resume_t *f_async_resume,
2622 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002623 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002624{
2625 conf->f_async_sign_start = f_async_sign;
2626 conf->f_async_decrypt_start = f_async_decrypt;
2627 conf->f_async_resume = f_async_resume;
2628 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002629 conf->p_async_config_data = async_config_data;
2630}
2631
Gilles Peskine8f97af72018-04-26 11:46:10 +02002632void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2633{
2634 return( conf->p_async_config_data );
2635}
2636
Gilles Peskine1febfef2018-04-30 11:54:39 +02002637void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002638{
2639 if( ssl->handshake == NULL )
2640 return( NULL );
2641 else
2642 return( ssl->handshake->user_async_ctx );
2643}
2644
Gilles Peskine1febfef2018-04-30 11:54:39 +02002645void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002646 void *ctx )
2647{
2648 if( ssl->handshake != NULL )
2649 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002650}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002651#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002652
Paul Bakker5121ce52009-01-03 21:22:43 +00002653/*
2654 * SSL get accessors
2655 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002656uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002657{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002658 if( ssl->session != NULL )
2659 return( ssl->session->verify_result );
2660
2661 if( ssl->session_negotiate != NULL )
2662 return( ssl->session_negotiate->verify_result );
2663
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002664 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002665}
2666
Glenn Strauss8f526902022-01-13 00:04:49 -05002667int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2668{
2669 if( ssl == NULL || ssl->session == NULL )
2670 return( 0 );
2671
2672 return( ssl->session->ciphersuite );
2673}
2674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002676{
Paul Bakker926c8e42013-03-06 10:23:34 +01002677 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002678 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002681}
2682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002684{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002686 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002687 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002688 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002689 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002690 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002691 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002692 default:
2693 return( "unknown (DTLS)" );
2694 }
2695 }
2696#endif
2697
Glenn Strauss60bfe602022-03-14 19:04:24 -04002698 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002699 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002700 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002701 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002702 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002703 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002704 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002705 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002706 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002707}
2708
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002709#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002710size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2711{
David Horstmann95d516f2021-05-04 18:36:56 +01002712 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002713 size_t read_mfl;
2714
2715 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2716 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2717 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2718 {
2719 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2720 }
2721
2722 /* Check if a smaller max length was negotiated */
2723 if( ssl->session_out != NULL )
2724 {
2725 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2726 if( read_mfl < max_len )
2727 {
2728 max_len = read_mfl;
2729 }
2730 }
2731
2732 // During a handshake, use the value being negotiated
2733 if( ssl->session_negotiate != NULL )
2734 {
2735 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2736 if( read_mfl < max_len )
2737 {
2738 max_len = read_mfl;
2739 }
2740 }
2741
2742 return( max_len );
2743}
2744
2745size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002746{
2747 size_t max_len;
2748
2749 /*
2750 * Assume mfl_code is correct since it was checked when set
2751 */
Angus Grattond8213d02016-05-25 20:56:48 +10002752 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002753
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002754 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002755 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002756 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002757 {
Angus Grattond8213d02016-05-25 20:56:48 +10002758 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002759 }
2760
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002761 /* During a handshake, use the value being negotiated */
2762 if( ssl->session_negotiate != NULL &&
2763 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2764 {
2765 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2766 }
2767
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002768 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002769}
2770#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2771
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002772#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002773size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002774{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002775 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2776 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2777 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2778 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2779 return ( 0 );
2780
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002781 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2782 return( ssl->mtu );
2783
2784 if( ssl->mtu == 0 )
2785 return( ssl->handshake->mtu );
2786
2787 return( ssl->mtu < ssl->handshake->mtu ?
2788 ssl->mtu : ssl->handshake->mtu );
2789}
2790#endif /* MBEDTLS_SSL_PROTO_DTLS */
2791
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002792int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2793{
2794 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2795
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002796#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2797 !defined(MBEDTLS_SSL_PROTO_DTLS)
2798 (void) ssl;
2799#endif
2800
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002801#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002802 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002803
2804 if( max_len > mfl )
2805 max_len = mfl;
2806#endif
2807
2808#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002809 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002810 {
Hanno Becker89490712020-02-05 10:50:12 +00002811 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002812 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2813 const size_t overhead = (size_t) ret;
2814
2815 if( ret < 0 )
2816 return( ret );
2817
2818 if( mtu <= overhead )
2819 {
2820 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2821 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2822 }
2823
2824 if( max_len > mtu - overhead )
2825 max_len = mtu - overhead;
2826 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002827#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002828
Hanno Becker0defedb2018-08-10 12:35:02 +01002829#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2830 !defined(MBEDTLS_SSL_PROTO_DTLS)
2831 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002832#endif
2833
2834 return( (int) max_len );
2835}
2836
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002837int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2838{
2839 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2840
2841#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2842 (void) ssl;
2843#endif
2844
2845#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2846 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2847
2848 if( max_len > mfl )
2849 max_len = mfl;
2850#endif
2851
2852 return( (int) max_len );
2853}
2854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855#if defined(MBEDTLS_X509_CRT_PARSE_C)
2856const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002857{
2858 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002859 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002860
Hanno Beckere6824572019-02-07 13:18:46 +00002861#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002862 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002863#else
2864 return( NULL );
2865#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002866}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002870int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2871 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002872{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002873 int ret;
2874
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002875 if( ssl == NULL ||
2876 dst == NULL ||
2877 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002878 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002879 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002881 }
2882
Hanno Beckere810bbc2021-05-14 16:01:05 +01002883 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2884 * idempotent: Each session can only be exported once.
2885 *
2886 * (This is in preparation for TLS 1.3 support where we will
2887 * need the ability to export multiple sessions (aka tickets),
2888 * which will be achieved by calling mbedtls_ssl_get_session()
2889 * multiple times until it fails.)
2890 *
2891 * Check whether we have already exported the current session,
2892 * and fail if so.
2893 */
2894 if( ssl->session->exported == 1 )
2895 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2896
2897 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2898 if( ret != 0 )
2899 return( ret );
2900
2901 /* Remember that we've exported the session. */
2902 ssl->session->exported = 1;
2903 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002904}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002906
Paul Bakker5121ce52009-01-03 21:22:43 +00002907/*
Hanno Beckera835da52019-05-16 12:39:07 +01002908 * Define ticket header determining Mbed TLS version
2909 * and structure of the ticket.
2910 */
2911
Hanno Becker94ef3b32019-05-16 12:50:45 +01002912/*
Hanno Becker50b59662019-05-28 14:30:45 +01002913 * Define bitflag determining compile-time settings influencing
2914 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002915 */
2916
Hanno Becker50b59662019-05-28 14:30:45 +01002917#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002918#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002919#else
Hanno Becker3e088662019-05-29 11:10:18 +01002920#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002921#endif /* MBEDTLS_HAVE_TIME */
2922
2923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002924#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002925#else
Hanno Becker3e088662019-05-29 11:10:18 +01002926#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002927#endif /* MBEDTLS_X509_CRT_PARSE_C */
2928
2929#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002930#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002931#else
Hanno Becker3e088662019-05-29 11:10:18 +01002932#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002933#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2934
2935#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002936#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002937#else
Hanno Becker3e088662019-05-29 11:10:18 +01002938#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002939#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2940
Hanno Becker94ef3b32019-05-16 12:50:45 +01002941#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002942#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002943#else
Hanno Becker3e088662019-05-29 11:10:18 +01002944#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002945#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2946
Hanno Becker94ef3b32019-05-16 12:50:45 +01002947#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2948#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2949#else
2950#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2951#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2952
Hanno Becker3e088662019-05-29 11:10:18 +01002953#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2954#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2955#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2956#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002957#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2958#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002959
Hanno Becker50b59662019-05-28 14:30:45 +01002960#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002961 ( (uint16_t) ( \
2962 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2963 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2964 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2965 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002966 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002967 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002968
Hanno Beckerf8787072019-05-16 12:41:07 +01002969static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002970 MBEDTLS_VERSION_MAJOR,
2971 MBEDTLS_VERSION_MINOR,
2972 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002973 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2974 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002975};
Hanno Beckera835da52019-05-16 12:39:07 +01002976
2977/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002978 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002979 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002980 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002981 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002982 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002983 * opaque mbedtls_version[3]; // library version: major, minor, patch
2984 * opaque session_format[2]; // library-version specific 16-bit field
2985 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002986 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002987 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002988 * Note: When updating the format, remember to keep
2989 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002990 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002991 * // In this version, `session_format` determines
2992 * // the setting of those compile-time
2993 * // configuration options which influence
2994 * // the structure of mbedtls_ssl_session.
2995 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002996 * uint8_t minor_ver; // Protocol minor version. Possible values:
2997 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002998 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002999 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003000 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003001 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003002 * serialized_session_tls12 data;
3003 *
3004 * };
3005 *
3006 * } serialized_session;
3007 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003008 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003009
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003010MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003011static int ssl_session_save( const mbedtls_ssl_session *session,
3012 unsigned char omit_header,
3013 unsigned char *buf,
3014 size_t buf_len,
3015 size_t *olen )
3016{
3017 unsigned char *p = buf;
3018 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003019 size_t remaining_len;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003020
Jerry Yu438ddd82022-07-07 06:55:50 +00003021 if( session == NULL )
3022 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3023
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003024 if( !omit_header )
3025 {
3026 /*
3027 * Add Mbed TLS version identifier
3028 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003029 used += sizeof( ssl_serialized_session_header );
3030
3031 if( used <= buf_len )
3032 {
3033 memcpy( p, ssl_serialized_session_header,
3034 sizeof( ssl_serialized_session_header ) );
3035 p += sizeof( ssl_serialized_session_header );
3036 }
3037 }
3038
3039 /*
3040 * TLS version identifier
3041 */
3042 used += 1;
3043 if( used <= buf_len )
3044 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003045 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003046 }
3047
3048 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003049 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003050 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003051 {
3052#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003053 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003054 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003055 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003056#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3057
Jerry Yu251a12e2022-07-13 15:15:48 +08003058#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3059 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yu438ddd82022-07-07 06:55:50 +00003060 used += ssl_tls13_session_save( session, p, remaining_len );
Jerry Yu251a12e2022-07-13 15:15:48 +08003061 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003062#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3063
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003064 default:
3065 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3066 }
3067
3068 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003069 if( used > buf_len )
3070 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003071
3072 return( 0 );
3073}
3074
3075/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003076 * Public wrapper for ssl_session_save()
3077 */
3078int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3079 unsigned char *buf,
3080 size_t buf_len,
3081 size_t *olen )
3082{
3083 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3084}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003085
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003086/*
3087 * Deserialize session, see mbedtls_ssl_session_save() for format.
3088 *
3089 * This internal version is wrapped by a public function that cleans up in
3090 * case of error, and has an extra option omit_header.
3091 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003092MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003093static int ssl_session_load( mbedtls_ssl_session *session,
3094 unsigned char omit_header,
3095 const unsigned char *buf,
3096 size_t len )
3097{
3098 const unsigned char *p = buf;
3099 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003100 size_t remaining_len;
3101
3102
3103 if( session == NULL )
3104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003105
3106 if( !omit_header )
3107 {
3108 /*
3109 * Check Mbed TLS version identifier
3110 */
3111
3112 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3113 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3114
3115 if( memcmp( p, ssl_serialized_session_header,
3116 sizeof( ssl_serialized_session_header ) ) != 0 )
3117 {
3118 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3119 }
3120 p += sizeof( ssl_serialized_session_header );
3121 }
3122
3123 /*
3124 * TLS version identifier
3125 */
3126 if( 1 > (size_t)( end - p ) )
3127 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003128 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003129
3130 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003131 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003132 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003133 {
3134#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003135 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003136 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003137#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3138
Jerry Yu438ddd82022-07-07 06:55:50 +00003139#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3140 case MBEDTLS_SSL_VERSION_TLS1_3:
3141 return( ssl_tls13_session_load( session, p, remaining_len ) );
3142#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3143
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003144 default:
3145 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3146 }
3147}
3148
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003149/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003150 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003151 */
3152int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3153 const unsigned char *buf,
3154 size_t len )
3155{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003156 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003157
3158 if( ret != 0 )
3159 mbedtls_ssl_session_free( session );
3160
3161 return( ret );
3162}
3163
3164/*
Paul Bakker1961b702013-01-25 14:49:24 +01003165 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003166 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003167MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003168static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3169{
3170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3171
Ronald Cron66dbf912022-02-02 15:33:46 +01003172 /*
3173 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003174 * that were written into the output buffer by the previous handshake step,
3175 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003176 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3177 * We proceed to the next handshake step only when all data from the
3178 * previous one have been sent to the peer, thus we make sure that this is
3179 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3180 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3181 * we have to wait before to go ahead.
3182 * In the case of TLS 1.3, handshake step handlers do not send data to the
3183 * peer. Data are only sent here and through
3184 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003185 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003186 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003187 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3188 return( ret );
3189
3190#if defined(MBEDTLS_SSL_PROTO_DTLS)
3191 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3192 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3193 {
3194 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3195 return( ret );
3196 }
3197#endif /* MBEDTLS_SSL_PROTO_DTLS */
3198
3199 return( ret );
3200}
3201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003203{
Hanno Becker41934dd2021-08-07 19:13:43 +01003204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003205
Hanno Becker41934dd2021-08-07 19:13:43 +01003206 if( ssl == NULL ||
3207 ssl->conf == NULL ||
3208 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003209 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003210 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003211 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003212 }
3213
3214 ret = ssl_prepare_handshake_step( ssl );
3215 if( ret != 0 )
3216 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003217
Jerry Yue7047812021-09-13 19:26:39 +08003218 ret = mbedtls_ssl_handle_pending_alert( ssl );
3219 if( ret != 0 )
3220 goto cleanup;
3221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003223 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003224 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003225 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3226 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003227
Ronald Cron9f0fba32022-02-10 16:45:15 +01003228 switch( ssl->state )
3229 {
3230 case MBEDTLS_SSL_HELLO_REQUEST:
3231 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3232 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003233
Ronald Cron9f0fba32022-02-10 16:45:15 +01003234 case MBEDTLS_SSL_CLIENT_HELLO:
3235 ret = mbedtls_ssl_write_client_hello( ssl );
3236 break;
3237
3238 default:
3239#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003240 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003241 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3242 else
3243 ret = mbedtls_ssl_handshake_client_step( ssl );
3244#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3245 ret = mbedtls_ssl_handshake_client_step( ssl );
3246#else
3247 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3248#endif
3249 }
Jerry Yub9930e72021-08-06 17:11:51 +08003250 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003251#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003253 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003254 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003255#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003256 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003257 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003258#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003259
3260#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3261 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3262 ret = mbedtls_ssl_handshake_server_step( ssl );
3263#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3264 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003265#endif
3266
Jerry Yue7047812021-09-13 19:26:39 +08003267 if( ret != 0 )
3268 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003269 /* handshake_step return error. And it is same
3270 * with alert_reason.
3271 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003272 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003273 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003274 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003275 goto cleanup;
3276 }
3277 }
3278
3279cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003280 return( ret );
3281}
3282
3283/*
3284 * Perform the SSL handshake
3285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003287{
3288 int ret = 0;
3289
Hanno Beckera817ea42020-10-20 15:20:23 +01003290 /* Sanity checks */
3291
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003292 if( ssl == NULL || ssl->conf == NULL )
3293 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3294
Hanno Beckera817ea42020-10-20 15:20:23 +01003295#if defined(MBEDTLS_SSL_PROTO_DTLS)
3296 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3297 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3298 {
3299 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3300 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3301 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3302 }
3303#endif /* MBEDTLS_SSL_PROTO_DTLS */
3304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003306
Hanno Beckera817ea42020-10-20 15:20:23 +01003307 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003308 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003309 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003311
3312 if( ret != 0 )
3313 break;
3314 }
3315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003317
3318 return( ret );
3319}
3320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003321#if defined(MBEDTLS_SSL_RENEGOTIATION)
3322#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003323/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003324 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003325 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003326MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003328{
Janos Follath865b3eb2019-12-16 11:46:15 +00003329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003332
3333 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3335 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003336
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003337 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003338 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003339 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003340 return( ret );
3341 }
3342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003344
3345 return( 0 );
3346}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003348
3349/*
3350 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351 * - any side: calling mbedtls_ssl_renegotiate(),
3352 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3353 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003354 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003355 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003357 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003358int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003359{
Janos Follath865b3eb2019-12-16 11:46:15 +00003360 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003363
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003364 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3365 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003366
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003367 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3368 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003370 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003372 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003373 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003374 ssl->handshake->out_msg_seq = 1;
3375 else
3376 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003377 }
3378#endif
3379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3381 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003384 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003386 return( ret );
3387 }
3388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003390
3391 return( 0 );
3392}
3393
3394/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003395 * Renegotiate current connection on client,
3396 * or request renegotiation on server
3397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003399{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003401
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003402 if( ssl == NULL || ssl->conf == NULL )
3403 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3404
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003406 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003407 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003408 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003409 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003413
3414 /* Did we already try/start sending HelloRequest? */
3415 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003417
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003418 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003419 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003421
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003423 /*
3424 * On client, either start the renegotiation process or,
3425 * if already in progress, continue the handshake
3426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003428 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003429 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003431
Hanno Becker40cdaa12020-02-05 10:48:27 +00003432 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003433 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003434 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003435 return( ret );
3436 }
3437 }
3438 else
3439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003441 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003443 return( ret );
3444 }
3445 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003447
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003448 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003449}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003451
Gilles Peskine9b562d52018-04-25 20:32:43 +02003452void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003453{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003454 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3455
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003456 if( handshake == NULL )
3457 return;
3458
Brett Warrene0edc842021-08-17 09:53:13 +01003459#if defined(MBEDTLS_ECP_C)
3460#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3461 if ( ssl->handshake->group_list_heap_allocated )
3462 mbedtls_free( (void*) handshake->group_list );
3463 handshake->group_list = NULL;
3464#endif /* MBEDTLS_DEPRECATED_REMOVED */
3465#endif /* MBEDTLS_ECP_C */
3466
Jerry Yuf017ee42022-01-12 15:49:48 +08003467#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3468#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3469 if ( ssl->handshake->sig_algs_heap_allocated )
3470 mbedtls_free( (void*) handshake->sig_algs );
3471 handshake->sig_algs = NULL;
3472#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003473#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3474 if( ssl->handshake->certificate_request_context )
3475 {
3476 mbedtls_free( (void*) handshake->certificate_request_context );
3477 }
3478#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003479#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3480
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003481#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3482 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3483 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003484 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003485 handshake->async_in_progress = 0;
3486 }
3487#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3488
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003489#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003490#if defined(MBEDTLS_USE_PSA_CRYPTO)
3491 psa_hash_abort( &handshake->fin_sha256_psa );
3492#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003493 mbedtls_sha256_free( &handshake->fin_sha256 );
3494#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003495#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003496#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003497#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003498 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003499#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003500 mbedtls_sha512_free( &handshake->fin_sha512 );
3501#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003502#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504#if defined(MBEDTLS_DHM_C)
3505 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003506#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003507#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003509#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003510#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003511 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003512#if defined(MBEDTLS_SSL_CLI_C)
3513 mbedtls_free( handshake->ecjpake_cache );
3514 handshake->ecjpake_cache = NULL;
3515 handshake->ecjpake_cache_len = 0;
3516#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003517#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003518
Janos Follath4ae5c292016-02-10 11:27:43 +00003519#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3520 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003521 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003523#endif
3524
Gilles Peskineeccd8882020-03-10 12:19:08 +01003525#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu5c28e7a2022-07-30 23:22:08 +08003526 mbedtls_ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003527#endif
3528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003529#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3530 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003531 /*
3532 * Free only the linked list wrapper, not the keys themselves
3533 * since the belong to the SNI callback
3534 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003535 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003537
Gilles Peskineeccd8882020-03-10 12:19:08 +01003538#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003539 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003540 if( handshake->ecrs_peer_cert != NULL )
3541 {
3542 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3543 mbedtls_free( handshake->ecrs_peer_cert );
3544 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003545#endif
3546
Hanno Becker75173122019-02-06 16:18:31 +00003547#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3548 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3549 mbedtls_pk_free( &handshake->peer_pubkey );
3550#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3551
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003552#if defined(MBEDTLS_SSL_CLI_C) && \
3553 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3554 mbedtls_free( handshake->cookie );
3555#endif /* MBEDTLS_SSL_CLI_C &&
3556 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003557
3558#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003559 mbedtls_ssl_flight_free( handshake->flight );
3560 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003561#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003562
Ronald Cronf12b81d2022-03-15 10:42:41 +01003563#if defined(MBEDTLS_ECDH_C) && \
3564 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003565 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003566 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003567#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3568
Ronald Cron6f135e12021-12-08 16:57:54 +01003569#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003570 mbedtls_ssl_transform_free( handshake->transform_handshake );
3571 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003572 mbedtls_free( handshake->transform_earlydata );
3573 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003574#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003575
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003576
3577#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3578 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3579 * processes datagrams and the fact that a datagram is allowed to have
3580 * several records in it, it is possible that the I/O buffers are not
3581 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003582 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3583 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003584#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003585
Jerry Yuba9c7272021-10-30 11:54:10 +08003586 /* mbedtls_platform_zeroize MUST be last one in this function */
3587 mbedtls_platform_zeroize( handshake,
3588 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003589}
3590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003592{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003593 if( session == NULL )
3594 return;
3595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003597 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003598#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003599
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003600#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003602#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003603
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003604 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003605}
3606
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003607#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003608
3609#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3610#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3611#else
3612#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3613#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3614
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003615#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003616
3617#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3618#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3619#else
3620#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3621#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3622
3623#if defined(MBEDTLS_SSL_ALPN)
3624#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3625#else
3626#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3627#endif /* MBEDTLS_SSL_ALPN */
3628
3629#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3630#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3631#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3632#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3633
3634#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3635 ( (uint32_t) ( \
3636 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3637 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3638 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3639 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3640 0u ) )
3641
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003642static unsigned char ssl_serialized_context_header[] = {
3643 MBEDTLS_VERSION_MAJOR,
3644 MBEDTLS_VERSION_MINOR,
3645 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003646 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3647 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3648 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3649 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3650 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003651};
3652
Paul Bakker5121ce52009-01-03 21:22:43 +00003653/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003654 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003655 *
3656 * The format of the serialized data is:
3657 * (in the presentation language of TLS, RFC 8446 section 3)
3658 *
3659 * // header
3660 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003661 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003662 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003663 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003664 * Note: When updating the format, remember to keep these
3665 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003666 *
3667 * // session sub-structure
3668 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3669 * // transform sub-structure
3670 * uint8 random[64]; // ServerHello.random+ClientHello.random
3671 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3672 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3673 * // fields from ssl_context
3674 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3675 * uint64 in_window_top; // DTLS: last validated record seq_num
3676 * uint64 in_window; // DTLS: bitmask for replay protection
3677 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3678 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3679 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3680 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3681 *
3682 * Note that many fields of the ssl_context or sub-structures are not
3683 * serialized, as they fall in one of the following categories:
3684 *
3685 * 1. forced value (eg in_left must be 0)
3686 * 2. pointer to dynamically-allocated memory (eg session, transform)
3687 * 3. value can be re-derived from other data (eg session keys from MS)
3688 * 4. value was temporary (eg content of input buffer)
3689 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003690 */
3691int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3692 unsigned char *buf,
3693 size_t buf_len,
3694 size_t *olen )
3695{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003696 unsigned char *p = buf;
3697 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003698 size_t session_len;
3699 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003700
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003701 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003702 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3703 * this function's documentation.
3704 *
3705 * These are due to assumptions/limitations in the implementation. Some of
3706 * them are likely to stay (no handshake in progress) some might go away
3707 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003708 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003709 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003710 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003711 {
3712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003714 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003715 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003716 {
3717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003718 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003719 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003720 /* Double-check that sub-structures are indeed ready */
3721 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003722 {
3723 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003724 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003725 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003726 /* There must be no pending incoming or outgoing data */
3727 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003728 {
3729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003730 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003731 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003732 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003733 {
3734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003735 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003736 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003737 /* Protocol must be DLTS, not TLS */
3738 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003739 {
3740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003741 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003742 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003743 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003744 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003745 {
3746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003748 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003749 /* We must be using an AEAD ciphersuite */
3750 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003751 {
3752 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003753 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003754 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003755 /* Renegotiation must not be enabled */
3756#if defined(MBEDTLS_SSL_RENEGOTIATION)
3757 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003758 {
3759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003760 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003761 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003762#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003763
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003764 /*
3765 * Version and format identifier
3766 */
3767 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003768
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003769 if( used <= buf_len )
3770 {
3771 memcpy( p, ssl_serialized_context_header,
3772 sizeof( ssl_serialized_context_header ) );
3773 p += sizeof( ssl_serialized_context_header );
3774 }
3775
3776 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003777 * Session (length + data)
3778 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003779 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003780 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3781 return( ret );
3782
3783 used += 4 + session_len;
3784 if( used <= buf_len )
3785 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003786 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3787 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003788
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003789 ret = ssl_session_save( ssl->session, 1,
3790 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003791 if( ret != 0 )
3792 return( ret );
3793
3794 p += session_len;
3795 }
3796
3797 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003798 * Transform
3799 */
3800 used += sizeof( ssl->transform->randbytes );
3801 if( used <= buf_len )
3802 {
3803 memcpy( p, ssl->transform->randbytes,
3804 sizeof( ssl->transform->randbytes ) );
3805 p += sizeof( ssl->transform->randbytes );
3806 }
3807
3808#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3809 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3810 if( used <= buf_len )
3811 {
3812 *p++ = ssl->transform->in_cid_len;
3813 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3814 p += ssl->transform->in_cid_len;
3815
3816 *p++ = ssl->transform->out_cid_len;
3817 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3818 p += ssl->transform->out_cid_len;
3819 }
3820#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3821
3822 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003823 * Saved fields from top-level ssl_context structure
3824 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003825 used += 4;
3826 if( used <= buf_len )
3827 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003828 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3829 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003830 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003831
3832#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3833 used += 16;
3834 if( used <= buf_len )
3835 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003836 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3837 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003838
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003839 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3840 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003841 }
3842#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3843
3844#if defined(MBEDTLS_SSL_PROTO_DTLS)
3845 used += 1;
3846 if( used <= buf_len )
3847 {
3848 *p++ = ssl->disable_datagram_packing;
3849 }
3850#endif /* MBEDTLS_SSL_PROTO_DTLS */
3851
Jerry Yuae0b2e22021-10-08 15:21:19 +08003852 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003853 if( used <= buf_len )
3854 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003855 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3856 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003857 }
3858
3859#if defined(MBEDTLS_SSL_PROTO_DTLS)
3860 used += 2;
3861 if( used <= buf_len )
3862 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003863 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3864 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003865 }
3866#endif /* MBEDTLS_SSL_PROTO_DTLS */
3867
3868#if defined(MBEDTLS_SSL_ALPN)
3869 {
3870 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003871 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003872 : 0;
3873
3874 used += 1 + alpn_len;
3875 if( used <= buf_len )
3876 {
3877 *p++ = alpn_len;
3878
3879 if( ssl->alpn_chosen != NULL )
3880 {
3881 memcpy( p, ssl->alpn_chosen, alpn_len );
3882 p += alpn_len;
3883 }
3884 }
3885 }
3886#endif /* MBEDTLS_SSL_ALPN */
3887
3888 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003889 * Done
3890 */
3891 *olen = used;
3892
3893 if( used > buf_len )
3894 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003895
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003896 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3897
Hanno Becker43aefe22020-02-05 10:44:56 +00003898 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003899}
3900
3901/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003902 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003903 *
3904 * This internal version is wrapped by a public function that cleans up in
3905 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003906 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003907MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003908static int ssl_context_load( mbedtls_ssl_context *ssl,
3909 const unsigned char *buf,
3910 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003911{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003912 const unsigned char *p = buf;
3913 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003914 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003916
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003917 /*
3918 * The context should have been freshly setup or reset.
3919 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003920 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003921 * renegotiating, or if the user mistakenly loaded a session first.)
3922 */
3923 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3924 ssl->session != NULL )
3925 {
3926 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3927 }
3928
3929 /*
3930 * We can't check that the config matches the initial one, but we can at
3931 * least check it matches the requirements for serializing.
3932 */
3933 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003934 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3935 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003936#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003937 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003938#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003939 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003940 {
3941 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3942 }
3943
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003944 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3945
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003946 /*
3947 * Check version identifier
3948 */
3949 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3951
3952 if( memcmp( p, ssl_serialized_context_header,
3953 sizeof( ssl_serialized_context_header ) ) != 0 )
3954 {
3955 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3956 }
3957 p += sizeof( ssl_serialized_context_header );
3958
3959 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003960 * Session
3961 */
3962 if( (size_t)( end - p ) < 4 )
3963 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3964
3965 session_len = ( (size_t) p[0] << 24 ) |
3966 ( (size_t) p[1] << 16 ) |
3967 ( (size_t) p[2] << 8 ) |
3968 ( (size_t) p[3] );
3969 p += 4;
3970
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003971 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003972 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003973 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003974 ssl->session_in = ssl->session;
3975 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003976 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003977
3978 if( (size_t)( end - p ) < session_len )
3979 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3980
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003981 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003982 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003983 {
3984 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003985 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003986 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003987
3988 p += session_len;
3989
3990 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003991 * Transform
3992 */
3993
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003994 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003995 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003996 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003997 ssl->transform_in = ssl->transform;
3998 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003999 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004000
4001 /* Read random bytes and populate structure */
4002 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4003 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004005 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004006 ssl->session->ciphersuite,
4007 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004008#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004009 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004010#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004011 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4012 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004013 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004014 ssl->conf->endpoint,
4015 ssl );
4016 if( ret != 0 )
4017 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004018#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004019 p += sizeof( ssl->transform->randbytes );
4020
4021#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4022 /* Read connection IDs and store them */
4023 if( (size_t)( end - p ) < 1 )
4024 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4025
4026 ssl->transform->in_cid_len = *p++;
4027
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004028 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004029 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4030
4031 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4032 p += ssl->transform->in_cid_len;
4033
4034 ssl->transform->out_cid_len = *p++;
4035
4036 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4037 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4038
4039 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4040 p += ssl->transform->out_cid_len;
4041#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4042
4043 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004044 * Saved fields from top-level ssl_context structure
4045 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004046 if( (size_t)( end - p ) < 4 )
4047 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4048
4049 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4050 ( (uint32_t) p[1] << 16 ) |
4051 ( (uint32_t) p[2] << 8 ) |
4052 ( (uint32_t) p[3] );
4053 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004054
4055#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4056 if( (size_t)( end - p ) < 16 )
4057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4058
4059 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4060 ( (uint64_t) p[1] << 48 ) |
4061 ( (uint64_t) p[2] << 40 ) |
4062 ( (uint64_t) p[3] << 32 ) |
4063 ( (uint64_t) p[4] << 24 ) |
4064 ( (uint64_t) p[5] << 16 ) |
4065 ( (uint64_t) p[6] << 8 ) |
4066 ( (uint64_t) p[7] );
4067 p += 8;
4068
4069 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4070 ( (uint64_t) p[1] << 48 ) |
4071 ( (uint64_t) p[2] << 40 ) |
4072 ( (uint64_t) p[3] << 32 ) |
4073 ( (uint64_t) p[4] << 24 ) |
4074 ( (uint64_t) p[5] << 16 ) |
4075 ( (uint64_t) p[6] << 8 ) |
4076 ( (uint64_t) p[7] );
4077 p += 8;
4078#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4079
4080#if defined(MBEDTLS_SSL_PROTO_DTLS)
4081 if( (size_t)( end - p ) < 1 )
4082 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4083
4084 ssl->disable_datagram_packing = *p++;
4085#endif /* MBEDTLS_SSL_PROTO_DTLS */
4086
Jerry Yud9a94fe2021-09-28 18:58:59 +08004087 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004088 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004089 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4090 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004091
4092#if defined(MBEDTLS_SSL_PROTO_DTLS)
4093 if( (size_t)( end - p ) < 2 )
4094 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4095
4096 ssl->mtu = ( p[0] << 8 ) | p[1];
4097 p += 2;
4098#endif /* MBEDTLS_SSL_PROTO_DTLS */
4099
4100#if defined(MBEDTLS_SSL_ALPN)
4101 {
4102 uint8_t alpn_len;
4103 const char **cur;
4104
4105 if( (size_t)( end - p ) < 1 )
4106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4107
4108 alpn_len = *p++;
4109
4110 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4111 {
4112 /* alpn_chosen should point to an item in the configured list */
4113 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4114 {
4115 if( strlen( *cur ) == alpn_len &&
4116 memcmp( p, cur, alpn_len ) == 0 )
4117 {
4118 ssl->alpn_chosen = *cur;
4119 break;
4120 }
4121 }
4122 }
4123
4124 /* can only happen on conf mismatch */
4125 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4126 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4127
4128 p += alpn_len;
4129 }
4130#endif /* MBEDTLS_SSL_ALPN */
4131
4132 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004133 * Forced fields from top-level ssl_context structure
4134 *
4135 * Most of them already set to the correct value by mbedtls_ssl_init() and
4136 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4137 */
4138 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004139 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004140
Hanno Becker361b10d2019-08-30 10:42:49 +01004141 /* Adjust pointers for header fields of outgoing records to
4142 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004143 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004144
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004145#if defined(MBEDTLS_SSL_PROTO_DTLS)
4146 ssl->in_epoch = 1;
4147#endif
4148
4149 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4150 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004151 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4152 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004153 if( ssl->handshake != NULL )
4154 {
4155 mbedtls_ssl_handshake_free( ssl );
4156 mbedtls_free( ssl->handshake );
4157 ssl->handshake = NULL;
4158 }
4159
4160 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004161 * Done - should have consumed entire buffer
4162 */
4163 if( p != end )
4164 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004165
4166 return( 0 );
4167}
4168
4169/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004170 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004171 */
4172int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4173 const unsigned char *buf,
4174 size_t len )
4175{
4176 int ret = ssl_context_load( context, buf, len );
4177
4178 if( ret != 0 )
4179 mbedtls_ssl_free( context );
4180
4181 return( ret );
4182}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004183#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004184
4185/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004186 * Free an SSL context
4187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004188void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004189{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004190 if( ssl == NULL )
4191 return;
4192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004193 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004194
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004195 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004196 {
sander-visserb8aa2072020-05-06 22:05:13 +02004197#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4198 size_t out_buf_len = ssl->out_buf_len;
4199#else
4200 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4201#endif
4202
Darryl Greenb33cc762019-11-28 14:29:44 +00004203 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004204 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004205 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004206 }
4207
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004208 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004209 {
sander-visserb8aa2072020-05-06 22:05:13 +02004210#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4211 size_t in_buf_len = ssl->in_buf_len;
4212#else
4213 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4214#endif
4215
Darryl Greenb33cc762019-11-28 14:29:44 +00004216 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004217 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004218 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004219 }
4220
Paul Bakker48916f92012-09-16 19:57:18 +00004221 if( ssl->transform )
4222 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004223 mbedtls_ssl_transform_free( ssl->transform );
4224 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004225 }
4226
4227 if( ssl->handshake )
4228 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004229 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004230 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4231 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004233 mbedtls_free( ssl->handshake );
4234 mbedtls_free( ssl->transform_negotiate );
4235 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004236 }
4237
Ronald Cron6f135e12021-12-08 16:57:54 +01004238#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004239 mbedtls_ssl_transform_free( ssl->transform_application );
4240 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004241#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004242
Paul Bakkerc0463502013-02-14 11:19:38 +01004243 if( ssl->session )
4244 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004245 mbedtls_ssl_session_free( ssl->session );
4246 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004247 }
4248
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004249#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004250 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004251 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004252 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004253 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004254 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004255#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004256
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004257#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004258 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004259#endif
4260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004261 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004262
Paul Bakker86f04f42013-02-14 11:20:09 +01004263 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004264 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004265}
4266
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004267/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004268 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004269 */
4270void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4271{
4272 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4273}
4274
Gilles Peskineae270bf2021-06-02 00:05:29 +02004275/* The selection should be the same as mbedtls_x509_crt_profile_default in
4276 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004277 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004278 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004279 * about this list.
4280 */
Brett Warrene0edc842021-08-17 09:53:13 +01004281static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004282#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004283 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004284#endif
4285#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004286 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004287#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004288#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004289 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004290#endif
4291#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004292 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004293#endif
4294#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004295 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004296#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004297#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004298 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004299#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004300#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004301 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004302#endif
4303#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004304 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004305#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004306 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004307};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004308
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004309static int ssl_preset_suiteb_ciphersuites[] = {
4310 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4311 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4312 0
4313};
4314
Gilles Peskineeccd8882020-03-10 12:19:08 +01004315#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004316
Jerry Yu909df7b2022-01-22 11:56:27 +08004317/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004318 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004319 * rules SHOULD be upheld.
4320 * - No duplicate entries.
4321 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004322 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004323 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004324 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004325static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004326
Jerry Yued5e9f42022-01-26 11:21:34 +08004327#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4328 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4329 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4330#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4331 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004332
Jerry Yu909df7b2022-01-22 11:56:27 +08004333#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4334 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4335 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4336#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4337 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4338
Jerry Yued5e9f42022-01-26 11:21:34 +08004339#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4340 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4341 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4342#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4343 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004344
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004345#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4346 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4347#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4348
4349#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4350 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4351#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4352
4353#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4354 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4355#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4356
Jerry Yu693a47a2022-06-23 14:02:28 +08004357#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4358 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4359#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4360
4361#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4362 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4363#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4364
4365#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4366 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4367#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4368
Gabor Mezei15b95a62022-05-09 16:37:58 +02004369 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004370};
4371
4372/* NOTICE: see above */
4373#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4374static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004375#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004376#if defined(MBEDTLS_ECDSA_C)
4377 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004378#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004379#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4380 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4381#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004382#if defined(MBEDTLS_RSA_C)
4383 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4384#endif
4385#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004386#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004387#if defined(MBEDTLS_ECDSA_C)
4388 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004389#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004390#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4391 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4392#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004393#if defined(MBEDTLS_RSA_C)
4394 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4395#endif
4396#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004397#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004398#if defined(MBEDTLS_ECDSA_C)
4399 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004400#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004401#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4402 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4403#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004404#if defined(MBEDTLS_RSA_C)
4405 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4406#endif
4407#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004408 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004409};
4410#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4411/* NOTICE: see above */
4412static uint16_t ssl_preset_suiteb_sig_algs[] = {
4413
Jerry Yu909df7b2022-01-22 11:56:27 +08004414#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4415 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4416 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4417#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4418 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4419
Jerry Yu53037892022-01-25 11:02:06 +08004420#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4421 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4422 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4423#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4424 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004425
4426#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4427 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4428#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004429
Jerry Yu53037892022-01-25 11:02:06 +08004430#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4431 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4432#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4433
Gabor Mezei15b95a62022-05-09 16:37:58 +02004434 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004435};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004436
Jerry Yu909df7b2022-01-22 11:56:27 +08004437/* NOTICE: see above */
4438#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4439static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004440#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004441#if defined(MBEDTLS_ECDSA_C)
4442 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004443#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004444#if defined(MBEDTLS_RSA_C)
4445 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4446#endif
4447#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004448#if defined(MBEDTLS_SHA384_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_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +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_SHA384 ),
4454#endif
4455#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004456 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004457};
Jerry Yu909df7b2022-01-22 11:56:27 +08004458#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4459
Jerry Yu1a8b4812022-01-20 17:56:50 +08004460#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004461
Brett Warrene0edc842021-08-17 09:53:13 +01004462static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004463#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004464 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004465#endif
4466#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004467 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004468#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004469 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004470};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004471
Jerry Yu1a8b4812022-01-20 17:56:50 +08004472#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004473/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004474 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004475MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004476static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004477{
4478 size_t i, j;
4479 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004480
Gabor Mezei15b95a62022-05-09 16:37:58 +02004481 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004482 {
Jerry Yuf377d642022-01-25 10:43:59 +08004483 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004484 {
Jerry Yuf377d642022-01-25 10:43:59 +08004485 if( sig_algs[i] != sig_algs[j] )
4486 continue;
4487 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4488 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4489 sig_algs[i], j, i );
4490 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004491 }
4492 }
4493 return( ret );
4494}
4495
4496#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4497
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004498/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004499 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004500 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004501int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004502 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004503{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004504#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004505 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004506#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004507
Jerry Yu1a8b4812022-01-20 17:56:50 +08004508#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004509 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004510 {
4511 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4512 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4513 }
4514
Jerry Yuf377d642022-01-25 10:43:59 +08004515 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004516 {
4517 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4518 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4519 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004520
4521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004522 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004523 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004524 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004525 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4526 }
4527
Jerry Yuf377d642022-01-25 10:43:59 +08004528 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004529 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004530 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004531 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4532 }
4533#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004534#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4535
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004536 /* Use the functions here so that they are covered in tests,
4537 * but otherwise access member directly for efficiency */
4538 mbedtls_ssl_conf_endpoint( conf, endpoint );
4539 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004540
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004541 /*
4542 * Things that are common to all presets
4543 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004544#if defined(MBEDTLS_SSL_CLI_C)
4545 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4546 {
4547 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4548#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4549 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4550#endif
4551 }
4552#endif
4553
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004554#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4555 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4556#endif
4557
4558#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4559 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4560#endif
4561
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004562#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004563 conf->f_cookie_write = ssl_cookie_write_dummy;
4564 conf->f_cookie_check = ssl_cookie_check_dummy;
4565#endif
4566
4567#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4568 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4569#endif
4570
Janos Follath088ce432017-04-10 12:42:31 +01004571#if defined(MBEDTLS_SSL_SRV_C)
4572 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004573 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004574#endif
4575
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004576#if defined(MBEDTLS_SSL_PROTO_DTLS)
4577 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4578 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4579#endif
4580
4581#if defined(MBEDTLS_SSL_RENEGOTIATION)
4582 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004583 memset( conf->renego_period, 0x00, 2 );
4584 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004585#endif
4586
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004587#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004588 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4589 {
4590 const unsigned char dhm_p[] =
4591 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4592 const unsigned char dhm_g[] =
4593 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004594
Hanno Beckere2defad2021-07-24 05:59:17 +01004595 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4596 dhm_p, sizeof( dhm_p ),
4597 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4598 {
4599 return( ret );
4600 }
4601 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004602#endif
4603
Ronald Cron6f135e12021-12-08 16:57:54 +01004604#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004605 /*
4606 * Allow all TLS 1.3 key exchange modes by default.
4607 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004608 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004609#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004610
XiaokangQian4d3a6042022-04-21 13:46:17 +00004611 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4612 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004613#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004614 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004615 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004616#else
XiaokangQian060d8672022-04-21 09:24:56 +00004617 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004618#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004619 }
4620 else
4621 {
4622#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4623 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4624 {
4625 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4626 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4627 }
4628 else
4629 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4630 {
4631 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4632 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4633 }
4634#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4635 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4636 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4637#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4638 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4639 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4640#else
4641 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4642#endif
4643 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004644
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004645 /*
4646 * Preset-specific defaults
4647 */
4648 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004649 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004650 /*
4651 * NSA Suite B
4652 */
4653 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004654
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004655 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004656
4657#if defined(MBEDTLS_X509_CRT_PARSE_C)
4658 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004659#endif
4660
Gilles Peskineeccd8882020-03-10 12:19:08 +01004661#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004662#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4663 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4664 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4665 else
4666#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4667 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004668#endif
4669
Brett Warrene0edc842021-08-17 09:53:13 +01004670#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4671 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004672#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004673 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004674 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004675
4676 /*
4677 * Default
4678 */
4679 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004680
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004681 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004682
4683#if defined(MBEDTLS_X509_CRT_PARSE_C)
4684 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4685#endif
4686
Gilles Peskineeccd8882020-03-10 12:19:08 +01004687#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004688#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4689 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4690 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4691 else
4692#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4693 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004694#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004695
Brett Warrene0edc842021-08-17 09:53:13 +01004696#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4697 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004698#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004699 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004700
4701#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4702 conf->dhm_min_bitlen = 1024;
4703#endif
4704 }
4705
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004706 return( 0 );
4707}
4708
4709/*
4710 * Free mbedtls_ssl_config
4711 */
4712void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4713{
4714#if defined(MBEDTLS_DHM_C)
4715 mbedtls_mpi_free( &conf->dhm_P );
4716 mbedtls_mpi_free( &conf->dhm_G );
4717#endif
4718
Gilles Peskineeccd8882020-03-10 12:19:08 +01004719#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004720#if defined(MBEDTLS_USE_PSA_CRYPTO)
4721 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4722 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004723 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4724 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004725#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004726 if( conf->psk != NULL )
4727 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004728 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004729 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004730 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004731 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004732 }
4733
4734 if( conf->psk_identity != NULL )
4735 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004736 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004737 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004738 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004739 conf->psk_identity_len = 0;
4740 }
4741#endif
4742
4743#if defined(MBEDTLS_X509_CRT_PARSE_C)
4744 ssl_key_cert_free( conf->key_cert );
4745#endif
4746
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004747 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004748}
4749
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004750#if defined(MBEDTLS_PK_C) && \
4751 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004752/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004756{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757#if defined(MBEDTLS_RSA_C)
4758 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4759 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004760#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761#if defined(MBEDTLS_ECDSA_C)
4762 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4763 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004764#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004766}
4767
Hanno Becker7e5437a2017-04-28 17:15:26 +01004768unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4769{
4770 switch( type ) {
4771 case MBEDTLS_PK_RSA:
4772 return( MBEDTLS_SSL_SIG_RSA );
4773 case MBEDTLS_PK_ECDSA:
4774 case MBEDTLS_PK_ECKEY:
4775 return( MBEDTLS_SSL_SIG_ECDSA );
4776 default:
4777 return( MBEDTLS_SSL_SIG_ANON );
4778 }
4779}
4780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004782{
4783 switch( sig )
4784 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785#if defined(MBEDTLS_RSA_C)
4786 case MBEDTLS_SSL_SIG_RSA:
4787 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004788#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789#if defined(MBEDTLS_ECDSA_C)
4790 case MBEDTLS_SSL_SIG_ECDSA:
4791 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004792#endif
4793 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004795 }
4796}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004797#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004798
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004799/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004800 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004803{
4804 switch( hash )
4805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004806#if defined(MBEDTLS_MD5_C)
4807 case MBEDTLS_SSL_HASH_MD5:
4808 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004809#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004810#if defined(MBEDTLS_SHA1_C)
4811 case MBEDTLS_SSL_HASH_SHA1:
4812 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004813#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004814#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004815 case MBEDTLS_SSL_HASH_SHA224:
4816 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004817#endif
4818#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004819 case MBEDTLS_SSL_HASH_SHA256:
4820 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004821#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004822#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823 case MBEDTLS_SSL_HASH_SHA384:
4824 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004825#endif
4826#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827 case MBEDTLS_SSL_HASH_SHA512:
4828 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004829#endif
4830 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004832 }
4833}
4834
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004835/*
4836 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4837 */
4838unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4839{
4840 switch( md )
4841 {
4842#if defined(MBEDTLS_MD5_C)
4843 case MBEDTLS_MD_MD5:
4844 return( MBEDTLS_SSL_HASH_MD5 );
4845#endif
4846#if defined(MBEDTLS_SHA1_C)
4847 case MBEDTLS_MD_SHA1:
4848 return( MBEDTLS_SSL_HASH_SHA1 );
4849#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004850#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004851 case MBEDTLS_MD_SHA224:
4852 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004853#endif
4854#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004855 case MBEDTLS_MD_SHA256:
4856 return( MBEDTLS_SSL_HASH_SHA256 );
4857#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004858#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004859 case MBEDTLS_MD_SHA384:
4860 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004861#endif
4862#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004863 case MBEDTLS_MD_SHA512:
4864 return( MBEDTLS_SSL_HASH_SHA512 );
4865#endif
4866 default:
4867 return( MBEDTLS_SSL_HASH_NONE );
4868 }
4869}
4870
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004871/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004872 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004873 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004874 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004875int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004876{
Brett Warrene0edc842021-08-17 09:53:13 +01004877 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004878
Brett Warrene0edc842021-08-17 09:53:13 +01004879 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004880 return( -1 );
4881
Brett Warrene0edc842021-08-17 09:53:13 +01004882 for( ; *group_list != 0; group_list++ )
4883 {
4884 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004885 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004886 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004887
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004888 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004889}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004890
4891#if defined(MBEDTLS_ECP_C)
4892/*
4893 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4894 */
4895int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4896{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004897 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004898 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4899}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004900#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004902#if defined(MBEDTLS_X509_CRT_PARSE_C)
4903int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4904 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004905 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004906 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004907{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004908 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004909 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004910 const char *ext_oid;
4911 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004914 {
4915 /* Server part of the key exchange */
4916 switch( ciphersuite->key_exchange )
4917 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004918 case MBEDTLS_KEY_EXCHANGE_RSA:
4919 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004920 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004921 break;
4922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004923 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4924 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4925 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4926 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004927 break;
4928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004929 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4930 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004931 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004932 break;
4933
4934 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935 case MBEDTLS_KEY_EXCHANGE_NONE:
4936 case MBEDTLS_KEY_EXCHANGE_PSK:
4937 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4938 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004939 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004940 usage = 0;
4941 }
4942 }
4943 else
4944 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004945 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4946 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004947 }
4948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004949 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004950 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004951 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004952 ret = -1;
4953 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004956 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004957 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4958 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004959 }
4960 else
4961 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004962 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4963 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004964 }
4965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004967 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004968 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004969 ret = -1;
4970 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004971
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004972 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004973}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004974#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004975
Jerry Yu148165c2021-09-24 23:20:59 +08004976#if defined(MBEDTLS_USE_PSA_CRYPTO)
4977int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4978 const mbedtls_md_type_t md,
4979 unsigned char *dst,
4980 size_t dst_len,
4981 size_t *olen )
4982{
Ronald Cronf6893e12022-01-07 22:09:01 +01004983 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4984 psa_hash_operation_t *hash_operation_to_clone;
4985 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4986
Jerry Yu148165c2021-09-24 23:20:59 +08004987 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004988
4989 switch( md )
4990 {
4991#if defined(MBEDTLS_SHA384_C)
4992 case MBEDTLS_MD_SHA384:
4993 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4994 break;
4995#endif
4996
4997#if defined(MBEDTLS_SHA256_C)
4998 case MBEDTLS_MD_SHA256:
4999 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5000 break;
5001#endif
5002
5003 default:
5004 goto exit;
5005 }
5006
5007 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5008 if( status != PSA_SUCCESS )
5009 goto exit;
5010
5011 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5012 if( status != PSA_SUCCESS )
5013 goto exit;
5014
5015exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005016 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005017}
5018#else /* MBEDTLS_USE_PSA_CRYPTO */
5019
Jerry Yu24c0ec32021-09-09 14:21:07 +08005020#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005021MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005022static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5023 unsigned char *dst,
5024 size_t dst_len,
5025 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005026{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005027 int ret;
5028 mbedtls_sha512_context sha512;
5029
5030 if( dst_len < 48 )
5031 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5032
5033 mbedtls_sha512_init( &sha512 );
5034 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5035
5036 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5037 {
5038 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5039 goto exit;
5040 }
5041
5042 *olen = 48;
5043
5044exit:
5045
5046 mbedtls_sha512_free( &sha512 );
5047 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005048}
5049#endif /* MBEDTLS_SHA384_C */
5050
5051#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005052MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005053static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5054 unsigned char *dst,
5055 size_t dst_len,
5056 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005057{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005058 int ret;
5059 mbedtls_sha256_context sha256;
5060
5061 if( dst_len < 32 )
5062 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5063
5064 mbedtls_sha256_init( &sha256 );
5065 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005066
Jerry Yu24c0ec32021-09-09 14:21:07 +08005067 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5068 {
5069 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5070 goto exit;
5071 }
5072
5073 *olen = 32;
5074
5075exit:
5076
5077 mbedtls_sha256_free( &sha256 );
5078 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005079}
5080#endif /* MBEDTLS_SHA256_C */
5081
Jerry Yu000f9762021-09-14 11:12:51 +08005082int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5083 const mbedtls_md_type_t md,
5084 unsigned char *dst,
5085 size_t dst_len,
5086 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005087{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005088 switch( md )
5089 {
5090
Jerry Yu24c0ec32021-09-09 14:21:07 +08005091#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005092 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005093 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005094#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005095
Jerry Yu24c0ec32021-09-09 14:21:07 +08005096#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005097 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005098 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005099#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005100
5101 default:
5102 break;
5103 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005105}
XiaokangQian647719a2021-12-07 09:16:29 +00005106
Jerry Yu148165c2021-09-24 23:20:59 +08005107#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005108
Gabor Mezei078e8032022-04-27 21:17:56 +02005109#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5110/* mbedtls_ssl_parse_sig_alg_ext()
5111 *
5112 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5113 * value (TLS 1.3 RFC8446):
5114 * enum {
5115 * ....
5116 * ecdsa_secp256r1_sha256( 0x0403 ),
5117 * ecdsa_secp384r1_sha384( 0x0503 ),
5118 * ecdsa_secp521r1_sha512( 0x0603 ),
5119 * ....
5120 * } SignatureScheme;
5121 *
5122 * struct {
5123 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5124 * } SignatureSchemeList;
5125 *
5126 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5127 * value (TLS 1.2 RFC5246):
5128 * enum {
5129 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5130 * sha512(6), (255)
5131 * } HashAlgorithm;
5132 *
5133 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5134 * SignatureAlgorithm;
5135 *
5136 * struct {
5137 * HashAlgorithm hash;
5138 * SignatureAlgorithm signature;
5139 * } SignatureAndHashAlgorithm;
5140 *
5141 * SignatureAndHashAlgorithm
5142 * supported_signature_algorithms<2..2^16-2>;
5143 *
5144 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5145 * generalization of the TLS 1.2 signature algorithm extension.
5146 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5147 * `SignatureScheme` field of TLS 1.3
5148 *
5149 */
5150int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5151 const unsigned char *buf,
5152 const unsigned char *end )
5153{
5154 const unsigned char *p = buf;
5155 size_t supported_sig_algs_len = 0;
5156 const unsigned char *supported_sig_algs_end;
5157 uint16_t sig_alg;
5158 uint32_t common_idx = 0;
5159
5160 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5161 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5162 p += 2;
5163
5164 memset( ssl->handshake->received_sig_algs, 0,
5165 sizeof(ssl->handshake->received_sig_algs) );
5166
5167 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5168 supported_sig_algs_end = p + supported_sig_algs_len;
5169 while( p < supported_sig_algs_end )
5170 {
5171 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5172 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5173 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005174 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5175 sig_alg,
5176 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005177#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005178 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005179 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5180 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5181 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005182 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005183 }
5184#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005185
Jerry Yuf3b46b52022-06-19 16:52:27 +08005186 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5187 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005188
5189 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5190 {
5191 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5192 common_idx += 1;
5193 }
5194 }
5195 /* Check that we consumed all the message. */
5196 if( p != end )
5197 {
5198 MBEDTLS_SSL_DEBUG_MSG( 1,
5199 ( "Signature algorithms extension length misaligned" ) );
5200 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5201 MBEDTLS_ERR_SSL_DECODE_ERROR );
5202 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5203 }
5204
5205 if( common_idx == 0 )
5206 {
5207 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5208 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5209 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5210 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5211 }
5212
Gabor Mezei15b95a62022-05-09 16:37:58 +02005213 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005214 return( 0 );
5215}
5216
5217#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5218
Jerry Yudc7bd172022-02-17 13:44:15 +08005219#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5220
5221#if defined(MBEDTLS_USE_PSA_CRYPTO)
5222
5223static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5224 mbedtls_svc_key_id_t key,
5225 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005226 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005227 const unsigned char* seed, size_t seed_length,
5228 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005229 const unsigned char* other_secret,
5230 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005231 size_t capacity )
5232{
5233 psa_status_t status;
5234
5235 status = psa_key_derivation_setup( derivation, alg );
5236 if( status != PSA_SUCCESS )
5237 return( status );
5238
5239 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5240 {
5241 status = psa_key_derivation_input_bytes( derivation,
5242 PSA_KEY_DERIVATION_INPUT_SEED,
5243 seed, seed_length );
5244 if( status != PSA_SUCCESS )
5245 return( status );
5246
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005247 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005248 {
5249 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005250 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5251 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005252 if( status != PSA_SUCCESS )
5253 return( status );
5254 }
5255
Jerry Yudc7bd172022-02-17 13:44:15 +08005256 if( mbedtls_svc_key_id_is_null( key ) )
5257 {
5258 status = psa_key_derivation_input_bytes(
5259 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005260 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005261 }
5262 else
5263 {
5264 status = psa_key_derivation_input_key(
5265 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5266 }
5267 if( status != PSA_SUCCESS )
5268 return( status );
5269
5270 status = psa_key_derivation_input_bytes( derivation,
5271 PSA_KEY_DERIVATION_INPUT_LABEL,
5272 label, label_length );
5273 if( status != PSA_SUCCESS )
5274 return( status );
5275 }
5276 else
5277 {
5278 return( PSA_ERROR_NOT_SUPPORTED );
5279 }
5280
5281 status = psa_key_derivation_set_capacity( derivation, capacity );
5282 if( status != PSA_SUCCESS )
5283 return( status );
5284
5285 return( PSA_SUCCESS );
5286}
5287
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005288MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005289static int tls_prf_generic( mbedtls_md_type_t md_type,
5290 const unsigned char *secret, size_t slen,
5291 const char *label,
5292 const unsigned char *random, size_t rlen,
5293 unsigned char *dstbuf, size_t dlen )
5294{
5295 psa_status_t status;
5296 psa_algorithm_t alg;
5297 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5298 psa_key_derivation_operation_t derivation =
5299 PSA_KEY_DERIVATION_OPERATION_INIT;
5300
5301 if( md_type == MBEDTLS_MD_SHA384 )
5302 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5303 else
5304 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5305
5306 /* Normally a "secret" should be long enough to be impossible to
5307 * find by brute force, and in particular should not be empty. But
5308 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5309 * and for this use case it makes sense to have a 0-length "secret".
5310 * Since the key API doesn't allow importing a key of length 0,
5311 * keep master_key=0, which setup_psa_key_derivation() understands
5312 * to mean a 0-length "secret" input. */
5313 if( slen != 0 )
5314 {
5315 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5316 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5317 psa_set_key_algorithm( &key_attributes, alg );
5318 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5319
5320 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5321 if( status != PSA_SUCCESS )
5322 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5323 }
5324
5325 status = setup_psa_key_derivation( &derivation,
5326 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005327 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005328 random, rlen,
5329 (unsigned char const *) label,
5330 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005331 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005332 dlen );
5333 if( status != PSA_SUCCESS )
5334 {
5335 psa_key_derivation_abort( &derivation );
5336 psa_destroy_key( master_key );
5337 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5338 }
5339
5340 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5341 if( status != PSA_SUCCESS )
5342 {
5343 psa_key_derivation_abort( &derivation );
5344 psa_destroy_key( master_key );
5345 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5346 }
5347
5348 status = psa_key_derivation_abort( &derivation );
5349 if( status != PSA_SUCCESS )
5350 {
5351 psa_destroy_key( master_key );
5352 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5353 }
5354
5355 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5356 status = psa_destroy_key( master_key );
5357 if( status != PSA_SUCCESS )
5358 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5359
5360 return( 0 );
5361}
5362
5363#else /* MBEDTLS_USE_PSA_CRYPTO */
5364
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005365MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005366static int tls_prf_generic( mbedtls_md_type_t md_type,
5367 const unsigned char *secret, size_t slen,
5368 const char *label,
5369 const unsigned char *random, size_t rlen,
5370 unsigned char *dstbuf, size_t dlen )
5371{
5372 size_t nb;
5373 size_t i, j, k, md_len;
5374 unsigned char *tmp;
5375 size_t tmp_len = 0;
5376 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5377 const mbedtls_md_info_t *md_info;
5378 mbedtls_md_context_t md_ctx;
5379 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5380
5381 mbedtls_md_init( &md_ctx );
5382
5383 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5384 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5385
5386 md_len = mbedtls_md_get_size( md_info );
5387
5388 tmp_len = md_len + strlen( label ) + rlen;
5389 tmp = mbedtls_calloc( 1, tmp_len );
5390 if( tmp == NULL )
5391 {
5392 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5393 goto exit;
5394 }
5395
5396 nb = strlen( label );
5397 memcpy( tmp + md_len, label, nb );
5398 memcpy( tmp + md_len + nb, random, rlen );
5399 nb += rlen;
5400
5401 /*
5402 * Compute P_<hash>(secret, label + random)[0..dlen]
5403 */
5404 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5405 goto exit;
5406
5407 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5408 if( ret != 0 )
5409 goto exit;
5410 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5411 if( ret != 0 )
5412 goto exit;
5413 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5414 if( ret != 0 )
5415 goto exit;
5416
5417 for( i = 0; i < dlen; i += md_len )
5418 {
5419 ret = mbedtls_md_hmac_reset ( &md_ctx );
5420 if( ret != 0 )
5421 goto exit;
5422 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5423 if( ret != 0 )
5424 goto exit;
5425 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5426 if( ret != 0 )
5427 goto exit;
5428
5429 ret = mbedtls_md_hmac_reset ( &md_ctx );
5430 if( ret != 0 )
5431 goto exit;
5432 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5433 if( ret != 0 )
5434 goto exit;
5435 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5436 if( ret != 0 )
5437 goto exit;
5438
5439 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5440
5441 for( j = 0; j < k; j++ )
5442 dstbuf[i + j] = h_i[j];
5443 }
5444
5445exit:
5446 mbedtls_md_free( &md_ctx );
5447
5448 mbedtls_platform_zeroize( tmp, tmp_len );
5449 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5450
5451 mbedtls_free( tmp );
5452
5453 return( ret );
5454}
5455#endif /* MBEDTLS_USE_PSA_CRYPTO */
5456
5457#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005458MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005459static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5460 const char *label,
5461 const unsigned char *random, size_t rlen,
5462 unsigned char *dstbuf, size_t dlen )
5463{
5464 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5465 label, random, rlen, dstbuf, dlen ) );
5466}
5467#endif /* MBEDTLS_SHA256_C */
5468
5469#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005470MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005471static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5472 const char *label,
5473 const unsigned char *random, size_t rlen,
5474 unsigned char *dstbuf, size_t dlen )
5475{
5476 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5477 label, random, rlen, dstbuf, dlen ) );
5478}
5479#endif /* MBEDTLS_SHA384_C */
5480
Jerry Yuf009d862022-02-17 14:01:37 +08005481/*
5482 * Set appropriate PRF function and other SSL / TLS1.2 functions
5483 *
5484 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005485 * - hash associated with the ciphersuite (only used by TLS 1.2)
5486 *
5487 * Outputs:
5488 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5489 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005490MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005491static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005492 mbedtls_md_type_t hash )
5493{
Jerry Yuf009d862022-02-17 14:01:37 +08005494#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005495 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005496 {
5497 handshake->tls_prf = tls_prf_sha384;
5498 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5499 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5500 }
5501 else
5502#endif
5503#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005504 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005505 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005506 handshake->tls_prf = tls_prf_sha256;
5507 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5508 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5509 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005510#else
Jerry Yuf009d862022-02-17 14:01:37 +08005511 {
Jerry Yuf009d862022-02-17 14:01:37 +08005512 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005513 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005514 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5515 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005516#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005517
5518 return( 0 );
5519}
Jerry Yud6ab2352022-02-17 14:03:43 +08005520
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005521/*
5522 * Compute master secret if needed
5523 *
5524 * Parameters:
5525 * [in/out] handshake
5526 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5527 * (PSA-PSK) ciphersuite_info, psk_opaque
5528 * [out] premaster (cleared)
5529 * [out] master
5530 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5531 * debug: conf->f_dbg, conf->p_dbg
5532 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005533 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005534 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005535MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005536static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5537 unsigned char *master,
5538 const mbedtls_ssl_context *ssl )
5539{
5540 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5541
5542 /* cf. RFC 5246, Section 8.1:
5543 * "The master secret is always exactly 48 bytes in length." */
5544 size_t const master_secret_len = 48;
5545
5546#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5547 unsigned char session_hash[48];
5548#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5549
5550 /* The label for the KDF used for key expansion.
5551 * This is either "master secret" or "extended master secret"
5552 * depending on whether the Extended Master Secret extension
5553 * is used. */
5554 char const *lbl = "master secret";
5555
Przemek Stekielae4ed302022-04-05 17:15:55 +02005556 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005557 * - If the Extended Master Secret extension is not used,
5558 * this is ClientHello.Random + ServerHello.Random
5559 * (see Sect. 8.1 in RFC 5246).
5560 * - If the Extended Master Secret extension is used,
5561 * this is the transcript of the handshake so far.
5562 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005563 unsigned char const *seed = handshake->randbytes;
5564 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005565
5566#if !defined(MBEDTLS_DEBUG_C) && \
5567 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5568 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5569 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5570 ssl = NULL; /* make sure we don't use it except for those cases */
5571 (void) ssl;
5572#endif
5573
5574 if( handshake->resume != 0 )
5575 {
5576 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5577 return( 0 );
5578 }
5579
5580#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5581 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5582 {
5583 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005584 seed = session_hash;
5585 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005586
5587 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005588 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005589 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005590#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005591
Przemek Stekiel99114f32022-04-22 11:20:09 +02005592#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005593 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005594 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005595 {
5596 /* Perform PSK-to-MS expansion in a single step. */
5597 psa_status_t status;
5598 psa_algorithm_t alg;
5599 mbedtls_svc_key_id_t psk;
5600 psa_key_derivation_operation_t derivation =
5601 PSA_KEY_DERIVATION_OPERATION_INIT;
5602 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5603
5604 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5605
5606 psk = mbedtls_ssl_get_opaque_psk( ssl );
5607
5608 if( hash_alg == MBEDTLS_MD_SHA384 )
5609 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5610 else
5611 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5612
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005613 size_t other_secret_len = 0;
5614 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005615
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005616 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005617 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005618 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005619 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005620 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005621 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005622 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005623 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005624 other_secret_len = 48;
5625 other_secret = handshake->premaster + 2;
5626 break;
5627 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005628 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005629 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5630 other_secret = handshake->premaster + 2;
5631 break;
5632 default:
5633 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005634 }
5635
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005636 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005637 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005638 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005639 (unsigned char const *) lbl,
5640 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005641 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005642 master_secret_len );
5643 if( status != PSA_SUCCESS )
5644 {
5645 psa_key_derivation_abort( &derivation );
5646 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5647 }
5648
5649 status = psa_key_derivation_output_bytes( &derivation,
5650 master,
5651 master_secret_len );
5652 if( status != PSA_SUCCESS )
5653 {
5654 psa_key_derivation_abort( &derivation );
5655 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5656 }
5657
5658 status = psa_key_derivation_abort( &derivation );
5659 if( status != PSA_SUCCESS )
5660 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5661 }
5662 else
5663#endif
5664 {
5665 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005666 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005667 master,
5668 master_secret_len );
5669 if( ret != 0 )
5670 {
5671 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5672 return( ret );
5673 }
5674
5675 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5676 handshake->premaster,
5677 handshake->pmslen );
5678
5679 mbedtls_platform_zeroize( handshake->premaster,
5680 sizeof(handshake->premaster) );
5681 }
5682
5683 return( 0 );
5684}
5685
Jerry Yud62f87e2022-02-17 14:09:02 +08005686int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5687{
5688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5689 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5690 ssl->handshake->ciphersuite_info;
5691
5692 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5693
5694 /* Set PRF, calc_verify and calc_finished function pointers */
5695 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005696 ciphersuite_info->mac );
5697 if( ret != 0 )
5698 {
5699 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5700 return( ret );
5701 }
5702
5703 /* Compute master secret if needed */
5704 ret = ssl_compute_master( ssl->handshake,
5705 ssl->session_negotiate->master,
5706 ssl );
5707 if( ret != 0 )
5708 {
5709 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5710 return( ret );
5711 }
5712
5713 /* Swap the client and server random values:
5714 * - MS derivation wanted client+server (RFC 5246 8.1)
5715 * - key derivation wants server+client (RFC 5246 6.3) */
5716 {
5717 unsigned char tmp[64];
5718 memcpy( tmp, ssl->handshake->randbytes, 64 );
5719 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5720 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5721 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5722 }
5723
5724 /* Populate transform structure */
5725 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5726 ssl->session_negotiate->ciphersuite,
5727 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005728#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005729 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005730#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005731 ssl->handshake->tls_prf,
5732 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005733 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005734 ssl->conf->endpoint,
5735 ssl );
5736 if( ret != 0 )
5737 {
5738 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5739 return( ret );
5740 }
5741
5742 /* We no longer need Server/ClientHello.random values */
5743 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5744 sizeof( ssl->handshake->randbytes ) );
5745
5746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5747
5748 return( 0 );
5749}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005750
Ronald Cron4dcbca92022-03-07 10:21:40 +01005751int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5752{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005753 switch( md )
5754 {
5755#if defined(MBEDTLS_SHA384_C)
5756 case MBEDTLS_SSL_HASH_SHA384:
5757 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5758 break;
5759#endif
5760#if defined(MBEDTLS_SHA256_C)
5761 case MBEDTLS_SSL_HASH_SHA256:
5762 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5763 break;
5764#endif
5765 default:
5766 return( -1 );
5767 }
5768
Ronald Cronc2f13a02022-03-07 10:25:24 +01005769 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005770}
5771
Jerry Yu8392e0d2022-02-17 14:10:24 +08005772#if defined(MBEDTLS_SHA256_C)
5773void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5774 unsigned char *hash,
5775 size_t *hlen )
5776{
5777#if defined(MBEDTLS_USE_PSA_CRYPTO)
5778 size_t hash_size;
5779 psa_status_t status;
5780 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5781
5782 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5783 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5784 if( status != PSA_SUCCESS )
5785 {
5786 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5787 return;
5788 }
5789
5790 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5791 if( status != PSA_SUCCESS )
5792 {
5793 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5794 return;
5795 }
5796
5797 *hlen = 32;
5798 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5800#else
5801 mbedtls_sha256_context sha256;
5802
5803 mbedtls_sha256_init( &sha256 );
5804
5805 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5806
5807 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5808 mbedtls_sha256_finish( &sha256, hash );
5809
5810 *hlen = 32;
5811
5812 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5814
5815 mbedtls_sha256_free( &sha256 );
5816#endif /* MBEDTLS_USE_PSA_CRYPTO */
5817 return;
5818}
5819#endif /* MBEDTLS_SHA256_C */
5820
Jerry Yuc1cb3842022-02-17 14:13:48 +08005821#if defined(MBEDTLS_SHA384_C)
5822void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5823 unsigned char *hash,
5824 size_t *hlen )
5825{
5826#if defined(MBEDTLS_USE_PSA_CRYPTO)
5827 size_t hash_size;
5828 psa_status_t status;
5829 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5830
5831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5832 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5833 if( status != PSA_SUCCESS )
5834 {
5835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5836 return;
5837 }
5838
5839 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5840 if( status != PSA_SUCCESS )
5841 {
5842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5843 return;
5844 }
5845
5846 *hlen = 48;
5847 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5849#else
5850 mbedtls_sha512_context sha512;
5851
5852 mbedtls_sha512_init( &sha512 );
5853
5854 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5855
5856 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5857 mbedtls_sha512_finish( &sha512, hash );
5858
5859 *hlen = 48;
5860
5861 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5863
5864 mbedtls_sha512_free( &sha512 );
5865#endif /* MBEDTLS_USE_PSA_CRYPTO */
5866 return;
5867}
5868#endif /* MBEDTLS_SHA384_C */
5869
Neil Armstrong80f6f322022-05-03 17:56:38 +02005870#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5871 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005872int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5873{
5874 unsigned char *p = ssl->handshake->premaster;
5875 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5876 const unsigned char *psk = NULL;
5877 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005878 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005879
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005880 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005881 {
5882 /*
5883 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005884 * checked before calling this function.
5885 *
5886 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005887 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005888 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005889 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5890 {
5891 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5892 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5893 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005894 }
5895
5896 /*
5897 * PMS = struct {
5898 * opaque other_secret<0..2^16-1>;
5899 * opaque psk<0..2^16-1>;
5900 * };
5901 * with "other_secret" depending on the particular key exchange
5902 */
5903#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5904 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5905 {
5906 if( end - p < 2 )
5907 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5908
5909 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5910 p += 2;
5911
5912 if( end < p || (size_t)( end - p ) < psk_len )
5913 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5914
5915 memset( p, 0, psk_len );
5916 p += psk_len;
5917 }
5918 else
5919#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5920#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5921 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5922 {
5923 /*
5924 * other_secret already set by the ClientKeyExchange message,
5925 * and is 48 bytes long
5926 */
5927 if( end - p < 2 )
5928 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5929
5930 *p++ = 0;
5931 *p++ = 48;
5932 p += 48;
5933 }
5934 else
5935#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5936#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5937 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5938 {
5939 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5940 size_t len;
5941
5942 /* Write length only when we know the actual value */
5943 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5944 p + 2, end - ( p + 2 ), &len,
5945 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5946 {
5947 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5948 return( ret );
5949 }
5950 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5951 p += 2 + len;
5952
5953 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5954 }
5955 else
5956#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005957#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005958 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5959 {
5960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5961 size_t zlen;
5962
5963 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5964 p + 2, end - ( p + 2 ),
5965 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5966 {
5967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5968 return( ret );
5969 }
5970
5971 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5972 p += 2 + zlen;
5973
5974 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5975 MBEDTLS_DEBUG_ECDH_Z );
5976 }
5977 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005978#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005979 {
5980 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5981 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5982 }
5983
5984 /* opaque psk<0..2^16-1>; */
5985 if( end - p < 2 )
5986 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5987
5988 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5989 p += 2;
5990
5991 if( end < p || (size_t)( end - p ) < psk_len )
5992 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5993
5994 memcpy( p, psk, psk_len );
5995 p += psk_len;
5996
5997 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5998
5999 return( 0 );
6000}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006001#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006002
6003#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006004MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006005static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6006
6007#if defined(MBEDTLS_SSL_PROTO_DTLS)
6008int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6009{
6010 /* If renegotiation is not enforced, retransmit until we would reach max
6011 * timeout if we were using the usual handshake doubling scheme */
6012 if( ssl->conf->renego_max_records < 0 )
6013 {
6014 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6015 unsigned char doublings = 1;
6016
6017 while( ratio != 0 )
6018 {
6019 ++doublings;
6020 ratio >>= 1;
6021 }
6022
6023 if( ++ssl->renego_records_seen > doublings )
6024 {
6025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6026 return( 0 );
6027 }
6028 }
6029
6030 return( ssl_write_hello_request( ssl ) );
6031}
6032#endif
6033#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006034
Jerry Yud9526692022-02-17 14:23:47 +08006035/*
6036 * Handshake functions
6037 */
6038#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6039/* No certificate support -> dummy functions */
6040int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6041{
6042 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6043 ssl->handshake->ciphersuite_info;
6044
6045 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6046
6047 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6048 {
6049 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6050 ssl->state++;
6051 return( 0 );
6052 }
6053
6054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6055 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6056}
6057
6058int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6059{
6060 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6061 ssl->handshake->ciphersuite_info;
6062
6063 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6064
6065 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6066 {
6067 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6068 ssl->state++;
6069 return( 0 );
6070 }
6071
6072 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6073 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6074}
6075
6076#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6077/* Some certificate support -> implement write and parse */
6078
6079int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6080{
6081 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6082 size_t i, n;
6083 const mbedtls_x509_crt *crt;
6084 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6085 ssl->handshake->ciphersuite_info;
6086
6087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6088
6089 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6090 {
6091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6092 ssl->state++;
6093 return( 0 );
6094 }
6095
6096#if defined(MBEDTLS_SSL_CLI_C)
6097 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6098 {
6099 if( ssl->handshake->client_auth == 0 )
6100 {
6101 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6102 ssl->state++;
6103 return( 0 );
6104 }
6105 }
6106#endif /* MBEDTLS_SSL_CLI_C */
6107#if defined(MBEDTLS_SSL_SRV_C)
6108 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6109 {
6110 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6111 {
6112 /* Should never happen because we shouldn't have picked the
6113 * ciphersuite if we don't have a certificate. */
6114 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6115 }
6116 }
6117#endif
6118
6119 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6120
6121 /*
6122 * 0 . 0 handshake type
6123 * 1 . 3 handshake length
6124 * 4 . 6 length of all certs
6125 * 7 . 9 length of cert. 1
6126 * 10 . n-1 peer certificate
6127 * n . n+2 length of cert. 2
6128 * n+3 . ... upper level cert, etc.
6129 */
6130 i = 7;
6131 crt = mbedtls_ssl_own_cert( ssl );
6132
6133 while( crt != NULL )
6134 {
6135 n = crt->raw.len;
6136 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6137 {
6138 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6139 " > %" MBEDTLS_PRINTF_SIZET,
6140 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6141 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6142 }
6143
6144 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6145 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6146 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6147
6148 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6149 i += n; crt = crt->next;
6150 }
6151
6152 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6153 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6154 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6155
6156 ssl->out_msglen = i;
6157 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6158 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6159
6160 ssl->state++;
6161
6162 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6163 {
6164 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6165 return( ret );
6166 }
6167
6168 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6169
6170 return( ret );
6171}
6172
6173#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6174
6175#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006176MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006177static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6178 unsigned char *crt_buf,
6179 size_t crt_buf_len )
6180{
6181 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6182
6183 if( peer_crt == NULL )
6184 return( -1 );
6185
6186 if( peer_crt->raw.len != crt_buf_len )
6187 return( -1 );
6188
6189 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6190}
6191#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006192MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006193static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6194 unsigned char *crt_buf,
6195 size_t crt_buf_len )
6196{
6197 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6198 unsigned char const * const peer_cert_digest =
6199 ssl->session->peer_cert_digest;
6200 mbedtls_md_type_t const peer_cert_digest_type =
6201 ssl->session->peer_cert_digest_type;
6202 mbedtls_md_info_t const * const digest_info =
6203 mbedtls_md_info_from_type( peer_cert_digest_type );
6204 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6205 size_t digest_len;
6206
6207 if( peer_cert_digest == NULL || digest_info == NULL )
6208 return( -1 );
6209
6210 digest_len = mbedtls_md_get_size( digest_info );
6211 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6212 return( -1 );
6213
6214 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6215 if( ret != 0 )
6216 return( -1 );
6217
6218 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6219}
6220#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6221#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6222
6223/*
6224 * Once the certificate message is read, parse it into a cert chain and
6225 * perform basic checks, but leave actual verification to the caller
6226 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006227MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006228static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6229 mbedtls_x509_crt *chain )
6230{
6231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6232#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6233 int crt_cnt=0;
6234#endif
6235 size_t i, n;
6236 uint8_t alert;
6237
6238 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6239 {
6240 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6241 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6242 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6243 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6244 }
6245
6246 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6247 {
6248 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6249 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6250 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6251 }
6252
6253 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
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_DECODE_ERROR );
6258 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6259 }
6260
6261 i = mbedtls_ssl_hs_hdr_len( ssl );
6262
6263 /*
6264 * Same message structure as in mbedtls_ssl_write_certificate()
6265 */
6266 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6267
6268 if( ssl->in_msg[i] != 0 ||
6269 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6270 {
6271 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6272 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6273 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6274 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6275 }
6276
6277 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6278 i += 3;
6279
6280 /* Iterate through and parse the CRTs in the provided chain. */
6281 while( i < ssl->in_hslen )
6282 {
6283 /* Check that there's room for the next CRT's length fields. */
6284 if ( i + 3 > ssl->in_hslen ) {
6285 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6286 mbedtls_ssl_send_alert_message( ssl,
6287 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6288 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6289 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6290 }
6291 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6292 * anything beyond 2**16 ~ 64K. */
6293 if( ssl->in_msg[i] != 0 )
6294 {
6295 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6296 mbedtls_ssl_send_alert_message( ssl,
6297 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6298 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6299 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6300 }
6301
6302 /* Read length of the next CRT in the chain. */
6303 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6304 | (unsigned int) ssl->in_msg[i + 2];
6305 i += 3;
6306
6307 if( n < 128 || i + n > ssl->in_hslen )
6308 {
6309 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6310 mbedtls_ssl_send_alert_message( ssl,
6311 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6312 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6313 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6314 }
6315
6316 /* Check if we're handling the first CRT in the chain. */
6317#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6318 if( crt_cnt++ == 0 &&
6319 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6320 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6321 {
6322 /* During client-side renegotiation, check that the server's
6323 * end-CRTs hasn't changed compared to the initial handshake,
6324 * mitigating the triple handshake attack. On success, reuse
6325 * the original end-CRT instead of parsing it again. */
6326 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6327 if( ssl_check_peer_crt_unchanged( ssl,
6328 &ssl->in_msg[i],
6329 n ) != 0 )
6330 {
6331 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6332 mbedtls_ssl_send_alert_message( ssl,
6333 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6334 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6335 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6336 }
6337
6338 /* Now we can safely free the original chain. */
6339 ssl_clear_peer_cert( ssl->session );
6340 }
6341#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6342
6343 /* Parse the next certificate in the chain. */
6344#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6345 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6346#else
6347 /* If we don't need to store the CRT chain permanently, parse
6348 * it in-place from the input buffer instead of making a copy. */
6349 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6350#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6351 switch( ret )
6352 {
6353 case 0: /*ok*/
6354 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6355 /* Ignore certificate with an unknown algorithm: maybe a
6356 prior certificate was already trusted. */
6357 break;
6358
6359 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6360 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6361 goto crt_parse_der_failed;
6362
6363 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6364 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6365 goto crt_parse_der_failed;
6366
6367 default:
6368 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6369 crt_parse_der_failed:
6370 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6371 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6372 return( ret );
6373 }
6374
6375 i += n;
6376 }
6377
6378 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6379 return( 0 );
6380}
6381
6382#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006383MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006384static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6385{
6386 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6387 return( -1 );
6388
6389 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6390 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6391 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6392 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6393 {
Ronald Cron19385882022-06-15 16:26:13 +02006394 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006395 return( 0 );
6396 }
6397 return( -1 );
6398}
6399#endif /* MBEDTLS_SSL_SRV_C */
6400
6401/* Check if a certificate message is expected.
6402 * Return either
6403 * - SSL_CERTIFICATE_EXPECTED, or
6404 * - SSL_CERTIFICATE_SKIP
6405 * indicating whether a Certificate message is expected or not.
6406 */
6407#define SSL_CERTIFICATE_EXPECTED 0
6408#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006409MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006410static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6411 int authmode )
6412{
6413 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6414 ssl->handshake->ciphersuite_info;
6415
6416 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6417 return( SSL_CERTIFICATE_SKIP );
6418
6419#if defined(MBEDTLS_SSL_SRV_C)
6420 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6421 {
6422 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6423 return( SSL_CERTIFICATE_SKIP );
6424
6425 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6426 {
6427 ssl->session_negotiate->verify_result =
6428 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6429 return( SSL_CERTIFICATE_SKIP );
6430 }
6431 }
6432#else
6433 ((void) authmode);
6434#endif /* MBEDTLS_SSL_SRV_C */
6435
6436 return( SSL_CERTIFICATE_EXPECTED );
6437}
6438
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006439MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006440static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6441 int authmode,
6442 mbedtls_x509_crt *chain,
6443 void *rs_ctx )
6444{
6445 int ret = 0;
6446 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6447 ssl->handshake->ciphersuite_info;
6448 int have_ca_chain = 0;
6449
6450 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6451 void *p_vrfy;
6452
6453 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6454 return( 0 );
6455
6456 if( ssl->f_vrfy != NULL )
6457 {
6458 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6459 f_vrfy = ssl->f_vrfy;
6460 p_vrfy = ssl->p_vrfy;
6461 }
6462 else
6463 {
6464 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6465 f_vrfy = ssl->conf->f_vrfy;
6466 p_vrfy = ssl->conf->p_vrfy;
6467 }
6468
6469 /*
6470 * Main check: verify certificate
6471 */
6472#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6473 if( ssl->conf->f_ca_cb != NULL )
6474 {
6475 ((void) rs_ctx);
6476 have_ca_chain = 1;
6477
6478 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6479 ret = mbedtls_x509_crt_verify_with_ca_cb(
6480 chain,
6481 ssl->conf->f_ca_cb,
6482 ssl->conf->p_ca_cb,
6483 ssl->conf->cert_profile,
6484 ssl->hostname,
6485 &ssl->session_negotiate->verify_result,
6486 f_vrfy, p_vrfy );
6487 }
6488 else
6489#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6490 {
6491 mbedtls_x509_crt *ca_chain;
6492 mbedtls_x509_crl *ca_crl;
6493
6494#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6495 if( ssl->handshake->sni_ca_chain != NULL )
6496 {
6497 ca_chain = ssl->handshake->sni_ca_chain;
6498 ca_crl = ssl->handshake->sni_ca_crl;
6499 }
6500 else
6501#endif
6502 {
6503 ca_chain = ssl->conf->ca_chain;
6504 ca_crl = ssl->conf->ca_crl;
6505 }
6506
6507 if( ca_chain != NULL )
6508 have_ca_chain = 1;
6509
6510 ret = mbedtls_x509_crt_verify_restartable(
6511 chain,
6512 ca_chain, ca_crl,
6513 ssl->conf->cert_profile,
6514 ssl->hostname,
6515 &ssl->session_negotiate->verify_result,
6516 f_vrfy, p_vrfy, rs_ctx );
6517 }
6518
6519 if( ret != 0 )
6520 {
6521 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6522 }
6523
6524#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6525 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6526 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6527#endif
6528
6529 /*
6530 * Secondary checks: always done, but change 'ret' only if it was 0
6531 */
6532
6533#if defined(MBEDTLS_ECP_C)
6534 {
6535 const mbedtls_pk_context *pk = &chain->pk;
6536
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006537 /* If certificate uses an EC key, make sure the curve is OK.
6538 * This is a public key, so it can't be opaque, so can_do() is a good
6539 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006540 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6541 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6542 {
6543 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6544
6545 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6546 if( ret == 0 )
6547 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6548 }
6549 }
6550#endif /* MBEDTLS_ECP_C */
6551
6552 if( mbedtls_ssl_check_cert_usage( chain,
6553 ciphersuite_info,
6554 ! ssl->conf->endpoint,
6555 &ssl->session_negotiate->verify_result ) != 0 )
6556 {
6557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6558 if( ret == 0 )
6559 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6560 }
6561
6562 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6563 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6564 * with details encoded in the verification flags. All other kinds
6565 * of error codes, including those from the user provided f_vrfy
6566 * functions, are treated as fatal and lead to a failure of
6567 * ssl_parse_certificate even if verification was optional. */
6568 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6569 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6570 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6571 {
6572 ret = 0;
6573 }
6574
6575 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6576 {
6577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6578 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6579 }
6580
6581 if( ret != 0 )
6582 {
6583 uint8_t alert;
6584
6585 /* The certificate may have been rejected for several reasons.
6586 Pick one and send the corresponding alert. Which alert to send
6587 may be a subject of debate in some cases. */
6588 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6589 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6590 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6591 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6592 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6593 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6594 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6595 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6596 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6597 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6598 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6599 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6600 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6601 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6602 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6603 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6604 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6605 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6606 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6607 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6608 else
6609 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6610 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6611 alert );
6612 }
6613
6614#if defined(MBEDTLS_DEBUG_C)
6615 if( ssl->session_negotiate->verify_result != 0 )
6616 {
6617 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6618 (unsigned int) ssl->session_negotiate->verify_result ) );
6619 }
6620 else
6621 {
6622 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6623 }
6624#endif /* MBEDTLS_DEBUG_C */
6625
6626 return( ret );
6627}
6628
6629#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006630MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006631static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6632 unsigned char *start, size_t len )
6633{
6634 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6635 /* Remember digest of the peer's end-CRT. */
6636 ssl->session_negotiate->peer_cert_digest =
6637 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6638 if( ssl->session_negotiate->peer_cert_digest == NULL )
6639 {
6640 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6641 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6642 mbedtls_ssl_send_alert_message( ssl,
6643 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6644 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6645
6646 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6647 }
6648
6649 ret = mbedtls_md( mbedtls_md_info_from_type(
6650 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6651 start, len,
6652 ssl->session_negotiate->peer_cert_digest );
6653
6654 ssl->session_negotiate->peer_cert_digest_type =
6655 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6656 ssl->session_negotiate->peer_cert_digest_len =
6657 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6658
6659 return( ret );
6660}
6661
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006662MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006663static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6664 unsigned char *start, size_t len )
6665{
6666 unsigned char *end = start + len;
6667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6668
6669 /* Make a copy of the peer's raw public key. */
6670 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6671 ret = mbedtls_pk_parse_subpubkey( &start, end,
6672 &ssl->handshake->peer_pubkey );
6673 if( ret != 0 )
6674 {
6675 /* We should have parsed the public key before. */
6676 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6677 }
6678
6679 return( 0 );
6680}
6681#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6682
6683int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6684{
6685 int ret = 0;
6686 int crt_expected;
6687#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6688 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6689 ? ssl->handshake->sni_authmode
6690 : ssl->conf->authmode;
6691#else
6692 const int authmode = ssl->conf->authmode;
6693#endif
6694 void *rs_ctx = NULL;
6695 mbedtls_x509_crt *chain = NULL;
6696
6697 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6698
6699 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6700 if( crt_expected == SSL_CERTIFICATE_SKIP )
6701 {
6702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6703 goto exit;
6704 }
6705
6706#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6707 if( ssl->handshake->ecrs_enabled &&
6708 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6709 {
6710 chain = ssl->handshake->ecrs_peer_cert;
6711 ssl->handshake->ecrs_peer_cert = NULL;
6712 goto crt_verify;
6713 }
6714#endif
6715
6716 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6717 {
6718 /* mbedtls_ssl_read_record may have sent an alert already. We
6719 let it decide whether to alert. */
6720 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6721 goto exit;
6722 }
6723
6724#if defined(MBEDTLS_SSL_SRV_C)
6725 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6726 {
6727 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6728
6729 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6730 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6731
6732 goto exit;
6733 }
6734#endif /* MBEDTLS_SSL_SRV_C */
6735
6736 /* Clear existing peer CRT structure in case we tried to
6737 * reuse a session but it failed, and allocate a new one. */
6738 ssl_clear_peer_cert( ssl->session_negotiate );
6739
6740 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6741 if( chain == NULL )
6742 {
6743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6744 sizeof( mbedtls_x509_crt ) ) );
6745 mbedtls_ssl_send_alert_message( ssl,
6746 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6747 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6748
6749 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6750 goto exit;
6751 }
6752 mbedtls_x509_crt_init( chain );
6753
6754 ret = ssl_parse_certificate_chain( ssl, chain );
6755 if( ret != 0 )
6756 goto exit;
6757
6758#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6759 if( ssl->handshake->ecrs_enabled)
6760 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6761
6762crt_verify:
6763 if( ssl->handshake->ecrs_enabled)
6764 rs_ctx = &ssl->handshake->ecrs_ctx;
6765#endif
6766
6767 ret = ssl_parse_certificate_verify( ssl, authmode,
6768 chain, rs_ctx );
6769 if( ret != 0 )
6770 goto exit;
6771
6772#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6773 {
6774 unsigned char *crt_start, *pk_start;
6775 size_t crt_len, pk_len;
6776
6777 /* We parse the CRT chain without copying, so
6778 * these pointers point into the input buffer,
6779 * and are hence still valid after freeing the
6780 * CRT chain. */
6781
6782 crt_start = chain->raw.p;
6783 crt_len = chain->raw.len;
6784
6785 pk_start = chain->pk_raw.p;
6786 pk_len = chain->pk_raw.len;
6787
6788 /* Free the CRT structures before computing
6789 * digest and copying the peer's public key. */
6790 mbedtls_x509_crt_free( chain );
6791 mbedtls_free( chain );
6792 chain = NULL;
6793
6794 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6795 if( ret != 0 )
6796 goto exit;
6797
6798 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6799 if( ret != 0 )
6800 goto exit;
6801 }
6802#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6803 /* Pass ownership to session structure. */
6804 ssl->session_negotiate->peer_cert = chain;
6805 chain = NULL;
6806#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6807
6808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6809
6810exit:
6811
6812 if( ret == 0 )
6813 ssl->state++;
6814
6815#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6816 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6817 {
6818 ssl->handshake->ecrs_peer_cert = chain;
6819 chain = NULL;
6820 }
6821#endif
6822
6823 if( chain != NULL )
6824 {
6825 mbedtls_x509_crt_free( chain );
6826 mbedtls_free( chain );
6827 }
6828
6829 return( ret );
6830}
6831#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6832
Jerry Yu615bd6f2022-02-17 14:25:15 +08006833#if defined(MBEDTLS_SHA256_C)
6834static void ssl_calc_finished_tls_sha256(
6835 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6836{
6837 int len = 12;
6838 const char *sender;
6839 unsigned char padbuf[32];
6840#if defined(MBEDTLS_USE_PSA_CRYPTO)
6841 size_t hash_size;
6842 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6843 psa_status_t status;
6844#else
6845 mbedtls_sha256_context sha256;
6846#endif
6847
6848 mbedtls_ssl_session *session = ssl->session_negotiate;
6849 if( !session )
6850 session = ssl->session;
6851
6852 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6853 ? "client finished"
6854 : "server finished";
6855
6856#if defined(MBEDTLS_USE_PSA_CRYPTO)
6857 sha256_psa = psa_hash_operation_init();
6858
6859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6860
6861 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6862 if( status != PSA_SUCCESS )
6863 {
6864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6865 return;
6866 }
6867
6868 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6869 if( status != PSA_SUCCESS )
6870 {
6871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6872 return;
6873 }
6874 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6875#else
6876
6877 mbedtls_sha256_init( &sha256 );
6878
6879 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6880
6881 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6882
6883 /*
6884 * TLSv1.2:
6885 * hash = PRF( master, finished_label,
6886 * Hash( handshake ) )[0.11]
6887 */
6888
6889#if !defined(MBEDTLS_SHA256_ALT)
6890 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6891 sha256.state, sizeof( sha256.state ) );
6892#endif
6893
6894 mbedtls_sha256_finish( &sha256, padbuf );
6895 mbedtls_sha256_free( &sha256 );
6896#endif /* MBEDTLS_USE_PSA_CRYPTO */
6897
6898 ssl->handshake->tls_prf( session->master, 48, sender,
6899 padbuf, 32, buf, len );
6900
6901 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6902
6903 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6904
6905 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6906}
6907#endif /* MBEDTLS_SHA256_C */
6908
Jerry Yub7ba49e2022-02-17 14:25:53 +08006909
6910#if defined(MBEDTLS_SHA384_C)
6911
6912static void ssl_calc_finished_tls_sha384(
6913 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6914{
6915 int len = 12;
6916 const char *sender;
6917 unsigned char padbuf[48];
6918#if defined(MBEDTLS_USE_PSA_CRYPTO)
6919 size_t hash_size;
6920 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6921 psa_status_t status;
6922#else
6923 mbedtls_sha512_context sha512;
6924#endif
6925
6926 mbedtls_ssl_session *session = ssl->session_negotiate;
6927 if( !session )
6928 session = ssl->session;
6929
6930 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6931 ? "client finished"
6932 : "server finished";
6933
6934#if defined(MBEDTLS_USE_PSA_CRYPTO)
6935 sha384_psa = psa_hash_operation_init();
6936
6937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6938
6939 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6940 if( status != PSA_SUCCESS )
6941 {
6942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6943 return;
6944 }
6945
6946 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6947 if( status != PSA_SUCCESS )
6948 {
6949 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6950 return;
6951 }
6952 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6953#else
6954 mbedtls_sha512_init( &sha512 );
6955
6956 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6957
6958 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6959
6960 /*
6961 * TLSv1.2:
6962 * hash = PRF( master, finished_label,
6963 * Hash( handshake ) )[0.11]
6964 */
6965
6966#if !defined(MBEDTLS_SHA512_ALT)
6967 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6968 sha512.state, sizeof( sha512.state ) );
6969#endif
6970 mbedtls_sha512_finish( &sha512, padbuf );
6971
6972 mbedtls_sha512_free( &sha512 );
6973#endif
6974
6975 ssl->handshake->tls_prf( session->master, 48, sender,
6976 padbuf, 48, buf, len );
6977
6978 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6979
6980 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6981
6982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6983}
6984#endif /* MBEDTLS_SHA384_C */
6985
Jerry Yuaef00152022-02-17 14:27:31 +08006986void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6987{
6988 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6989
6990 /*
6991 * Free our handshake params
6992 */
6993 mbedtls_ssl_handshake_free( ssl );
6994 mbedtls_free( ssl->handshake );
6995 ssl->handshake = NULL;
6996
6997 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006998 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006999 */
7000 if( ssl->transform )
7001 {
7002 mbedtls_ssl_transform_free( ssl->transform );
7003 mbedtls_free( ssl->transform );
7004 }
7005 ssl->transform = ssl->transform_negotiate;
7006 ssl->transform_negotiate = NULL;
7007
7008 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7009}
7010
Jerry Yu2a9fff52022-02-17 14:28:51 +08007011void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7012{
7013 int resume = ssl->handshake->resume;
7014
7015 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7016
7017#if defined(MBEDTLS_SSL_RENEGOTIATION)
7018 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7019 {
7020 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7021 ssl->renego_records_seen = 0;
7022 }
7023#endif
7024
7025 /*
7026 * Free the previous session and switch in the current one
7027 */
7028 if( ssl->session )
7029 {
7030#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7031 /* RFC 7366 3.1: keep the EtM state */
7032 ssl->session_negotiate->encrypt_then_mac =
7033 ssl->session->encrypt_then_mac;
7034#endif
7035
7036 mbedtls_ssl_session_free( ssl->session );
7037 mbedtls_free( ssl->session );
7038 }
7039 ssl->session = ssl->session_negotiate;
7040 ssl->session_negotiate = NULL;
7041
7042 /*
7043 * Add cache entry
7044 */
7045 if( ssl->conf->f_set_cache != NULL &&
7046 ssl->session->id_len != 0 &&
7047 resume == 0 )
7048 {
7049 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7050 ssl->session->id,
7051 ssl->session->id_len,
7052 ssl->session ) != 0 )
7053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7054 }
7055
7056#if defined(MBEDTLS_SSL_PROTO_DTLS)
7057 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7058 ssl->handshake->flight != NULL )
7059 {
7060 /* Cancel handshake timer */
7061 mbedtls_ssl_set_timer( ssl, 0 );
7062
7063 /* Keep last flight around in case we need to resend it:
7064 * we need the handshake and transform structures for that */
7065 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7066 }
7067 else
7068#endif
7069 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7070
7071 ssl->state++;
7072
7073 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7074}
7075
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007076int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7077{
7078 int ret, hash_len;
7079
7080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7081
7082 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7083
7084 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7085
7086 /*
7087 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7088 * may define some other value. Currently (early 2016), no defined
7089 * ciphersuite does this (and this is unlikely to change as activity has
7090 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7091 */
7092 hash_len = 12;
7093
7094#if defined(MBEDTLS_SSL_RENEGOTIATION)
7095 ssl->verify_data_len = hash_len;
7096 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7097#endif
7098
7099 ssl->out_msglen = 4 + hash_len;
7100 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7101 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7102
7103 /*
7104 * In case of session resuming, invert the client and server
7105 * ChangeCipherSpec messages order.
7106 */
7107 if( ssl->handshake->resume != 0 )
7108 {
7109#if defined(MBEDTLS_SSL_CLI_C)
7110 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7111 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7112#endif
7113#if defined(MBEDTLS_SSL_SRV_C)
7114 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7115 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7116#endif
7117 }
7118 else
7119 ssl->state++;
7120
7121 /*
7122 * Switch to our negotiated transform and session parameters for outbound
7123 * data.
7124 */
7125 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7126
7127#if defined(MBEDTLS_SSL_PROTO_DTLS)
7128 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7129 {
7130 unsigned char i;
7131
7132 /* Remember current epoch settings for resending */
7133 ssl->handshake->alt_transform_out = ssl->transform_out;
7134 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7135 sizeof( ssl->handshake->alt_out_ctr ) );
7136
7137 /* Set sequence_number to zero */
7138 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7139
7140
7141 /* Increment epoch */
7142 for( i = 2; i > 0; i-- )
7143 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7144 break;
7145
7146 /* The loop goes to its end iff the counter is wrapping */
7147 if( i == 0 )
7148 {
7149 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7150 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7151 }
7152 }
7153 else
7154#endif /* MBEDTLS_SSL_PROTO_DTLS */
7155 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7156
7157 ssl->transform_out = ssl->transform_negotiate;
7158 ssl->session_out = ssl->session_negotiate;
7159
7160#if defined(MBEDTLS_SSL_PROTO_DTLS)
7161 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7162 mbedtls_ssl_send_flight_completed( ssl );
7163#endif
7164
7165 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7166 {
7167 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7168 return( ret );
7169 }
7170
7171#if defined(MBEDTLS_SSL_PROTO_DTLS)
7172 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7173 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7174 {
7175 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7176 return( ret );
7177 }
7178#endif
7179
7180 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7181
7182 return( 0 );
7183}
7184
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007185#define SSL_MAX_HASH_LEN 12
7186
7187int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7188{
7189 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7190 unsigned int hash_len = 12;
7191 unsigned char buf[SSL_MAX_HASH_LEN];
7192
7193 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7194
7195 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7196
7197 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7198 {
7199 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7200 goto exit;
7201 }
7202
7203 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7204 {
7205 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7206 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7207 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7208 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7209 goto exit;
7210 }
7211
7212 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7213 {
7214 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7215 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7216 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7217 goto exit;
7218 }
7219
7220 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7221 {
7222 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7223 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7224 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7225 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7226 goto exit;
7227 }
7228
7229 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7230 buf, hash_len ) != 0 )
7231 {
7232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7233 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7234 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7235 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7236 goto exit;
7237 }
7238
7239#if defined(MBEDTLS_SSL_RENEGOTIATION)
7240 ssl->verify_data_len = hash_len;
7241 memcpy( ssl->peer_verify_data, buf, hash_len );
7242#endif
7243
7244 if( ssl->handshake->resume != 0 )
7245 {
7246#if defined(MBEDTLS_SSL_CLI_C)
7247 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7248 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7249#endif
7250#if defined(MBEDTLS_SSL_SRV_C)
7251 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7252 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7253#endif
7254 }
7255 else
7256 ssl->state++;
7257
7258#if defined(MBEDTLS_SSL_PROTO_DTLS)
7259 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7260 mbedtls_ssl_recv_flight_completed( ssl );
7261#endif
7262
7263 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7264
7265exit:
7266 mbedtls_platform_zeroize( buf, hash_len );
7267 return( ret );
7268}
7269
Jerry Yu392112c2022-02-17 14:34:10 +08007270#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7271/*
7272 * Helper to get TLS 1.2 PRF from ciphersuite
7273 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7274 */
7275static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7276{
7277#if defined(MBEDTLS_SHA384_C)
7278 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7279 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7280
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007281 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007282 return( tls_prf_sha384 );
7283#else
7284 (void) ciphersuite_id;
7285#endif
7286 return( tls_prf_sha256 );
7287}
7288#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007289
7290static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7291{
7292 ((void) tls_prf);
7293#if defined(MBEDTLS_SHA384_C)
7294 if( tls_prf == tls_prf_sha384 )
7295 {
7296 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7297 }
7298 else
7299#endif
7300#if defined(MBEDTLS_SHA256_C)
7301 if( tls_prf == tls_prf_sha256 )
7302 {
7303 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7304 }
7305 else
7306#endif
7307 return( MBEDTLS_SSL_TLS_PRF_NONE );
7308}
7309
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007310/*
7311 * Populate a transform structure with session keys and all the other
7312 * necessary information.
7313 *
7314 * Parameters:
7315 * - [in/out]: transform: structure to populate
7316 * [in] must be just initialised with mbedtls_ssl_transform_init()
7317 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7318 * - [in] ciphersuite
7319 * - [in] master
7320 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007321 * - [in] tls_prf: pointer to PRF to use for key derivation
7322 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007323 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007324 * - [in] endpoint: client or server
7325 * - [in] ssl: used for:
7326 * - ssl->conf->{f,p}_export_keys
7327 * [in] optionally used for:
7328 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7329 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007330MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007331static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7332 int ciphersuite,
7333 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007334#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007335 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007336#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007337 ssl_tls_prf_t tls_prf,
7338 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007339 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007340 unsigned endpoint,
7341 const mbedtls_ssl_context *ssl )
7342{
7343 int ret = 0;
7344 unsigned char keyblk[256];
7345 unsigned char *key1;
7346 unsigned char *key2;
7347 unsigned char *mac_enc;
7348 unsigned char *mac_dec;
7349 size_t mac_key_len = 0;
7350 size_t iv_copy_len;
7351 size_t keylen;
7352 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007353 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007354#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007355 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007356 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007357#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007358
7359#if defined(MBEDTLS_USE_PSA_CRYPTO)
7360 psa_key_type_t key_type;
7361 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7362 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007363 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007364 size_t key_bits;
7365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7366#endif
7367
7368#if !defined(MBEDTLS_DEBUG_C) && \
7369 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7370 if( ssl->f_export_keys == NULL )
7371 {
7372 ssl = NULL; /* make sure we don't use it except for these cases */
7373 (void) ssl;
7374 }
7375#endif
7376
7377 /*
7378 * Some data just needs copying into the structure
7379 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007380#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007381 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007382#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007383 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007384
7385#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7386 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7387#endif
7388
7389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007390 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007391 {
7392 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7393 * generation separate. This should never happen. */
7394 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7395 }
7396#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7397
7398 /*
7399 * Get various info structures
7400 */
7401 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7402 if( ciphersuite_info == NULL )
7403 {
7404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7405 ciphersuite ) );
7406 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7407 }
7408
Neil Armstrongab555e02022-04-04 11:07:59 +02007409 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007410#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007411 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007412#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007413 ciphersuite_info );
7414
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007415 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7416 transform->taglen =
7417 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7418
7419#if defined(MBEDTLS_USE_PSA_CRYPTO)
7420 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7421 transform->taglen,
7422 &alg,
7423 &key_type,
7424 &key_bits ) ) != PSA_SUCCESS )
7425 {
7426 ret = psa_ssl_status_to_mbedtls( status );
7427 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7428 goto end;
7429 }
7430#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007431 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7432 if( cipher_info == NULL )
7433 {
7434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7435 ciphersuite_info->cipher ) );
7436 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7437 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007438#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007439
Neil Armstronge4512952022-03-08 09:08:22 +01007440#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007441 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007442 if( mac_alg == 0 )
7443 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007444 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007445 (unsigned) ciphersuite_info->mac ) );
7446 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7447 }
7448#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007449 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7450 if( md_info == NULL )
7451 {
7452 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7453 (unsigned) ciphersuite_info->mac ) );
7454 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7455 }
Neil Armstronge4512952022-03-08 09:08:22 +01007456#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007457
7458#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7459 /* Copy own and peer's CID if the use of the CID
7460 * extension has been negotiated. */
7461 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7462 {
7463 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7464
7465 transform->in_cid_len = ssl->own_cid_len;
7466 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7467 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7468 transform->in_cid_len );
7469
7470 transform->out_cid_len = ssl->handshake->peer_cid_len;
7471 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7472 ssl->handshake->peer_cid_len );
7473 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7474 transform->out_cid_len );
7475 }
7476#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7477
7478 /*
7479 * Compute key block using the PRF
7480 */
7481 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7482 if( ret != 0 )
7483 {
7484 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7485 return( ret );
7486 }
7487
7488 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7489 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7490 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7491 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7492 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7493
7494 /*
7495 * Determine the appropriate key, IV and MAC length.
7496 */
7497
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007498#if defined(MBEDTLS_USE_PSA_CRYPTO)
7499 keylen = PSA_BITS_TO_BYTES(key_bits);
7500#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007501 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007502#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007503
7504#if defined(MBEDTLS_GCM_C) || \
7505 defined(MBEDTLS_CCM_C) || \
7506 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007507 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007508 {
7509 size_t explicit_ivlen;
7510
7511 transform->maclen = 0;
7512 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007513
7514 /* All modes haves 96-bit IVs, but the length of the static parts vary
7515 * with mode and version:
7516 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7517 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7518 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7519 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7520 * sequence number).
7521 */
7522 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007523#if defined(MBEDTLS_USE_PSA_CRYPTO)
7524 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7525#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007526 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007527#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007528 transform->fixed_ivlen = 12;
7529 else
7530 transform->fixed_ivlen = 4;
7531
7532 /* Minimum length of encrypted record */
7533 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7534 transform->minlen = explicit_ivlen + transform->taglen;
7535 }
7536 else
7537#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7538#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007539 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7540 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7541 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007542 {
Neil Armstronge4512952022-03-08 09:08:22 +01007543#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007544 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007545#else
7546 size_t block_size = cipher_info->block_size;
7547#endif /* MBEDTLS_USE_PSA_CRYPTO */
7548
7549#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007550 /* Get MAC length */
7551 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7552#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007553 /* Initialize HMAC contexts */
7554 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7555 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7556 {
7557 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7558 goto end;
7559 }
7560
7561 /* Get MAC length */
7562 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007563#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007564 transform->maclen = mac_key_len;
7565
7566 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007567#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007568 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007569#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007570 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007572
7573 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007574 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007575 transform->minlen = transform->maclen;
7576 else
7577 {
7578 /*
7579 * GenericBlockCipher:
7580 * 1. if EtM is in use: one block plus MAC
7581 * otherwise: * first multiple of blocklen greater than maclen
7582 * 2. IV
7583 */
7584#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007585 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007586 {
7587 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007588 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007589 }
7590 else
7591#endif
7592 {
7593 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007594 + block_size
7595 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007596 }
7597
Glenn Strauss07c64162022-03-14 12:34:51 -04007598 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007599 {
7600 transform->minlen += transform->ivlen;
7601 }
7602 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007603 {
7604 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7605 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7606 goto end;
7607 }
7608 }
7609 }
7610 else
7611#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7612 {
7613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7615 }
7616
7617 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7618 (unsigned) keylen,
7619 (unsigned) transform->minlen,
7620 (unsigned) transform->ivlen,
7621 (unsigned) transform->maclen ) );
7622
7623 /*
7624 * Finally setup the cipher contexts, IVs and MAC secrets.
7625 */
7626#if defined(MBEDTLS_SSL_CLI_C)
7627 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7628 {
7629 key1 = keyblk + mac_key_len * 2;
7630 key2 = keyblk + mac_key_len * 2 + keylen;
7631
7632 mac_enc = keyblk;
7633 mac_dec = keyblk + mac_key_len;
7634
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007635 iv_copy_len = ( transform->fixed_ivlen ) ?
7636 transform->fixed_ivlen : transform->ivlen;
7637 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7638 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7639 iv_copy_len );
7640 }
7641 else
7642#endif /* MBEDTLS_SSL_CLI_C */
7643#if defined(MBEDTLS_SSL_SRV_C)
7644 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7645 {
7646 key1 = keyblk + mac_key_len * 2 + keylen;
7647 key2 = keyblk + mac_key_len * 2;
7648
7649 mac_enc = keyblk + mac_key_len;
7650 mac_dec = keyblk;
7651
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007652 iv_copy_len = ( transform->fixed_ivlen ) ?
7653 transform->fixed_ivlen : transform->ivlen;
7654 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7655 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7656 iv_copy_len );
7657 }
7658 else
7659#endif /* MBEDTLS_SSL_SRV_C */
7660 {
7661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7662 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7663 goto end;
7664 }
7665
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007666 if( ssl != NULL && ssl->f_export_keys != NULL )
7667 {
7668 ssl->f_export_keys( ssl->p_export_keys,
7669 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7670 master, 48,
7671 randbytes + 32,
7672 randbytes,
7673 tls_prf_get_type( tls_prf ) );
7674 }
7675
7676#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007677 transform->psa_alg = alg;
7678
7679 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7680 {
7681 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7682 psa_set_key_algorithm( &attributes, alg );
7683 psa_set_key_type( &attributes, key_type );
7684
7685 if( ( status = psa_import_key( &attributes,
7686 key1,
7687 PSA_BITS_TO_BYTES( key_bits ),
7688 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7689 {
7690 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7691 ret = psa_ssl_status_to_mbedtls( status );
7692 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7693 goto end;
7694 }
7695
7696 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7697
7698 if( ( status = psa_import_key( &attributes,
7699 key2,
7700 PSA_BITS_TO_BYTES( key_bits ),
7701 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7702 {
7703 ret = psa_ssl_status_to_mbedtls( status );
7704 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7705 goto end;
7706 }
7707 }
7708#else
7709 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7710 cipher_info ) ) != 0 )
7711 {
7712 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7713 goto end;
7714 }
7715
7716 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7717 cipher_info ) ) != 0 )
7718 {
7719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7720 goto end;
7721 }
7722
7723 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7724 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7725 MBEDTLS_ENCRYPT ) ) != 0 )
7726 {
7727 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7728 goto end;
7729 }
7730
7731 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7732 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7733 MBEDTLS_DECRYPT ) ) != 0 )
7734 {
7735 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7736 goto end;
7737 }
7738
7739#if defined(MBEDTLS_CIPHER_MODE_CBC)
7740 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7741 {
7742 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7743 MBEDTLS_PADDING_NONE ) ) != 0 )
7744 {
7745 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7746 goto end;
7747 }
7748
7749 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7750 MBEDTLS_PADDING_NONE ) ) != 0 )
7751 {
7752 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7753 goto end;
7754 }
7755 }
7756#endif /* MBEDTLS_CIPHER_MODE_CBC */
7757#endif /* MBEDTLS_USE_PSA_CRYPTO */
7758
Neil Armstrong29c0c042022-03-17 17:47:28 +01007759#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7760 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7761 For AEAD-based ciphersuites, there is nothing to do here. */
7762 if( mac_key_len != 0 )
7763 {
7764#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007765 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007766
7767 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007768 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007769 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7770
7771 if( ( status = psa_import_key( &attributes,
7772 mac_enc, mac_key_len,
7773 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7774 {
7775 ret = psa_ssl_status_to_mbedtls( status );
7776 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7777 goto end;
7778 }
7779
Ronald Cronfb39f152022-03-25 14:36:28 +01007780 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7781 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7782 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007783 /* mbedtls_ct_hmac() requires the key to be exportable */
7784 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7785 PSA_KEY_USAGE_VERIFY_HASH );
7786 else
7787 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7788
7789 if( ( status = psa_import_key( &attributes,
7790 mac_dec, mac_key_len,
7791 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7792 {
7793 ret = psa_ssl_status_to_mbedtls( status );
7794 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7795 goto end;
7796 }
7797#else
7798 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7799 if( ret != 0 )
7800 goto end;
7801 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7802 if( ret != 0 )
7803 goto end;
7804#endif /* MBEDTLS_USE_PSA_CRYPTO */
7805 }
7806#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7807
7808 ((void) mac_dec);
7809 ((void) mac_enc);
7810
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007811end:
7812 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7813 return( ret );
7814}
7815
Jerry Yuee40f9d2022-02-17 14:55:16 +08007816#if defined(MBEDTLS_USE_PSA_CRYPTO)
7817int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7818 unsigned char *hash, size_t *hashlen,
7819 unsigned char *data, size_t data_len,
7820 mbedtls_md_type_t md_alg )
7821{
7822 psa_status_t status;
7823 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007824 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007825
7826 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7827
7828 if( ( status = psa_hash_setup( &hash_operation,
7829 hash_alg ) ) != PSA_SUCCESS )
7830 {
7831 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7832 goto exit;
7833 }
7834
7835 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7836 64 ) ) != PSA_SUCCESS )
7837 {
7838 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7839 goto exit;
7840 }
7841
7842 if( ( status = psa_hash_update( &hash_operation,
7843 data, data_len ) ) != PSA_SUCCESS )
7844 {
7845 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7846 goto exit;
7847 }
7848
7849 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7850 hashlen ) ) != PSA_SUCCESS )
7851 {
7852 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7853 goto exit;
7854 }
7855
7856exit:
7857 if( status != PSA_SUCCESS )
7858 {
7859 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7860 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7861 switch( status )
7862 {
7863 case PSA_ERROR_NOT_SUPPORTED:
7864 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7865 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7866 case PSA_ERROR_BUFFER_TOO_SMALL:
7867 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7868 case PSA_ERROR_INSUFFICIENT_MEMORY:
7869 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7870 default:
7871 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7872 }
7873 }
7874 return( 0 );
7875}
7876
7877#else
7878
7879int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7880 unsigned char *hash, size_t *hashlen,
7881 unsigned char *data, size_t data_len,
7882 mbedtls_md_type_t md_alg )
7883{
7884 int ret = 0;
7885 mbedtls_md_context_t ctx;
7886 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7887 *hashlen = mbedtls_md_get_size( md_info );
7888
7889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7890
7891 mbedtls_md_init( &ctx );
7892
7893 /*
7894 * digitally-signed struct {
7895 * opaque client_random[32];
7896 * opaque server_random[32];
7897 * ServerDHParams params;
7898 * };
7899 */
7900 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7901 {
7902 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7903 goto exit;
7904 }
7905 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7906 {
7907 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7908 goto exit;
7909 }
7910 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7911 {
7912 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7913 goto exit;
7914 }
7915 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7916 {
7917 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7918 goto exit;
7919 }
7920 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7921 {
7922 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7923 goto exit;
7924 }
7925
7926exit:
7927 mbedtls_md_free( &ctx );
7928
7929 if( ret != 0 )
7930 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7931 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7932
7933 return( ret );
7934}
7935#endif /* MBEDTLS_USE_PSA_CRYPTO */
7936
Jerry Yud9d91da2022-02-17 14:57:06 +08007937#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7938
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007939/* Find the preferred hash for a given signature algorithm. */
7940unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7941 mbedtls_ssl_context *ssl,
7942 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007943{
Gabor Mezei078e8032022-04-27 21:17:56 +02007944 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007945 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007946
7947 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007948 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007949
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007950 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007951 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007952 unsigned int hash_alg_received =
7953 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7954 received_sig_algs[i] );
7955 unsigned int sig_alg_received =
7956 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7957 received_sig_algs[i] );
7958
7959 if( sig_alg == sig_alg_received )
7960 {
7961#if defined(MBEDTLS_USE_PSA_CRYPTO)
7962 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7963 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007964 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007965 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007966
Neil Armstrong96eceb82022-06-30 18:05:05 +02007967 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7968 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7969 PSA_ALG_ECDSA( psa_hash_alg ),
7970 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007971 continue;
7972
Neil Armstrong96eceb82022-06-30 18:05:05 +02007973 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02007974 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7975 PSA_ALG_RSA_PKCS1V15_SIGN(
7976 psa_hash_alg ),
7977 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007978 continue;
7979 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007980#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02007981
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007982 return( hash_alg_received );
7983 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007984 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007985
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007986 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007987}
7988
7989#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7990
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007991/* Serialization of TLS 1.2 sessions:
7992 *
7993 * struct {
7994 * uint64 start_time;
7995 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007996 * uint8 session_id_len; // at most 32
7997 * opaque session_id[32];
7998 * opaque master[48]; // fixed length in the standard
7999 * uint32 verify_result;
8000 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8001 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8002 * uint32 ticket_lifetime;
8003 * uint8 mfl_code; // up to 255 according to standard
8004 * uint8 encrypt_then_mac; // 0 or 1
8005 * } serialized_session_tls12;
8006 *
8007 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008008static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008009 unsigned char *buf,
8010 size_t buf_len )
8011{
8012 unsigned char *p = buf;
8013 size_t used = 0;
8014
8015#if defined(MBEDTLS_HAVE_TIME)
8016 uint64_t start;
8017#endif
8018#if defined(MBEDTLS_X509_CRT_PARSE_C)
8019#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8020 size_t cert_len;
8021#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8022#endif /* MBEDTLS_X509_CRT_PARSE_C */
8023
8024 /*
8025 * Time
8026 */
8027#if defined(MBEDTLS_HAVE_TIME)
8028 used += 8;
8029
8030 if( used <= buf_len )
8031 {
8032 start = (uint64_t) session->start;
8033
8034 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8035 p += 8;
8036 }
8037#endif /* MBEDTLS_HAVE_TIME */
8038
8039 /*
8040 * Basic mandatory fields
8041 */
8042 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008043 + 1 /* id_len */
8044 + sizeof( session->id )
8045 + sizeof( session->master )
8046 + 4; /* verify_result */
8047
8048 if( used <= buf_len )
8049 {
8050 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8051 p += 2;
8052
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008053 *p++ = MBEDTLS_BYTE_0( session->id_len );
8054 memcpy( p, session->id, 32 );
8055 p += 32;
8056
8057 memcpy( p, session->master, 48 );
8058 p += 48;
8059
8060 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8061 p += 4;
8062 }
8063
8064 /*
8065 * Peer's end-entity certificate
8066 */
8067#if defined(MBEDTLS_X509_CRT_PARSE_C)
8068#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8069 if( session->peer_cert == NULL )
8070 cert_len = 0;
8071 else
8072 cert_len = session->peer_cert->raw.len;
8073
8074 used += 3 + cert_len;
8075
8076 if( used <= buf_len )
8077 {
8078 *p++ = MBEDTLS_BYTE_2( cert_len );
8079 *p++ = MBEDTLS_BYTE_1( cert_len );
8080 *p++ = MBEDTLS_BYTE_0( cert_len );
8081
8082 if( session->peer_cert != NULL )
8083 {
8084 memcpy( p, session->peer_cert->raw.p, cert_len );
8085 p += cert_len;
8086 }
8087 }
8088#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8089 if( session->peer_cert_digest != NULL )
8090 {
8091 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8092 if( used <= buf_len )
8093 {
8094 *p++ = (unsigned char) session->peer_cert_digest_type;
8095 *p++ = (unsigned char) session->peer_cert_digest_len;
8096 memcpy( p, session->peer_cert_digest,
8097 session->peer_cert_digest_len );
8098 p += session->peer_cert_digest_len;
8099 }
8100 }
8101 else
8102 {
8103 used += 2;
8104 if( used <= buf_len )
8105 {
8106 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8107 *p++ = 0;
8108 }
8109 }
8110#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8111#endif /* MBEDTLS_X509_CRT_PARSE_C */
8112
8113 /*
8114 * Session ticket if any, plus associated data
8115 */
8116#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8117 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8118
8119 if( used <= buf_len )
8120 {
8121 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8122 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8123 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8124
8125 if( session->ticket != NULL )
8126 {
8127 memcpy( p, session->ticket, session->ticket_len );
8128 p += session->ticket_len;
8129 }
8130
8131 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8132 p += 4;
8133 }
8134#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8135
8136 /*
8137 * Misc extension-related info
8138 */
8139#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8140 used += 1;
8141
8142 if( used <= buf_len )
8143 *p++ = session->mfl_code;
8144#endif
8145
8146#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8147 used += 1;
8148
8149 if( used <= buf_len )
8150 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8151#endif
8152
8153 return( used );
8154}
8155
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008156MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008157static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008158 const unsigned char *buf,
8159 size_t len )
8160{
8161#if defined(MBEDTLS_HAVE_TIME)
8162 uint64_t start;
8163#endif
8164#if defined(MBEDTLS_X509_CRT_PARSE_C)
8165#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8166 size_t cert_len;
8167#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8168#endif /* MBEDTLS_X509_CRT_PARSE_C */
8169
8170 const unsigned char *p = buf;
8171 const unsigned char * const end = buf + len;
8172
8173 /*
8174 * Time
8175 */
8176#if defined(MBEDTLS_HAVE_TIME)
8177 if( 8 > (size_t)( end - p ) )
8178 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8179
8180 start = ( (uint64_t) p[0] << 56 ) |
8181 ( (uint64_t) p[1] << 48 ) |
8182 ( (uint64_t) p[2] << 40 ) |
8183 ( (uint64_t) p[3] << 32 ) |
8184 ( (uint64_t) p[4] << 24 ) |
8185 ( (uint64_t) p[5] << 16 ) |
8186 ( (uint64_t) p[6] << 8 ) |
8187 ( (uint64_t) p[7] );
8188 p += 8;
8189
8190 session->start = (time_t) start;
8191#endif /* MBEDTLS_HAVE_TIME */
8192
8193 /*
8194 * Basic mandatory fields
8195 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008196 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008197 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8198
8199 session->ciphersuite = ( p[0] << 8 ) | p[1];
8200 p += 2;
8201
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008202 session->id_len = *p++;
8203 memcpy( session->id, p, 32 );
8204 p += 32;
8205
8206 memcpy( session->master, p, 48 );
8207 p += 48;
8208
8209 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8210 ( (uint32_t) p[1] << 16 ) |
8211 ( (uint32_t) p[2] << 8 ) |
8212 ( (uint32_t) p[3] );
8213 p += 4;
8214
8215 /* Immediately clear invalid pointer values that have been read, in case
8216 * we exit early before we replaced them with valid ones. */
8217#if defined(MBEDTLS_X509_CRT_PARSE_C)
8218#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8219 session->peer_cert = NULL;
8220#else
8221 session->peer_cert_digest = NULL;
8222#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8223#endif /* MBEDTLS_X509_CRT_PARSE_C */
8224#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8225 session->ticket = NULL;
8226#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8227
8228 /*
8229 * Peer certificate
8230 */
8231#if defined(MBEDTLS_X509_CRT_PARSE_C)
8232#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8233 /* Deserialize CRT from the end of the ticket. */
8234 if( 3 > (size_t)( end - p ) )
8235 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8236
8237 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8238 p += 3;
8239
8240 if( cert_len != 0 )
8241 {
8242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8243
8244 if( cert_len > (size_t)( end - p ) )
8245 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8246
8247 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8248
8249 if( session->peer_cert == NULL )
8250 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8251
8252 mbedtls_x509_crt_init( session->peer_cert );
8253
8254 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8255 p, cert_len ) ) != 0 )
8256 {
8257 mbedtls_x509_crt_free( session->peer_cert );
8258 mbedtls_free( session->peer_cert );
8259 session->peer_cert = NULL;
8260 return( ret );
8261 }
8262
8263 p += cert_len;
8264 }
8265#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8266 /* Deserialize CRT digest from the end of the ticket. */
8267 if( 2 > (size_t)( end - p ) )
8268 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8269
8270 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8271 session->peer_cert_digest_len = (size_t) *p++;
8272
8273 if( session->peer_cert_digest_len != 0 )
8274 {
8275 const mbedtls_md_info_t *md_info =
8276 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8277 if( md_info == NULL )
8278 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8279 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8280 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8281
8282 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8283 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8284
8285 session->peer_cert_digest =
8286 mbedtls_calloc( 1, session->peer_cert_digest_len );
8287 if( session->peer_cert_digest == NULL )
8288 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8289
8290 memcpy( session->peer_cert_digest, p,
8291 session->peer_cert_digest_len );
8292 p += session->peer_cert_digest_len;
8293 }
8294#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8295#endif /* MBEDTLS_X509_CRT_PARSE_C */
8296
8297 /*
8298 * Session ticket and associated data
8299 */
8300#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8301 if( 3 > (size_t)( end - p ) )
8302 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8303
8304 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8305 p += 3;
8306
8307 if( session->ticket_len != 0 )
8308 {
8309 if( session->ticket_len > (size_t)( end - p ) )
8310 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8311
8312 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8313 if( session->ticket == NULL )
8314 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8315
8316 memcpy( session->ticket, p, session->ticket_len );
8317 p += session->ticket_len;
8318 }
8319
8320 if( 4 > (size_t)( end - p ) )
8321 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8322
8323 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8324 ( (uint32_t) p[1] << 16 ) |
8325 ( (uint32_t) p[2] << 8 ) |
8326 ( (uint32_t) p[3] );
8327 p += 4;
8328#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8329
8330 /*
8331 * Misc extension-related info
8332 */
8333#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8334 if( 1 > (size_t)( end - p ) )
8335 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8336
8337 session->mfl_code = *p++;
8338#endif
8339
8340#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8341 if( 1 > (size_t)( end - p ) )
8342 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8343
8344 session->encrypt_then_mac = *p++;
8345#endif
8346
8347 /* Done, should have consumed entire buffer */
8348 if( p != end )
8349 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8350
8351 return( 0 );
8352}
Jerry Yudc7bd172022-02-17 13:44:15 +08008353#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8354
XiaokangQian75d40ef2022-04-20 11:05:24 +00008355int mbedtls_ssl_validate_ciphersuite(
8356 const mbedtls_ssl_context *ssl,
8357 const mbedtls_ssl_ciphersuite_t *suite_info,
8358 mbedtls_ssl_protocol_version min_tls_version,
8359 mbedtls_ssl_protocol_version max_tls_version )
8360{
8361 (void) ssl;
8362
8363 if( suite_info == NULL )
8364 return( -1 );
8365
8366 if( ( suite_info->min_tls_version > max_tls_version ) ||
8367 ( suite_info->max_tls_version < min_tls_version ) )
8368 {
8369 return( -1 );
8370 }
8371
XiaokangQian060d8672022-04-21 09:24:56 +00008372#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008373#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8374 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8375 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8376 {
8377 return( -1 );
8378 }
8379#endif
8380
8381 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8382#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8383 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8384 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8385 {
8386 return( -1 );
8387 }
8388#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8389#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8390
8391 return( 0 );
8392}
8393
XiaokangQianeaf36512022-04-24 09:07:44 +00008394#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8395/*
8396 * Function for writing a signature algorithm extension.
8397 *
8398 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8399 * value (TLS 1.3 RFC8446):
8400 * enum {
8401 * ....
8402 * ecdsa_secp256r1_sha256( 0x0403 ),
8403 * ecdsa_secp384r1_sha384( 0x0503 ),
8404 * ecdsa_secp521r1_sha512( 0x0603 ),
8405 * ....
8406 * } SignatureScheme;
8407 *
8408 * struct {
8409 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8410 * } SignatureSchemeList;
8411 *
8412 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8413 * value (TLS 1.2 RFC5246):
8414 * enum {
8415 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8416 * sha512(6), (255)
8417 * } HashAlgorithm;
8418 *
8419 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8420 * SignatureAlgorithm;
8421 *
8422 * struct {
8423 * HashAlgorithm hash;
8424 * SignatureAlgorithm signature;
8425 * } SignatureAndHashAlgorithm;
8426 *
8427 * SignatureAndHashAlgorithm
8428 * supported_signature_algorithms<2..2^16-2>;
8429 *
8430 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8431 * generalization of the TLS 1.2 signature algorithm extension.
8432 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8433 * `SignatureScheme` field of TLS 1.3
8434 *
8435 */
8436int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8437 const unsigned char *end, size_t *out_len )
8438{
8439 unsigned char *p = buf;
8440 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8441 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8442
8443 *out_len = 0;
8444
8445 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8446
8447 /* Check if we have space for header and length field:
8448 * - extension_type (2 bytes)
8449 * - extension_data_length (2 bytes)
8450 * - supported_signature_algorithms_length (2 bytes)
8451 */
8452 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8453 p += 6;
8454
8455 /*
8456 * Write supported_signature_algorithms
8457 */
8458 supported_sig_alg = p;
8459 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8460 if( sig_alg == NULL )
8461 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8462
8463 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8464 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008465 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8466 *sig_alg,
8467 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008468 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8469 continue;
8470 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8471 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8472 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008473 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008474 *sig_alg,
8475 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008476 }
8477
8478 /* Length of supported_signature_algorithms */
8479 supported_sig_alg_len = p - supported_sig_alg;
8480 if( supported_sig_alg_len == 0 )
8481 {
8482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8483 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8484 }
8485
XiaokangQianeaf36512022-04-24 09:07:44 +00008486 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008487 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008488 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8489
XiaokangQianeaf36512022-04-24 09:07:44 +00008490 *out_len = p - buf;
8491
8492#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8493 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8494#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8495 return( 0 );
8496}
8497#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8498
XiaokangQian40a35232022-05-07 09:02:40 +00008499#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008500/*
8501 * mbedtls_ssl_parse_server_name_ext
8502 *
8503 * Structure of server_name extension:
8504 *
8505 * enum {
8506 * host_name(0), (255)
8507 * } NameType;
8508 * opaque HostName<1..2^16-1>;
8509 *
8510 * struct {
8511 * NameType name_type;
8512 * select (name_type) {
8513 * case host_name: HostName;
8514 * } name;
8515 * } ServerName;
8516 * struct {
8517 * ServerName server_name_list<1..2^16-1>
8518 * } ServerNameList;
8519 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008520MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008521int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8522 const unsigned char *buf,
8523 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008524{
8525 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8526 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008527 size_t server_name_list_len, hostname_len;
8528 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008529
XiaokangQianf2a94202022-05-20 06:44:24 +00008530 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008531
8532 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008533 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008534 p += 2;
8535
XiaokangQian9b2b7712022-05-17 02:57:00 +00008536 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8537 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008538 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008539 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008540 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008541 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008542 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8543 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008544
8545 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8546 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008547 /* sni_name is intended to be used only during the parsing of the
8548 * ClientHello message (it is reset to NULL before the end of
8549 * the message parsing). Thus it is ok to just point to the
8550 * reception buffer and not make a copy of it.
8551 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008552 ssl->handshake->sni_name = p + 3;
8553 ssl->handshake->sni_name_len = hostname_len;
8554 if( ssl->conf->f_sni == NULL )
8555 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008556 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008557 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008558 if( ret != 0 )
8559 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008560 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008561 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8562 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008563 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8564 }
8565 return( 0 );
8566 }
8567
8568 p += hostname_len + 3;
8569 }
8570
8571 return( 0 );
8572}
8573#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8574
XiaokangQianacb39922022-06-17 10:18:48 +00008575#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008576MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008577int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8578 const unsigned char *buf,
8579 const unsigned char *end )
8580{
8581 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008582 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008583 const unsigned char *protocol_name_list;
8584 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008585 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008586
8587 /* If ALPN not configured, just ignore the extension */
8588 if( ssl->conf->alpn_list == NULL )
8589 return( 0 );
8590
8591 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008592 * RFC7301, section 3.1
8593 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008594 *
XiaokangQianc7403452022-06-23 03:24:12 +00008595 * struct {
8596 * ProtocolName protocol_name_list<2..2^16-1>
8597 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008598 */
8599
XiaokangQianc7403452022-06-23 03:24:12 +00008600 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008601 * protocol_name_list_len 2 bytes
8602 * protocol_name_len 1 bytes
8603 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008604 */
XiaokangQianacb39922022-06-17 10:18:48 +00008605 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8606
XiaokangQianc7403452022-06-23 03:24:12 +00008607 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008608 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008609 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008610 protocol_name_list = p;
8611 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008612
8613 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008614 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008615 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008616 protocol_name_len = *p++;
8617 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8618 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008619 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008620 {
8621 MBEDTLS_SSL_PEND_FATAL_ALERT(
8622 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8623 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008624 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008625 }
8626
8627 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008628 }
8629
8630 /* Use our order of preference */
8631 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8632 {
8633 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008634 p = protocol_name_list;
8635 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008636 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008637 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008638 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008639 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008640 {
8641 ssl->alpn_chosen = *alpn;
8642 return( 0 );
8643 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008644
8645 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008646 }
8647 }
8648
XiaokangQian95d5f542022-06-24 02:29:26 +00008649 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008650 MBEDTLS_SSL_PEND_FATAL_ALERT(
8651 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8652 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8653 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8654}
8655
8656int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8657 unsigned char *buf,
8658 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008659 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008660{
8661 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008662 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008663 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008664
8665 if( ssl->alpn_chosen == NULL )
8666 {
8667 return( 0 );
8668 }
8669
XiaokangQian95d5f542022-06-24 02:29:26 +00008670 protocol_name_len = strlen( ssl->alpn_chosen );
8671 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008672
8673 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8674 /*
8675 * 0 . 1 ext identifier
8676 * 2 . 3 ext length
8677 * 4 . 5 protocol list length
8678 * 6 . 6 protocol name length
8679 * 7 . 7+n protocol name
8680 */
8681 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8682
XiaokangQian95d5f542022-06-24 02:29:26 +00008683 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008684
XiaokangQian95d5f542022-06-24 02:29:26 +00008685 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8686 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008687 /* Note: the length of the chosen protocol has been checked to be less
8688 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8689 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008690 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008691
XiaokangQian95d5f542022-06-24 02:29:26 +00008692 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008693 return ( 0 );
8694}
8695#endif /* MBEDTLS_SSL_ALPN */
8696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008697#endif /* MBEDTLS_SSL_TLS_C */