blob: e08a47e6e732260be8dc96f3edfa4f841870da02 [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
Andrzej Kureka242e832022-08-11 10:03:14 -0400576 mbedtls_sha512_starts( &ssl->handshake->fin_sha384, 1 );
Jerry Yuc73c6182022-02-08 20:29:25 +0800577#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
Andrzej Kureka242e832022-08-11 10:03:14 -0400595 mbedtls_sha512_update( &ssl->handshake->fin_sha384, buf, len );
Jerry Yuc73c6182022-02-08 20:29:25 +0800596#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
Andrzej Kureka242e832022-08-11 10:03:14 -0400619 mbedtls_sha512_update( &ssl->handshake->fin_sha384, buf, len );
Jerry Yuc73c6182022-02-08 20:29:25 +0800620#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
Andrzej Kureka242e832022-08-11 10:03:14 -0400642 mbedtls_sha512_init( &handshake->fin_sha384 );
643 mbedtls_sha512_starts( &handshake->fin_sha384, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200644#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500645#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200646
647 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649#if defined(MBEDTLS_DHM_C)
650 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200651#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200652#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200654#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200655#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200656 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200657#if defined(MBEDTLS_SSL_CLI_C)
658 handshake->ecjpake_cache = NULL;
659 handshake->ecjpake_cache_len = 0;
660#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200661#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200662
Gilles Peskineeccd8882020-03-10 12:19:08 +0100663#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200664 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200665#endif
666
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200667#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
668 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
669#endif
Hanno Becker75173122019-02-06 16:18:31 +0000670
671#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
672 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
673 mbedtls_pk_init( &handshake->peer_pubkey );
674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Hanno Beckera18d1322018-01-03 14:27:32 +0000677void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200680
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100681#if defined(MBEDTLS_USE_PSA_CRYPTO)
682 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
683 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100684#else
685 mbedtls_cipher_init( &transform->cipher_ctx_enc );
686 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100687#endif
688
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100690#if defined(MBEDTLS_USE_PSA_CRYPTO)
691 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
692 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100693#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 mbedtls_md_init( &transform->md_ctx_enc );
695 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000696#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100697#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200698}
699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200703}
704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200705MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000707{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200708 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000709 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200711 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200713 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200714 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715
716 /*
717 * Either the pointers are now NULL or cleared properly and can be freed.
718 * Now allocate missing structures.
719 */
720 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200721 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200722 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200723 }
Paul Bakker48916f92012-09-16 19:57:18 +0000724
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200726 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200727 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200728 }
Paul Bakker48916f92012-09-16 19:57:18 +0000729
Paul Bakker82788fb2014-10-20 13:59:19 +0200730 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200731 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200732 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200733 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500734#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
735 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400736
Andrzej Kurek4a063792020-10-21 15:08:44 +0200737 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
738 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500739#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000740
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200741 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000742 if( ssl->handshake == NULL ||
743 ssl->transform_negotiate == NULL ||
744 ssl->session_negotiate == NULL )
745 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 mbedtls_free( ssl->handshake );
749 mbedtls_free( ssl->transform_negotiate );
750 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200751
752 ssl->handshake = NULL;
753 ssl->transform_negotiate = NULL;
754 ssl->session_negotiate = NULL;
755
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200756 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000757 }
758
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200759 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000761 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200762 ssl_handshake_params_init( ssl->handshake );
763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200765 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
766 {
767 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200768
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200769 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
770 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
771 else
772 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200773
Hanno Becker0f57a652020-02-05 10:37:26 +0000774 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200775 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200776#endif
777
Brett Warrene0edc842021-08-17 09:53:13 +0100778/*
779 * curve_list is translated to IANA TLS group identifiers here because
780 * mbedtls_ssl_conf_curves returns void and so can't return
781 * any error codes.
782 */
783#if defined(MBEDTLS_ECP_C)
784#if !defined(MBEDTLS_DEPRECATED_REMOVED)
785 /* Heap allocate and translate curve_list from internal to IANA group ids */
786 if ( ssl->conf->curve_list != NULL )
787 {
788 size_t length;
789 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
790
791 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
792 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
793
794 /* Leave room for zero termination */
795 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
796 if ( group_list == NULL )
797 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
798
799 for( size_t i = 0; i < length; i++ )
800 {
801 const mbedtls_ecp_curve_info *info =
802 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
803 if ( info == NULL )
804 {
805 mbedtls_free( group_list );
806 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
807 }
808 group_list[i] = info->tls_id;
809 }
810
811 group_list[length] = 0;
812
813 ssl->handshake->group_list = group_list;
814 ssl->handshake->group_list_heap_allocated = 1;
815 }
816 else
817 {
818 ssl->handshake->group_list = ssl->conf->group_list;
819 ssl->handshake->group_list_heap_allocated = 0;
820 }
821#endif /* MBEDTLS_DEPRECATED_REMOVED */
822#endif /* MBEDTLS_ECP_C */
823
Jerry Yuf017ee42022-01-12 15:49:48 +0800824#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
825#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800826#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800827 /* Heap allocate and translate sig_hashes from internal hash identifiers to
828 signature algorithms IANA identifiers. */
829 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 ssl->conf->sig_hashes != NULL )
831 {
832 const int *md;
833 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800834 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 uint16_t *p;
836
Jerry Yub476a442022-01-21 18:14:45 +0800837#if defined(static_assert)
838 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
839 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
840 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800841#endif
842
Jerry Yuf017ee42022-01-12 15:49:48 +0800843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
846 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800847#if defined(MBEDTLS_ECDSA_C)
848 sig_algs_len += sizeof( uint16_t );
849#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800850
Jerry Yub476a442022-01-21 18:14:45 +0800851#if defined(MBEDTLS_RSA_C)
852 sig_algs_len += sizeof( uint16_t );
853#endif
854 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
855 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857
Jerry Yub476a442022-01-21 18:14:45 +0800858 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800859 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
860
Jerry Yub476a442022-01-21 18:14:45 +0800861 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
862 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800863 if( ssl->handshake->sig_algs == NULL )
864 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
865
866 p = (uint16_t *)ssl->handshake->sig_algs;
867 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
868 {
869 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
870 if( hash == MBEDTLS_SSL_HASH_NONE )
871 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800872#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800873 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
874 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800875#endif
876#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800877 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
878 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800879#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800880 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200881 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800882 ssl->handshake->sig_algs_heap_allocated = 1;
883 }
884 else
Jerry Yua69269a2022-01-17 21:06:01 +0800885#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800886 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800887 ssl->handshake->sig_algs_heap_allocated = 0;
888 }
Jerry Yucc539102022-06-27 16:27:35 +0800889#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800890#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000891 return( 0 );
892}
893
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200894#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200896MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897static int ssl_cookie_write_dummy( void *ctx,
898 unsigned char **p, unsigned char *end,
899 const unsigned char *cli_id, size_t cli_id_len )
900{
901 ((void) ctx);
902 ((void) p);
903 ((void) end);
904 ((void) cli_id);
905 ((void) cli_id_len);
906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200908}
909
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200910MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200911static int ssl_cookie_check_dummy( void *ctx,
912 const unsigned char *cookie, size_t cookie_len,
913 const unsigned char *cli_id, size_t cli_id_len )
914{
915 ((void) ctx);
916 ((void) cookie);
917 ((void) cookie_len);
918 ((void) cli_id);
919 ((void) cli_id_len);
920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200922}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200923#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200924
Paul Bakker5121ce52009-01-03 21:22:43 +0000925/*
926 * Initialize an SSL context
927 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200928void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
929{
930 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
931}
932
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200933MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800934static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
935{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100936 const mbedtls_ssl_config *conf = ssl->conf;
937
Ronald Cron6f135e12021-12-08 16:57:54 +0100938#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100939 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
940 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000941 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
Jerry Yu60835a82021-08-04 10:13:52 +0800947 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
948 return( 0 );
949 }
950#endif
951
952#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100953 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800954 {
955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
956 return( 0 );
957 }
958#endif
959
Ronald Cron6f135e12021-12-08 16:57:54 +0100960#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100961 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800962 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
964 {
965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
966 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
967 }
968
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000969 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
970 {
971 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
972 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
973 }
974
975
Ronald Crone1d3f062022-02-10 14:50:54 +0100976 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
977 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800978 }
979#endif
980
981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
982 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
983}
984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200985MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800986static int ssl_conf_check(const mbedtls_ssl_context *ssl)
987{
988 int ret;
989 ret = ssl_conf_version_check( ssl );
990 if( ret != 0 )
991 return( ret );
992
993 /* Space for further checks */
994
995 return( 0 );
996}
997
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200998/*
999 * Setup an SSL context
1000 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001001
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001002int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001003 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004{
Janos Follath865b3eb2019-12-16 11:46:15 +00001005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001006 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1007 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001008
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001009 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001010
Jerry Yu60835a82021-08-04 10:13:52 +08001011 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1012 return( ret );
1013
Paul Bakker62f2dee2012-09-28 07:31:51 +00001014 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001015 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001016 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001017
1018 /* Set to NULL in case of an error condition */
1019 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001020
Darryl Greenb33cc762019-11-28 14:29:44 +00001021#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1022 ssl->in_buf_len = in_buf_len;
1023#endif
1024 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001025 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001028 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001030 }
1031
Darryl Greenb33cc762019-11-28 14:29:44 +00001032#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1033 ssl->out_buf_len = out_buf_len;
1034#endif
1035 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001036 if( ssl->out_buf == NULL )
1037 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001039 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001040 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001041 }
1042
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001043 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001044
Johan Pascalb62bb512015-12-03 21:56:45 +01001045#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001046 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001047#endif
1048
Paul Bakker48916f92012-09-16 19:57:18 +00001049 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001050 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001051
1052 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001053
1054error:
1055 mbedtls_free( ssl->in_buf );
1056 mbedtls_free( ssl->out_buf );
1057
1058 ssl->conf = NULL;
1059
Darryl Greenb33cc762019-11-28 14:29:44 +00001060#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1061 ssl->in_buf_len = 0;
1062 ssl->out_buf_len = 0;
1063#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001064 ssl->in_buf = NULL;
1065 ssl->out_buf = NULL;
1066
1067 ssl->in_hdr = NULL;
1068 ssl->in_ctr = NULL;
1069 ssl->in_len = NULL;
1070 ssl->in_iv = NULL;
1071 ssl->in_msg = NULL;
1072
1073 ssl->out_hdr = NULL;
1074 ssl->out_ctr = NULL;
1075 ssl->out_len = NULL;
1076 ssl->out_iv = NULL;
1077 ssl->out_msg = NULL;
1078
k-stachowiak9f7798e2018-07-31 16:52:32 +02001079 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001080}
1081
1082/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001083 * Reset an initialized and used SSL context for re-use while retaining
1084 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001085 *
1086 * If partial is non-zero, keep data in the input buffer and client ID.
1087 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001088 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001089void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1090 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001091{
Darryl Greenb33cc762019-11-28 14:29:44 +00001092#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1093 size_t in_buf_len = ssl->in_buf_len;
1094 size_t out_buf_len = ssl->out_buf_len;
1095#else
1096 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1097 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1098#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001099
Hanno Beckerb0302c42021-08-03 09:39:42 +01001100#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1101 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001102#endif
1103
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001104 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001105 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001106
Hanno Beckerb0302c42021-08-03 09:39:42 +01001107 mbedtls_ssl_reset_in_out_pointers( ssl );
1108
1109 /* Reset incoming message parsing */
1110 ssl->in_offt = NULL;
1111 ssl->nb_zero = 0;
1112 ssl->in_msgtype = 0;
1113 ssl->in_msglen = 0;
1114 ssl->in_hslen = 0;
1115 ssl->keep_current_message = 0;
1116 ssl->transform_in = NULL;
1117
1118#if defined(MBEDTLS_SSL_PROTO_DTLS)
1119 ssl->next_record_offset = 0;
1120 ssl->in_epoch = 0;
1121#endif
1122
1123 /* Keep current datagram if partial == 1 */
1124 if( partial == 0 )
1125 {
1126 ssl->in_left = 0;
1127 memset( ssl->in_buf, 0, in_buf_len );
1128 }
1129
Ronald Cronad8c17b2022-06-10 17:18:09 +02001130 ssl->send_alert = 0;
1131
Hanno Beckerb0302c42021-08-03 09:39:42 +01001132 /* Reset outgoing message writing */
1133 ssl->out_msgtype = 0;
1134 ssl->out_msglen = 0;
1135 ssl->out_left = 0;
1136 memset( ssl->out_buf, 0, out_buf_len );
1137 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1138 ssl->transform_out = NULL;
1139
1140#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1141 mbedtls_ssl_dtls_replay_reset( ssl );
1142#endif
1143
XiaokangQian2b01dc32022-01-21 02:53:13 +00001144#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001145 if( ssl->transform )
1146 {
1147 mbedtls_ssl_transform_free( ssl->transform );
1148 mbedtls_free( ssl->transform );
1149 ssl->transform = NULL;
1150 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001151#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1152
XiaokangQian2b01dc32022-01-21 02:53:13 +00001153#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1154 mbedtls_ssl_transform_free( ssl->transform_application );
1155 mbedtls_free( ssl->transform_application );
1156 ssl->transform_application = NULL;
1157
1158 if( ssl->handshake != NULL )
1159 {
1160 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1161 mbedtls_free( ssl->handshake->transform_earlydata );
1162 ssl->handshake->transform_earlydata = NULL;
1163
1164 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1165 mbedtls_free( ssl->handshake->transform_handshake );
1166 ssl->handshake->transform_handshake = NULL;
1167 }
1168
XiaokangQian2b01dc32022-01-21 02:53:13 +00001169#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001170}
1171
1172int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1173{
1174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1175
1176 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1177
XiaokangQian78b1fa72022-01-19 06:56:30 +00001178 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001179
1180 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#if defined(MBEDTLS_SSL_RENEGOTIATION)
1182 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001183 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001184
1185 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1187 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001188#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001190
Hanno Beckerb0302c42021-08-03 09:39:42 +01001191 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001192 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001193 if( ssl->session )
1194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195 mbedtls_ssl_session_free( ssl->session );
1196 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001197 ssl->session = NULL;
1198 }
1199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001201 ssl->alpn_chosen = NULL;
1202#endif
1203
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001204#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001205#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001206 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001207#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001208 {
1209 mbedtls_free( ssl->cli_id );
1210 ssl->cli_id = NULL;
1211 ssl->cli_id_len = 0;
1212 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001213#endif
1214
Paul Bakker48916f92012-09-16 19:57:18 +00001215 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1216 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001217
1218 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001219}
1220
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001221/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001222 * Reset an initialized and used SSL context for re-use while retaining
1223 * all application-set variables, function pointers and data.
1224 */
1225int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1226{
Hanno Becker43aefe22020-02-05 10:44:56 +00001227 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001228}
1229
1230/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001231 * SSL set accessors
1232 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001233void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001236}
1237
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001238void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001239{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001240 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001241}
1242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001244void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001245{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001246 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001247}
1248#endif
1249
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001250void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001251{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001252 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001253}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001256
Hanno Becker1841b0a2018-08-24 11:13:57 +01001257void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1258 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001259{
1260 ssl->disable_datagram_packing = !allow_packing;
1261}
1262
1263void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1264 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001265{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001266 conf->hs_timeout_min = min;
1267 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001268}
1269#endif
1270
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001271void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001272{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001273 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001274}
1275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001277void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001278 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001279 void *p_vrfy )
1280{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001281 conf->f_vrfy = f_vrfy;
1282 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001283}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001285
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001286void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001287 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001288 void *p_rng )
1289{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001290 conf->f_rng = f_rng;
1291 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001292}
1293
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001294void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001295 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001296 void *p_dbg )
1297{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001298 conf->f_dbg = f_dbg;
1299 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001300}
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001303 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_send_t *f_send,
1305 mbedtls_ssl_recv_t *f_recv,
1306 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001307{
1308 ssl->p_bio = p_bio;
1309 ssl->f_send = f_send;
1310 ssl->f_recv = f_recv;
1311 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001312}
1313
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001314#if defined(MBEDTLS_SSL_PROTO_DTLS)
1315void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1316{
1317 ssl->mtu = mtu;
1318}
1319#endif
1320
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001321void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001322{
1323 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001324}
1325
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001326void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1327 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001328 mbedtls_ssl_set_timer_t *f_set_timer,
1329 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001330{
1331 ssl->p_timer = p_timer;
1332 ssl->f_set_timer = f_set_timer;
1333 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001334
1335 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001336 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001337}
1338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001340void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001341 void *p_cache,
1342 mbedtls_ssl_cache_get_t *f_get_cache,
1343 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001344{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001345 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001346 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001347 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001348}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#if defined(MBEDTLS_SSL_CLI_C)
1352int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001353{
Janos Follath865b3eb2019-12-16 11:46:15 +00001354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001355
1356 if( ssl == NULL ||
1357 session == NULL ||
1358 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001359 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001362 }
1363
Hanno Beckere810bbc2021-05-14 16:01:05 +01001364 if( ssl->handshake->resume == 1 )
1365 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1366
Hanno Becker52055ae2019-02-06 14:30:46 +00001367 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1368 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001369 return( ret );
1370
Paul Bakker0a597072012-09-25 21:55:46 +00001371 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001372
1373 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001376
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001377void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1378 const int *ciphersuites )
1379{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001380 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001381}
1382
Ronald Cron6f135e12021-12-08 16:57:54 +01001383#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001384void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001385 const int kex_modes )
1386{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001387 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001388}
Ronald Cron6f135e12021-12-08 16:57:54 +01001389#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001392void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001393 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001394{
1395 conf->cert_profile = profile;
1396}
1397
Glenn Strauss36872db2022-01-22 05:06:31 -05001398static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1399{
1400 mbedtls_ssl_key_cert *cur = key_cert, *next;
1401
1402 while( cur != NULL )
1403 {
1404 next = cur->next;
1405 mbedtls_free( cur );
1406 cur = next;
1407 }
1408}
1409
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001411MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001412static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1413 mbedtls_x509_crt *cert,
1414 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415{
niisato8ee24222018-06-25 19:05:48 +09001416 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417
Glenn Strauss36872db2022-01-22 05:06:31 -05001418 if( cert == NULL )
1419 {
1420 /* Free list if cert is null */
1421 ssl_key_cert_free( *head );
1422 *head = NULL;
1423 return( 0 );
1424 }
1425
niisato8ee24222018-06-25 19:05:48 +09001426 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1427 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001428 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001429
niisato8ee24222018-06-25 19:05:48 +09001430 new_cert->cert = cert;
1431 new_cert->key = key;
1432 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001433
Glenn Strauss36872db2022-01-22 05:06:31 -05001434 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001435 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001436 {
niisato8ee24222018-06-25 19:05:48 +09001437 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001438 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001439 else
1440 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001441 mbedtls_ssl_key_cert *cur = *head;
1442 while( cur->next != NULL )
1443 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001444 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001445 }
1446
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001447 return( 0 );
1448}
1449
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001450int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001451 mbedtls_x509_crt *own_cert,
1452 mbedtls_pk_context *pk_key )
1453{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001454 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001455}
1456
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001457void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001458 mbedtls_x509_crt *ca_chain,
1459 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001460{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001461 conf->ca_chain = ca_chain;
1462 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001463
1464#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1465 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1466 * cannot be used together. */
1467 conf->f_ca_cb = NULL;
1468 conf->p_ca_cb = NULL;
1469#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001470}
Hanno Becker5adaad92019-03-27 16:54:37 +00001471
1472#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1473void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001474 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001475 void *p_ca_cb )
1476{
1477 conf->f_ca_cb = f_ca_cb;
1478 conf->p_ca_cb = p_ca_cb;
1479
1480 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1481 * cannot be used together. */
1482 conf->ca_chain = NULL;
1483 conf->ca_crl = NULL;
1484}
1485#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001487
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001488#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001489const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1490 size_t *name_len )
1491{
1492 *name_len = ssl->handshake->sni_name_len;
1493 return( ssl->handshake->sni_name );
1494}
1495
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001496int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1497 mbedtls_x509_crt *own_cert,
1498 mbedtls_pk_context *pk_key )
1499{
1500 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1501 own_cert, pk_key ) );
1502}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001503
1504void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1505 mbedtls_x509_crt *ca_chain,
1506 mbedtls_x509_crl *ca_crl )
1507{
1508 ssl->handshake->sni_ca_chain = ca_chain;
1509 ssl->handshake->sni_ca_crl = ca_crl;
1510}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001511
Glenn Strauss999ef702022-03-11 01:37:23 -05001512#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1513void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1514 const mbedtls_x509_crt *crt)
1515{
1516 ssl->handshake->dn_hints = crt;
1517}
1518#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1519
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001520void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1521 int authmode )
1522{
1523 ssl->handshake->sni_authmode = authmode;
1524}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001525#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1526
Hanno Becker8927c832019-04-03 12:52:50 +01001527#if defined(MBEDTLS_X509_CRT_PARSE_C)
1528void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1529 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1530 void *p_vrfy )
1531{
1532 ssl->f_vrfy = f_vrfy;
1533 ssl->p_vrfy = p_vrfy;
1534}
1535#endif
1536
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001537#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001538/*
1539 * Set EC J-PAKE password for current handshake
1540 */
1541int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1542 const unsigned char *pw,
1543 size_t pw_len )
1544{
1545 mbedtls_ecjpake_role role;
1546
Janos Follath8eb64132016-06-03 15:40:57 +01001547 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001548 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1549
1550 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1551 role = MBEDTLS_ECJPAKE_SERVER;
1552 else
1553 role = MBEDTLS_ECJPAKE_CLIENT;
1554
1555 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1556 role,
1557 MBEDTLS_MD_SHA256,
1558 MBEDTLS_ECP_DP_SECP256R1,
1559 pw, pw_len ) );
1560}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001561#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001562
Gilles Peskineeccd8882020-03-10 12:19:08 +01001563#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001564
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001565MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001566static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1567{
1568#if defined(MBEDTLS_USE_PSA_CRYPTO)
1569 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1570 return( 1 );
1571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001572 if( conf->psk != NULL )
1573 return( 1 );
1574
1575 return( 0 );
1576}
1577
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001578static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1579{
1580 /* Remove reference to existing PSK, if any. */
1581#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001582 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001583 {
1584 /* The maintenance of the PSK key slot is the
1585 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001586 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001587 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001588#endif /* MBEDTLS_USE_PSA_CRYPTO */
1589 if( conf->psk != NULL )
1590 {
1591 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1592
1593 mbedtls_free( conf->psk );
1594 conf->psk = NULL;
1595 conf->psk_len = 0;
1596 }
1597
1598 /* Remove reference to PSK identity, if any. */
1599 if( conf->psk_identity != NULL )
1600 {
1601 mbedtls_free( conf->psk_identity );
1602 conf->psk_identity = NULL;
1603 conf->psk_identity_len = 0;
1604 }
1605}
1606
Hanno Becker7390c712018-11-15 13:33:04 +00001607/* This function assumes that PSK identity in the SSL config is unset.
1608 * It checks that the provided identity is well-formed and attempts
1609 * to make a copy of it in the SSL config.
1610 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001611MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001612static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1613 unsigned char const *psk_identity,
1614 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001615{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001616 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001617 if( psk_identity == NULL ||
1618 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001619 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001620 {
1621 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1622 }
1623
Hanno Becker7390c712018-11-15 13:33:04 +00001624 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1625 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001626 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001627
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001628 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001629 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001630
1631 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001632}
1633
Hanno Becker7390c712018-11-15 13:33:04 +00001634int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1635 const unsigned char *psk, size_t psk_len,
1636 const unsigned char *psk_identity, size_t psk_identity_len )
1637{
Janos Follath865b3eb2019-12-16 11:46:15 +00001638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001639
1640 /* We currently only support one PSK, raw or opaque. */
1641 if( ssl_conf_psk_is_configured( conf ) )
1642 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001643
1644 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001645 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001647 if( psk_len == 0 )
1648 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1649 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1651
Hanno Becker7390c712018-11-15 13:33:04 +00001652 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1653 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1654 conf->psk_len = psk_len;
1655 memcpy( conf->psk, psk, conf->psk_len );
1656
1657 /* Check and set PSK Identity */
1658 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1659 if( ret != 0 )
1660 ssl_conf_remove_psk( conf );
1661
1662 return( ret );
1663}
1664
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001665static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1666{
1667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001668 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001669 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001670 /* The maintenance of the external PSK key slot is the
1671 * user's responsibility. */
1672 if( ssl->handshake->psk_opaque_is_internal )
1673 {
1674 psa_destroy_key( ssl->handshake->psk_opaque );
1675 ssl->handshake->psk_opaque_is_internal = 0;
1676 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001677 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001678 }
Neil Armstronge952a302022-05-03 10:22:14 +02001679#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680 if( ssl->handshake->psk != NULL )
1681 {
1682 mbedtls_platform_zeroize( ssl->handshake->psk,
1683 ssl->handshake->psk_len );
1684 mbedtls_free( ssl->handshake->psk );
1685 ssl->handshake->psk_len = 0;
1686 }
Neil Armstronge952a302022-05-03 10:22:14 +02001687#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001688}
1689
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001690int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1691 const unsigned char *psk, size_t psk_len )
1692{
Neil Armstrong501c9322022-05-03 09:35:09 +02001693#if defined(MBEDTLS_USE_PSA_CRYPTO)
1694 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1695 psa_status_t status;
1696 psa_algorithm_t alg;
1697 mbedtls_svc_key_id_t key;
1698#endif /* MBEDTLS_USE_PSA_CRYPTO */
1699
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001700 if( psk == NULL || ssl->handshake == NULL )
1701 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1702
1703 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1705
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001707
Neil Armstrong501c9322022-05-03 09:35:09 +02001708#if defined(MBEDTLS_USE_PSA_CRYPTO)
1709 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1710 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1711 else
1712 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1713
Jerry Yu568ec252022-07-22 21:27:34 +08001714#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1c105562022-07-10 06:32:38 +00001715 psa_set_key_usage_flags( &key_attributes,
1716 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
Jerry Yu568ec252022-07-22 21:27:34 +08001717#else
Neil Armstrong501c9322022-05-03 09:35:09 +02001718 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
Jerry Yu568ec252022-07-22 21:27:34 +08001719#endif
Neil Armstrong501c9322022-05-03 09:35:09 +02001720 psa_set_key_algorithm( &key_attributes, alg );
1721 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1722
1723 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1724 if( status != PSA_SUCCESS )
1725 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1726
1727 /* Allow calling psa_destroy_key() on psk remove */
1728 ssl->handshake->psk_opaque_is_internal = 1;
1729 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1730#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001731 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001733
1734 ssl->handshake->psk_len = psk_len;
1735 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1736
1737 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001738#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001739}
1740
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001741#if defined(MBEDTLS_USE_PSA_CRYPTO)
1742int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001743 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001744 const unsigned char *psk_identity,
1745 size_t psk_identity_len )
1746{
Janos Follath865b3eb2019-12-16 11:46:15 +00001747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001748
1749 /* We currently only support one PSK, raw or opaque. */
1750 if( ssl_conf_psk_is_configured( conf ) )
1751 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001752
Hanno Becker7390c712018-11-15 13:33:04 +00001753 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001754 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001756 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001757
1758 /* Check and set PSK Identity */
1759 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1760 psk_identity_len );
1761 if( ret != 0 )
1762 ssl_conf_remove_psk( conf );
1763
1764 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001765}
1766
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001767int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1768 mbedtls_svc_key_id_t psk )
1769{
1770 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1771 ( ssl->handshake == NULL ) )
1772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1773
1774 ssl_remove_psk( ssl );
1775 ssl->handshake->psk_opaque = psk;
1776 return( 0 );
1777}
1778#endif /* MBEDTLS_USE_PSA_CRYPTO */
1779
1780void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1781 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1782 size_t),
1783 void *p_psk )
1784{
1785 conf->f_psk = f_psk;
1786 conf->p_psk = p_psk;
1787}
1788#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1789
1790#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001791static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1792 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001793{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001794#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001795 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001796 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001797#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001798 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001799 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001800 return( MBEDTLS_SSL_MODE_STREAM );
1801}
1802
1803#else /* MBEDTLS_USE_PSA_CRYPTO */
1804
1805static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1806 mbedtls_cipher_mode_t mode )
1807{
1808#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1809 if( mode == MBEDTLS_MODE_CBC )
1810 return( MBEDTLS_SSL_MODE_CBC );
1811#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1812
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001813#if defined(MBEDTLS_GCM_C) || \
1814 defined(MBEDTLS_CCM_C) || \
1815 defined(MBEDTLS_CHACHAPOLY_C)
1816 if( mode == MBEDTLS_MODE_GCM ||
1817 mode == MBEDTLS_MODE_CCM ||
1818 mode == MBEDTLS_MODE_CHACHAPOLY )
1819 return( MBEDTLS_SSL_MODE_AEAD );
1820#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001821
1822 return( MBEDTLS_SSL_MODE_STREAM );
1823}
Gilles Peskine301711e2022-04-26 16:57:05 +02001824#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001825
Gilles Peskinee108d982022-04-26 16:50:40 +02001826static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1827 mbedtls_ssl_mode_t base_mode,
1828 int encrypt_then_mac )
1829{
1830#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1831 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1832 base_mode == MBEDTLS_SSL_MODE_CBC )
1833 {
1834 return( MBEDTLS_SSL_MODE_CBC_ETM );
1835 }
1836#else
1837 (void) encrypt_then_mac;
1838#endif
1839 return( base_mode );
1840}
1841
Neil Armstrongab555e02022-04-04 11:07:59 +02001842mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001843 const mbedtls_ssl_transform *transform )
1844{
Gilles Peskinee108d982022-04-26 16:50:40 +02001845 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001846#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001847 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001848#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001849 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1850#endif
1851 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001852
Gilles Peskinee108d982022-04-26 16:50:40 +02001853 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001854#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001855 encrypt_then_mac = transform->encrypt_then_mac;
1856#endif
1857 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001858}
1859
Neil Armstrongab555e02022-04-04 11:07:59 +02001860mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001861#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001862 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001863#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001864 const mbedtls_ssl_ciphersuite_t *suite )
1865{
Gilles Peskinee108d982022-04-26 16:50:40 +02001866 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1867
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001868#if defined(MBEDTLS_USE_PSA_CRYPTO)
1869 psa_status_t status;
1870 psa_algorithm_t alg;
1871 psa_key_type_t type;
1872 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001873 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1874 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001875 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001876#else
1877 const mbedtls_cipher_info_t *cipher =
1878 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001879 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001880 {
1881 base_mode =
1882 mbedtls_ssl_get_base_mode(
1883 mbedtls_cipher_info_get_mode( cipher ) );
1884 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001885#endif /* MBEDTLS_USE_PSA_CRYPTO */
1886
Gilles Peskinee108d982022-04-26 16:50:40 +02001887#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1888 int encrypt_then_mac = 0;
1889#endif
1890 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001891}
1892
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001893#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001894
1895#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00001896/* Serialization of TLS 1.3 sessions:
1897 *
1898 * struct {
1899 * uint64 ticket_received;
1900 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08001901 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00001902 * } ClientOnlyData;
1903 *
1904 * struct {
1905 * uint8 endpoint;
1906 * uint8 ciphersuite[2];
1907 * uint32 ticket_age_add;
1908 * uint8 ticket_flags;
1909 * opaque resumption_key<0..255>;
1910 * select ( endpoint ) {
1911 * case client: ClientOnlyData;
1912 * case server: uint64 start_time;
1913 * };
1914 * } serialized_session_tls13;
1915 *
1916 */
1917#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08001918MBEDTLS_CHECK_RETURN_CRITICAL
1919static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
1920 unsigned char *buf,
1921 size_t buf_len,
1922 size_t *olen )
Jerry Yu438ddd82022-07-07 06:55:50 +00001923{
1924 unsigned char *p = buf;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001925 size_t needed = 1 /* endpoint */
1926 + 2 /* ciphersuite */
1927 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08001928 + 1 /* ticket_flags */
1929 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08001930 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08001931
1932 if( session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN )
1933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1934 needed += session->resumption_key_len; /* resumption_key */
1935
Jerry Yu438ddd82022-07-07 06:55:50 +00001936#if defined(MBEDTLS_HAVE_TIME)
1937 needed += 8; /* start_time or ticket_received */
1938#endif
1939
1940#if defined(MBEDTLS_SSL_CLI_C)
1941 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1942 {
1943 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08001944 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08001945
1946 /* Check size_t overflow */
Jerry Yue36fdd62022-08-17 21:31:36 +08001947 if( session->ticket_len > SIZE_MAX - needed )
1948 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu34191072022-08-18 10:32:09 +08001949
Jerry Yue28d9742022-08-18 15:44:03 +08001950 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00001951 }
1952#endif /* MBEDTLS_SSL_CLI_C */
1953
Jerry Yue36fdd62022-08-17 21:31:36 +08001954 *olen = needed;
Jerry Yu438ddd82022-07-07 06:55:50 +00001955 if( needed > buf_len )
Jerry Yue36fdd62022-08-17 21:31:36 +08001956 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Jerry Yu438ddd82022-07-07 06:55:50 +00001957
1958 p[0] = session->endpoint;
1959 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
1960 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
1961 p[7] = session->ticket_flags;
1962
1963 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08001964 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001965 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001966 memcpy( p, session->resumption_key, session->resumption_key_len );
1967 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001968
1969#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
1970 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
1971 {
1972 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
1973 p += 8;
1974 }
1975#endif /* MBEDTLS_HAVE_TIME */
1976
1977#if defined(MBEDTLS_SSL_CLI_C)
1978 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1979 {
1980#if defined(MBEDTLS_HAVE_TIME)
1981 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
1982 p += 8;
1983#endif
1984 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
1985 p += 4;
1986
1987 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
1988 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08001989
1990 if( session->ticket != NULL && session->ticket_len > 0 )
Jerry Yu438ddd82022-07-07 06:55:50 +00001991 {
1992 memcpy( p, session->ticket, session->ticket_len );
1993 p += session->ticket_len;
1994 }
1995 }
1996#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yue36fdd62022-08-17 21:31:36 +08001997 return( 0 );
Jerry Yu438ddd82022-07-07 06:55:50 +00001998}
1999
2000MBEDTLS_CHECK_RETURN_CRITICAL
2001static int ssl_tls13_session_load( mbedtls_ssl_session *session,
2002 const unsigned char *buf,
2003 size_t len )
2004{
2005 const unsigned char *p = buf;
2006 const unsigned char *end = buf + len;
2007
2008 if( end - p < 9 )
2009 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2010 session->endpoint = p[0];
2011 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2012 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2013 session->ticket_flags = p[7];
2014
2015 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002016 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002017 p += 9;
2018
Jerry Yubc7c1a42022-07-21 22:57:37 +08002019 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002020 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2021
Jerry Yubc7c1a42022-07-21 22:57:37 +08002022 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002023 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002024 memcpy( session->resumption_key, p, session->resumption_key_len );
2025 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002026
2027#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2028 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2029 {
2030 if( end - p < 8 )
2031 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2032 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2033 p += 8;
2034 }
2035#endif /* MBEDTLS_HAVE_TIME */
2036
2037#if defined(MBEDTLS_SSL_CLI_C)
2038 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2039 {
2040#if defined(MBEDTLS_HAVE_TIME)
2041 if( end - p < 8 )
2042 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2043 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2044 p += 8;
2045#endif
2046 if( end - p < 4 )
2047 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2048 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2049 p += 4;
2050
2051 if( end - p < 2 )
2052 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2053 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2054 p += 2;
2055
2056 if( end - p < ( long int )session->ticket_len )
2057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2058 if( session->ticket_len > 0 )
2059 {
2060 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2061 if( session->ticket == NULL )
2062 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2063 memcpy( session->ticket, p, session->ticket_len );
2064 p += session->ticket_len;
2065 }
2066 }
2067#endif /* MBEDTLS_SSL_CLI_C */
2068
2069 return( 0 );
2070
2071}
2072#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002073MBEDTLS_CHECK_RETURN_CRITICAL
2074static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2075 unsigned char *buf,
2076 size_t buf_len,
2077 size_t *olen )
Jerry Yu251a12e2022-07-13 15:15:48 +08002078{
2079 ((void) session);
2080 ((void) buf);
2081 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002082 *olen = 0;
2083 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu251a12e2022-07-13 15:15:48 +08002084}
Jerry Yu438ddd82022-07-07 06:55:50 +00002085
2086static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2087 unsigned char *buf,
2088 size_t buf_len )
2089{
2090 ((void) session);
2091 ((void) buf);
2092 ((void) buf_len);
2093 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2094}
2095#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002096#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2097
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002098psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002099 size_t taglen,
2100 psa_algorithm_t *alg,
2101 psa_key_type_t *key_type,
2102 size_t *key_size )
2103{
2104 switch ( mbedtls_cipher_type )
2105 {
2106 case MBEDTLS_CIPHER_AES_128_CBC:
2107 *alg = PSA_ALG_CBC_NO_PADDING;
2108 *key_type = PSA_KEY_TYPE_AES;
2109 *key_size = 128;
2110 break;
2111 case MBEDTLS_CIPHER_AES_128_CCM:
2112 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2113 *key_type = PSA_KEY_TYPE_AES;
2114 *key_size = 128;
2115 break;
2116 case MBEDTLS_CIPHER_AES_128_GCM:
2117 *alg = PSA_ALG_GCM;
2118 *key_type = PSA_KEY_TYPE_AES;
2119 *key_size = 128;
2120 break;
2121 case MBEDTLS_CIPHER_AES_192_CCM:
2122 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2123 *key_type = PSA_KEY_TYPE_AES;
2124 *key_size = 192;
2125 break;
2126 case MBEDTLS_CIPHER_AES_192_GCM:
2127 *alg = PSA_ALG_GCM;
2128 *key_type = PSA_KEY_TYPE_AES;
2129 *key_size = 192;
2130 break;
2131 case MBEDTLS_CIPHER_AES_256_CBC:
2132 *alg = PSA_ALG_CBC_NO_PADDING;
2133 *key_type = PSA_KEY_TYPE_AES;
2134 *key_size = 256;
2135 break;
2136 case MBEDTLS_CIPHER_AES_256_CCM:
2137 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2138 *key_type = PSA_KEY_TYPE_AES;
2139 *key_size = 256;
2140 break;
2141 case MBEDTLS_CIPHER_AES_256_GCM:
2142 *alg = PSA_ALG_GCM;
2143 *key_type = PSA_KEY_TYPE_AES;
2144 *key_size = 256;
2145 break;
2146 case MBEDTLS_CIPHER_ARIA_128_CBC:
2147 *alg = PSA_ALG_CBC_NO_PADDING;
2148 *key_type = PSA_KEY_TYPE_ARIA;
2149 *key_size = 128;
2150 break;
2151 case MBEDTLS_CIPHER_ARIA_128_CCM:
2152 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2153 *key_type = PSA_KEY_TYPE_ARIA;
2154 *key_size = 128;
2155 break;
2156 case MBEDTLS_CIPHER_ARIA_128_GCM:
2157 *alg = PSA_ALG_GCM;
2158 *key_type = PSA_KEY_TYPE_ARIA;
2159 *key_size = 128;
2160 break;
2161 case MBEDTLS_CIPHER_ARIA_192_CCM:
2162 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2163 *key_type = PSA_KEY_TYPE_ARIA;
2164 *key_size = 192;
2165 break;
2166 case MBEDTLS_CIPHER_ARIA_192_GCM:
2167 *alg = PSA_ALG_GCM;
2168 *key_type = PSA_KEY_TYPE_ARIA;
2169 *key_size = 192;
2170 break;
2171 case MBEDTLS_CIPHER_ARIA_256_CBC:
2172 *alg = PSA_ALG_CBC_NO_PADDING;
2173 *key_type = PSA_KEY_TYPE_ARIA;
2174 *key_size = 256;
2175 break;
2176 case MBEDTLS_CIPHER_ARIA_256_CCM:
2177 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2178 *key_type = PSA_KEY_TYPE_ARIA;
2179 *key_size = 256;
2180 break;
2181 case MBEDTLS_CIPHER_ARIA_256_GCM:
2182 *alg = PSA_ALG_GCM;
2183 *key_type = PSA_KEY_TYPE_ARIA;
2184 *key_size = 256;
2185 break;
2186 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2187 *alg = PSA_ALG_CBC_NO_PADDING;
2188 *key_type = PSA_KEY_TYPE_CAMELLIA;
2189 *key_size = 128;
2190 break;
2191 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2192 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2193 *key_type = PSA_KEY_TYPE_CAMELLIA;
2194 *key_size = 128;
2195 break;
2196 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2197 *alg = PSA_ALG_GCM;
2198 *key_type = PSA_KEY_TYPE_CAMELLIA;
2199 *key_size = 128;
2200 break;
2201 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2202 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2203 *key_type = PSA_KEY_TYPE_CAMELLIA;
2204 *key_size = 192;
2205 break;
2206 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2207 *alg = PSA_ALG_GCM;
2208 *key_type = PSA_KEY_TYPE_CAMELLIA;
2209 *key_size = 192;
2210 break;
2211 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2212 *alg = PSA_ALG_CBC_NO_PADDING;
2213 *key_type = PSA_KEY_TYPE_CAMELLIA;
2214 *key_size = 256;
2215 break;
2216 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2217 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2218 *key_type = PSA_KEY_TYPE_CAMELLIA;
2219 *key_size = 256;
2220 break;
2221 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2222 *alg = PSA_ALG_GCM;
2223 *key_type = PSA_KEY_TYPE_CAMELLIA;
2224 *key_size = 256;
2225 break;
2226 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2227 *alg = PSA_ALG_CHACHA20_POLY1305;
2228 *key_type = PSA_KEY_TYPE_CHACHA20;
2229 *key_size = 256;
2230 break;
2231 case MBEDTLS_CIPHER_NULL:
2232 *alg = MBEDTLS_SSL_NULL_CIPHER;
2233 *key_type = 0;
2234 *key_size = 0;
2235 break;
2236 default:
2237 return PSA_ERROR_NOT_SUPPORTED;
2238 }
2239
2240 return PSA_SUCCESS;
2241}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002242#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002243
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002244#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002245int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2246 const unsigned char *dhm_P, size_t P_len,
2247 const unsigned char *dhm_G, size_t G_len )
2248{
Janos Follath865b3eb2019-12-16 11:46:15 +00002249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002250
Glenn Strausscee11292021-12-20 01:43:17 -05002251 mbedtls_mpi_free( &conf->dhm_P );
2252 mbedtls_mpi_free( &conf->dhm_G );
2253
Hanno Beckera90658f2017-10-04 15:29:08 +01002254 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2255 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2256 {
2257 mbedtls_mpi_free( &conf->dhm_P );
2258 mbedtls_mpi_free( &conf->dhm_G );
2259 return( ret );
2260 }
2261
2262 return( 0 );
2263}
Paul Bakker5121ce52009-01-03 21:22:43 +00002264
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002265int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002266{
Janos Follath865b3eb2019-12-16 11:46:15 +00002267 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002268
Glenn Strausscee11292021-12-20 01:43:17 -05002269 mbedtls_mpi_free( &conf->dhm_P );
2270 mbedtls_mpi_free( &conf->dhm_G );
2271
Gilles Peskinee5702482021-06-11 21:59:08 +02002272 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2273 &conf->dhm_P ) ) != 0 ||
2274 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2275 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002276 {
2277 mbedtls_mpi_free( &conf->dhm_P );
2278 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002279 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002280 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002281
2282 return( 0 );
2283}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002284#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002285
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002286#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2287/*
2288 * Set the minimum length for Diffie-Hellman parameters
2289 */
2290void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2291 unsigned int bitlen )
2292{
2293 conf->dhm_min_bitlen = bitlen;
2294}
2295#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2296
Gilles Peskineeccd8882020-03-10 12:19:08 +01002297#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002298#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002299/*
2300 * Set allowed/preferred hashes for handshake signatures
2301 */
2302void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2303 const int *hashes )
2304{
2305 conf->sig_hashes = hashes;
2306}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002307#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002308
Jerry Yuf017ee42022-01-12 15:49:48 +08002309/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002310void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2311 const uint16_t* sig_algs )
2312{
Jerry Yuf017ee42022-01-12 15:49:48 +08002313#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2314 conf->sig_hashes = NULL;
2315#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2316 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002317}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002318#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002319
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002320#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002321#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002322/*
2323 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002324 *
2325 * mbedtls_ssl_setup() takes the provided list
2326 * and translates it to a list of IANA TLS group identifiers,
2327 * stored in ssl->handshake->group_list.
2328 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002329 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002330void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002331 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002332{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002333 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002334 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002335}
Brett Warrene0edc842021-08-17 09:53:13 +01002336#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002337#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002338
Brett Warrene0edc842021-08-17 09:53:13 +01002339/*
2340 * Set the allowed groups
2341 */
2342void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2343 const uint16_t *group_list )
2344{
2345#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2346 conf->curve_list = NULL;
2347#endif
2348 conf->group_list = group_list;
2349}
2350
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002351#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002353{
Hanno Becker947194e2017-04-07 13:25:49 +01002354 /* Initialize to suppress unnecessary compiler warning */
2355 size_t hostname_len = 0;
2356
2357 /* Check if new hostname is valid before
2358 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002359 if( hostname != NULL )
2360 {
2361 hostname_len = strlen( hostname );
2362
2363 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2364 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2365 }
2366
2367 /* Now it's clear that we will overwrite the old hostname,
2368 * so we can free it safely */
2369
2370 if( ssl->hostname != NULL )
2371 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002372 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002373 mbedtls_free( ssl->hostname );
2374 }
2375
2376 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002377
Paul Bakker5121ce52009-01-03 21:22:43 +00002378 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002379 {
2380 ssl->hostname = NULL;
2381 }
2382 else
2383 {
2384 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002385 if( ssl->hostname == NULL )
2386 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002387
Hanno Becker947194e2017-04-07 13:25:49 +01002388 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002389
Hanno Becker947194e2017-04-07 13:25:49 +01002390 ssl->hostname[hostname_len] = '\0';
2391 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002392
2393 return( 0 );
2394}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002395#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002397#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002398void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002400 const unsigned char *, size_t),
2401 void *p_sni )
2402{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002403 conf->f_sni = f_sni;
2404 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002405}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002409int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002410{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002411 size_t cur_len, tot_len;
2412 const char **p;
2413
2414 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002415 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2416 * MUST NOT be truncated."
2417 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002418 */
2419 tot_len = 0;
2420 for( p = protos; *p != NULL; p++ )
2421 {
2422 cur_len = strlen( *p );
2423 tot_len += cur_len;
2424
Ronald Cron8216dd32020-04-23 16:41:44 +02002425 if( ( cur_len == 0 ) ||
2426 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2427 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002429 }
2430
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002431 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002432
2433 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002434}
2435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002437{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002438 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002439}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002441
Johan Pascalb62bb512015-12-03 21:56:45 +01002442#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002443void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2444 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002445{
2446 conf->dtls_srtp_mki_support = support_mki_value;
2447}
2448
Ron Eldoref72faf2018-07-12 11:54:20 +03002449int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2450 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002451 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002452{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002453 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002454 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002455 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002456 }
Ron Eldor591f1622018-01-22 12:30:04 +02002457
2458 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002459 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002460 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002461 }
Ron Eldor591f1622018-01-22 12:30:04 +02002462
2463 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2464 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002465 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002466}
2467
Ron Eldoref72faf2018-07-12 11:54:20 +03002468int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002469 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002470{
Johan Pascal253d0262020-09-22 13:04:45 +02002471 const mbedtls_ssl_srtp_profile *p;
2472 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002473
Johan Pascal253d0262020-09-22 13:04:45 +02002474 /* check the profiles list: all entry must be valid,
2475 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002476 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2477 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2478 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002479 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002480 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002481 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002482 list_size++;
2483 }
2484 else
2485 {
2486 /* unsupported value, stop parsing and set the size to an error value */
2487 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002488 }
2489 }
2490
Johan Pascal5ef72d22020-10-28 17:05:47 +01002491 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002492 {
Johan Pascal253d0262020-09-22 13:04:45 +02002493 conf->dtls_srtp_profile_list = NULL;
2494 conf->dtls_srtp_profile_list_len = 0;
2495 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2496 }
2497
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002498 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002499 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002500
2501 return( 0 );
2502}
2503
Johan Pascal5ef72d22020-10-28 17:05:47 +01002504void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2505 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002506{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002507 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2508 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002509 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002510 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002511 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002512 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002513 else
2514 {
2515 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002516 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2517 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002518 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002519}
Johan Pascalb62bb512015-12-03 21:56:45 +01002520#endif /* MBEDTLS_SSL_DTLS_SRTP */
2521
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302522#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002523void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002524{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002525 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002526}
2527
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002528void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002529{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002530 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002531}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302532#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002533
Janos Follath088ce432017-04-10 12:42:31 +01002534#if defined(MBEDTLS_SSL_SRV_C)
2535void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2536 char cert_req_ca_list )
2537{
2538 conf->cert_req_ca_list = cert_req_ca_list;
2539}
2540#endif
2541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002543void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002544{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002545 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002546}
2547#endif
2548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002550void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002551{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002552 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002553}
2554#endif
2555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002557int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002558{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002560 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002563 }
2564
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002565 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002566
2567 return( 0 );
2568}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002570
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002571void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002572{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002573 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002574}
2575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002577void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002578{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002579 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002580}
2581
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002582void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002583{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002584 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002585}
2586
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002587void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002588 const unsigned char period[8] )
2589{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002590 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002591}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002595#if defined(MBEDTLS_SSL_CLI_C)
2596void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002597{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002598 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002599}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002600#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002601
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002602#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002603void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2604 mbedtls_ssl_ticket_write_t *f_ticket_write,
2605 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2606 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002607{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002608 conf->f_ticket_write = f_ticket_write;
2609 conf->f_ticket_parse = f_ticket_parse;
2610 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002611}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002612#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002614
Hanno Becker7e6c1782021-06-08 09:24:55 +01002615void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2616 mbedtls_ssl_export_keys_t *f_export_keys,
2617 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002618{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002619 ssl->f_export_keys = f_export_keys;
2620 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002621}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002622
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002623#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002624void mbedtls_ssl_conf_async_private_cb(
2625 mbedtls_ssl_config *conf,
2626 mbedtls_ssl_async_sign_t *f_async_sign,
2627 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2628 mbedtls_ssl_async_resume_t *f_async_resume,
2629 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002630 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002631{
2632 conf->f_async_sign_start = f_async_sign;
2633 conf->f_async_decrypt_start = f_async_decrypt;
2634 conf->f_async_resume = f_async_resume;
2635 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002636 conf->p_async_config_data = async_config_data;
2637}
2638
Gilles Peskine8f97af72018-04-26 11:46:10 +02002639void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2640{
2641 return( conf->p_async_config_data );
2642}
2643
Gilles Peskine1febfef2018-04-30 11:54:39 +02002644void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002645{
2646 if( ssl->handshake == NULL )
2647 return( NULL );
2648 else
2649 return( ssl->handshake->user_async_ctx );
2650}
2651
Gilles Peskine1febfef2018-04-30 11:54:39 +02002652void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002653 void *ctx )
2654{
2655 if( ssl->handshake != NULL )
2656 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002657}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002658#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002659
Paul Bakker5121ce52009-01-03 21:22:43 +00002660/*
2661 * SSL get accessors
2662 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002663uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002664{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002665 if( ssl->session != NULL )
2666 return( ssl->session->verify_result );
2667
2668 if( ssl->session_negotiate != NULL )
2669 return( ssl->session_negotiate->verify_result );
2670
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002671 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002672}
2673
Glenn Strauss8f526902022-01-13 00:04:49 -05002674int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2675{
2676 if( ssl == NULL || ssl->session == NULL )
2677 return( 0 );
2678
2679 return( ssl->session->ciphersuite );
2680}
2681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002683{
Paul Bakker926c8e42013-03-06 10:23:34 +01002684 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002685 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002688}
2689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002691{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002693 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002694 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002695 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002696 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002697 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002698 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002699 default:
2700 return( "unknown (DTLS)" );
2701 }
2702 }
2703#endif
2704
Glenn Strauss60bfe602022-03-14 19:04:24 -04002705 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002706 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002707 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002708 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002709 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002710 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002711 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002712 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002713 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002714}
2715
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002716#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002717size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2718{
David Horstmann95d516f2021-05-04 18:36:56 +01002719 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002720 size_t read_mfl;
2721
2722 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2723 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2724 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2725 {
2726 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2727 }
2728
2729 /* Check if a smaller max length was negotiated */
2730 if( ssl->session_out != NULL )
2731 {
2732 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2733 if( read_mfl < max_len )
2734 {
2735 max_len = read_mfl;
2736 }
2737 }
2738
2739 // During a handshake, use the value being negotiated
2740 if( ssl->session_negotiate != NULL )
2741 {
2742 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2743 if( read_mfl < max_len )
2744 {
2745 max_len = read_mfl;
2746 }
2747 }
2748
2749 return( max_len );
2750}
2751
2752size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002753{
2754 size_t max_len;
2755
2756 /*
2757 * Assume mfl_code is correct since it was checked when set
2758 */
Angus Grattond8213d02016-05-25 20:56:48 +10002759 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002760
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002761 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002762 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002763 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002764 {
Angus Grattond8213d02016-05-25 20:56:48 +10002765 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002766 }
2767
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002768 /* During a handshake, use the value being negotiated */
2769 if( ssl->session_negotiate != NULL &&
2770 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2771 {
2772 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2773 }
2774
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002775 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002776}
2777#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2778
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002780size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002781{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002782 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2783 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2784 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2785 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2786 return ( 0 );
2787
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002788 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2789 return( ssl->mtu );
2790
2791 if( ssl->mtu == 0 )
2792 return( ssl->handshake->mtu );
2793
2794 return( ssl->mtu < ssl->handshake->mtu ?
2795 ssl->mtu : ssl->handshake->mtu );
2796}
2797#endif /* MBEDTLS_SSL_PROTO_DTLS */
2798
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002799int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2800{
2801 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2802
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002803#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2804 !defined(MBEDTLS_SSL_PROTO_DTLS)
2805 (void) ssl;
2806#endif
2807
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002808#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002809 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002810
2811 if( max_len > mfl )
2812 max_len = mfl;
2813#endif
2814
2815#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002816 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002817 {
Hanno Becker89490712020-02-05 10:50:12 +00002818 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002819 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2820 const size_t overhead = (size_t) ret;
2821
2822 if( ret < 0 )
2823 return( ret );
2824
2825 if( mtu <= overhead )
2826 {
2827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2828 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2829 }
2830
2831 if( max_len > mtu - overhead )
2832 max_len = mtu - overhead;
2833 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002834#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002835
Hanno Becker0defedb2018-08-10 12:35:02 +01002836#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2837 !defined(MBEDTLS_SSL_PROTO_DTLS)
2838 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002839#endif
2840
2841 return( (int) max_len );
2842}
2843
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002844int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2845{
2846 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2847
2848#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2849 (void) ssl;
2850#endif
2851
2852#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2853 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2854
2855 if( max_len > mfl )
2856 max_len = mfl;
2857#endif
2858
2859 return( (int) max_len );
2860}
2861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862#if defined(MBEDTLS_X509_CRT_PARSE_C)
2863const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002864{
2865 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002866 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002867
Hanno Beckere6824572019-02-07 13:18:46 +00002868#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002869 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002870#else
2871 return( NULL );
2872#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002873}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002877int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2878 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002879{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002880 int ret;
2881
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002882 if( ssl == NULL ||
2883 dst == NULL ||
2884 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002885 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002886 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002888 }
2889
Hanno Beckere810bbc2021-05-14 16:01:05 +01002890 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2891 * idempotent: Each session can only be exported once.
2892 *
2893 * (This is in preparation for TLS 1.3 support where we will
2894 * need the ability to export multiple sessions (aka tickets),
2895 * which will be achieved by calling mbedtls_ssl_get_session()
2896 * multiple times until it fails.)
2897 *
2898 * Check whether we have already exported the current session,
2899 * and fail if so.
2900 */
2901 if( ssl->session->exported == 1 )
2902 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2903
2904 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2905 if( ret != 0 )
2906 return( ret );
2907
2908 /* Remember that we've exported the session. */
2909 ssl->session->exported = 1;
2910 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002911}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002913
Paul Bakker5121ce52009-01-03 21:22:43 +00002914/*
Hanno Beckera835da52019-05-16 12:39:07 +01002915 * Define ticket header determining Mbed TLS version
2916 * and structure of the ticket.
2917 */
2918
Hanno Becker94ef3b32019-05-16 12:50:45 +01002919/*
Hanno Becker50b59662019-05-28 14:30:45 +01002920 * Define bitflag determining compile-time settings influencing
2921 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002922 */
2923
Hanno Becker50b59662019-05-28 14:30:45 +01002924#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002925#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002926#else
Hanno Becker3e088662019-05-29 11:10:18 +01002927#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002928#endif /* MBEDTLS_HAVE_TIME */
2929
2930#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002931#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002932#else
Hanno Becker3e088662019-05-29 11:10:18 +01002933#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002934#endif /* MBEDTLS_X509_CRT_PARSE_C */
2935
2936#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002937#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002938#else
Hanno Becker3e088662019-05-29 11:10:18 +01002939#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002940#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2941
2942#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002943#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002944#else
Hanno Becker3e088662019-05-29 11:10:18 +01002945#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002946#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2947
Hanno Becker94ef3b32019-05-16 12:50:45 +01002948#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002949#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002950#else
Hanno Becker3e088662019-05-29 11:10:18 +01002951#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002952#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2953
Hanno Becker94ef3b32019-05-16 12:50:45 +01002954#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2955#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2956#else
2957#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2958#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2959
Hanno Becker3e088662019-05-29 11:10:18 +01002960#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2961#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2962#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2963#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002964#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2965#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002966
Hanno Becker50b59662019-05-28 14:30:45 +01002967#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002968 ( (uint16_t) ( \
2969 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2970 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2971 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2972 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002973 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002974 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002975
Hanno Beckerf8787072019-05-16 12:41:07 +01002976static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002977 MBEDTLS_VERSION_MAJOR,
2978 MBEDTLS_VERSION_MINOR,
2979 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002980 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2981 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002982};
Hanno Beckera835da52019-05-16 12:39:07 +01002983
2984/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002985 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002986 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002987 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002988 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002989 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002990 * opaque mbedtls_version[3]; // library version: major, minor, patch
2991 * opaque session_format[2]; // library-version specific 16-bit field
2992 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002993 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002994 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002995 * Note: When updating the format, remember to keep
2996 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002997 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002998 * // In this version, `session_format` determines
2999 * // the setting of those compile-time
3000 * // configuration options which influence
3001 * // the structure of mbedtls_ssl_session.
3002 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003003 * uint8_t minor_ver; // Protocol minor version. Possible values:
3004 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003005 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003006 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003007 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003008 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003009 * serialized_session_tls12 data;
3010 *
3011 * };
3012 *
3013 * } serialized_session;
3014 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003015 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003016
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003017MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003018static int ssl_session_save( const mbedtls_ssl_session *session,
3019 unsigned char omit_header,
3020 unsigned char *buf,
3021 size_t buf_len,
3022 size_t *olen )
3023{
3024 unsigned char *p = buf;
3025 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003026 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003027#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3028 size_t out_len;
3029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3030#endif
Jerry Yu438ddd82022-07-07 06:55:50 +00003031 if( session == NULL )
3032 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3033
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003034 if( !omit_header )
3035 {
3036 /*
3037 * Add Mbed TLS version identifier
3038 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003039 used += sizeof( ssl_serialized_session_header );
3040
3041 if( used <= buf_len )
3042 {
3043 memcpy( p, ssl_serialized_session_header,
3044 sizeof( ssl_serialized_session_header ) );
3045 p += sizeof( ssl_serialized_session_header );
3046 }
3047 }
3048
3049 /*
3050 * TLS version identifier
3051 */
3052 used += 1;
3053 if( used <= buf_len )
3054 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003055 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003056 }
3057
3058 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003059 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003060 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003061 {
3062#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003063 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003064 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003065 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3067
Jerry Yu251a12e2022-07-13 15:15:48 +08003068#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3069 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yue36fdd62022-08-17 21:31:36 +08003070 ret = ssl_tls13_session_save( session, p, remaining_len, &out_len );
3071 if( ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
Jerry Yue36fdd62022-08-17 21:31:36 +08003072 return( ret );
Jerry Yue36fdd62022-08-17 21:31:36 +08003073 used += out_len;
Jerry Yu251a12e2022-07-13 15:15:48 +08003074 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003075#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3076
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003077 default:
3078 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3079 }
3080
3081 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003082 if( used > buf_len )
3083 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003084
3085 return( 0 );
3086}
3087
3088/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003089 * Public wrapper for ssl_session_save()
3090 */
3091int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3092 unsigned char *buf,
3093 size_t buf_len,
3094 size_t *olen )
3095{
3096 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3097}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003098
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003099/*
3100 * Deserialize session, see mbedtls_ssl_session_save() for format.
3101 *
3102 * This internal version is wrapped by a public function that cleans up in
3103 * case of error, and has an extra option omit_header.
3104 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003105MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003106static int ssl_session_load( mbedtls_ssl_session *session,
3107 unsigned char omit_header,
3108 const unsigned char *buf,
3109 size_t len )
3110{
3111 const unsigned char *p = buf;
3112 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003113 size_t remaining_len;
3114
3115
3116 if( session == NULL )
3117 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003118
3119 if( !omit_header )
3120 {
3121 /*
3122 * Check Mbed TLS version identifier
3123 */
3124
3125 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3126 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3127
3128 if( memcmp( p, ssl_serialized_session_header,
3129 sizeof( ssl_serialized_session_header ) ) != 0 )
3130 {
3131 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3132 }
3133 p += sizeof( ssl_serialized_session_header );
3134 }
3135
3136 /*
3137 * TLS version identifier
3138 */
3139 if( 1 > (size_t)( end - p ) )
3140 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003141 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003142
3143 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003144 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003145 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003146 {
3147#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003148 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003149 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003150#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3151
Jerry Yu438ddd82022-07-07 06:55:50 +00003152#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3153 case MBEDTLS_SSL_VERSION_TLS1_3:
3154 return( ssl_tls13_session_load( session, p, remaining_len ) );
3155#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3156
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003157 default:
3158 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3159 }
3160}
3161
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003162/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003163 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003164 */
3165int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3166 const unsigned char *buf,
3167 size_t len )
3168{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003169 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003170
3171 if( ret != 0 )
3172 mbedtls_ssl_session_free( session );
3173
3174 return( ret );
3175}
3176
3177/*
Paul Bakker1961b702013-01-25 14:49:24 +01003178 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003179 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003180MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003181static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3182{
3183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3184
Ronald Cron66dbf912022-02-02 15:33:46 +01003185 /*
3186 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003187 * that were written into the output buffer by the previous handshake step,
3188 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003189 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3190 * We proceed to the next handshake step only when all data from the
3191 * previous one have been sent to the peer, thus we make sure that this is
3192 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3193 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3194 * we have to wait before to go ahead.
3195 * In the case of TLS 1.3, handshake step handlers do not send data to the
3196 * peer. Data are only sent here and through
3197 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003198 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003199 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003200 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3201 return( ret );
3202
3203#if defined(MBEDTLS_SSL_PROTO_DTLS)
3204 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3205 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3206 {
3207 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3208 return( ret );
3209 }
3210#endif /* MBEDTLS_SSL_PROTO_DTLS */
3211
3212 return( ret );
3213}
3214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003216{
Hanno Becker41934dd2021-08-07 19:13:43 +01003217 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003218
Hanno Becker41934dd2021-08-07 19:13:43 +01003219 if( ssl == NULL ||
3220 ssl->conf == NULL ||
3221 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003222 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003223 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003224 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003225 }
3226
3227 ret = ssl_prepare_handshake_step( ssl );
3228 if( ret != 0 )
3229 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003230
Jerry Yue7047812021-09-13 19:26:39 +08003231 ret = mbedtls_ssl_handle_pending_alert( ssl );
3232 if( ret != 0 )
3233 goto cleanup;
3234
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003236 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003237 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3239 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003240
Ronald Cron9f0fba32022-02-10 16:45:15 +01003241 switch( ssl->state )
3242 {
3243 case MBEDTLS_SSL_HELLO_REQUEST:
3244 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3245 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003246
Ronald Cron9f0fba32022-02-10 16:45:15 +01003247 case MBEDTLS_SSL_CLIENT_HELLO:
3248 ret = mbedtls_ssl_write_client_hello( ssl );
3249 break;
3250
3251 default:
3252#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003253 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003254 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3255 else
3256 ret = mbedtls_ssl_handshake_client_step( ssl );
3257#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3258 ret = mbedtls_ssl_handshake_client_step( ssl );
3259#else
3260 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3261#endif
3262 }
Jerry Yub9930e72021-08-06 17:11:51 +08003263 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003264#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003265#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003266 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003267 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003268#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003269 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003270 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003271#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003272
3273#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3274 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3275 ret = mbedtls_ssl_handshake_server_step( ssl );
3276#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3277 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003278#endif
3279
Jerry Yue7047812021-09-13 19:26:39 +08003280 if( ret != 0 )
3281 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003282 /* handshake_step return error. And it is same
3283 * with alert_reason.
3284 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003285 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003286 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003287 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003288 goto cleanup;
3289 }
3290 }
3291
3292cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003293 return( ret );
3294}
3295
3296/*
3297 * Perform the SSL handshake
3298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003300{
3301 int ret = 0;
3302
Hanno Beckera817ea42020-10-20 15:20:23 +01003303 /* Sanity checks */
3304
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003305 if( ssl == NULL || ssl->conf == NULL )
3306 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3307
Hanno Beckera817ea42020-10-20 15:20:23 +01003308#if defined(MBEDTLS_SSL_PROTO_DTLS)
3309 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3310 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3311 {
3312 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3313 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3314 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3315 }
3316#endif /* MBEDTLS_SSL_PROTO_DTLS */
3317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003319
Hanno Beckera817ea42020-10-20 15:20:23 +01003320 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003321 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003322 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003324
3325 if( ret != 0 )
3326 break;
3327 }
3328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003330
3331 return( ret );
3332}
3333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334#if defined(MBEDTLS_SSL_RENEGOTIATION)
3335#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003336/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003337 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003338 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003339MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003341{
Janos Follath865b3eb2019-12-16 11:46:15 +00003342 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003345
3346 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3348 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003349
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003350 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003351 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003352 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003353 return( ret );
3354 }
3355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003357
3358 return( 0 );
3359}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003361
3362/*
3363 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003364 * - any side: calling mbedtls_ssl_renegotiate(),
3365 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3366 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003367 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003368 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003370 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003371int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003372{
Janos Follath865b3eb2019-12-16 11:46:15 +00003373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003376
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003377 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3378 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003379
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003380 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3381 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003383 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003385 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003386 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003387 ssl->handshake->out_msg_seq = 1;
3388 else
3389 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003390 }
3391#endif
3392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3394 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003397 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003399 return( ret );
3400 }
3401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003403
3404 return( 0 );
3405}
3406
3407/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003408 * Renegotiate current connection on client,
3409 * or request renegotiation on server
3410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003412{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003414
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003415 if( ssl == NULL || ssl->conf == NULL )
3416 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3417
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003419 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003420 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003421 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003422 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003426
3427 /* Did we already try/start sending HelloRequest? */
3428 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003430
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003431 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003432 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003436 /*
3437 * On client, either start the renegotiation process or,
3438 * if already in progress, continue the handshake
3439 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003441 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003442 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003444
Hanno Becker40cdaa12020-02-05 10:48:27 +00003445 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003446 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003447 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003448 return( ret );
3449 }
3450 }
3451 else
3452 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003456 return( ret );
3457 }
3458 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003460
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003461 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003462}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003464
Gilles Peskine9b562d52018-04-25 20:32:43 +02003465void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003466{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003467 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3468
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003469 if( handshake == NULL )
3470 return;
3471
Brett Warrene0edc842021-08-17 09:53:13 +01003472#if defined(MBEDTLS_ECP_C)
3473#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3474 if ( ssl->handshake->group_list_heap_allocated )
3475 mbedtls_free( (void*) handshake->group_list );
3476 handshake->group_list = NULL;
3477#endif /* MBEDTLS_DEPRECATED_REMOVED */
3478#endif /* MBEDTLS_ECP_C */
3479
Jerry Yuf017ee42022-01-12 15:49:48 +08003480#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3481#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3482 if ( ssl->handshake->sig_algs_heap_allocated )
3483 mbedtls_free( (void*) handshake->sig_algs );
3484 handshake->sig_algs = NULL;
3485#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003486#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3487 if( ssl->handshake->certificate_request_context )
3488 {
3489 mbedtls_free( (void*) handshake->certificate_request_context );
3490 }
3491#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003492#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3493
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003494#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3495 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3496 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003497 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003498 handshake->async_in_progress = 0;
3499 }
3500#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3501
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003502#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003503#if defined(MBEDTLS_USE_PSA_CRYPTO)
3504 psa_hash_abort( &handshake->fin_sha256_psa );
3505#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003506 mbedtls_sha256_free( &handshake->fin_sha256 );
3507#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003508#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003509#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003510#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003511 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003512#else
Andrzej Kureka242e832022-08-11 10:03:14 -04003513 mbedtls_sha512_free( &handshake->fin_sha384 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003514#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003515#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#if defined(MBEDTLS_DHM_C)
3518 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003519#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003520#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003522#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003523#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003524 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003525#if defined(MBEDTLS_SSL_CLI_C)
3526 mbedtls_free( handshake->ecjpake_cache );
3527 handshake->ecjpake_cache = NULL;
3528 handshake->ecjpake_cache_len = 0;
3529#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003530#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003531
Janos Follath4ae5c292016-02-10 11:27:43 +00003532#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3533 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003534 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003535 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003536#endif
3537
Gilles Peskineeccd8882020-03-10 12:19:08 +01003538#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003539#if defined(MBEDTLS_USE_PSA_CRYPTO)
3540 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3541 {
3542 /* The maintenance of the external PSK key slot is the
3543 * user's responsibility. */
3544 if( ssl->handshake->psk_opaque_is_internal )
3545 {
3546 psa_destroy_key( ssl->handshake->psk_opaque );
3547 ssl->handshake->psk_opaque_is_internal = 0;
3548 }
3549 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3550 }
Neil Armstronge952a302022-05-03 10:22:14 +02003551#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003552 if( handshake->psk != NULL )
3553 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003554 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003555 mbedtls_free( handshake->psk );
3556 }
Neil Armstronge952a302022-05-03 10:22:14 +02003557#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003558#endif
3559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3561 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003562 /*
3563 * Free only the linked list wrapper, not the keys themselves
3564 * since the belong to the SNI callback
3565 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003566 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003568
Gilles Peskineeccd8882020-03-10 12:19:08 +01003569#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003570 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003571 if( handshake->ecrs_peer_cert != NULL )
3572 {
3573 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3574 mbedtls_free( handshake->ecrs_peer_cert );
3575 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003576#endif
3577
Hanno Becker75173122019-02-06 16:18:31 +00003578#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3579 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3580 mbedtls_pk_free( &handshake->peer_pubkey );
3581#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3582
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003583#if defined(MBEDTLS_SSL_CLI_C) && \
3584 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3585 mbedtls_free( handshake->cookie );
3586#endif /* MBEDTLS_SSL_CLI_C &&
3587 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003588
3589#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003590 mbedtls_ssl_flight_free( handshake->flight );
3591 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003592#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003593
Ronald Cronf12b81d2022-03-15 10:42:41 +01003594#if defined(MBEDTLS_ECDH_C) && \
3595 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003596 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003597 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003598#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3599
Ronald Cron6f135e12021-12-08 16:57:54 +01003600#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003601 mbedtls_ssl_transform_free( handshake->transform_handshake );
3602 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003603 mbedtls_free( handshake->transform_earlydata );
3604 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003605#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003606
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003607
3608#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3609 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3610 * processes datagrams and the fact that a datagram is allowed to have
3611 * several records in it, it is possible that the I/O buffers are not
3612 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003613 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3614 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003615#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003616
Jerry Yuba9c7272021-10-30 11:54:10 +08003617 /* mbedtls_platform_zeroize MUST be last one in this function */
3618 mbedtls_platform_zeroize( handshake,
3619 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003620}
3621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003622void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003623{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003624 if( session == NULL )
3625 return;
3626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003628 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003629#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003630
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003631#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003633#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003634
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003635 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003636}
3637
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003638#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003639
3640#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3641#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3642#else
3643#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3644#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3645
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003646#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003647
3648#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3649#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3650#else
3651#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3652#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3653
3654#if defined(MBEDTLS_SSL_ALPN)
3655#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3656#else
3657#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3658#endif /* MBEDTLS_SSL_ALPN */
3659
3660#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3661#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3662#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3663#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3664
3665#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3666 ( (uint32_t) ( \
3667 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3668 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3669 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3670 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3671 0u ) )
3672
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003673static unsigned char ssl_serialized_context_header[] = {
3674 MBEDTLS_VERSION_MAJOR,
3675 MBEDTLS_VERSION_MINOR,
3676 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003677 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3678 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3679 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3680 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3681 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003682};
3683
Paul Bakker5121ce52009-01-03 21:22:43 +00003684/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003685 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003686 *
3687 * The format of the serialized data is:
3688 * (in the presentation language of TLS, RFC 8446 section 3)
3689 *
3690 * // header
3691 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003692 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003693 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003694 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003695 * Note: When updating the format, remember to keep these
3696 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003697 *
3698 * // session sub-structure
3699 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3700 * // transform sub-structure
3701 * uint8 random[64]; // ServerHello.random+ClientHello.random
3702 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3703 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3704 * // fields from ssl_context
3705 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3706 * uint64 in_window_top; // DTLS: last validated record seq_num
3707 * uint64 in_window; // DTLS: bitmask for replay protection
3708 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3709 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3710 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3711 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3712 *
3713 * Note that many fields of the ssl_context or sub-structures are not
3714 * serialized, as they fall in one of the following categories:
3715 *
3716 * 1. forced value (eg in_left must be 0)
3717 * 2. pointer to dynamically-allocated memory (eg session, transform)
3718 * 3. value can be re-derived from other data (eg session keys from MS)
3719 * 4. value was temporary (eg content of input buffer)
3720 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003721 */
3722int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3723 unsigned char *buf,
3724 size_t buf_len,
3725 size_t *olen )
3726{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003727 unsigned char *p = buf;
3728 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729 size_t session_len;
3730 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003731
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003732 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003733 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3734 * this function's documentation.
3735 *
3736 * These are due to assumptions/limitations in the implementation. Some of
3737 * them are likely to stay (no handshake in progress) some might go away
3738 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003739 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003740 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003741 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003742 {
3743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003744 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003745 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003746 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003747 {
3748 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003749 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003750 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003751 /* Double-check that sub-structures are indeed ready */
3752 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003753 {
3754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003756 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003757 /* There must be no pending incoming or outgoing data */
3758 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003759 {
3760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003762 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003763 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003764 {
3765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003767 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003768 /* Protocol must be DLTS, not TLS */
3769 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003770 {
3771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003773 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003774 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003775 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003776 {
3777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003778 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003779 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003780 /* We must be using an AEAD ciphersuite */
3781 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003782 {
3783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003785 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003786 /* Renegotiation must not be enabled */
3787#if defined(MBEDTLS_SSL_RENEGOTIATION)
3788 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003789 {
3790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003791 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003792 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003793#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003794
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003795 /*
3796 * Version and format identifier
3797 */
3798 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003799
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003800 if( used <= buf_len )
3801 {
3802 memcpy( p, ssl_serialized_context_header,
3803 sizeof( ssl_serialized_context_header ) );
3804 p += sizeof( ssl_serialized_context_header );
3805 }
3806
3807 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003808 * Session (length + data)
3809 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003810 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003811 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3812 return( ret );
3813
3814 used += 4 + session_len;
3815 if( used <= buf_len )
3816 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003817 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3818 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003819
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003820 ret = ssl_session_save( ssl->session, 1,
3821 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003822 if( ret != 0 )
3823 return( ret );
3824
3825 p += session_len;
3826 }
3827
3828 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003829 * Transform
3830 */
3831 used += sizeof( ssl->transform->randbytes );
3832 if( used <= buf_len )
3833 {
3834 memcpy( p, ssl->transform->randbytes,
3835 sizeof( ssl->transform->randbytes ) );
3836 p += sizeof( ssl->transform->randbytes );
3837 }
3838
3839#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3840 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3841 if( used <= buf_len )
3842 {
3843 *p++ = ssl->transform->in_cid_len;
3844 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3845 p += ssl->transform->in_cid_len;
3846
3847 *p++ = ssl->transform->out_cid_len;
3848 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3849 p += ssl->transform->out_cid_len;
3850 }
3851#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3852
3853 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003854 * Saved fields from top-level ssl_context structure
3855 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003856 used += 4;
3857 if( used <= buf_len )
3858 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003859 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3860 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003861 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003862
3863#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3864 used += 16;
3865 if( used <= buf_len )
3866 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003867 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3868 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003869
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003870 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3871 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003872 }
3873#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3874
3875#if defined(MBEDTLS_SSL_PROTO_DTLS)
3876 used += 1;
3877 if( used <= buf_len )
3878 {
3879 *p++ = ssl->disable_datagram_packing;
3880 }
3881#endif /* MBEDTLS_SSL_PROTO_DTLS */
3882
Jerry Yuae0b2e22021-10-08 15:21:19 +08003883 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003884 if( used <= buf_len )
3885 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003886 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3887 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003888 }
3889
3890#if defined(MBEDTLS_SSL_PROTO_DTLS)
3891 used += 2;
3892 if( used <= buf_len )
3893 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003894 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3895 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003896 }
3897#endif /* MBEDTLS_SSL_PROTO_DTLS */
3898
3899#if defined(MBEDTLS_SSL_ALPN)
3900 {
3901 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003902 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003903 : 0;
3904
3905 used += 1 + alpn_len;
3906 if( used <= buf_len )
3907 {
3908 *p++ = alpn_len;
3909
3910 if( ssl->alpn_chosen != NULL )
3911 {
3912 memcpy( p, ssl->alpn_chosen, alpn_len );
3913 p += alpn_len;
3914 }
3915 }
3916 }
3917#endif /* MBEDTLS_SSL_ALPN */
3918
3919 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003920 * Done
3921 */
3922 *olen = used;
3923
3924 if( used > buf_len )
3925 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003926
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003927 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3928
Hanno Becker43aefe22020-02-05 10:44:56 +00003929 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003930}
3931
3932/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003933 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003934 *
3935 * This internal version is wrapped by a public function that cleans up in
3936 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003937 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003938MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003939static int ssl_context_load( mbedtls_ssl_context *ssl,
3940 const unsigned char *buf,
3941 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003942{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003943 const unsigned char *p = buf;
3944 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003945 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003947
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003948 /*
3949 * The context should have been freshly setup or reset.
3950 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003951 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003952 * renegotiating, or if the user mistakenly loaded a session first.)
3953 */
3954 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3955 ssl->session != NULL )
3956 {
3957 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3958 }
3959
3960 /*
3961 * We can't check that the config matches the initial one, but we can at
3962 * least check it matches the requirements for serializing.
3963 */
3964 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003965 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3966 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003967#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003968 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003969#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003970 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003971 {
3972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3973 }
3974
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003975 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3976
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003977 /*
3978 * Check version identifier
3979 */
3980 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3981 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3982
3983 if( memcmp( p, ssl_serialized_context_header,
3984 sizeof( ssl_serialized_context_header ) ) != 0 )
3985 {
3986 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3987 }
3988 p += sizeof( ssl_serialized_context_header );
3989
3990 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003991 * Session
3992 */
3993 if( (size_t)( end - p ) < 4 )
3994 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3995
3996 session_len = ( (size_t) p[0] << 24 ) |
3997 ( (size_t) p[1] << 16 ) |
3998 ( (size_t) p[2] << 8 ) |
3999 ( (size_t) p[3] );
4000 p += 4;
4001
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004002 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004003 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004004 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004005 ssl->session_in = ssl->session;
4006 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004007 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004008
4009 if( (size_t)( end - p ) < session_len )
4010 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4011
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004012 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004013 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004014 {
4015 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004016 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004017 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004018
4019 p += session_len;
4020
4021 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004022 * Transform
4023 */
4024
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004025 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004026 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004027 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004028 ssl->transform_in = ssl->transform;
4029 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004030 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004031
4032 /* Read random bytes and populate structure */
4033 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4034 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004035#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004036 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004037 ssl->session->ciphersuite,
4038 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004039#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004040 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004041#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004042 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4043 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004044 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004045 ssl->conf->endpoint,
4046 ssl );
4047 if( ret != 0 )
4048 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004049#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004050 p += sizeof( ssl->transform->randbytes );
4051
4052#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4053 /* Read connection IDs and store them */
4054 if( (size_t)( end - p ) < 1 )
4055 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4056
4057 ssl->transform->in_cid_len = *p++;
4058
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004059 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004060 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4061
4062 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4063 p += ssl->transform->in_cid_len;
4064
4065 ssl->transform->out_cid_len = *p++;
4066
4067 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4068 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4069
4070 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4071 p += ssl->transform->out_cid_len;
4072#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4073
4074 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004075 * Saved fields from top-level ssl_context structure
4076 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004077 if( (size_t)( end - p ) < 4 )
4078 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4079
4080 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4081 ( (uint32_t) p[1] << 16 ) |
4082 ( (uint32_t) p[2] << 8 ) |
4083 ( (uint32_t) p[3] );
4084 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004085
4086#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4087 if( (size_t)( end - p ) < 16 )
4088 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4089
4090 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4091 ( (uint64_t) p[1] << 48 ) |
4092 ( (uint64_t) p[2] << 40 ) |
4093 ( (uint64_t) p[3] << 32 ) |
4094 ( (uint64_t) p[4] << 24 ) |
4095 ( (uint64_t) p[5] << 16 ) |
4096 ( (uint64_t) p[6] << 8 ) |
4097 ( (uint64_t) p[7] );
4098 p += 8;
4099
4100 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4101 ( (uint64_t) p[1] << 48 ) |
4102 ( (uint64_t) p[2] << 40 ) |
4103 ( (uint64_t) p[3] << 32 ) |
4104 ( (uint64_t) p[4] << 24 ) |
4105 ( (uint64_t) p[5] << 16 ) |
4106 ( (uint64_t) p[6] << 8 ) |
4107 ( (uint64_t) p[7] );
4108 p += 8;
4109#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4110
4111#if defined(MBEDTLS_SSL_PROTO_DTLS)
4112 if( (size_t)( end - p ) < 1 )
4113 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4114
4115 ssl->disable_datagram_packing = *p++;
4116#endif /* MBEDTLS_SSL_PROTO_DTLS */
4117
Jerry Yud9a94fe2021-09-28 18:58:59 +08004118 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004119 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004120 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4121 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004122
4123#if defined(MBEDTLS_SSL_PROTO_DTLS)
4124 if( (size_t)( end - p ) < 2 )
4125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4126
4127 ssl->mtu = ( p[0] << 8 ) | p[1];
4128 p += 2;
4129#endif /* MBEDTLS_SSL_PROTO_DTLS */
4130
4131#if defined(MBEDTLS_SSL_ALPN)
4132 {
4133 uint8_t alpn_len;
4134 const char **cur;
4135
4136 if( (size_t)( end - p ) < 1 )
4137 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4138
4139 alpn_len = *p++;
4140
4141 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4142 {
4143 /* alpn_chosen should point to an item in the configured list */
4144 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4145 {
4146 if( strlen( *cur ) == alpn_len &&
4147 memcmp( p, cur, alpn_len ) == 0 )
4148 {
4149 ssl->alpn_chosen = *cur;
4150 break;
4151 }
4152 }
4153 }
4154
4155 /* can only happen on conf mismatch */
4156 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4157 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4158
4159 p += alpn_len;
4160 }
4161#endif /* MBEDTLS_SSL_ALPN */
4162
4163 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004164 * Forced fields from top-level ssl_context structure
4165 *
4166 * Most of them already set to the correct value by mbedtls_ssl_init() and
4167 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4168 */
4169 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004170 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004171
Hanno Becker361b10d2019-08-30 10:42:49 +01004172 /* Adjust pointers for header fields of outgoing records to
4173 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004174 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004175
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004176#if defined(MBEDTLS_SSL_PROTO_DTLS)
4177 ssl->in_epoch = 1;
4178#endif
4179
4180 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4181 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004182 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4183 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004184 if( ssl->handshake != NULL )
4185 {
4186 mbedtls_ssl_handshake_free( ssl );
4187 mbedtls_free( ssl->handshake );
4188 ssl->handshake = NULL;
4189 }
4190
4191 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004192 * Done - should have consumed entire buffer
4193 */
4194 if( p != end )
4195 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004196
4197 return( 0 );
4198}
4199
4200/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004201 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004202 */
4203int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4204 const unsigned char *buf,
4205 size_t len )
4206{
4207 int ret = ssl_context_load( context, buf, len );
4208
4209 if( ret != 0 )
4210 mbedtls_ssl_free( context );
4211
4212 return( ret );
4213}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004214#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004215
4216/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004217 * Free an SSL context
4218 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004219void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004220{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004221 if( ssl == NULL )
4222 return;
4223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004224 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004225
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004226 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004227 {
sander-visserb8aa2072020-05-06 22:05:13 +02004228#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4229 size_t out_buf_len = ssl->out_buf_len;
4230#else
4231 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4232#endif
4233
Darryl Greenb33cc762019-11-28 14:29:44 +00004234 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004235 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004236 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004237 }
4238
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004239 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004240 {
sander-visserb8aa2072020-05-06 22:05:13 +02004241#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4242 size_t in_buf_len = ssl->in_buf_len;
4243#else
4244 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4245#endif
4246
Darryl Greenb33cc762019-11-28 14:29:44 +00004247 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004248 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004249 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004250 }
4251
Paul Bakker48916f92012-09-16 19:57:18 +00004252 if( ssl->transform )
4253 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004254 mbedtls_ssl_transform_free( ssl->transform );
4255 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004256 }
4257
4258 if( ssl->handshake )
4259 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004260 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004261 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4262 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004264 mbedtls_free( ssl->handshake );
4265 mbedtls_free( ssl->transform_negotiate );
4266 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004267 }
4268
Ronald Cron6f135e12021-12-08 16:57:54 +01004269#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004270 mbedtls_ssl_transform_free( ssl->transform_application );
4271 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004272#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004273
Paul Bakkerc0463502013-02-14 11:19:38 +01004274 if( ssl->session )
4275 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004276 mbedtls_ssl_session_free( ssl->session );
4277 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004278 }
4279
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004280#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004281 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004282 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004283 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004284 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004285 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004286#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004287
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004288#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004289 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004290#endif
4291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004292 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004293
Paul Bakker86f04f42013-02-14 11:20:09 +01004294 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004295 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004296}
4297
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004298/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004299 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004300 */
4301void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4302{
4303 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4304}
4305
Gilles Peskineae270bf2021-06-02 00:05:29 +02004306/* The selection should be the same as mbedtls_x509_crt_profile_default in
4307 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004308 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004309 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004310 * about this list.
4311 */
Brett Warrene0edc842021-08-17 09:53:13 +01004312static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004313#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004314 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004315#endif
4316#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004317 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004318#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004319#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004320 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004321#endif
4322#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004323 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004324#endif
4325#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004326 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004327#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004328#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004329 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004330#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004331#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004332 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004333#endif
4334#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004335 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004336#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004337 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004338};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004339
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004340static int ssl_preset_suiteb_ciphersuites[] = {
4341 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4342 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4343 0
4344};
4345
Gilles Peskineeccd8882020-03-10 12:19:08 +01004346#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004347
Jerry Yu909df7b2022-01-22 11:56:27 +08004348/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004349 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004350 * rules SHOULD be upheld.
4351 * - No duplicate entries.
4352 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004353 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004354 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004355 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004356static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004357
Jerry Yued5e9f42022-01-26 11:21:34 +08004358#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4359 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4360 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4361#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4362 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004363
Jerry Yu909df7b2022-01-22 11:56:27 +08004364#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4365 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4366 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4367#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4368 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4369
Jerry Yued5e9f42022-01-26 11:21:34 +08004370#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4371 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4372 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4373#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4374 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004375
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004376#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4377 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4378#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4379
4380#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4381 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4382#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4383
4384#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4385 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4386#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4387
Jerry Yu693a47a2022-06-23 14:02:28 +08004388#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4389 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4390#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4391
4392#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4393 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4394#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4395
4396#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4397 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4398#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4399
Gabor Mezei15b95a62022-05-09 16:37:58 +02004400 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004401};
4402
4403/* NOTICE: see above */
4404#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4405static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004406#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004407#if defined(MBEDTLS_ECDSA_C)
4408 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004409#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004410#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4411 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4412#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004413#if defined(MBEDTLS_RSA_C)
4414 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4415#endif
4416#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004417#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004418#if defined(MBEDTLS_ECDSA_C)
4419 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004420#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004421#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4422 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4423#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004424#if defined(MBEDTLS_RSA_C)
4425 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4426#endif
4427#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004428#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004429#if defined(MBEDTLS_ECDSA_C)
4430 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004431#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004432#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4433 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4434#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004435#if defined(MBEDTLS_RSA_C)
4436 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4437#endif
4438#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004439 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004440};
4441#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4442/* NOTICE: see above */
4443static uint16_t ssl_preset_suiteb_sig_algs[] = {
4444
Jerry Yu909df7b2022-01-22 11:56:27 +08004445#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4446 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4447 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4448#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4449 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4450
Jerry Yu53037892022-01-25 11:02:06 +08004451#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4452 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4453 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4454#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4455 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004456
4457#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4458 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4459#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004460
Jerry Yu53037892022-01-25 11:02:06 +08004461#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4462 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4463#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4464
Gabor Mezei15b95a62022-05-09 16:37:58 +02004465 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004466};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004467
Jerry Yu909df7b2022-01-22 11:56:27 +08004468/* NOTICE: see above */
4469#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4470static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004471#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004472#if defined(MBEDTLS_ECDSA_C)
4473 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004474#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004475#if defined(MBEDTLS_RSA_C)
4476 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4477#endif
4478#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004479#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004480#if defined(MBEDTLS_ECDSA_C)
4481 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004482#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004483#if defined(MBEDTLS_RSA_C)
4484 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4485#endif
4486#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004487 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004488};
Jerry Yu909df7b2022-01-22 11:56:27 +08004489#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4490
Jerry Yu1a8b4812022-01-20 17:56:50 +08004491#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004492
Brett Warrene0edc842021-08-17 09:53:13 +01004493static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004494#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004495 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004496#endif
4497#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004498 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004499#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004500 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004501};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004502
Jerry Yu1a8b4812022-01-20 17:56:50 +08004503#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004504/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004505 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004506MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004507static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004508{
4509 size_t i, j;
4510 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004511
Gabor Mezei15b95a62022-05-09 16:37:58 +02004512 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004513 {
Jerry Yuf377d642022-01-25 10:43:59 +08004514 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004515 {
Jerry Yuf377d642022-01-25 10:43:59 +08004516 if( sig_algs[i] != sig_algs[j] )
4517 continue;
4518 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4519 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4520 sig_algs[i], j, i );
4521 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004522 }
4523 }
4524 return( ret );
4525}
4526
4527#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4528
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004529/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004530 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004531 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004532int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004533 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004534{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004535#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004536 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004537#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004538
Jerry Yu1a8b4812022-01-20 17:56:50 +08004539#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004540 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004541 {
4542 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4543 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4544 }
4545
Jerry Yuf377d642022-01-25 10:43:59 +08004546 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004547 {
4548 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4549 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4550 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004551
4552#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004553 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004554 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004555 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004556 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4557 }
4558
Jerry Yuf377d642022-01-25 10:43:59 +08004559 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004560 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004561 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004562 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4563 }
4564#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004565#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4566
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004567 /* Use the functions here so that they are covered in tests,
4568 * but otherwise access member directly for efficiency */
4569 mbedtls_ssl_conf_endpoint( conf, endpoint );
4570 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004571
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004572 /*
4573 * Things that are common to all presets
4574 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004575#if defined(MBEDTLS_SSL_CLI_C)
4576 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4577 {
4578 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4579#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4580 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4581#endif
4582 }
4583#endif
4584
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004585#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4586 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4587#endif
4588
4589#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4590 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4591#endif
4592
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004593#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004594 conf->f_cookie_write = ssl_cookie_write_dummy;
4595 conf->f_cookie_check = ssl_cookie_check_dummy;
4596#endif
4597
4598#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4599 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4600#endif
4601
Janos Follath088ce432017-04-10 12:42:31 +01004602#if defined(MBEDTLS_SSL_SRV_C)
4603 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004604 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004605#endif
4606
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004607#if defined(MBEDTLS_SSL_PROTO_DTLS)
4608 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4609 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4610#endif
4611
4612#if defined(MBEDTLS_SSL_RENEGOTIATION)
4613 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004614 memset( conf->renego_period, 0x00, 2 );
4615 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004616#endif
4617
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004618#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004619 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4620 {
4621 const unsigned char dhm_p[] =
4622 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4623 const unsigned char dhm_g[] =
4624 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004625
Hanno Beckere2defad2021-07-24 05:59:17 +01004626 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4627 dhm_p, sizeof( dhm_p ),
4628 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4629 {
4630 return( ret );
4631 }
4632 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004633#endif
4634
Ronald Cron6f135e12021-12-08 16:57:54 +01004635#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004636 /*
4637 * Allow all TLS 1.3 key exchange modes by default.
4638 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004639 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004640#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004641
XiaokangQian4d3a6042022-04-21 13:46:17 +00004642 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4643 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004644#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004645 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004646 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004647#else
XiaokangQian060d8672022-04-21 09:24:56 +00004648 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004649#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004650 }
4651 else
4652 {
4653#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4654 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4655 {
4656 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4657 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4658 }
4659 else
4660 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4661 {
4662 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4663 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4664 }
4665#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4666 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4667 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4668#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4669 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4670 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4671#else
4672 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4673#endif
4674 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004675
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004676 /*
4677 * Preset-specific defaults
4678 */
4679 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004680 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004681 /*
4682 * NSA Suite B
4683 */
4684 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004685
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004686 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004687
4688#if defined(MBEDTLS_X509_CRT_PARSE_C)
4689 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004690#endif
4691
Gilles Peskineeccd8882020-03-10 12:19:08 +01004692#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004693#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4694 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4695 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4696 else
4697#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4698 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004699#endif
4700
Brett Warrene0edc842021-08-17 09:53:13 +01004701#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4702 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004703#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004704 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004705 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004706
4707 /*
4708 * Default
4709 */
4710 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004711
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004712 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004713
4714#if defined(MBEDTLS_X509_CRT_PARSE_C)
4715 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4716#endif
4717
Gilles Peskineeccd8882020-03-10 12:19:08 +01004718#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004719#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4720 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4721 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4722 else
4723#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4724 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004725#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004726
Brett Warrene0edc842021-08-17 09:53:13 +01004727#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4728 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004729#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004730 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004731
4732#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4733 conf->dhm_min_bitlen = 1024;
4734#endif
4735 }
4736
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004737 return( 0 );
4738}
4739
4740/*
4741 * Free mbedtls_ssl_config
4742 */
4743void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4744{
4745#if defined(MBEDTLS_DHM_C)
4746 mbedtls_mpi_free( &conf->dhm_P );
4747 mbedtls_mpi_free( &conf->dhm_G );
4748#endif
4749
Gilles Peskineeccd8882020-03-10 12:19:08 +01004750#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004751#if defined(MBEDTLS_USE_PSA_CRYPTO)
4752 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4753 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004754 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4755 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004756#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004757 if( conf->psk != NULL )
4758 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004759 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004760 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004761 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004762 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004763 }
4764
4765 if( conf->psk_identity != NULL )
4766 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004767 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004768 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004769 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004770 conf->psk_identity_len = 0;
4771 }
4772#endif
4773
4774#if defined(MBEDTLS_X509_CRT_PARSE_C)
4775 ssl_key_cert_free( conf->key_cert );
4776#endif
4777
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004778 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004779}
4780
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004781#if defined(MBEDTLS_PK_C) && \
4782 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004783/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004787{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004788#if defined(MBEDTLS_RSA_C)
4789 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4790 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004791#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792#if defined(MBEDTLS_ECDSA_C)
4793 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4794 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004795#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004797}
4798
Hanno Becker7e5437a2017-04-28 17:15:26 +01004799unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4800{
4801 switch( type ) {
4802 case MBEDTLS_PK_RSA:
4803 return( MBEDTLS_SSL_SIG_RSA );
4804 case MBEDTLS_PK_ECDSA:
4805 case MBEDTLS_PK_ECKEY:
4806 return( MBEDTLS_SSL_SIG_ECDSA );
4807 default:
4808 return( MBEDTLS_SSL_SIG_ANON );
4809 }
4810}
4811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004812mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004813{
4814 switch( sig )
4815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004816#if defined(MBEDTLS_RSA_C)
4817 case MBEDTLS_SSL_SIG_RSA:
4818 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004819#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004820#if defined(MBEDTLS_ECDSA_C)
4821 case MBEDTLS_SSL_SIG_ECDSA:
4822 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004823#endif
4824 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004825 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004826 }
4827}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004828#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004829
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004830/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004831 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004833mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004834{
4835 switch( hash )
4836 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004837#if defined(MBEDTLS_MD5_C)
4838 case MBEDTLS_SSL_HASH_MD5:
4839 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004840#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004841#if defined(MBEDTLS_SHA1_C)
4842 case MBEDTLS_SSL_HASH_SHA1:
4843 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004844#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004845#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004846 case MBEDTLS_SSL_HASH_SHA224:
4847 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004848#endif
4849#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004850 case MBEDTLS_SSL_HASH_SHA256:
4851 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004852#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004853#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004854 case MBEDTLS_SSL_HASH_SHA384:
4855 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004856#endif
4857#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004858 case MBEDTLS_SSL_HASH_SHA512:
4859 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004860#endif
4861 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004862 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004863 }
4864}
4865
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004866/*
4867 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4868 */
4869unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4870{
4871 switch( md )
4872 {
4873#if defined(MBEDTLS_MD5_C)
4874 case MBEDTLS_MD_MD5:
4875 return( MBEDTLS_SSL_HASH_MD5 );
4876#endif
4877#if defined(MBEDTLS_SHA1_C)
4878 case MBEDTLS_MD_SHA1:
4879 return( MBEDTLS_SSL_HASH_SHA1 );
4880#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004881#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004882 case MBEDTLS_MD_SHA224:
4883 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004884#endif
4885#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004886 case MBEDTLS_MD_SHA256:
4887 return( MBEDTLS_SSL_HASH_SHA256 );
4888#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004889#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004890 case MBEDTLS_MD_SHA384:
4891 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004892#endif
4893#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004894 case MBEDTLS_MD_SHA512:
4895 return( MBEDTLS_SSL_HASH_SHA512 );
4896#endif
4897 default:
4898 return( MBEDTLS_SSL_HASH_NONE );
4899 }
4900}
4901
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004902/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004903 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004904 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004905 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004906int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004907{
Brett Warrene0edc842021-08-17 09:53:13 +01004908 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004909
Brett Warrene0edc842021-08-17 09:53:13 +01004910 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004911 return( -1 );
4912
Brett Warrene0edc842021-08-17 09:53:13 +01004913 for( ; *group_list != 0; group_list++ )
4914 {
4915 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004916 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004917 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004918
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004919 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004920}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004921
4922#if defined(MBEDTLS_ECP_C)
4923/*
4924 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4925 */
4926int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4927{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004928 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004929 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4930}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004931#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004933#if defined(MBEDTLS_X509_CRT_PARSE_C)
4934int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4935 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004936 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004937 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004938{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004939 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004940 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004941 const char *ext_oid;
4942 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004944 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004945 {
4946 /* Server part of the key exchange */
4947 switch( ciphersuite->key_exchange )
4948 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004949 case MBEDTLS_KEY_EXCHANGE_RSA:
4950 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004951 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004952 break;
4953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004954 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4955 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4956 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4957 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004958 break;
4959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4961 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004962 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004963 break;
4964
4965 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966 case MBEDTLS_KEY_EXCHANGE_NONE:
4967 case MBEDTLS_KEY_EXCHANGE_PSK:
4968 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4969 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004970 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004971 usage = 0;
4972 }
4973 }
4974 else
4975 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004976 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4977 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004978 }
4979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004980 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004981 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004982 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004983 ret = -1;
4984 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004987 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4989 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004990 }
4991 else
4992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004993 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4994 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004995 }
4996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004998 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004999 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005000 ret = -1;
5001 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005002
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005003 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005004}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005006
Jerry Yu148165c2021-09-24 23:20:59 +08005007#if defined(MBEDTLS_USE_PSA_CRYPTO)
5008int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5009 const mbedtls_md_type_t md,
5010 unsigned char *dst,
5011 size_t dst_len,
5012 size_t *olen )
5013{
Ronald Cronf6893e12022-01-07 22:09:01 +01005014 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5015 psa_hash_operation_t *hash_operation_to_clone;
5016 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5017
Jerry Yu148165c2021-09-24 23:20:59 +08005018 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005019
5020 switch( md )
5021 {
5022#if defined(MBEDTLS_SHA384_C)
5023 case MBEDTLS_MD_SHA384:
5024 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5025 break;
5026#endif
5027
5028#if defined(MBEDTLS_SHA256_C)
5029 case MBEDTLS_MD_SHA256:
5030 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5031 break;
5032#endif
5033
5034 default:
5035 goto exit;
5036 }
5037
5038 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5039 if( status != PSA_SUCCESS )
5040 goto exit;
5041
5042 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5043 if( status != PSA_SUCCESS )
5044 goto exit;
5045
5046exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005047 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005048}
5049#else /* MBEDTLS_USE_PSA_CRYPTO */
5050
Jerry Yu24c0ec32021-09-09 14:21:07 +08005051#if defined(MBEDTLS_SHA384_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_sha384( 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_sha512_context sha512;
5060
5061 if( dst_len < 48 )
5062 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5063
5064 mbedtls_sha512_init( &sha512 );
Andrzej Kureka242e832022-08-11 10:03:14 -04005065 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005066
5067 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5068 {
5069 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5070 goto exit;
5071 }
5072
5073 *olen = 48;
5074
5075exit:
5076
5077 mbedtls_sha512_free( &sha512 );
5078 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005079}
5080#endif /* MBEDTLS_SHA384_C */
5081
5082#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005083MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005084static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5085 unsigned char *dst,
5086 size_t dst_len,
5087 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005088{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005089 int ret;
5090 mbedtls_sha256_context sha256;
5091
5092 if( dst_len < 32 )
5093 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5094
5095 mbedtls_sha256_init( &sha256 );
5096 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005097
Jerry Yu24c0ec32021-09-09 14:21:07 +08005098 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5099 {
5100 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5101 goto exit;
5102 }
5103
5104 *olen = 32;
5105
5106exit:
5107
5108 mbedtls_sha256_free( &sha256 );
5109 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005110}
5111#endif /* MBEDTLS_SHA256_C */
5112
Jerry Yu000f9762021-09-14 11:12:51 +08005113int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5114 const mbedtls_md_type_t md,
5115 unsigned char *dst,
5116 size_t dst_len,
5117 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005118{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005119 switch( md )
5120 {
5121
Jerry Yu24c0ec32021-09-09 14:21:07 +08005122#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005123 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005124 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005125#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005126
Jerry Yu24c0ec32021-09-09 14:21:07 +08005127#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005128 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005129 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005130#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005131
5132 default:
5133 break;
5134 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005135 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005136}
XiaokangQian647719a2021-12-07 09:16:29 +00005137
Jerry Yu148165c2021-09-24 23:20:59 +08005138#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005139
Gabor Mezei078e8032022-04-27 21:17:56 +02005140#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5141/* mbedtls_ssl_parse_sig_alg_ext()
5142 *
5143 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5144 * value (TLS 1.3 RFC8446):
5145 * enum {
5146 * ....
5147 * ecdsa_secp256r1_sha256( 0x0403 ),
5148 * ecdsa_secp384r1_sha384( 0x0503 ),
5149 * ecdsa_secp521r1_sha512( 0x0603 ),
5150 * ....
5151 * } SignatureScheme;
5152 *
5153 * struct {
5154 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5155 * } SignatureSchemeList;
5156 *
5157 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5158 * value (TLS 1.2 RFC5246):
5159 * enum {
5160 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5161 * sha512(6), (255)
5162 * } HashAlgorithm;
5163 *
5164 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5165 * SignatureAlgorithm;
5166 *
5167 * struct {
5168 * HashAlgorithm hash;
5169 * SignatureAlgorithm signature;
5170 * } SignatureAndHashAlgorithm;
5171 *
5172 * SignatureAndHashAlgorithm
5173 * supported_signature_algorithms<2..2^16-2>;
5174 *
5175 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5176 * generalization of the TLS 1.2 signature algorithm extension.
5177 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5178 * `SignatureScheme` field of TLS 1.3
5179 *
5180 */
5181int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5182 const unsigned char *buf,
5183 const unsigned char *end )
5184{
5185 const unsigned char *p = buf;
5186 size_t supported_sig_algs_len = 0;
5187 const unsigned char *supported_sig_algs_end;
5188 uint16_t sig_alg;
5189 uint32_t common_idx = 0;
5190
5191 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5192 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5193 p += 2;
5194
5195 memset( ssl->handshake->received_sig_algs, 0,
5196 sizeof(ssl->handshake->received_sig_algs) );
5197
5198 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5199 supported_sig_algs_end = p + supported_sig_algs_len;
5200 while( p < supported_sig_algs_end )
5201 {
5202 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5203 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5204 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005205 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5206 sig_alg,
5207 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005208#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005209 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005210 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5211 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5212 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005213 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005214 }
5215#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005216
Jerry Yuf3b46b52022-06-19 16:52:27 +08005217 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5218 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005219
5220 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5221 {
5222 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5223 common_idx += 1;
5224 }
5225 }
5226 /* Check that we consumed all the message. */
5227 if( p != end )
5228 {
5229 MBEDTLS_SSL_DEBUG_MSG( 1,
5230 ( "Signature algorithms extension length misaligned" ) );
5231 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5232 MBEDTLS_ERR_SSL_DECODE_ERROR );
5233 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5234 }
5235
5236 if( common_idx == 0 )
5237 {
5238 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5239 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5240 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5241 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5242 }
5243
Gabor Mezei15b95a62022-05-09 16:37:58 +02005244 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005245 return( 0 );
5246}
5247
5248#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5249
Jerry Yudc7bd172022-02-17 13:44:15 +08005250#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5251
5252#if defined(MBEDTLS_USE_PSA_CRYPTO)
5253
5254static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5255 mbedtls_svc_key_id_t key,
5256 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005257 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005258 const unsigned char* seed, size_t seed_length,
5259 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005260 const unsigned char* other_secret,
5261 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005262 size_t capacity )
5263{
5264 psa_status_t status;
5265
5266 status = psa_key_derivation_setup( derivation, alg );
5267 if( status != PSA_SUCCESS )
5268 return( status );
5269
5270 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5271 {
5272 status = psa_key_derivation_input_bytes( derivation,
5273 PSA_KEY_DERIVATION_INPUT_SEED,
5274 seed, seed_length );
5275 if( status != PSA_SUCCESS )
5276 return( status );
5277
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005278 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005279 {
5280 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005281 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5282 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005283 if( status != PSA_SUCCESS )
5284 return( status );
5285 }
5286
Jerry Yudc7bd172022-02-17 13:44:15 +08005287 if( mbedtls_svc_key_id_is_null( key ) )
5288 {
5289 status = psa_key_derivation_input_bytes(
5290 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005291 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005292 }
5293 else
5294 {
5295 status = psa_key_derivation_input_key(
5296 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5297 }
5298 if( status != PSA_SUCCESS )
5299 return( status );
5300
5301 status = psa_key_derivation_input_bytes( derivation,
5302 PSA_KEY_DERIVATION_INPUT_LABEL,
5303 label, label_length );
5304 if( status != PSA_SUCCESS )
5305 return( status );
5306 }
5307 else
5308 {
5309 return( PSA_ERROR_NOT_SUPPORTED );
5310 }
5311
5312 status = psa_key_derivation_set_capacity( derivation, capacity );
5313 if( status != PSA_SUCCESS )
5314 return( status );
5315
5316 return( PSA_SUCCESS );
5317}
5318
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005319MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005320static int tls_prf_generic( mbedtls_md_type_t md_type,
5321 const unsigned char *secret, size_t slen,
5322 const char *label,
5323 const unsigned char *random, size_t rlen,
5324 unsigned char *dstbuf, size_t dlen )
5325{
5326 psa_status_t status;
5327 psa_algorithm_t alg;
5328 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5329 psa_key_derivation_operation_t derivation =
5330 PSA_KEY_DERIVATION_OPERATION_INIT;
5331
5332 if( md_type == MBEDTLS_MD_SHA384 )
5333 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5334 else
5335 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5336
5337 /* Normally a "secret" should be long enough to be impossible to
5338 * find by brute force, and in particular should not be empty. But
5339 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5340 * and for this use case it makes sense to have a 0-length "secret".
5341 * Since the key API doesn't allow importing a key of length 0,
5342 * keep master_key=0, which setup_psa_key_derivation() understands
5343 * to mean a 0-length "secret" input. */
5344 if( slen != 0 )
5345 {
5346 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5347 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5348 psa_set_key_algorithm( &key_attributes, alg );
5349 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5350
5351 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5352 if( status != PSA_SUCCESS )
5353 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5354 }
5355
5356 status = setup_psa_key_derivation( &derivation,
5357 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005358 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005359 random, rlen,
5360 (unsigned char const *) label,
5361 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005362 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005363 dlen );
5364 if( status != PSA_SUCCESS )
5365 {
5366 psa_key_derivation_abort( &derivation );
5367 psa_destroy_key( master_key );
5368 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5369 }
5370
5371 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5372 if( status != PSA_SUCCESS )
5373 {
5374 psa_key_derivation_abort( &derivation );
5375 psa_destroy_key( master_key );
5376 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5377 }
5378
5379 status = psa_key_derivation_abort( &derivation );
5380 if( status != PSA_SUCCESS )
5381 {
5382 psa_destroy_key( master_key );
5383 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5384 }
5385
5386 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5387 status = psa_destroy_key( master_key );
5388 if( status != PSA_SUCCESS )
5389 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5390
5391 return( 0 );
5392}
5393
5394#else /* MBEDTLS_USE_PSA_CRYPTO */
5395
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005396MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005397static int tls_prf_generic( mbedtls_md_type_t md_type,
5398 const unsigned char *secret, size_t slen,
5399 const char *label,
5400 const unsigned char *random, size_t rlen,
5401 unsigned char *dstbuf, size_t dlen )
5402{
5403 size_t nb;
5404 size_t i, j, k, md_len;
5405 unsigned char *tmp;
5406 size_t tmp_len = 0;
5407 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5408 const mbedtls_md_info_t *md_info;
5409 mbedtls_md_context_t md_ctx;
5410 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5411
5412 mbedtls_md_init( &md_ctx );
5413
5414 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5415 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5416
5417 md_len = mbedtls_md_get_size( md_info );
5418
5419 tmp_len = md_len + strlen( label ) + rlen;
5420 tmp = mbedtls_calloc( 1, tmp_len );
5421 if( tmp == NULL )
5422 {
5423 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5424 goto exit;
5425 }
5426
5427 nb = strlen( label );
5428 memcpy( tmp + md_len, label, nb );
5429 memcpy( tmp + md_len + nb, random, rlen );
5430 nb += rlen;
5431
5432 /*
5433 * Compute P_<hash>(secret, label + random)[0..dlen]
5434 */
5435 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5436 goto exit;
5437
5438 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5439 if( ret != 0 )
5440 goto exit;
5441 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5442 if( ret != 0 )
5443 goto exit;
5444 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5445 if( ret != 0 )
5446 goto exit;
5447
5448 for( i = 0; i < dlen; i += md_len )
5449 {
5450 ret = mbedtls_md_hmac_reset ( &md_ctx );
5451 if( ret != 0 )
5452 goto exit;
5453 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5454 if( ret != 0 )
5455 goto exit;
5456 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5457 if( ret != 0 )
5458 goto exit;
5459
5460 ret = mbedtls_md_hmac_reset ( &md_ctx );
5461 if( ret != 0 )
5462 goto exit;
5463 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5464 if( ret != 0 )
5465 goto exit;
5466 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5467 if( ret != 0 )
5468 goto exit;
5469
5470 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5471
5472 for( j = 0; j < k; j++ )
5473 dstbuf[i + j] = h_i[j];
5474 }
5475
5476exit:
5477 mbedtls_md_free( &md_ctx );
5478
5479 mbedtls_platform_zeroize( tmp, tmp_len );
5480 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5481
5482 mbedtls_free( tmp );
5483
5484 return( ret );
5485}
5486#endif /* MBEDTLS_USE_PSA_CRYPTO */
5487
5488#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005489MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005490static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5491 const char *label,
5492 const unsigned char *random, size_t rlen,
5493 unsigned char *dstbuf, size_t dlen )
5494{
5495 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5496 label, random, rlen, dstbuf, dlen ) );
5497}
5498#endif /* MBEDTLS_SHA256_C */
5499
5500#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005501MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005502static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5503 const char *label,
5504 const unsigned char *random, size_t rlen,
5505 unsigned char *dstbuf, size_t dlen )
5506{
5507 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5508 label, random, rlen, dstbuf, dlen ) );
5509}
5510#endif /* MBEDTLS_SHA384_C */
5511
Jerry Yuf009d862022-02-17 14:01:37 +08005512/*
5513 * Set appropriate PRF function and other SSL / TLS1.2 functions
5514 *
5515 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005516 * - hash associated with the ciphersuite (only used by TLS 1.2)
5517 *
5518 * Outputs:
5519 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5520 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005521MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005522static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005523 mbedtls_md_type_t hash )
5524{
Jerry Yuf009d862022-02-17 14:01:37 +08005525#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005526 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005527 {
5528 handshake->tls_prf = tls_prf_sha384;
5529 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5530 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5531 }
5532 else
5533#endif
5534#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005535 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005536 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005537 handshake->tls_prf = tls_prf_sha256;
5538 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5539 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5540 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005541#else
Jerry Yuf009d862022-02-17 14:01:37 +08005542 {
Jerry Yuf009d862022-02-17 14:01:37 +08005543 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005544 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005545 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5546 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005547#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005548
5549 return( 0 );
5550}
Jerry Yud6ab2352022-02-17 14:03:43 +08005551
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005552/*
5553 * Compute master secret if needed
5554 *
5555 * Parameters:
5556 * [in/out] handshake
5557 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5558 * (PSA-PSK) ciphersuite_info, psk_opaque
5559 * [out] premaster (cleared)
5560 * [out] master
5561 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5562 * debug: conf->f_dbg, conf->p_dbg
5563 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005564 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005565 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005566MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005567static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5568 unsigned char *master,
5569 const mbedtls_ssl_context *ssl )
5570{
5571 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5572
5573 /* cf. RFC 5246, Section 8.1:
5574 * "The master secret is always exactly 48 bytes in length." */
5575 size_t const master_secret_len = 48;
5576
5577#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5578 unsigned char session_hash[48];
5579#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5580
5581 /* The label for the KDF used for key expansion.
5582 * This is either "master secret" or "extended master secret"
5583 * depending on whether the Extended Master Secret extension
5584 * is used. */
5585 char const *lbl = "master secret";
5586
Przemek Stekielae4ed302022-04-05 17:15:55 +02005587 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005588 * - If the Extended Master Secret extension is not used,
5589 * this is ClientHello.Random + ServerHello.Random
5590 * (see Sect. 8.1 in RFC 5246).
5591 * - If the Extended Master Secret extension is used,
5592 * this is the transcript of the handshake so far.
5593 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005594 unsigned char const *seed = handshake->randbytes;
5595 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005596
5597#if !defined(MBEDTLS_DEBUG_C) && \
5598 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5599 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5600 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5601 ssl = NULL; /* make sure we don't use it except for those cases */
5602 (void) ssl;
5603#endif
5604
5605 if( handshake->resume != 0 )
5606 {
5607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5608 return( 0 );
5609 }
5610
5611#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5612 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5613 {
5614 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005615 seed = session_hash;
5616 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005617
5618 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005619 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005620 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005621#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005622
Przemek Stekiel99114f32022-04-22 11:20:09 +02005623#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005624 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005625 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005626 {
5627 /* Perform PSK-to-MS expansion in a single step. */
5628 psa_status_t status;
5629 psa_algorithm_t alg;
5630 mbedtls_svc_key_id_t psk;
5631 psa_key_derivation_operation_t derivation =
5632 PSA_KEY_DERIVATION_OPERATION_INIT;
5633 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5634
5635 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5636
5637 psk = mbedtls_ssl_get_opaque_psk( ssl );
5638
5639 if( hash_alg == MBEDTLS_MD_SHA384 )
5640 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5641 else
5642 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5643
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005644 size_t other_secret_len = 0;
5645 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005646
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005647 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005648 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005649 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005650 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005651 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005652 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005653 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005654 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005655 other_secret_len = 48;
5656 other_secret = handshake->premaster + 2;
5657 break;
5658 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005659 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005660 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5661 other_secret = handshake->premaster + 2;
5662 break;
5663 default:
5664 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005665 }
5666
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005667 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005668 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005669 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005670 (unsigned char const *) lbl,
5671 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005672 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005673 master_secret_len );
5674 if( status != PSA_SUCCESS )
5675 {
5676 psa_key_derivation_abort( &derivation );
5677 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5678 }
5679
5680 status = psa_key_derivation_output_bytes( &derivation,
5681 master,
5682 master_secret_len );
5683 if( status != PSA_SUCCESS )
5684 {
5685 psa_key_derivation_abort( &derivation );
5686 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5687 }
5688
5689 status = psa_key_derivation_abort( &derivation );
5690 if( status != PSA_SUCCESS )
5691 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5692 }
5693 else
5694#endif
5695 {
5696 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005697 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005698 master,
5699 master_secret_len );
5700 if( ret != 0 )
5701 {
5702 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5703 return( ret );
5704 }
5705
5706 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5707 handshake->premaster,
5708 handshake->pmslen );
5709
5710 mbedtls_platform_zeroize( handshake->premaster,
5711 sizeof(handshake->premaster) );
5712 }
5713
5714 return( 0 );
5715}
5716
Jerry Yud62f87e2022-02-17 14:09:02 +08005717int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5718{
5719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5720 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5721 ssl->handshake->ciphersuite_info;
5722
5723 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5724
5725 /* Set PRF, calc_verify and calc_finished function pointers */
5726 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005727 ciphersuite_info->mac );
5728 if( ret != 0 )
5729 {
5730 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5731 return( ret );
5732 }
5733
5734 /* Compute master secret if needed */
5735 ret = ssl_compute_master( ssl->handshake,
5736 ssl->session_negotiate->master,
5737 ssl );
5738 if( ret != 0 )
5739 {
5740 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5741 return( ret );
5742 }
5743
5744 /* Swap the client and server random values:
5745 * - MS derivation wanted client+server (RFC 5246 8.1)
5746 * - key derivation wants server+client (RFC 5246 6.3) */
5747 {
5748 unsigned char tmp[64];
5749 memcpy( tmp, ssl->handshake->randbytes, 64 );
5750 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5751 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5752 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5753 }
5754
5755 /* Populate transform structure */
5756 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5757 ssl->session_negotiate->ciphersuite,
5758 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005759#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005760 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005761#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005762 ssl->handshake->tls_prf,
5763 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005764 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005765 ssl->conf->endpoint,
5766 ssl );
5767 if( ret != 0 )
5768 {
5769 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5770 return( ret );
5771 }
5772
5773 /* We no longer need Server/ClientHello.random values */
5774 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5775 sizeof( ssl->handshake->randbytes ) );
5776
5777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5778
5779 return( 0 );
5780}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005781
Ronald Cron4dcbca92022-03-07 10:21:40 +01005782int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5783{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005784 switch( md )
5785 {
5786#if defined(MBEDTLS_SHA384_C)
5787 case MBEDTLS_SSL_HASH_SHA384:
5788 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5789 break;
5790#endif
5791#if defined(MBEDTLS_SHA256_C)
5792 case MBEDTLS_SSL_HASH_SHA256:
5793 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5794 break;
5795#endif
5796 default:
5797 return( -1 );
5798 }
5799
Ronald Cronc2f13a02022-03-07 10:25:24 +01005800 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005801}
5802
Jerry Yu8392e0d2022-02-17 14:10:24 +08005803#if defined(MBEDTLS_SHA256_C)
5804void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5805 unsigned char *hash,
5806 size_t *hlen )
5807{
5808#if defined(MBEDTLS_USE_PSA_CRYPTO)
5809 size_t hash_size;
5810 psa_status_t status;
5811 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5812
5813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5814 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5815 if( status != PSA_SUCCESS )
5816 {
5817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5818 return;
5819 }
5820
5821 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5822 if( status != PSA_SUCCESS )
5823 {
5824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5825 return;
5826 }
5827
5828 *hlen = 32;
5829 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5831#else
5832 mbedtls_sha256_context sha256;
5833
5834 mbedtls_sha256_init( &sha256 );
5835
5836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5837
5838 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5839 mbedtls_sha256_finish( &sha256, hash );
5840
5841 *hlen = 32;
5842
5843 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5845
5846 mbedtls_sha256_free( &sha256 );
5847#endif /* MBEDTLS_USE_PSA_CRYPTO */
5848 return;
5849}
5850#endif /* MBEDTLS_SHA256_C */
5851
Jerry Yuc1cb3842022-02-17 14:13:48 +08005852#if defined(MBEDTLS_SHA384_C)
5853void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5854 unsigned char *hash,
5855 size_t *hlen )
5856{
5857#if defined(MBEDTLS_USE_PSA_CRYPTO)
5858 size_t hash_size;
5859 psa_status_t status;
5860 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5861
5862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5863 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5864 if( status != PSA_SUCCESS )
5865 {
5866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5867 return;
5868 }
5869
5870 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5871 if( status != PSA_SUCCESS )
5872 {
5873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5874 return;
5875 }
5876
5877 *hlen = 48;
5878 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5879 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5880#else
5881 mbedtls_sha512_context sha512;
5882
5883 mbedtls_sha512_init( &sha512 );
5884
5885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5886
Andrzej Kureka242e832022-08-11 10:03:14 -04005887 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yuc1cb3842022-02-17 14:13:48 +08005888 mbedtls_sha512_finish( &sha512, hash );
5889
5890 *hlen = 48;
5891
5892 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5894
5895 mbedtls_sha512_free( &sha512 );
5896#endif /* MBEDTLS_USE_PSA_CRYPTO */
5897 return;
5898}
5899#endif /* MBEDTLS_SHA384_C */
5900
Neil Armstrong80f6f322022-05-03 17:56:38 +02005901#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5902 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005903int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5904{
5905 unsigned char *p = ssl->handshake->premaster;
5906 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5907 const unsigned char *psk = NULL;
5908 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005909 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005910
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005911 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005912 {
5913 /*
5914 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005915 * checked before calling this function.
5916 *
5917 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005918 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005919 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005920 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5921 {
5922 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5923 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5924 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005925 }
5926
5927 /*
5928 * PMS = struct {
5929 * opaque other_secret<0..2^16-1>;
5930 * opaque psk<0..2^16-1>;
5931 * };
5932 * with "other_secret" depending on the particular key exchange
5933 */
5934#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5935 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5936 {
5937 if( end - p < 2 )
5938 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5939
5940 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5941 p += 2;
5942
5943 if( end < p || (size_t)( end - p ) < psk_len )
5944 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5945
5946 memset( p, 0, psk_len );
5947 p += psk_len;
5948 }
5949 else
5950#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5951#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5952 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5953 {
5954 /*
5955 * other_secret already set by the ClientKeyExchange message,
5956 * and is 48 bytes long
5957 */
5958 if( end - p < 2 )
5959 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5960
5961 *p++ = 0;
5962 *p++ = 48;
5963 p += 48;
5964 }
5965 else
5966#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5967#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5968 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5969 {
5970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5971 size_t len;
5972
5973 /* Write length only when we know the actual value */
5974 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5975 p + 2, end - ( p + 2 ), &len,
5976 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5977 {
5978 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5979 return( ret );
5980 }
5981 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5982 p += 2 + len;
5983
5984 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5985 }
5986 else
5987#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005988#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005989 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5990 {
5991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5992 size_t zlen;
5993
5994 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5995 p + 2, end - ( p + 2 ),
5996 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5997 {
5998 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5999 return( ret );
6000 }
6001
6002 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6003 p += 2 + zlen;
6004
6005 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6006 MBEDTLS_DEBUG_ECDH_Z );
6007 }
6008 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006009#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006010 {
6011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6012 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6013 }
6014
6015 /* opaque psk<0..2^16-1>; */
6016 if( end - p < 2 )
6017 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6018
6019 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6020 p += 2;
6021
6022 if( end < p || (size_t)( end - p ) < psk_len )
6023 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6024
6025 memcpy( p, psk, psk_len );
6026 p += psk_len;
6027
6028 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6029
6030 return( 0 );
6031}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006032#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006033
6034#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006035MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006036static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6037
6038#if defined(MBEDTLS_SSL_PROTO_DTLS)
6039int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6040{
6041 /* If renegotiation is not enforced, retransmit until we would reach max
6042 * timeout if we were using the usual handshake doubling scheme */
6043 if( ssl->conf->renego_max_records < 0 )
6044 {
6045 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6046 unsigned char doublings = 1;
6047
6048 while( ratio != 0 )
6049 {
6050 ++doublings;
6051 ratio >>= 1;
6052 }
6053
6054 if( ++ssl->renego_records_seen > doublings )
6055 {
6056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6057 return( 0 );
6058 }
6059 }
6060
6061 return( ssl_write_hello_request( ssl ) );
6062}
6063#endif
6064#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006065
Jerry Yud9526692022-02-17 14:23:47 +08006066/*
6067 * Handshake functions
6068 */
6069#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6070/* No certificate support -> dummy functions */
6071int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6072{
6073 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6074 ssl->handshake->ciphersuite_info;
6075
6076 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6077
6078 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6079 {
6080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6081 ssl->state++;
6082 return( 0 );
6083 }
6084
6085 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6086 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6087}
6088
6089int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6090{
6091 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6092 ssl->handshake->ciphersuite_info;
6093
6094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6095
6096 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6097 {
6098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6099 ssl->state++;
6100 return( 0 );
6101 }
6102
6103 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6105}
6106
6107#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6108/* Some certificate support -> implement write and parse */
6109
6110int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6111{
6112 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6113 size_t i, n;
6114 const mbedtls_x509_crt *crt;
6115 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6116 ssl->handshake->ciphersuite_info;
6117
6118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6119
6120 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6121 {
6122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6123 ssl->state++;
6124 return( 0 );
6125 }
6126
6127#if defined(MBEDTLS_SSL_CLI_C)
6128 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6129 {
6130 if( ssl->handshake->client_auth == 0 )
6131 {
6132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6133 ssl->state++;
6134 return( 0 );
6135 }
6136 }
6137#endif /* MBEDTLS_SSL_CLI_C */
6138#if defined(MBEDTLS_SSL_SRV_C)
6139 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6140 {
6141 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6142 {
6143 /* Should never happen because we shouldn't have picked the
6144 * ciphersuite if we don't have a certificate. */
6145 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6146 }
6147 }
6148#endif
6149
6150 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6151
6152 /*
6153 * 0 . 0 handshake type
6154 * 1 . 3 handshake length
6155 * 4 . 6 length of all certs
6156 * 7 . 9 length of cert. 1
6157 * 10 . n-1 peer certificate
6158 * n . n+2 length of cert. 2
6159 * n+3 . ... upper level cert, etc.
6160 */
6161 i = 7;
6162 crt = mbedtls_ssl_own_cert( ssl );
6163
6164 while( crt != NULL )
6165 {
6166 n = crt->raw.len;
6167 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6168 {
6169 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6170 " > %" MBEDTLS_PRINTF_SIZET,
6171 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6172 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6173 }
6174
6175 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6176 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6177 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6178
6179 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6180 i += n; crt = crt->next;
6181 }
6182
6183 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6184 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6185 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6186
6187 ssl->out_msglen = i;
6188 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6189 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6190
6191 ssl->state++;
6192
6193 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6194 {
6195 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6196 return( ret );
6197 }
6198
6199 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6200
6201 return( ret );
6202}
6203
6204#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6205
6206#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006207MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006208static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6209 unsigned char *crt_buf,
6210 size_t crt_buf_len )
6211{
6212 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6213
6214 if( peer_crt == NULL )
6215 return( -1 );
6216
6217 if( peer_crt->raw.len != crt_buf_len )
6218 return( -1 );
6219
6220 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6221}
6222#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006223MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006224static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6225 unsigned char *crt_buf,
6226 size_t crt_buf_len )
6227{
6228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6229 unsigned char const * const peer_cert_digest =
6230 ssl->session->peer_cert_digest;
6231 mbedtls_md_type_t const peer_cert_digest_type =
6232 ssl->session->peer_cert_digest_type;
6233 mbedtls_md_info_t const * const digest_info =
6234 mbedtls_md_info_from_type( peer_cert_digest_type );
6235 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6236 size_t digest_len;
6237
6238 if( peer_cert_digest == NULL || digest_info == NULL )
6239 return( -1 );
6240
6241 digest_len = mbedtls_md_get_size( digest_info );
6242 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6243 return( -1 );
6244
6245 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6246 if( ret != 0 )
6247 return( -1 );
6248
6249 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6250}
6251#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6252#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6253
6254/*
6255 * Once the certificate message is read, parse it into a cert chain and
6256 * perform basic checks, but leave actual verification to the caller
6257 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006258MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006259static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6260 mbedtls_x509_crt *chain )
6261{
6262 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6263#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6264 int crt_cnt=0;
6265#endif
6266 size_t i, n;
6267 uint8_t alert;
6268
6269 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
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_UNEXPECTED_MESSAGE );
6274 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6275 }
6276
6277 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6278 {
6279 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6280 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6281 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6282 }
6283
6284 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6285 {
6286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6287 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6288 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6289 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6290 }
6291
6292 i = mbedtls_ssl_hs_hdr_len( ssl );
6293
6294 /*
6295 * Same message structure as in mbedtls_ssl_write_certificate()
6296 */
6297 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6298
6299 if( ssl->in_msg[i] != 0 ||
6300 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6301 {
6302 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6303 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6304 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6305 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6306 }
6307
6308 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6309 i += 3;
6310
6311 /* Iterate through and parse the CRTs in the provided chain. */
6312 while( i < ssl->in_hslen )
6313 {
6314 /* Check that there's room for the next CRT's length fields. */
6315 if ( i + 3 > ssl->in_hslen ) {
6316 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6317 mbedtls_ssl_send_alert_message( ssl,
6318 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6319 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6320 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6321 }
6322 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6323 * anything beyond 2**16 ~ 64K. */
6324 if( ssl->in_msg[i] != 0 )
6325 {
6326 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6327 mbedtls_ssl_send_alert_message( ssl,
6328 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6329 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6330 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6331 }
6332
6333 /* Read length of the next CRT in the chain. */
6334 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6335 | (unsigned int) ssl->in_msg[i + 2];
6336 i += 3;
6337
6338 if( n < 128 || i + n > ssl->in_hslen )
6339 {
6340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6341 mbedtls_ssl_send_alert_message( ssl,
6342 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6343 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6344 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6345 }
6346
6347 /* Check if we're handling the first CRT in the chain. */
6348#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6349 if( crt_cnt++ == 0 &&
6350 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6351 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6352 {
6353 /* During client-side renegotiation, check that the server's
6354 * end-CRTs hasn't changed compared to the initial handshake,
6355 * mitigating the triple handshake attack. On success, reuse
6356 * the original end-CRT instead of parsing it again. */
6357 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6358 if( ssl_check_peer_crt_unchanged( ssl,
6359 &ssl->in_msg[i],
6360 n ) != 0 )
6361 {
6362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6363 mbedtls_ssl_send_alert_message( ssl,
6364 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6365 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6366 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6367 }
6368
6369 /* Now we can safely free the original chain. */
6370 ssl_clear_peer_cert( ssl->session );
6371 }
6372#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6373
6374 /* Parse the next certificate in the chain. */
6375#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6376 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6377#else
6378 /* If we don't need to store the CRT chain permanently, parse
6379 * it in-place from the input buffer instead of making a copy. */
6380 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6381#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6382 switch( ret )
6383 {
6384 case 0: /*ok*/
6385 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6386 /* Ignore certificate with an unknown algorithm: maybe a
6387 prior certificate was already trusted. */
6388 break;
6389
6390 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6391 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6392 goto crt_parse_der_failed;
6393
6394 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6395 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6396 goto crt_parse_der_failed;
6397
6398 default:
6399 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6400 crt_parse_der_failed:
6401 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6402 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6403 return( ret );
6404 }
6405
6406 i += n;
6407 }
6408
6409 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6410 return( 0 );
6411}
6412
6413#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006414MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006415static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6416{
6417 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6418 return( -1 );
6419
6420 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6421 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6422 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6423 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6424 {
Ronald Cron19385882022-06-15 16:26:13 +02006425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006426 return( 0 );
6427 }
6428 return( -1 );
6429}
6430#endif /* MBEDTLS_SSL_SRV_C */
6431
6432/* Check if a certificate message is expected.
6433 * Return either
6434 * - SSL_CERTIFICATE_EXPECTED, or
6435 * - SSL_CERTIFICATE_SKIP
6436 * indicating whether a Certificate message is expected or not.
6437 */
6438#define SSL_CERTIFICATE_EXPECTED 0
6439#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006440MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006441static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6442 int authmode )
6443{
6444 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6445 ssl->handshake->ciphersuite_info;
6446
6447 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6448 return( SSL_CERTIFICATE_SKIP );
6449
6450#if defined(MBEDTLS_SSL_SRV_C)
6451 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6452 {
6453 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6454 return( SSL_CERTIFICATE_SKIP );
6455
6456 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6457 {
6458 ssl->session_negotiate->verify_result =
6459 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6460 return( SSL_CERTIFICATE_SKIP );
6461 }
6462 }
6463#else
6464 ((void) authmode);
6465#endif /* MBEDTLS_SSL_SRV_C */
6466
6467 return( SSL_CERTIFICATE_EXPECTED );
6468}
6469
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006470MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006471static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6472 int authmode,
6473 mbedtls_x509_crt *chain,
6474 void *rs_ctx )
6475{
6476 int ret = 0;
6477 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6478 ssl->handshake->ciphersuite_info;
6479 int have_ca_chain = 0;
6480
6481 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6482 void *p_vrfy;
6483
6484 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6485 return( 0 );
6486
6487 if( ssl->f_vrfy != NULL )
6488 {
6489 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6490 f_vrfy = ssl->f_vrfy;
6491 p_vrfy = ssl->p_vrfy;
6492 }
6493 else
6494 {
6495 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6496 f_vrfy = ssl->conf->f_vrfy;
6497 p_vrfy = ssl->conf->p_vrfy;
6498 }
6499
6500 /*
6501 * Main check: verify certificate
6502 */
6503#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6504 if( ssl->conf->f_ca_cb != NULL )
6505 {
6506 ((void) rs_ctx);
6507 have_ca_chain = 1;
6508
6509 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6510 ret = mbedtls_x509_crt_verify_with_ca_cb(
6511 chain,
6512 ssl->conf->f_ca_cb,
6513 ssl->conf->p_ca_cb,
6514 ssl->conf->cert_profile,
6515 ssl->hostname,
6516 &ssl->session_negotiate->verify_result,
6517 f_vrfy, p_vrfy );
6518 }
6519 else
6520#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6521 {
6522 mbedtls_x509_crt *ca_chain;
6523 mbedtls_x509_crl *ca_crl;
6524
6525#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6526 if( ssl->handshake->sni_ca_chain != NULL )
6527 {
6528 ca_chain = ssl->handshake->sni_ca_chain;
6529 ca_crl = ssl->handshake->sni_ca_crl;
6530 }
6531 else
6532#endif
6533 {
6534 ca_chain = ssl->conf->ca_chain;
6535 ca_crl = ssl->conf->ca_crl;
6536 }
6537
6538 if( ca_chain != NULL )
6539 have_ca_chain = 1;
6540
6541 ret = mbedtls_x509_crt_verify_restartable(
6542 chain,
6543 ca_chain, ca_crl,
6544 ssl->conf->cert_profile,
6545 ssl->hostname,
6546 &ssl->session_negotiate->verify_result,
6547 f_vrfy, p_vrfy, rs_ctx );
6548 }
6549
6550 if( ret != 0 )
6551 {
6552 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6553 }
6554
6555#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6556 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6557 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6558#endif
6559
6560 /*
6561 * Secondary checks: always done, but change 'ret' only if it was 0
6562 */
6563
6564#if defined(MBEDTLS_ECP_C)
6565 {
6566 const mbedtls_pk_context *pk = &chain->pk;
6567
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006568 /* If certificate uses an EC key, make sure the curve is OK.
6569 * This is a public key, so it can't be opaque, so can_do() is a good
6570 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006571 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6572 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6573 {
6574 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6575
6576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6577 if( ret == 0 )
6578 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6579 }
6580 }
6581#endif /* MBEDTLS_ECP_C */
6582
6583 if( mbedtls_ssl_check_cert_usage( chain,
6584 ciphersuite_info,
6585 ! ssl->conf->endpoint,
6586 &ssl->session_negotiate->verify_result ) != 0 )
6587 {
6588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6589 if( ret == 0 )
6590 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6591 }
6592
6593 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6594 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6595 * with details encoded in the verification flags. All other kinds
6596 * of error codes, including those from the user provided f_vrfy
6597 * functions, are treated as fatal and lead to a failure of
6598 * ssl_parse_certificate even if verification was optional. */
6599 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6600 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6601 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6602 {
6603 ret = 0;
6604 }
6605
6606 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6607 {
6608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6609 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6610 }
6611
6612 if( ret != 0 )
6613 {
6614 uint8_t alert;
6615
6616 /* The certificate may have been rejected for several reasons.
6617 Pick one and send the corresponding alert. Which alert to send
6618 may be a subject of debate in some cases. */
6619 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6620 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6621 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6622 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6623 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6624 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6625 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6626 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6627 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6628 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6629 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6630 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6631 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6632 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6633 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6634 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6635 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6636 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6637 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6638 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6639 else
6640 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6641 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6642 alert );
6643 }
6644
6645#if defined(MBEDTLS_DEBUG_C)
6646 if( ssl->session_negotiate->verify_result != 0 )
6647 {
6648 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6649 (unsigned int) ssl->session_negotiate->verify_result ) );
6650 }
6651 else
6652 {
6653 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6654 }
6655#endif /* MBEDTLS_DEBUG_C */
6656
6657 return( ret );
6658}
6659
6660#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006661MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006662static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6663 unsigned char *start, size_t len )
6664{
6665 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6666 /* Remember digest of the peer's end-CRT. */
6667 ssl->session_negotiate->peer_cert_digest =
6668 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6669 if( ssl->session_negotiate->peer_cert_digest == NULL )
6670 {
6671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6672 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6673 mbedtls_ssl_send_alert_message( ssl,
6674 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6675 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6676
6677 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6678 }
6679
6680 ret = mbedtls_md( mbedtls_md_info_from_type(
6681 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6682 start, len,
6683 ssl->session_negotiate->peer_cert_digest );
6684
6685 ssl->session_negotiate->peer_cert_digest_type =
6686 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6687 ssl->session_negotiate->peer_cert_digest_len =
6688 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6689
6690 return( ret );
6691}
6692
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006693MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006694static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6695 unsigned char *start, size_t len )
6696{
6697 unsigned char *end = start + len;
6698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6699
6700 /* Make a copy of the peer's raw public key. */
6701 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6702 ret = mbedtls_pk_parse_subpubkey( &start, end,
6703 &ssl->handshake->peer_pubkey );
6704 if( ret != 0 )
6705 {
6706 /* We should have parsed the public key before. */
6707 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6708 }
6709
6710 return( 0 );
6711}
6712#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6713
6714int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6715{
6716 int ret = 0;
6717 int crt_expected;
6718#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6719 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6720 ? ssl->handshake->sni_authmode
6721 : ssl->conf->authmode;
6722#else
6723 const int authmode = ssl->conf->authmode;
6724#endif
6725 void *rs_ctx = NULL;
6726 mbedtls_x509_crt *chain = NULL;
6727
6728 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6729
6730 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6731 if( crt_expected == SSL_CERTIFICATE_SKIP )
6732 {
6733 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6734 goto exit;
6735 }
6736
6737#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6738 if( ssl->handshake->ecrs_enabled &&
6739 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6740 {
6741 chain = ssl->handshake->ecrs_peer_cert;
6742 ssl->handshake->ecrs_peer_cert = NULL;
6743 goto crt_verify;
6744 }
6745#endif
6746
6747 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6748 {
6749 /* mbedtls_ssl_read_record may have sent an alert already. We
6750 let it decide whether to alert. */
6751 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6752 goto exit;
6753 }
6754
6755#if defined(MBEDTLS_SSL_SRV_C)
6756 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6757 {
6758 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6759
6760 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6761 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6762
6763 goto exit;
6764 }
6765#endif /* MBEDTLS_SSL_SRV_C */
6766
6767 /* Clear existing peer CRT structure in case we tried to
6768 * reuse a session but it failed, and allocate a new one. */
6769 ssl_clear_peer_cert( ssl->session_negotiate );
6770
6771 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6772 if( chain == NULL )
6773 {
6774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6775 sizeof( mbedtls_x509_crt ) ) );
6776 mbedtls_ssl_send_alert_message( ssl,
6777 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6778 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6779
6780 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6781 goto exit;
6782 }
6783 mbedtls_x509_crt_init( chain );
6784
6785 ret = ssl_parse_certificate_chain( ssl, chain );
6786 if( ret != 0 )
6787 goto exit;
6788
6789#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6790 if( ssl->handshake->ecrs_enabled)
6791 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6792
6793crt_verify:
6794 if( ssl->handshake->ecrs_enabled)
6795 rs_ctx = &ssl->handshake->ecrs_ctx;
6796#endif
6797
6798 ret = ssl_parse_certificate_verify( ssl, authmode,
6799 chain, rs_ctx );
6800 if( ret != 0 )
6801 goto exit;
6802
6803#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6804 {
6805 unsigned char *crt_start, *pk_start;
6806 size_t crt_len, pk_len;
6807
6808 /* We parse the CRT chain without copying, so
6809 * these pointers point into the input buffer,
6810 * and are hence still valid after freeing the
6811 * CRT chain. */
6812
6813 crt_start = chain->raw.p;
6814 crt_len = chain->raw.len;
6815
6816 pk_start = chain->pk_raw.p;
6817 pk_len = chain->pk_raw.len;
6818
6819 /* Free the CRT structures before computing
6820 * digest and copying the peer's public key. */
6821 mbedtls_x509_crt_free( chain );
6822 mbedtls_free( chain );
6823 chain = NULL;
6824
6825 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6826 if( ret != 0 )
6827 goto exit;
6828
6829 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6830 if( ret != 0 )
6831 goto exit;
6832 }
6833#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6834 /* Pass ownership to session structure. */
6835 ssl->session_negotiate->peer_cert = chain;
6836 chain = NULL;
6837#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6838
6839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6840
6841exit:
6842
6843 if( ret == 0 )
6844 ssl->state++;
6845
6846#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6847 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6848 {
6849 ssl->handshake->ecrs_peer_cert = chain;
6850 chain = NULL;
6851 }
6852#endif
6853
6854 if( chain != NULL )
6855 {
6856 mbedtls_x509_crt_free( chain );
6857 mbedtls_free( chain );
6858 }
6859
6860 return( ret );
6861}
6862#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6863
Jerry Yu615bd6f2022-02-17 14:25:15 +08006864#if defined(MBEDTLS_SHA256_C)
6865static void ssl_calc_finished_tls_sha256(
6866 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6867{
6868 int len = 12;
6869 const char *sender;
6870 unsigned char padbuf[32];
6871#if defined(MBEDTLS_USE_PSA_CRYPTO)
6872 size_t hash_size;
6873 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6874 psa_status_t status;
6875#else
6876 mbedtls_sha256_context sha256;
6877#endif
6878
6879 mbedtls_ssl_session *session = ssl->session_negotiate;
6880 if( !session )
6881 session = ssl->session;
6882
6883 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6884 ? "client finished"
6885 : "server finished";
6886
6887#if defined(MBEDTLS_USE_PSA_CRYPTO)
6888 sha256_psa = psa_hash_operation_init();
6889
6890 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6891
6892 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6893 if( status != PSA_SUCCESS )
6894 {
6895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6896 return;
6897 }
6898
6899 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6900 if( status != PSA_SUCCESS )
6901 {
6902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6903 return;
6904 }
6905 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6906#else
6907
6908 mbedtls_sha256_init( &sha256 );
6909
6910 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6911
6912 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6913
6914 /*
6915 * TLSv1.2:
6916 * hash = PRF( master, finished_label,
6917 * Hash( handshake ) )[0.11]
6918 */
6919
6920#if !defined(MBEDTLS_SHA256_ALT)
6921 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6922 sha256.state, sizeof( sha256.state ) );
6923#endif
6924
6925 mbedtls_sha256_finish( &sha256, padbuf );
6926 mbedtls_sha256_free( &sha256 );
6927#endif /* MBEDTLS_USE_PSA_CRYPTO */
6928
6929 ssl->handshake->tls_prf( session->master, 48, sender,
6930 padbuf, 32, buf, len );
6931
6932 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6933
6934 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6935
6936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6937}
6938#endif /* MBEDTLS_SHA256_C */
6939
Jerry Yub7ba49e2022-02-17 14:25:53 +08006940
6941#if defined(MBEDTLS_SHA384_C)
6942
6943static void ssl_calc_finished_tls_sha384(
6944 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6945{
6946 int len = 12;
6947 const char *sender;
6948 unsigned char padbuf[48];
6949#if defined(MBEDTLS_USE_PSA_CRYPTO)
6950 size_t hash_size;
6951 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6952 psa_status_t status;
6953#else
6954 mbedtls_sha512_context sha512;
6955#endif
6956
6957 mbedtls_ssl_session *session = ssl->session_negotiate;
6958 if( !session )
6959 session = ssl->session;
6960
6961 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6962 ? "client finished"
6963 : "server finished";
6964
6965#if defined(MBEDTLS_USE_PSA_CRYPTO)
6966 sha384_psa = psa_hash_operation_init();
6967
6968 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6969
6970 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6971 if( status != PSA_SUCCESS )
6972 {
6973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6974 return;
6975 }
6976
6977 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6978 if( status != PSA_SUCCESS )
6979 {
6980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6981 return;
6982 }
6983 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6984#else
6985 mbedtls_sha512_init( &sha512 );
6986
6987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6988
Andrzej Kureka242e832022-08-11 10:03:14 -04006989 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yub7ba49e2022-02-17 14:25:53 +08006990
6991 /*
6992 * TLSv1.2:
6993 * hash = PRF( master, finished_label,
6994 * Hash( handshake ) )[0.11]
6995 */
6996
6997#if !defined(MBEDTLS_SHA512_ALT)
6998 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6999 sha512.state, sizeof( sha512.state ) );
7000#endif
7001 mbedtls_sha512_finish( &sha512, padbuf );
7002
7003 mbedtls_sha512_free( &sha512 );
7004#endif
7005
7006 ssl->handshake->tls_prf( session->master, 48, sender,
7007 padbuf, 48, buf, len );
7008
7009 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7010
7011 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7012
7013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7014}
7015#endif /* MBEDTLS_SHA384_C */
7016
Jerry Yuaef00152022-02-17 14:27:31 +08007017void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7018{
7019 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7020
7021 /*
7022 * Free our handshake params
7023 */
7024 mbedtls_ssl_handshake_free( ssl );
7025 mbedtls_free( ssl->handshake );
7026 ssl->handshake = NULL;
7027
7028 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007029 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007030 */
7031 if( ssl->transform )
7032 {
7033 mbedtls_ssl_transform_free( ssl->transform );
7034 mbedtls_free( ssl->transform );
7035 }
7036 ssl->transform = ssl->transform_negotiate;
7037 ssl->transform_negotiate = NULL;
7038
7039 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7040}
7041
Jerry Yu2a9fff52022-02-17 14:28:51 +08007042void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7043{
7044 int resume = ssl->handshake->resume;
7045
7046 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7047
7048#if defined(MBEDTLS_SSL_RENEGOTIATION)
7049 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7050 {
7051 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7052 ssl->renego_records_seen = 0;
7053 }
7054#endif
7055
7056 /*
7057 * Free the previous session and switch in the current one
7058 */
7059 if( ssl->session )
7060 {
7061#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7062 /* RFC 7366 3.1: keep the EtM state */
7063 ssl->session_negotiate->encrypt_then_mac =
7064 ssl->session->encrypt_then_mac;
7065#endif
7066
7067 mbedtls_ssl_session_free( ssl->session );
7068 mbedtls_free( ssl->session );
7069 }
7070 ssl->session = ssl->session_negotiate;
7071 ssl->session_negotiate = NULL;
7072
7073 /*
7074 * Add cache entry
7075 */
7076 if( ssl->conf->f_set_cache != NULL &&
7077 ssl->session->id_len != 0 &&
7078 resume == 0 )
7079 {
7080 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7081 ssl->session->id,
7082 ssl->session->id_len,
7083 ssl->session ) != 0 )
7084 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7085 }
7086
7087#if defined(MBEDTLS_SSL_PROTO_DTLS)
7088 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7089 ssl->handshake->flight != NULL )
7090 {
7091 /* Cancel handshake timer */
7092 mbedtls_ssl_set_timer( ssl, 0 );
7093
7094 /* Keep last flight around in case we need to resend it:
7095 * we need the handshake and transform structures for that */
7096 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7097 }
7098 else
7099#endif
7100 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7101
7102 ssl->state++;
7103
7104 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7105}
7106
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007107int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7108{
7109 int ret, hash_len;
7110
7111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7112
7113 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7114
7115 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7116
7117 /*
7118 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7119 * may define some other value. Currently (early 2016), no defined
7120 * ciphersuite does this (and this is unlikely to change as activity has
7121 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7122 */
7123 hash_len = 12;
7124
7125#if defined(MBEDTLS_SSL_RENEGOTIATION)
7126 ssl->verify_data_len = hash_len;
7127 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7128#endif
7129
7130 ssl->out_msglen = 4 + hash_len;
7131 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7132 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7133
7134 /*
7135 * In case of session resuming, invert the client and server
7136 * ChangeCipherSpec messages order.
7137 */
7138 if( ssl->handshake->resume != 0 )
7139 {
7140#if defined(MBEDTLS_SSL_CLI_C)
7141 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7142 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7143#endif
7144#if defined(MBEDTLS_SSL_SRV_C)
7145 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7146 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7147#endif
7148 }
7149 else
7150 ssl->state++;
7151
7152 /*
7153 * Switch to our negotiated transform and session parameters for outbound
7154 * data.
7155 */
7156 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7157
7158#if defined(MBEDTLS_SSL_PROTO_DTLS)
7159 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7160 {
7161 unsigned char i;
7162
7163 /* Remember current epoch settings for resending */
7164 ssl->handshake->alt_transform_out = ssl->transform_out;
7165 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7166 sizeof( ssl->handshake->alt_out_ctr ) );
7167
7168 /* Set sequence_number to zero */
7169 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7170
7171
7172 /* Increment epoch */
7173 for( i = 2; i > 0; i-- )
7174 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7175 break;
7176
7177 /* The loop goes to its end iff the counter is wrapping */
7178 if( i == 0 )
7179 {
7180 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7181 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7182 }
7183 }
7184 else
7185#endif /* MBEDTLS_SSL_PROTO_DTLS */
7186 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7187
7188 ssl->transform_out = ssl->transform_negotiate;
7189 ssl->session_out = ssl->session_negotiate;
7190
7191#if defined(MBEDTLS_SSL_PROTO_DTLS)
7192 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7193 mbedtls_ssl_send_flight_completed( ssl );
7194#endif
7195
7196 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7197 {
7198 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7199 return( ret );
7200 }
7201
7202#if defined(MBEDTLS_SSL_PROTO_DTLS)
7203 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7204 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7205 {
7206 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7207 return( ret );
7208 }
7209#endif
7210
7211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7212
7213 return( 0 );
7214}
7215
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007216#define SSL_MAX_HASH_LEN 12
7217
7218int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7219{
7220 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7221 unsigned int hash_len = 12;
7222 unsigned char buf[SSL_MAX_HASH_LEN];
7223
7224 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7225
7226 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7227
7228 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7229 {
7230 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7231 goto exit;
7232 }
7233
7234 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7235 {
7236 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7237 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7238 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7239 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7240 goto exit;
7241 }
7242
7243 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7244 {
7245 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7246 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7247 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7248 goto exit;
7249 }
7250
7251 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7252 {
7253 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7254 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7255 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7256 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7257 goto exit;
7258 }
7259
7260 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7261 buf, hash_len ) != 0 )
7262 {
7263 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7264 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7265 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7266 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7267 goto exit;
7268 }
7269
7270#if defined(MBEDTLS_SSL_RENEGOTIATION)
7271 ssl->verify_data_len = hash_len;
7272 memcpy( ssl->peer_verify_data, buf, hash_len );
7273#endif
7274
7275 if( ssl->handshake->resume != 0 )
7276 {
7277#if defined(MBEDTLS_SSL_CLI_C)
7278 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7279 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7280#endif
7281#if defined(MBEDTLS_SSL_SRV_C)
7282 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7283 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7284#endif
7285 }
7286 else
7287 ssl->state++;
7288
7289#if defined(MBEDTLS_SSL_PROTO_DTLS)
7290 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7291 mbedtls_ssl_recv_flight_completed( ssl );
7292#endif
7293
7294 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7295
7296exit:
7297 mbedtls_platform_zeroize( buf, hash_len );
7298 return( ret );
7299}
7300
Jerry Yu392112c2022-02-17 14:34:10 +08007301#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7302/*
7303 * Helper to get TLS 1.2 PRF from ciphersuite
7304 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7305 */
7306static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7307{
7308#if defined(MBEDTLS_SHA384_C)
7309 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7310 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7311
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007312 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007313 return( tls_prf_sha384 );
7314#else
7315 (void) ciphersuite_id;
7316#endif
7317 return( tls_prf_sha256 );
7318}
7319#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007320
7321static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7322{
7323 ((void) tls_prf);
7324#if defined(MBEDTLS_SHA384_C)
7325 if( tls_prf == tls_prf_sha384 )
7326 {
7327 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7328 }
7329 else
7330#endif
7331#if defined(MBEDTLS_SHA256_C)
7332 if( tls_prf == tls_prf_sha256 )
7333 {
7334 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7335 }
7336 else
7337#endif
7338 return( MBEDTLS_SSL_TLS_PRF_NONE );
7339}
7340
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007341/*
7342 * Populate a transform structure with session keys and all the other
7343 * necessary information.
7344 *
7345 * Parameters:
7346 * - [in/out]: transform: structure to populate
7347 * [in] must be just initialised with mbedtls_ssl_transform_init()
7348 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7349 * - [in] ciphersuite
7350 * - [in] master
7351 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007352 * - [in] tls_prf: pointer to PRF to use for key derivation
7353 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007354 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007355 * - [in] endpoint: client or server
7356 * - [in] ssl: used for:
7357 * - ssl->conf->{f,p}_export_keys
7358 * [in] optionally used for:
7359 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7360 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007361MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007362static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7363 int ciphersuite,
7364 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007365#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007366 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007367#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007368 ssl_tls_prf_t tls_prf,
7369 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007370 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007371 unsigned endpoint,
7372 const mbedtls_ssl_context *ssl )
7373{
7374 int ret = 0;
7375 unsigned char keyblk[256];
7376 unsigned char *key1;
7377 unsigned char *key2;
7378 unsigned char *mac_enc;
7379 unsigned char *mac_dec;
7380 size_t mac_key_len = 0;
7381 size_t iv_copy_len;
7382 size_t keylen;
7383 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007384 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007385#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007386 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007387 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007388#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007389
7390#if defined(MBEDTLS_USE_PSA_CRYPTO)
7391 psa_key_type_t key_type;
7392 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7393 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007394 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007395 size_t key_bits;
7396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7397#endif
7398
7399#if !defined(MBEDTLS_DEBUG_C) && \
7400 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7401 if( ssl->f_export_keys == NULL )
7402 {
7403 ssl = NULL; /* make sure we don't use it except for these cases */
7404 (void) ssl;
7405 }
7406#endif
7407
7408 /*
7409 * Some data just needs copying into the structure
7410 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007412 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007413#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007414 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007415
7416#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7417 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7418#endif
7419
7420#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007421 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007422 {
7423 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7424 * generation separate. This should never happen. */
7425 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7426 }
7427#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7428
7429 /*
7430 * Get various info structures
7431 */
7432 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7433 if( ciphersuite_info == NULL )
7434 {
7435 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7436 ciphersuite ) );
7437 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7438 }
7439
Neil Armstrongab555e02022-04-04 11:07:59 +02007440 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007441#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007442 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007443#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007444 ciphersuite_info );
7445
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007446 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7447 transform->taglen =
7448 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7449
7450#if defined(MBEDTLS_USE_PSA_CRYPTO)
7451 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7452 transform->taglen,
7453 &alg,
7454 &key_type,
7455 &key_bits ) ) != PSA_SUCCESS )
7456 {
7457 ret = psa_ssl_status_to_mbedtls( status );
7458 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7459 goto end;
7460 }
7461#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007462 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7463 if( cipher_info == NULL )
7464 {
7465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7466 ciphersuite_info->cipher ) );
7467 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7468 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007469#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007470
Neil Armstronge4512952022-03-08 09:08:22 +01007471#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007472 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007473 if( mac_alg == 0 )
7474 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007476 (unsigned) ciphersuite_info->mac ) );
7477 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7478 }
7479#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007480 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7481 if( md_info == NULL )
7482 {
7483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7484 (unsigned) ciphersuite_info->mac ) );
7485 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7486 }
Neil Armstronge4512952022-03-08 09:08:22 +01007487#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007488
7489#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7490 /* Copy own and peer's CID if the use of the CID
7491 * extension has been negotiated. */
7492 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7493 {
7494 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7495
7496 transform->in_cid_len = ssl->own_cid_len;
7497 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7498 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7499 transform->in_cid_len );
7500
7501 transform->out_cid_len = ssl->handshake->peer_cid_len;
7502 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7503 ssl->handshake->peer_cid_len );
7504 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7505 transform->out_cid_len );
7506 }
7507#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7508
7509 /*
7510 * Compute key block using the PRF
7511 */
7512 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7513 if( ret != 0 )
7514 {
7515 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7516 return( ret );
7517 }
7518
7519 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7520 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7521 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7522 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7523 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7524
7525 /*
7526 * Determine the appropriate key, IV and MAC length.
7527 */
7528
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007529#if defined(MBEDTLS_USE_PSA_CRYPTO)
7530 keylen = PSA_BITS_TO_BYTES(key_bits);
7531#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007532 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007533#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007534
7535#if defined(MBEDTLS_GCM_C) || \
7536 defined(MBEDTLS_CCM_C) || \
7537 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007538 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007539 {
7540 size_t explicit_ivlen;
7541
7542 transform->maclen = 0;
7543 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007544
7545 /* All modes haves 96-bit IVs, but the length of the static parts vary
7546 * with mode and version:
7547 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7548 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7549 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7550 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7551 * sequence number).
7552 */
7553 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007554#if defined(MBEDTLS_USE_PSA_CRYPTO)
7555 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7556#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007557 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007558#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007559 transform->fixed_ivlen = 12;
7560 else
7561 transform->fixed_ivlen = 4;
7562
7563 /* Minimum length of encrypted record */
7564 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7565 transform->minlen = explicit_ivlen + transform->taglen;
7566 }
7567 else
7568#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7569#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007570 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7571 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7572 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007573 {
Neil Armstronge4512952022-03-08 09:08:22 +01007574#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007575 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007576#else
7577 size_t block_size = cipher_info->block_size;
7578#endif /* MBEDTLS_USE_PSA_CRYPTO */
7579
7580#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007581 /* Get MAC length */
7582 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7583#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007584 /* Initialize HMAC contexts */
7585 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7586 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7587 {
7588 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7589 goto end;
7590 }
7591
7592 /* Get MAC length */
7593 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007594#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007595 transform->maclen = mac_key_len;
7596
7597 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007598#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007599 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007600#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007601 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007602#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007603
7604 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007605 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007606 transform->minlen = transform->maclen;
7607 else
7608 {
7609 /*
7610 * GenericBlockCipher:
7611 * 1. if EtM is in use: one block plus MAC
7612 * otherwise: * first multiple of blocklen greater than maclen
7613 * 2. IV
7614 */
7615#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007616 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007617 {
7618 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007619 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007620 }
7621 else
7622#endif
7623 {
7624 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007625 + block_size
7626 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007627 }
7628
Glenn Strauss07c64162022-03-14 12:34:51 -04007629 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007630 {
7631 transform->minlen += transform->ivlen;
7632 }
7633 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007634 {
7635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7636 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7637 goto end;
7638 }
7639 }
7640 }
7641 else
7642#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7643 {
7644 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7645 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7646 }
7647
7648 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7649 (unsigned) keylen,
7650 (unsigned) transform->minlen,
7651 (unsigned) transform->ivlen,
7652 (unsigned) transform->maclen ) );
7653
7654 /*
7655 * Finally setup the cipher contexts, IVs and MAC secrets.
7656 */
7657#if defined(MBEDTLS_SSL_CLI_C)
7658 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7659 {
7660 key1 = keyblk + mac_key_len * 2;
7661 key2 = keyblk + mac_key_len * 2 + keylen;
7662
7663 mac_enc = keyblk;
7664 mac_dec = keyblk + mac_key_len;
7665
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007666 iv_copy_len = ( transform->fixed_ivlen ) ?
7667 transform->fixed_ivlen : transform->ivlen;
7668 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7669 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7670 iv_copy_len );
7671 }
7672 else
7673#endif /* MBEDTLS_SSL_CLI_C */
7674#if defined(MBEDTLS_SSL_SRV_C)
7675 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7676 {
7677 key1 = keyblk + mac_key_len * 2 + keylen;
7678 key2 = keyblk + mac_key_len * 2;
7679
7680 mac_enc = keyblk + mac_key_len;
7681 mac_dec = keyblk;
7682
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007683 iv_copy_len = ( transform->fixed_ivlen ) ?
7684 transform->fixed_ivlen : transform->ivlen;
7685 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7686 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7687 iv_copy_len );
7688 }
7689 else
7690#endif /* MBEDTLS_SSL_SRV_C */
7691 {
7692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7693 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7694 goto end;
7695 }
7696
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007697 if( ssl != NULL && ssl->f_export_keys != NULL )
7698 {
7699 ssl->f_export_keys( ssl->p_export_keys,
7700 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7701 master, 48,
7702 randbytes + 32,
7703 randbytes,
7704 tls_prf_get_type( tls_prf ) );
7705 }
7706
7707#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007708 transform->psa_alg = alg;
7709
7710 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7711 {
7712 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7713 psa_set_key_algorithm( &attributes, alg );
7714 psa_set_key_type( &attributes, key_type );
7715
7716 if( ( status = psa_import_key( &attributes,
7717 key1,
7718 PSA_BITS_TO_BYTES( key_bits ),
7719 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7720 {
7721 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7722 ret = psa_ssl_status_to_mbedtls( status );
7723 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7724 goto end;
7725 }
7726
7727 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7728
7729 if( ( status = psa_import_key( &attributes,
7730 key2,
7731 PSA_BITS_TO_BYTES( key_bits ),
7732 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7733 {
7734 ret = psa_ssl_status_to_mbedtls( status );
7735 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7736 goto end;
7737 }
7738 }
7739#else
7740 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7741 cipher_info ) ) != 0 )
7742 {
7743 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7744 goto end;
7745 }
7746
7747 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7748 cipher_info ) ) != 0 )
7749 {
7750 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7751 goto end;
7752 }
7753
7754 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7755 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7756 MBEDTLS_ENCRYPT ) ) != 0 )
7757 {
7758 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7759 goto end;
7760 }
7761
7762 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7763 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7764 MBEDTLS_DECRYPT ) ) != 0 )
7765 {
7766 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7767 goto end;
7768 }
7769
7770#if defined(MBEDTLS_CIPHER_MODE_CBC)
7771 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7772 {
7773 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7774 MBEDTLS_PADDING_NONE ) ) != 0 )
7775 {
7776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7777 goto end;
7778 }
7779
7780 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7781 MBEDTLS_PADDING_NONE ) ) != 0 )
7782 {
7783 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7784 goto end;
7785 }
7786 }
7787#endif /* MBEDTLS_CIPHER_MODE_CBC */
7788#endif /* MBEDTLS_USE_PSA_CRYPTO */
7789
Neil Armstrong29c0c042022-03-17 17:47:28 +01007790#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7791 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7792 For AEAD-based ciphersuites, there is nothing to do here. */
7793 if( mac_key_len != 0 )
7794 {
7795#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007796 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007797
7798 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007799 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007800 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7801
7802 if( ( status = psa_import_key( &attributes,
7803 mac_enc, mac_key_len,
7804 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7805 {
7806 ret = psa_ssl_status_to_mbedtls( status );
7807 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7808 goto end;
7809 }
7810
Ronald Cronfb39f152022-03-25 14:36:28 +01007811 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7812 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7813 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007814 /* mbedtls_ct_hmac() requires the key to be exportable */
7815 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7816 PSA_KEY_USAGE_VERIFY_HASH );
7817 else
7818 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7819
7820 if( ( status = psa_import_key( &attributes,
7821 mac_dec, mac_key_len,
7822 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7823 {
7824 ret = psa_ssl_status_to_mbedtls( status );
7825 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7826 goto end;
7827 }
7828#else
7829 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7830 if( ret != 0 )
7831 goto end;
7832 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7833 if( ret != 0 )
7834 goto end;
7835#endif /* MBEDTLS_USE_PSA_CRYPTO */
7836 }
7837#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7838
7839 ((void) mac_dec);
7840 ((void) mac_enc);
7841
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007842end:
7843 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7844 return( ret );
7845}
7846
Jerry Yuee40f9d2022-02-17 14:55:16 +08007847#if defined(MBEDTLS_USE_PSA_CRYPTO)
7848int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7849 unsigned char *hash, size_t *hashlen,
7850 unsigned char *data, size_t data_len,
7851 mbedtls_md_type_t md_alg )
7852{
7853 psa_status_t status;
7854 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007855 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007856
7857 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7858
7859 if( ( status = psa_hash_setup( &hash_operation,
7860 hash_alg ) ) != PSA_SUCCESS )
7861 {
7862 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7863 goto exit;
7864 }
7865
7866 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7867 64 ) ) != PSA_SUCCESS )
7868 {
7869 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7870 goto exit;
7871 }
7872
7873 if( ( status = psa_hash_update( &hash_operation,
7874 data, data_len ) ) != PSA_SUCCESS )
7875 {
7876 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7877 goto exit;
7878 }
7879
7880 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7881 hashlen ) ) != PSA_SUCCESS )
7882 {
7883 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7884 goto exit;
7885 }
7886
7887exit:
7888 if( status != PSA_SUCCESS )
7889 {
7890 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7891 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7892 switch( status )
7893 {
7894 case PSA_ERROR_NOT_SUPPORTED:
7895 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7896 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7897 case PSA_ERROR_BUFFER_TOO_SMALL:
7898 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7899 case PSA_ERROR_INSUFFICIENT_MEMORY:
7900 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7901 default:
7902 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7903 }
7904 }
7905 return( 0 );
7906}
7907
7908#else
7909
7910int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7911 unsigned char *hash, size_t *hashlen,
7912 unsigned char *data, size_t data_len,
7913 mbedtls_md_type_t md_alg )
7914{
7915 int ret = 0;
7916 mbedtls_md_context_t ctx;
7917 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7918 *hashlen = mbedtls_md_get_size( md_info );
7919
7920 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7921
7922 mbedtls_md_init( &ctx );
7923
7924 /*
7925 * digitally-signed struct {
7926 * opaque client_random[32];
7927 * opaque server_random[32];
7928 * ServerDHParams params;
7929 * };
7930 */
7931 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7932 {
7933 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7934 goto exit;
7935 }
7936 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7937 {
7938 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7939 goto exit;
7940 }
7941 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7942 {
7943 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7944 goto exit;
7945 }
7946 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7947 {
7948 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7949 goto exit;
7950 }
7951 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7952 {
7953 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7954 goto exit;
7955 }
7956
7957exit:
7958 mbedtls_md_free( &ctx );
7959
7960 if( ret != 0 )
7961 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7962 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7963
7964 return( ret );
7965}
7966#endif /* MBEDTLS_USE_PSA_CRYPTO */
7967
Jerry Yud9d91da2022-02-17 14:57:06 +08007968#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7969
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007970/* Find the preferred hash for a given signature algorithm. */
7971unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7972 mbedtls_ssl_context *ssl,
7973 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007974{
Gabor Mezei078e8032022-04-27 21:17:56 +02007975 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007976 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007977
7978 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007979 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007980
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007981 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007982 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007983 unsigned int hash_alg_received =
7984 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7985 received_sig_algs[i] );
7986 unsigned int sig_alg_received =
7987 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7988 received_sig_algs[i] );
7989
7990 if( sig_alg == sig_alg_received )
7991 {
7992#if defined(MBEDTLS_USE_PSA_CRYPTO)
7993 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7994 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007995 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007996 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007997
Neil Armstrong96eceb82022-06-30 18:05:05 +02007998 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7999 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8000 PSA_ALG_ECDSA( psa_hash_alg ),
8001 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008002 continue;
8003
Neil Armstrong96eceb82022-06-30 18:05:05 +02008004 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008005 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8006 PSA_ALG_RSA_PKCS1V15_SIGN(
8007 psa_hash_alg ),
8008 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008009 continue;
8010 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008011#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008012
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008013 return( hash_alg_received );
8014 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008015 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008016
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008017 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008018}
8019
8020#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8021
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008022/* Serialization of TLS 1.2 sessions:
8023 *
8024 * struct {
8025 * uint64 start_time;
8026 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008027 * uint8 session_id_len; // at most 32
8028 * opaque session_id[32];
8029 * opaque master[48]; // fixed length in the standard
8030 * uint32 verify_result;
8031 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8032 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8033 * uint32 ticket_lifetime;
8034 * uint8 mfl_code; // up to 255 according to standard
8035 * uint8 encrypt_then_mac; // 0 or 1
8036 * } serialized_session_tls12;
8037 *
8038 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008039static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008040 unsigned char *buf,
8041 size_t buf_len )
8042{
8043 unsigned char *p = buf;
8044 size_t used = 0;
8045
8046#if defined(MBEDTLS_HAVE_TIME)
8047 uint64_t start;
8048#endif
8049#if defined(MBEDTLS_X509_CRT_PARSE_C)
8050#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8051 size_t cert_len;
8052#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8053#endif /* MBEDTLS_X509_CRT_PARSE_C */
8054
8055 /*
8056 * Time
8057 */
8058#if defined(MBEDTLS_HAVE_TIME)
8059 used += 8;
8060
8061 if( used <= buf_len )
8062 {
8063 start = (uint64_t) session->start;
8064
8065 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8066 p += 8;
8067 }
8068#endif /* MBEDTLS_HAVE_TIME */
8069
8070 /*
8071 * Basic mandatory fields
8072 */
8073 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008074 + 1 /* id_len */
8075 + sizeof( session->id )
8076 + sizeof( session->master )
8077 + 4; /* verify_result */
8078
8079 if( used <= buf_len )
8080 {
8081 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8082 p += 2;
8083
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008084 *p++ = MBEDTLS_BYTE_0( session->id_len );
8085 memcpy( p, session->id, 32 );
8086 p += 32;
8087
8088 memcpy( p, session->master, 48 );
8089 p += 48;
8090
8091 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8092 p += 4;
8093 }
8094
8095 /*
8096 * Peer's end-entity certificate
8097 */
8098#if defined(MBEDTLS_X509_CRT_PARSE_C)
8099#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8100 if( session->peer_cert == NULL )
8101 cert_len = 0;
8102 else
8103 cert_len = session->peer_cert->raw.len;
8104
8105 used += 3 + cert_len;
8106
8107 if( used <= buf_len )
8108 {
8109 *p++ = MBEDTLS_BYTE_2( cert_len );
8110 *p++ = MBEDTLS_BYTE_1( cert_len );
8111 *p++ = MBEDTLS_BYTE_0( cert_len );
8112
8113 if( session->peer_cert != NULL )
8114 {
8115 memcpy( p, session->peer_cert->raw.p, cert_len );
8116 p += cert_len;
8117 }
8118 }
8119#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8120 if( session->peer_cert_digest != NULL )
8121 {
8122 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8123 if( used <= buf_len )
8124 {
8125 *p++ = (unsigned char) session->peer_cert_digest_type;
8126 *p++ = (unsigned char) session->peer_cert_digest_len;
8127 memcpy( p, session->peer_cert_digest,
8128 session->peer_cert_digest_len );
8129 p += session->peer_cert_digest_len;
8130 }
8131 }
8132 else
8133 {
8134 used += 2;
8135 if( used <= buf_len )
8136 {
8137 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8138 *p++ = 0;
8139 }
8140 }
8141#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8142#endif /* MBEDTLS_X509_CRT_PARSE_C */
8143
8144 /*
8145 * Session ticket if any, plus associated data
8146 */
8147#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8148 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8149
8150 if( used <= buf_len )
8151 {
8152 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8153 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8154 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8155
8156 if( session->ticket != NULL )
8157 {
8158 memcpy( p, session->ticket, session->ticket_len );
8159 p += session->ticket_len;
8160 }
8161
8162 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8163 p += 4;
8164 }
8165#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8166
8167 /*
8168 * Misc extension-related info
8169 */
8170#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8171 used += 1;
8172
8173 if( used <= buf_len )
8174 *p++ = session->mfl_code;
8175#endif
8176
8177#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8178 used += 1;
8179
8180 if( used <= buf_len )
8181 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8182#endif
8183
8184 return( used );
8185}
8186
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008187MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008188static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008189 const unsigned char *buf,
8190 size_t len )
8191{
8192#if defined(MBEDTLS_HAVE_TIME)
8193 uint64_t start;
8194#endif
8195#if defined(MBEDTLS_X509_CRT_PARSE_C)
8196#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8197 size_t cert_len;
8198#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8199#endif /* MBEDTLS_X509_CRT_PARSE_C */
8200
8201 const unsigned char *p = buf;
8202 const unsigned char * const end = buf + len;
8203
8204 /*
8205 * Time
8206 */
8207#if defined(MBEDTLS_HAVE_TIME)
8208 if( 8 > (size_t)( end - p ) )
8209 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8210
8211 start = ( (uint64_t) p[0] << 56 ) |
8212 ( (uint64_t) p[1] << 48 ) |
8213 ( (uint64_t) p[2] << 40 ) |
8214 ( (uint64_t) p[3] << 32 ) |
8215 ( (uint64_t) p[4] << 24 ) |
8216 ( (uint64_t) p[5] << 16 ) |
8217 ( (uint64_t) p[6] << 8 ) |
8218 ( (uint64_t) p[7] );
8219 p += 8;
8220
8221 session->start = (time_t) start;
8222#endif /* MBEDTLS_HAVE_TIME */
8223
8224 /*
8225 * Basic mandatory fields
8226 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008227 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008228 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8229
8230 session->ciphersuite = ( p[0] << 8 ) | p[1];
8231 p += 2;
8232
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008233 session->id_len = *p++;
8234 memcpy( session->id, p, 32 );
8235 p += 32;
8236
8237 memcpy( session->master, p, 48 );
8238 p += 48;
8239
8240 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8241 ( (uint32_t) p[1] << 16 ) |
8242 ( (uint32_t) p[2] << 8 ) |
8243 ( (uint32_t) p[3] );
8244 p += 4;
8245
8246 /* Immediately clear invalid pointer values that have been read, in case
8247 * we exit early before we replaced them with valid ones. */
8248#if defined(MBEDTLS_X509_CRT_PARSE_C)
8249#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8250 session->peer_cert = NULL;
8251#else
8252 session->peer_cert_digest = NULL;
8253#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8254#endif /* MBEDTLS_X509_CRT_PARSE_C */
8255#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8256 session->ticket = NULL;
8257#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8258
8259 /*
8260 * Peer certificate
8261 */
8262#if defined(MBEDTLS_X509_CRT_PARSE_C)
8263#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8264 /* Deserialize CRT from the end of the ticket. */
8265 if( 3 > (size_t)( end - p ) )
8266 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8267
8268 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8269 p += 3;
8270
8271 if( cert_len != 0 )
8272 {
8273 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8274
8275 if( cert_len > (size_t)( end - p ) )
8276 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8277
8278 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8279
8280 if( session->peer_cert == NULL )
8281 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8282
8283 mbedtls_x509_crt_init( session->peer_cert );
8284
8285 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8286 p, cert_len ) ) != 0 )
8287 {
8288 mbedtls_x509_crt_free( session->peer_cert );
8289 mbedtls_free( session->peer_cert );
8290 session->peer_cert = NULL;
8291 return( ret );
8292 }
8293
8294 p += cert_len;
8295 }
8296#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8297 /* Deserialize CRT digest from the end of the ticket. */
8298 if( 2 > (size_t)( end - p ) )
8299 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8300
8301 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8302 session->peer_cert_digest_len = (size_t) *p++;
8303
8304 if( session->peer_cert_digest_len != 0 )
8305 {
8306 const mbedtls_md_info_t *md_info =
8307 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8308 if( md_info == NULL )
8309 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8310 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8311 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8312
8313 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8314 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8315
8316 session->peer_cert_digest =
8317 mbedtls_calloc( 1, session->peer_cert_digest_len );
8318 if( session->peer_cert_digest == NULL )
8319 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8320
8321 memcpy( session->peer_cert_digest, p,
8322 session->peer_cert_digest_len );
8323 p += session->peer_cert_digest_len;
8324 }
8325#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8326#endif /* MBEDTLS_X509_CRT_PARSE_C */
8327
8328 /*
8329 * Session ticket and associated data
8330 */
8331#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8332 if( 3 > (size_t)( end - p ) )
8333 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8334
8335 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8336 p += 3;
8337
8338 if( session->ticket_len != 0 )
8339 {
8340 if( session->ticket_len > (size_t)( end - p ) )
8341 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8342
8343 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8344 if( session->ticket == NULL )
8345 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8346
8347 memcpy( session->ticket, p, session->ticket_len );
8348 p += session->ticket_len;
8349 }
8350
8351 if( 4 > (size_t)( end - p ) )
8352 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8353
8354 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8355 ( (uint32_t) p[1] << 16 ) |
8356 ( (uint32_t) p[2] << 8 ) |
8357 ( (uint32_t) p[3] );
8358 p += 4;
8359#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8360
8361 /*
8362 * Misc extension-related info
8363 */
8364#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8365 if( 1 > (size_t)( end - p ) )
8366 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8367
8368 session->mfl_code = *p++;
8369#endif
8370
8371#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8372 if( 1 > (size_t)( end - p ) )
8373 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8374
8375 session->encrypt_then_mac = *p++;
8376#endif
8377
8378 /* Done, should have consumed entire buffer */
8379 if( p != end )
8380 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8381
8382 return( 0 );
8383}
Jerry Yudc7bd172022-02-17 13:44:15 +08008384#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8385
XiaokangQian75d40ef2022-04-20 11:05:24 +00008386int mbedtls_ssl_validate_ciphersuite(
8387 const mbedtls_ssl_context *ssl,
8388 const mbedtls_ssl_ciphersuite_t *suite_info,
8389 mbedtls_ssl_protocol_version min_tls_version,
8390 mbedtls_ssl_protocol_version max_tls_version )
8391{
8392 (void) ssl;
8393
8394 if( suite_info == NULL )
8395 return( -1 );
8396
8397 if( ( suite_info->min_tls_version > max_tls_version ) ||
8398 ( suite_info->max_tls_version < min_tls_version ) )
8399 {
8400 return( -1 );
8401 }
8402
XiaokangQian060d8672022-04-21 09:24:56 +00008403#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008404#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8405 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8406 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8407 {
8408 return( -1 );
8409 }
8410#endif
8411
8412 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8413#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8414 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8415 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8416 {
8417 return( -1 );
8418 }
8419#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8420#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8421
8422 return( 0 );
8423}
8424
XiaokangQianeaf36512022-04-24 09:07:44 +00008425#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8426/*
8427 * Function for writing a signature algorithm extension.
8428 *
8429 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8430 * value (TLS 1.3 RFC8446):
8431 * enum {
8432 * ....
8433 * ecdsa_secp256r1_sha256( 0x0403 ),
8434 * ecdsa_secp384r1_sha384( 0x0503 ),
8435 * ecdsa_secp521r1_sha512( 0x0603 ),
8436 * ....
8437 * } SignatureScheme;
8438 *
8439 * struct {
8440 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8441 * } SignatureSchemeList;
8442 *
8443 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8444 * value (TLS 1.2 RFC5246):
8445 * enum {
8446 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8447 * sha512(6), (255)
8448 * } HashAlgorithm;
8449 *
8450 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8451 * SignatureAlgorithm;
8452 *
8453 * struct {
8454 * HashAlgorithm hash;
8455 * SignatureAlgorithm signature;
8456 * } SignatureAndHashAlgorithm;
8457 *
8458 * SignatureAndHashAlgorithm
8459 * supported_signature_algorithms<2..2^16-2>;
8460 *
8461 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8462 * generalization of the TLS 1.2 signature algorithm extension.
8463 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8464 * `SignatureScheme` field of TLS 1.3
8465 *
8466 */
8467int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8468 const unsigned char *end, size_t *out_len )
8469{
8470 unsigned char *p = buf;
8471 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8472 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8473
8474 *out_len = 0;
8475
8476 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8477
8478 /* Check if we have space for header and length field:
8479 * - extension_type (2 bytes)
8480 * - extension_data_length (2 bytes)
8481 * - supported_signature_algorithms_length (2 bytes)
8482 */
8483 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8484 p += 6;
8485
8486 /*
8487 * Write supported_signature_algorithms
8488 */
8489 supported_sig_alg = p;
8490 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8491 if( sig_alg == NULL )
8492 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8493
8494 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8495 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008496 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8497 *sig_alg,
8498 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008499 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8500 continue;
8501 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8502 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8503 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008504 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008505 *sig_alg,
8506 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008507 }
8508
8509 /* Length of supported_signature_algorithms */
8510 supported_sig_alg_len = p - supported_sig_alg;
8511 if( supported_sig_alg_len == 0 )
8512 {
8513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8514 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8515 }
8516
XiaokangQianeaf36512022-04-24 09:07:44 +00008517 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008518 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008519 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8520
XiaokangQianeaf36512022-04-24 09:07:44 +00008521 *out_len = p - buf;
8522
8523#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8524 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8525#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8526 return( 0 );
8527}
8528#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8529
XiaokangQian40a35232022-05-07 09:02:40 +00008530#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008531/*
8532 * mbedtls_ssl_parse_server_name_ext
8533 *
8534 * Structure of server_name extension:
8535 *
8536 * enum {
8537 * host_name(0), (255)
8538 * } NameType;
8539 * opaque HostName<1..2^16-1>;
8540 *
8541 * struct {
8542 * NameType name_type;
8543 * select (name_type) {
8544 * case host_name: HostName;
8545 * } name;
8546 * } ServerName;
8547 * struct {
8548 * ServerName server_name_list<1..2^16-1>
8549 * } ServerNameList;
8550 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008551MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008552int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8553 const unsigned char *buf,
8554 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008555{
8556 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8557 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008558 size_t server_name_list_len, hostname_len;
8559 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008560
XiaokangQianf2a94202022-05-20 06:44:24 +00008561 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008562
8563 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008564 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008565 p += 2;
8566
XiaokangQian9b2b7712022-05-17 02:57:00 +00008567 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8568 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008569 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008570 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008571 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008572 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008573 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8574 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008575
8576 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8577 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008578 /* sni_name is intended to be used only during the parsing of the
8579 * ClientHello message (it is reset to NULL before the end of
8580 * the message parsing). Thus it is ok to just point to the
8581 * reception buffer and not make a copy of it.
8582 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008583 ssl->handshake->sni_name = p + 3;
8584 ssl->handshake->sni_name_len = hostname_len;
8585 if( ssl->conf->f_sni == NULL )
8586 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008587 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008588 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008589 if( ret != 0 )
8590 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008591 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008592 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8593 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008594 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8595 }
8596 return( 0 );
8597 }
8598
8599 p += hostname_len + 3;
8600 }
8601
8602 return( 0 );
8603}
8604#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8605
XiaokangQianacb39922022-06-17 10:18:48 +00008606#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008607MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008608int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8609 const unsigned char *buf,
8610 const unsigned char *end )
8611{
8612 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008613 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008614 const unsigned char *protocol_name_list;
8615 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008616 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008617
8618 /* If ALPN not configured, just ignore the extension */
8619 if( ssl->conf->alpn_list == NULL )
8620 return( 0 );
8621
8622 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008623 * RFC7301, section 3.1
8624 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008625 *
XiaokangQianc7403452022-06-23 03:24:12 +00008626 * struct {
8627 * ProtocolName protocol_name_list<2..2^16-1>
8628 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008629 */
8630
XiaokangQianc7403452022-06-23 03:24:12 +00008631 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008632 * protocol_name_list_len 2 bytes
8633 * protocol_name_len 1 bytes
8634 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008635 */
XiaokangQianacb39922022-06-17 10:18:48 +00008636 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8637
XiaokangQianc7403452022-06-23 03:24:12 +00008638 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008639 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008640 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008641 protocol_name_list = p;
8642 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008643
8644 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008645 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008646 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008647 protocol_name_len = *p++;
8648 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8649 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008650 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008651 {
8652 MBEDTLS_SSL_PEND_FATAL_ALERT(
8653 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8654 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008655 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008656 }
8657
8658 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008659 }
8660
8661 /* Use our order of preference */
8662 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8663 {
8664 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008665 p = protocol_name_list;
8666 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008667 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008668 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008669 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008670 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008671 {
8672 ssl->alpn_chosen = *alpn;
8673 return( 0 );
8674 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008675
8676 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008677 }
8678 }
8679
XiaokangQian95d5f542022-06-24 02:29:26 +00008680 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008681 MBEDTLS_SSL_PEND_FATAL_ALERT(
8682 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8683 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8684 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8685}
8686
8687int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8688 unsigned char *buf,
8689 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008690 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008691{
8692 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008693 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008694 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008695
8696 if( ssl->alpn_chosen == NULL )
8697 {
8698 return( 0 );
8699 }
8700
XiaokangQian95d5f542022-06-24 02:29:26 +00008701 protocol_name_len = strlen( ssl->alpn_chosen );
8702 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008703
8704 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8705 /*
8706 * 0 . 1 ext identifier
8707 * 2 . 3 ext length
8708 * 4 . 5 protocol list length
8709 * 6 . 6 protocol name length
8710 * 7 . 7+n protocol name
8711 */
8712 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8713
XiaokangQian95d5f542022-06-24 02:29:26 +00008714 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008715
XiaokangQian95d5f542022-06-24 02:29:26 +00008716 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8717 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008718 /* Note: the length of the chosen protocol has been checked to be less
8719 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8720 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008721 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008722
XiaokangQian95d5f542022-06-24 02:29:26 +00008723 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008724 return ( 0 );
8725}
8726#endif /* MBEDTLS_SSL_ALPN */
8727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008728#endif /* MBEDTLS_SSL_TLS_C */