blob: 55b7f85cecb74408f83100bae93ee85fffd96b4e [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Ronald Cronad8c17b2022-06-10 17:18:09 +020061#if defined(MBEDTLS_TEST_HOOKS)
62static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
63
64void mbedtls_ssl_set_chk_buf_ptr_fail_args(
65 const uint8_t *cur, const uint8_t *end, size_t need )
66{
67 chk_buf_ptr_fail_args.cur = cur;
68 chk_buf_ptr_fail_args.end = end;
69 chk_buf_ptr_fail_args.need = need;
70}
71
72void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void )
73{
74 memset( &chk_buf_ptr_fail_args, 0, sizeof( chk_buf_ptr_fail_args ) );
75}
76
77int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args )
78{
79 return( ( chk_buf_ptr_fail_args.cur != args->cur ) ||
80 ( chk_buf_ptr_fail_args.end != args->end ) ||
81 ( chk_buf_ptr_fail_args.need != args->need ) );
82}
83#endif /* MBEDTLS_TEST_HOOKS */
84
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010086
Hanno Beckera0e20d02019-05-15 14:03:01 +010087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010088/* Top-level Connection ID API */
89
Hanno Becker8367ccc2019-05-14 11:30:10 +010090int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
91 size_t len,
92 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010093{
94 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
95 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
96
Hanno Becker611ac772019-05-14 11:45:26 +010097 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
98 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
99 {
100 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
101 }
102
103 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100104 conf->cid_len = len;
105 return( 0 );
106}
107
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100108int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
109 int enable,
110 unsigned char const *own_cid,
111 size_t own_cid_len )
112{
Hanno Becker76a79ab2019-05-03 14:38:32 +0100113 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
114 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
115
Hanno Beckerca092242019-04-25 16:01:49 +0100116 ssl->negotiate_cid = enable;
117 if( enable == MBEDTLS_SSL_CID_DISABLED )
118 {
119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
120 return( 0 );
121 }
122 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +0100123 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Hanno Beckerad4a1372019-05-03 13:06:44 +0100125 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100126 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100127 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
128 (unsigned) own_cid_len,
129 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100130 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
131 }
132
133 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100134 /* Truncation is not an issue here because
135 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
136 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100137
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100138 return( 0 );
139}
140
Paul Elliott0113cf12022-03-11 20:26:47 +0000141int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
142 int *enabled,
143 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
144 size_t *own_cid_len )
145{
146 *enabled = MBEDTLS_SSL_CID_DISABLED;
147
148 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
149 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
150
151 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
152 * zero as this is indistinguishable from not requesting to use
153 * the CID extension. */
154 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
155 return( 0 );
156
157 if( own_cid_len != NULL )
158 {
159 *own_cid_len = ssl->own_cid_len;
160 if( own_cid != NULL )
161 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
162 }
163
164 *enabled = MBEDTLS_SSL_CID_ENABLED;
165
166 return( 0 );
167}
168
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100169int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
170 int *enabled,
171 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
172 size_t *peer_cid_len )
173{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100174 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100175
Hanno Becker76a79ab2019-05-03 14:38:32 +0100176 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000177 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100178 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100179 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100180 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181
Hanno Beckerc5f24222019-05-03 12:54:52 +0100182 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
183 * were used, but client and server requested the empty CID.
184 * This is indistinguishable from not using the CID extension
185 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186 if( ssl->transform_in->in_cid_len == 0 &&
187 ssl->transform_in->out_cid_len == 0 )
188 {
189 return( 0 );
190 }
191
Hanno Becker615ef172019-05-22 16:50:35 +0100192 if( peer_cid_len != NULL )
193 {
194 *peer_cid_len = ssl->transform_in->out_cid_len;
195 if( peer_cid != NULL )
196 {
197 memcpy( peer_cid, ssl->transform_in->out_cid,
198 ssl->transform_in->out_cid_len );
199 }
200 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100201
202 *enabled = MBEDTLS_SSL_CID_ENABLED;
203
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100204 return( 0 );
205}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100206#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200211/*
212 * Convert max_fragment_length codes to length.
213 * RFC 6066 says:
214 * enum{
215 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
216 * } MaxFragmentLength;
217 * and we add 0 -> extension unused
218 */
Angus Grattond8213d02016-05-25 20:56:48 +1000219static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200220{
Angus Grattond8213d02016-05-25 20:56:48 +1000221 switch( mfl )
222 {
223 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
224 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
225 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
226 return 512;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
228 return 1024;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
230 return 2048;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
232 return 4096;
233 default:
234 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
235 }
236}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200238
Hanno Becker52055ae2019-02-06 14:30:46 +0000239int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
240 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200241{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 mbedtls_ssl_session_free( dst );
243 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200244
吴敬辉0b716112021-11-29 10:46:35 +0800245#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
246 dst->ticket = NULL;
247#endif
248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000250
251#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252 if( src->peer_cert != NULL )
253 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200255
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200256 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200257 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200258 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200263 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200266 dst->peer_cert = NULL;
267 return( ret );
268 }
269 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000270#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 if( src->peer_cert_digest != NULL )
272 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000274 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000275 if( dst->peer_cert_digest == NULL )
276 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
277
278 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
279 src->peer_cert_digest_len );
280 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000281 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 }
283#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200287#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288 if( src->ticket != NULL )
289 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200290 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200291 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200292 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200293
294 memcpy( dst->ticket, src->ticket, src->ticket_len );
295 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200296#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297
298 return( 0 );
299}
300
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500301#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200302MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
304{
305 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
306 if( resized_buffer == NULL )
307 return -1;
308
309 /* We want to copy len_new bytes when downsizing the buffer, and
310 * len_old bytes when upsizing, so we choose the smaller of two sizes,
311 * to fit one buffer into another. Size checks, ensuring that no data is
312 * lost, are done outside of this function. */
313 memcpy( resized_buffer, *buffer,
314 ( len_new < *len_old ) ? len_new : *len_old );
315 mbedtls_platform_zeroize( *buffer, *len_old );
316 mbedtls_free( *buffer );
317
318 *buffer = resized_buffer;
319 *len_old = len_new;
320
321 return 0;
322}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323
324static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500325 size_t in_buf_new_len,
326 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200327{
328 int modified = 0;
329 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
330 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
331 if( ssl->in_buf != NULL )
332 {
333 written_in = ssl->in_msg - ssl->in_buf;
334 iv_offset_in = ssl->in_iv - ssl->in_buf;
335 len_offset_in = ssl->in_len - ssl->in_buf;
336 if( downsizing ?
337 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
338 ssl->in_buf_len < in_buf_new_len )
339 {
340 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
341 {
342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
343 }
344 else
345 {
Paul Elliottb7449902021-03-10 18:14:58 +0000346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
347 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200348 modified = 1;
349 }
350 }
351 }
352
353 if( ssl->out_buf != NULL )
354 {
355 written_out = ssl->out_msg - ssl->out_buf;
356 iv_offset_out = ssl->out_iv - ssl->out_buf;
357 len_offset_out = ssl->out_len - ssl->out_buf;
358 if( downsizing ?
359 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
360 ssl->out_buf_len < out_buf_new_len )
361 {
362 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
363 {
364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
365 }
366 else
367 {
Paul Elliottb7449902021-03-10 18:14:58 +0000368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
369 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 modified = 1;
371 }
372 }
373 }
374 if( modified )
375 {
376 /* Update pointers here to avoid doing it twice. */
377 mbedtls_ssl_reset_in_out_pointers( ssl );
378 /* Fields below might not be properly updated with record
379 * splitting or with CID, so they are manually updated here. */
380 ssl->out_msg = ssl->out_buf + written_out;
381 ssl->out_len = ssl->out_buf + len_offset_out;
382 ssl->out_iv = ssl->out_buf + iv_offset_out;
383
384 ssl->in_msg = ssl->in_buf + written_in;
385 ssl->in_len = ssl->in_buf + len_offset_in;
386 ssl->in_iv = ssl->in_buf + iv_offset_in;
387 }
388}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500389#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
390
Jerry Yudb8c48a2022-01-27 14:54:54 +0800391#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
394typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
395 const char *label,
396 const unsigned char *random, size_t rlen,
397 unsigned char *dstbuf, size_t dlen );
398
399static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
400
401#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
402
403/* Type for the TLS PRF */
404typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
405 const unsigned char *, size_t,
406 unsigned char *, size_t);
407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200408MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800409static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
410 int ciphersuite,
411 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800415 ssl_tls_prf_t tls_prf,
416 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400417 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800418 unsigned endpoint,
419 const mbedtls_ssl_context *ssl );
420
421#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800423static int tls_prf_sha256( const unsigned char *secret, size_t slen,
424 const char *label,
425 const unsigned char *random, size_t rlen,
426 unsigned char *dstbuf, size_t dlen );
427static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
428static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
429
430#endif /* MBEDTLS_SHA256_C */
431
432#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200433MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800434static int tls_prf_sha384( const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen );
438
439static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
440static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
441#endif /* MBEDTLS_SHA384_C */
442
443static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
444 unsigned char *buf,
445 size_t buf_len );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200446MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800447static int ssl_session_load_tls12( mbedtls_ssl_session *session,
448 const unsigned char *buf,
449 size_t len );
450#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
451
Jerry Yu53d23e22022-02-09 16:25:09 +0800452static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
453
Jerry Yudb8c48a2022-01-27 14:54:54 +0800454#if defined(MBEDTLS_SHA256_C)
455static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800456#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800457
458#if defined(MBEDTLS_SHA384_C)
459static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800460#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000461
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
463 const unsigned char *secret, size_t slen,
464 const char *label,
465 const unsigned char *random, size_t rlen,
466 unsigned char *dstbuf, size_t dlen )
467{
468 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
469
470 switch( prf )
471 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300472#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200473#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 case MBEDTLS_SSL_TLS_PRF_SHA384:
475 tls_prf = tls_prf_sha384;
476 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200477#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300478#if defined(MBEDTLS_SHA256_C)
479 case MBEDTLS_SSL_TLS_PRF_SHA256:
480 tls_prf = tls_prf_sha256;
481 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300482#endif /* MBEDTLS_SHA256_C */
483#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300484 default:
485 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
486 }
487
488 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
489}
490
Jerry Yuc73c6182022-02-08 20:29:25 +0800491#if defined(MBEDTLS_X509_CRT_PARSE_C)
492static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
493{
494#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
495 if( session->peer_cert != NULL )
496 {
497 mbedtls_x509_crt_free( session->peer_cert );
498 mbedtls_free( session->peer_cert );
499 session->peer_cert = NULL;
500 }
501#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
502 if( session->peer_cert_digest != NULL )
503 {
504 /* Zeroization is not necessary. */
505 mbedtls_free( session->peer_cert_digest );
506 session->peer_cert_digest = NULL;
507 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
508 session->peer_cert_digest_len = 0;
509 }
510#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
511}
512#endif /* MBEDTLS_X509_CRT_PARSE_C */
513
514void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
515 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
516{
517 ((void) ciphersuite_info);
518
519#if defined(MBEDTLS_SHA384_C)
520 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
521 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
522 else
523#endif
524#if defined(MBEDTLS_SHA256_C)
525 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
526 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
527 else
528#endif
529 {
530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
531 return;
532 }
533}
534
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100535static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
536 unsigned hs_type,
537 size_t total_hs_len )
538{
539 unsigned char hs_hdr[4];
540
541 /* Build HS header for checksum update. */
542 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
543 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
544 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
545 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
546
547 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
548}
549
550void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
551 unsigned hs_type,
552 unsigned char const *msg,
553 size_t msg_len )
554{
555 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
556 ssl->handshake->update_checksum( ssl, msg, msg_len );
557}
558
Jerry Yuc73c6182022-02-08 20:29:25 +0800559void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
560{
561 ((void) ssl);
562#if defined(MBEDTLS_SHA256_C)
563#if defined(MBEDTLS_USE_PSA_CRYPTO)
564 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
565 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
566#else
567 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
568#endif
569#endif
570#if defined(MBEDTLS_SHA384_C)
571#if defined(MBEDTLS_USE_PSA_CRYPTO)
572 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
573 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
574#else
575 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
576#endif
577#endif
578}
579
580static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
581 const unsigned char *buf, size_t len )
582{
583#if defined(MBEDTLS_SHA256_C)
584#if defined(MBEDTLS_USE_PSA_CRYPTO)
585 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
586#else
587 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
588#endif
589#endif
590#if defined(MBEDTLS_SHA384_C)
591#if defined(MBEDTLS_USE_PSA_CRYPTO)
592 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
593#else
594 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
595#endif
596#endif
597}
598
599#if defined(MBEDTLS_SHA256_C)
600static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
601 const unsigned char *buf, size_t len )
602{
603#if defined(MBEDTLS_USE_PSA_CRYPTO)
604 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
605#else
606 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
607#endif
608}
609#endif
610
611#if defined(MBEDTLS_SHA384_C)
612static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
613 const unsigned char *buf, size_t len )
614{
615#if defined(MBEDTLS_USE_PSA_CRYPTO)
616 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
617#else
618 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
619#endif
620}
621#endif
622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200624{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200625 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500628#if defined(MBEDTLS_USE_PSA_CRYPTO)
629 handshake->fin_sha256_psa = psa_hash_operation_init();
630 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
631#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200633 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200634#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500635#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200636#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500637#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500638 handshake->fin_sha384_psa = psa_hash_operation_init();
639 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500640#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200642 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200643#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500644#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200645
646 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#if defined(MBEDTLS_DHM_C)
649 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200650#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200651#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200653#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200654#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200655 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200656#if defined(MBEDTLS_SSL_CLI_C)
657 handshake->ecjpake_cache = NULL;
658 handshake->ecjpake_cache_len = 0;
659#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200660#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200661
Gilles Peskineeccd8882020-03-10 12:19:08 +0100662#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200663 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200664#endif
665
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200666#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
667 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
668#endif
Hanno Becker75173122019-02-06 16:18:31 +0000669
670#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
671 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
672 mbedtls_pk_init( &handshake->peer_pubkey );
673#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200674}
675
Hanno Beckera18d1322018-01-03 14:27:32 +0000676void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200677{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200679
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100680#if defined(MBEDTLS_USE_PSA_CRYPTO)
681 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
682 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100683#else
684 mbedtls_cipher_init( &transform->cipher_ctx_enc );
685 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100686#endif
687
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000688#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100689#if defined(MBEDTLS_USE_PSA_CRYPTO)
690 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
691 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100692#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 mbedtls_md_init( &transform->md_ctx_enc );
694 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000695#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100696#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200697}
698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200700{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200702}
703
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200704MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200705static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000706{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200707 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000708 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200710 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200712 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200713 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200714
715 /*
716 * Either the pointers are now NULL or cleared properly and can be freed.
717 * Now allocate missing structures.
718 */
719 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200720 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200721 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200722 }
Paul Bakker48916f92012-09-16 19:57:18 +0000723
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200724 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200725 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200726 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200727 }
Paul Bakker48916f92012-09-16 19:57:18 +0000728
Paul Bakker82788fb2014-10-20 13:59:19 +0200729 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200730 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200731 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200732 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500733#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
734 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400735
Andrzej Kurek4a063792020-10-21 15:08:44 +0200736 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
737 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500738#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000739
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200740 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000741 if( ssl->handshake == NULL ||
742 ssl->transform_negotiate == NULL ||
743 ssl->session_negotiate == NULL )
744 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 mbedtls_free( ssl->handshake );
748 mbedtls_free( ssl->transform_negotiate );
749 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200750
751 ssl->handshake = NULL;
752 ssl->transform_negotiate = NULL;
753 ssl->session_negotiate = NULL;
754
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200755 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000756 }
757
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200758 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000760 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200761 ssl_handshake_params_init( ssl->handshake );
762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200763#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200764 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
765 {
766 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200767
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200768 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
769 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
770 else
771 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200772
Hanno Becker0f57a652020-02-05 10:37:26 +0000773 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200774 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200775#endif
776
Brett Warrene0edc842021-08-17 09:53:13 +0100777/*
778 * curve_list is translated to IANA TLS group identifiers here because
779 * mbedtls_ssl_conf_curves returns void and so can't return
780 * any error codes.
781 */
782#if defined(MBEDTLS_ECP_C)
783#if !defined(MBEDTLS_DEPRECATED_REMOVED)
784 /* Heap allocate and translate curve_list from internal to IANA group ids */
785 if ( ssl->conf->curve_list != NULL )
786 {
787 size_t length;
788 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
789
790 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
791 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
792
793 /* Leave room for zero termination */
794 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
795 if ( group_list == NULL )
796 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
797
798 for( size_t i = 0; i < length; i++ )
799 {
800 const mbedtls_ecp_curve_info *info =
801 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
802 if ( info == NULL )
803 {
804 mbedtls_free( group_list );
805 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
806 }
807 group_list[i] = info->tls_id;
808 }
809
810 group_list[length] = 0;
811
812 ssl->handshake->group_list = group_list;
813 ssl->handshake->group_list_heap_allocated = 1;
814 }
815 else
816 {
817 ssl->handshake->group_list = ssl->conf->group_list;
818 ssl->handshake->group_list_heap_allocated = 0;
819 }
820#endif /* MBEDTLS_DEPRECATED_REMOVED */
821#endif /* MBEDTLS_ECP_C */
822
Jerry Yuf017ee42022-01-12 15:49:48 +0800823#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
824#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800825#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800826 /* Heap allocate and translate sig_hashes from internal hash identifiers to
827 signature algorithms IANA identifiers. */
828 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800829 ssl->conf->sig_hashes != NULL )
830 {
831 const int *md;
832 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800833 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800834 uint16_t *p;
835
Jerry Yub476a442022-01-21 18:14:45 +0800836#if defined(static_assert)
837 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
838 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
839 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800840#endif
841
Jerry Yuf017ee42022-01-12 15:49:48 +0800842 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
843 {
844 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
845 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800846#if defined(MBEDTLS_ECDSA_C)
847 sig_algs_len += sizeof( uint16_t );
848#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800849
Jerry Yub476a442022-01-21 18:14:45 +0800850#if defined(MBEDTLS_RSA_C)
851 sig_algs_len += sizeof( uint16_t );
852#endif
853 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
854 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800855 }
856
Jerry Yub476a442022-01-21 18:14:45 +0800857 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800858 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
859
Jerry Yub476a442022-01-21 18:14:45 +0800860 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
861 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800862 if( ssl->handshake->sig_algs == NULL )
863 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
864
865 p = (uint16_t *)ssl->handshake->sig_algs;
866 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
867 {
868 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
869 if( hash == MBEDTLS_SSL_HASH_NONE )
870 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800871#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800872 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
873 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800874#endif
875#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800876 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
877 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800878#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800879 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200880 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800881 ssl->handshake->sig_algs_heap_allocated = 1;
882 }
883 else
Jerry Yua69269a2022-01-17 21:06:01 +0800884#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800885 {
886 ssl->handshake->sig_algs = ssl->conf->sig_algs;
887 ssl->handshake->sig_algs_heap_allocated = 0;
888 }
889#endif /* MBEDTLS_DEPRECATED_REMOVED */
890#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
1512void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1513 int authmode )
1514{
1515 ssl->handshake->sni_authmode = authmode;
1516}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001517#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1518
Hanno Becker8927c832019-04-03 12:52:50 +01001519#if defined(MBEDTLS_X509_CRT_PARSE_C)
1520void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1521 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1522 void *p_vrfy )
1523{
1524 ssl->f_vrfy = f_vrfy;
1525 ssl->p_vrfy = p_vrfy;
1526}
1527#endif
1528
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001529#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001530/*
1531 * Set EC J-PAKE password for current handshake
1532 */
1533int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1534 const unsigned char *pw,
1535 size_t pw_len )
1536{
1537 mbedtls_ecjpake_role role;
1538
Janos Follath8eb64132016-06-03 15:40:57 +01001539 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001540 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1541
1542 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1543 role = MBEDTLS_ECJPAKE_SERVER;
1544 else
1545 role = MBEDTLS_ECJPAKE_CLIENT;
1546
1547 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1548 role,
1549 MBEDTLS_MD_SHA256,
1550 MBEDTLS_ECP_DP_SECP256R1,
1551 pw, pw_len ) );
1552}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001553#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001554
Gilles Peskineeccd8882020-03-10 12:19:08 +01001555#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001556
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001557MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001558static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1559{
1560#if defined(MBEDTLS_USE_PSA_CRYPTO)
1561 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1562 return( 1 );
1563#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001564 if( conf->psk != NULL )
1565 return( 1 );
1566
1567 return( 0 );
1568}
1569
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001570static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1571{
1572 /* Remove reference to existing PSK, if any. */
1573#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001574 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001575 {
1576 /* The maintenance of the PSK key slot is the
1577 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001578 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001579 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001580#endif /* MBEDTLS_USE_PSA_CRYPTO */
1581 if( conf->psk != NULL )
1582 {
1583 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1584
1585 mbedtls_free( conf->psk );
1586 conf->psk = NULL;
1587 conf->psk_len = 0;
1588 }
1589
1590 /* Remove reference to PSK identity, if any. */
1591 if( conf->psk_identity != NULL )
1592 {
1593 mbedtls_free( conf->psk_identity );
1594 conf->psk_identity = NULL;
1595 conf->psk_identity_len = 0;
1596 }
1597}
1598
Hanno Becker7390c712018-11-15 13:33:04 +00001599/* This function assumes that PSK identity in the SSL config is unset.
1600 * It checks that the provided identity is well-formed and attempts
1601 * to make a copy of it in the SSL config.
1602 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001603MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001604static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1605 unsigned char const *psk_identity,
1606 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001607{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001608 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001609 if( psk_identity == NULL ||
1610 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001611 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001612 {
1613 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1614 }
1615
Hanno Becker7390c712018-11-15 13:33:04 +00001616 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1617 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001618 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001619
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001620 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001621 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001622
1623 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001624}
1625
Hanno Becker7390c712018-11-15 13:33:04 +00001626int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1627 const unsigned char *psk, size_t psk_len,
1628 const unsigned char *psk_identity, size_t psk_identity_len )
1629{
Janos Follath865b3eb2019-12-16 11:46:15 +00001630 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001631
1632 /* We currently only support one PSK, raw or opaque. */
1633 if( ssl_conf_psk_is_configured( conf ) )
1634 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001635
1636 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001637 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001638 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001639 if( psk_len == 0 )
1640 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1641 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1642 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1643
Hanno Becker7390c712018-11-15 13:33:04 +00001644 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1645 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1646 conf->psk_len = psk_len;
1647 memcpy( conf->psk, psk, conf->psk_len );
1648
1649 /* Check and set PSK Identity */
1650 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1651 if( ret != 0 )
1652 ssl_conf_remove_psk( conf );
1653
1654 return( ret );
1655}
1656
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001657static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1658{
1659#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001660 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001661 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001662 /* The maintenance of the external PSK key slot is the
1663 * user's responsibility. */
1664 if( ssl->handshake->psk_opaque_is_internal )
1665 {
1666 psa_destroy_key( ssl->handshake->psk_opaque );
1667 ssl->handshake->psk_opaque_is_internal = 0;
1668 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001669 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001670 }
Neil Armstronge952a302022-05-03 10:22:14 +02001671#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001672 if( ssl->handshake->psk != NULL )
1673 {
1674 mbedtls_platform_zeroize( ssl->handshake->psk,
1675 ssl->handshake->psk_len );
1676 mbedtls_free( ssl->handshake->psk );
1677 ssl->handshake->psk_len = 0;
1678 }
Neil Armstronge952a302022-05-03 10:22:14 +02001679#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680}
1681
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001682int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1683 const unsigned char *psk, size_t psk_len )
1684{
Neil Armstrong501c9322022-05-03 09:35:09 +02001685#if defined(MBEDTLS_USE_PSA_CRYPTO)
1686 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1687 psa_status_t status;
1688 psa_algorithm_t alg;
1689 mbedtls_svc_key_id_t key;
1690#endif /* MBEDTLS_USE_PSA_CRYPTO */
1691
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001692 if( psk == NULL || ssl->handshake == NULL )
1693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1694
1695 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1697
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001698 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001699
Neil Armstrong501c9322022-05-03 09:35:09 +02001700#if defined(MBEDTLS_USE_PSA_CRYPTO)
1701 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1702 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1703 else
1704 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1705
1706 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1707 psa_set_key_algorithm( &key_attributes, alg );
1708 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1709
1710 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1711 if( status != PSA_SUCCESS )
1712 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1713
1714 /* Allow calling psa_destroy_key() on psk remove */
1715 ssl->handshake->psk_opaque_is_internal = 1;
1716 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1717#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001718 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001719 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001720
1721 ssl->handshake->psk_len = psk_len;
1722 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1723
1724 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001725#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001726}
1727
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001728#if defined(MBEDTLS_USE_PSA_CRYPTO)
1729int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001730 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001731 const unsigned char *psk_identity,
1732 size_t psk_identity_len )
1733{
Janos Follath865b3eb2019-12-16 11:46:15 +00001734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001735
1736 /* We currently only support one PSK, raw or opaque. */
1737 if( ssl_conf_psk_is_configured( conf ) )
1738 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001739
Hanno Becker7390c712018-11-15 13:33:04 +00001740 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001741 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001742 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001743 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001744
1745 /* Check and set PSK Identity */
1746 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1747 psk_identity_len );
1748 if( ret != 0 )
1749 ssl_conf_remove_psk( conf );
1750
1751 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001752}
1753
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001754int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1755 mbedtls_svc_key_id_t psk )
1756{
1757 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1758 ( ssl->handshake == NULL ) )
1759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1760
1761 ssl_remove_psk( ssl );
1762 ssl->handshake->psk_opaque = psk;
1763 return( 0 );
1764}
1765#endif /* MBEDTLS_USE_PSA_CRYPTO */
1766
1767void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1768 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1769 size_t),
1770 void *p_psk )
1771{
1772 conf->f_psk = f_psk;
1773 conf->p_psk = p_psk;
1774}
1775#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1776
1777#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001778static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1779 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001780{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001781#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001782 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001783 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001784#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001785 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001786 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001787 return( MBEDTLS_SSL_MODE_STREAM );
1788}
1789
1790#else /* MBEDTLS_USE_PSA_CRYPTO */
1791
1792static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1793 mbedtls_cipher_mode_t mode )
1794{
1795#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1796 if( mode == MBEDTLS_MODE_CBC )
1797 return( MBEDTLS_SSL_MODE_CBC );
1798#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1799
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001800#if defined(MBEDTLS_GCM_C) || \
1801 defined(MBEDTLS_CCM_C) || \
1802 defined(MBEDTLS_CHACHAPOLY_C)
1803 if( mode == MBEDTLS_MODE_GCM ||
1804 mode == MBEDTLS_MODE_CCM ||
1805 mode == MBEDTLS_MODE_CHACHAPOLY )
1806 return( MBEDTLS_SSL_MODE_AEAD );
1807#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001808
1809 return( MBEDTLS_SSL_MODE_STREAM );
1810}
Gilles Peskine301711e2022-04-26 16:57:05 +02001811#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001812
Gilles Peskinee108d982022-04-26 16:50:40 +02001813static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1814 mbedtls_ssl_mode_t base_mode,
1815 int encrypt_then_mac )
1816{
1817#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1818 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1819 base_mode == MBEDTLS_SSL_MODE_CBC )
1820 {
1821 return( MBEDTLS_SSL_MODE_CBC_ETM );
1822 }
1823#else
1824 (void) encrypt_then_mac;
1825#endif
1826 return( base_mode );
1827}
1828
Neil Armstrongab555e02022-04-04 11:07:59 +02001829mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001830 const mbedtls_ssl_transform *transform )
1831{
Gilles Peskinee108d982022-04-26 16:50:40 +02001832 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001833#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001834 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001835#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001836 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1837#endif
1838 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001839
Gilles Peskinee108d982022-04-26 16:50:40 +02001840 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001841#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001842 encrypt_then_mac = transform->encrypt_then_mac;
1843#endif
1844 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001845}
1846
Neil Armstrongab555e02022-04-04 11:07:59 +02001847mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001848#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001849 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001850#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001851 const mbedtls_ssl_ciphersuite_t *suite )
1852{
Gilles Peskinee108d982022-04-26 16:50:40 +02001853 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1854
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001855#if defined(MBEDTLS_USE_PSA_CRYPTO)
1856 psa_status_t status;
1857 psa_algorithm_t alg;
1858 psa_key_type_t type;
1859 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001860 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1861 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001862 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001863#else
1864 const mbedtls_cipher_info_t *cipher =
1865 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001866 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001867 {
1868 base_mode =
1869 mbedtls_ssl_get_base_mode(
1870 mbedtls_cipher_info_get_mode( cipher ) );
1871 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001872#endif /* MBEDTLS_USE_PSA_CRYPTO */
1873
Gilles Peskinee108d982022-04-26 16:50:40 +02001874#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1875 int encrypt_then_mac = 0;
1876#endif
1877 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001878}
1879
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001880#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001881psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001882 size_t taglen,
1883 psa_algorithm_t *alg,
1884 psa_key_type_t *key_type,
1885 size_t *key_size )
1886{
1887 switch ( mbedtls_cipher_type )
1888 {
1889 case MBEDTLS_CIPHER_AES_128_CBC:
1890 *alg = PSA_ALG_CBC_NO_PADDING;
1891 *key_type = PSA_KEY_TYPE_AES;
1892 *key_size = 128;
1893 break;
1894 case MBEDTLS_CIPHER_AES_128_CCM:
1895 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1896 *key_type = PSA_KEY_TYPE_AES;
1897 *key_size = 128;
1898 break;
1899 case MBEDTLS_CIPHER_AES_128_GCM:
1900 *alg = PSA_ALG_GCM;
1901 *key_type = PSA_KEY_TYPE_AES;
1902 *key_size = 128;
1903 break;
1904 case MBEDTLS_CIPHER_AES_192_CCM:
1905 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1906 *key_type = PSA_KEY_TYPE_AES;
1907 *key_size = 192;
1908 break;
1909 case MBEDTLS_CIPHER_AES_192_GCM:
1910 *alg = PSA_ALG_GCM;
1911 *key_type = PSA_KEY_TYPE_AES;
1912 *key_size = 192;
1913 break;
1914 case MBEDTLS_CIPHER_AES_256_CBC:
1915 *alg = PSA_ALG_CBC_NO_PADDING;
1916 *key_type = PSA_KEY_TYPE_AES;
1917 *key_size = 256;
1918 break;
1919 case MBEDTLS_CIPHER_AES_256_CCM:
1920 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1921 *key_type = PSA_KEY_TYPE_AES;
1922 *key_size = 256;
1923 break;
1924 case MBEDTLS_CIPHER_AES_256_GCM:
1925 *alg = PSA_ALG_GCM;
1926 *key_type = PSA_KEY_TYPE_AES;
1927 *key_size = 256;
1928 break;
1929 case MBEDTLS_CIPHER_ARIA_128_CBC:
1930 *alg = PSA_ALG_CBC_NO_PADDING;
1931 *key_type = PSA_KEY_TYPE_ARIA;
1932 *key_size = 128;
1933 break;
1934 case MBEDTLS_CIPHER_ARIA_128_CCM:
1935 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1936 *key_type = PSA_KEY_TYPE_ARIA;
1937 *key_size = 128;
1938 break;
1939 case MBEDTLS_CIPHER_ARIA_128_GCM:
1940 *alg = PSA_ALG_GCM;
1941 *key_type = PSA_KEY_TYPE_ARIA;
1942 *key_size = 128;
1943 break;
1944 case MBEDTLS_CIPHER_ARIA_192_CCM:
1945 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1946 *key_type = PSA_KEY_TYPE_ARIA;
1947 *key_size = 192;
1948 break;
1949 case MBEDTLS_CIPHER_ARIA_192_GCM:
1950 *alg = PSA_ALG_GCM;
1951 *key_type = PSA_KEY_TYPE_ARIA;
1952 *key_size = 192;
1953 break;
1954 case MBEDTLS_CIPHER_ARIA_256_CBC:
1955 *alg = PSA_ALG_CBC_NO_PADDING;
1956 *key_type = PSA_KEY_TYPE_ARIA;
1957 *key_size = 256;
1958 break;
1959 case MBEDTLS_CIPHER_ARIA_256_CCM:
1960 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1961 *key_type = PSA_KEY_TYPE_ARIA;
1962 *key_size = 256;
1963 break;
1964 case MBEDTLS_CIPHER_ARIA_256_GCM:
1965 *alg = PSA_ALG_GCM;
1966 *key_type = PSA_KEY_TYPE_ARIA;
1967 *key_size = 256;
1968 break;
1969 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1970 *alg = PSA_ALG_CBC_NO_PADDING;
1971 *key_type = PSA_KEY_TYPE_CAMELLIA;
1972 *key_size = 128;
1973 break;
1974 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1975 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1976 *key_type = PSA_KEY_TYPE_CAMELLIA;
1977 *key_size = 128;
1978 break;
1979 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1980 *alg = PSA_ALG_GCM;
1981 *key_type = PSA_KEY_TYPE_CAMELLIA;
1982 *key_size = 128;
1983 break;
1984 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1985 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1986 *key_type = PSA_KEY_TYPE_CAMELLIA;
1987 *key_size = 192;
1988 break;
1989 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1990 *alg = PSA_ALG_GCM;
1991 *key_type = PSA_KEY_TYPE_CAMELLIA;
1992 *key_size = 192;
1993 break;
1994 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1995 *alg = PSA_ALG_CBC_NO_PADDING;
1996 *key_type = PSA_KEY_TYPE_CAMELLIA;
1997 *key_size = 256;
1998 break;
1999 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2000 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2001 *key_type = PSA_KEY_TYPE_CAMELLIA;
2002 *key_size = 256;
2003 break;
2004 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2005 *alg = PSA_ALG_GCM;
2006 *key_type = PSA_KEY_TYPE_CAMELLIA;
2007 *key_size = 256;
2008 break;
2009 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2010 *alg = PSA_ALG_CHACHA20_POLY1305;
2011 *key_type = PSA_KEY_TYPE_CHACHA20;
2012 *key_size = 256;
2013 break;
2014 case MBEDTLS_CIPHER_NULL:
2015 *alg = MBEDTLS_SSL_NULL_CIPHER;
2016 *key_type = 0;
2017 *key_size = 0;
2018 break;
2019 default:
2020 return PSA_ERROR_NOT_SUPPORTED;
2021 }
2022
2023 return PSA_SUCCESS;
2024}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002025#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002026
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002027#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002028int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2029 const unsigned char *dhm_P, size_t P_len,
2030 const unsigned char *dhm_G, size_t G_len )
2031{
Janos Follath865b3eb2019-12-16 11:46:15 +00002032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002033
Glenn Strausscee11292021-12-20 01:43:17 -05002034 mbedtls_mpi_free( &conf->dhm_P );
2035 mbedtls_mpi_free( &conf->dhm_G );
2036
Hanno Beckera90658f2017-10-04 15:29:08 +01002037 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2038 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2039 {
2040 mbedtls_mpi_free( &conf->dhm_P );
2041 mbedtls_mpi_free( &conf->dhm_G );
2042 return( ret );
2043 }
2044
2045 return( 0 );
2046}
Paul Bakker5121ce52009-01-03 21:22:43 +00002047
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002048int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002049{
Janos Follath865b3eb2019-12-16 11:46:15 +00002050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002051
Glenn Strausscee11292021-12-20 01:43:17 -05002052 mbedtls_mpi_free( &conf->dhm_P );
2053 mbedtls_mpi_free( &conf->dhm_G );
2054
Gilles Peskinee5702482021-06-11 21:59:08 +02002055 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2056 &conf->dhm_P ) ) != 0 ||
2057 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2058 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002059 {
2060 mbedtls_mpi_free( &conf->dhm_P );
2061 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002062 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002063 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002064
2065 return( 0 );
2066}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002067#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002068
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002069#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2070/*
2071 * Set the minimum length for Diffie-Hellman parameters
2072 */
2073void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2074 unsigned int bitlen )
2075{
2076 conf->dhm_min_bitlen = bitlen;
2077}
2078#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2079
Gilles Peskineeccd8882020-03-10 12:19:08 +01002080#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002081#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002082/*
2083 * Set allowed/preferred hashes for handshake signatures
2084 */
2085void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2086 const int *hashes )
2087{
2088 conf->sig_hashes = hashes;
2089}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002090#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002091
Jerry Yuf017ee42022-01-12 15:49:48 +08002092/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002093void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2094 const uint16_t* sig_algs )
2095{
Jerry Yuf017ee42022-01-12 15:49:48 +08002096#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2097 conf->sig_hashes = NULL;
2098#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2099 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002100}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002101#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002102
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002103#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002104#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002105/*
2106 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002107 *
2108 * mbedtls_ssl_setup() takes the provided list
2109 * and translates it to a list of IANA TLS group identifiers,
2110 * stored in ssl->handshake->group_list.
2111 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002112 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002113void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002114 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002115{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002116 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002117 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002118}
Brett Warrene0edc842021-08-17 09:53:13 +01002119#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002120#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002121
Brett Warrene0edc842021-08-17 09:53:13 +01002122/*
2123 * Set the allowed groups
2124 */
2125void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2126 const uint16_t *group_list )
2127{
2128#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2129 conf->curve_list = NULL;
2130#endif
2131 conf->group_list = group_list;
2132}
2133
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002134#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002136{
Hanno Becker947194e2017-04-07 13:25:49 +01002137 /* Initialize to suppress unnecessary compiler warning */
2138 size_t hostname_len = 0;
2139
2140 /* Check if new hostname is valid before
2141 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002142 if( hostname != NULL )
2143 {
2144 hostname_len = strlen( hostname );
2145
2146 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2147 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2148 }
2149
2150 /* Now it's clear that we will overwrite the old hostname,
2151 * so we can free it safely */
2152
2153 if( ssl->hostname != NULL )
2154 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002155 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002156 mbedtls_free( ssl->hostname );
2157 }
2158
2159 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002160
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002162 {
2163 ssl->hostname = NULL;
2164 }
2165 else
2166 {
2167 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002168 if( ssl->hostname == NULL )
2169 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002170
Hanno Becker947194e2017-04-07 13:25:49 +01002171 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002172
Hanno Becker947194e2017-04-07 13:25:49 +01002173 ssl->hostname[hostname_len] = '\0';
2174 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002175
2176 return( 0 );
2177}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002178#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002179
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002180#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002181void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002183 const unsigned char *, size_t),
2184 void *p_sni )
2185{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002186 conf->f_sni = f_sni;
2187 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002188}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002192int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002193{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002194 size_t cur_len, tot_len;
2195 const char **p;
2196
2197 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002198 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2199 * MUST NOT be truncated."
2200 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002201 */
2202 tot_len = 0;
2203 for( p = protos; *p != NULL; p++ )
2204 {
2205 cur_len = strlen( *p );
2206 tot_len += cur_len;
2207
Ronald Cron8216dd32020-04-23 16:41:44 +02002208 if( ( cur_len == 0 ) ||
2209 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2210 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002212 }
2213
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002214 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002215
2216 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002217}
2218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002220{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002221 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002222}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002224
Johan Pascalb62bb512015-12-03 21:56:45 +01002225#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002226void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2227 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002228{
2229 conf->dtls_srtp_mki_support = support_mki_value;
2230}
2231
Ron Eldoref72faf2018-07-12 11:54:20 +03002232int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2233 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002234 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002235{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002236 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002237 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002238 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002239 }
Ron Eldor591f1622018-01-22 12:30:04 +02002240
2241 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002242 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002243 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002244 }
Ron Eldor591f1622018-01-22 12:30:04 +02002245
2246 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2247 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002248 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002249}
2250
Ron Eldoref72faf2018-07-12 11:54:20 +03002251int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002252 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002253{
Johan Pascal253d0262020-09-22 13:04:45 +02002254 const mbedtls_ssl_srtp_profile *p;
2255 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002256
Johan Pascal253d0262020-09-22 13:04:45 +02002257 /* check the profiles list: all entry must be valid,
2258 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002259 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2260 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2261 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002262 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002263 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002264 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002265 list_size++;
2266 }
2267 else
2268 {
2269 /* unsupported value, stop parsing and set the size to an error value */
2270 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002271 }
2272 }
2273
Johan Pascal5ef72d22020-10-28 17:05:47 +01002274 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002275 {
Johan Pascal253d0262020-09-22 13:04:45 +02002276 conf->dtls_srtp_profile_list = NULL;
2277 conf->dtls_srtp_profile_list_len = 0;
2278 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2279 }
2280
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002281 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002282 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002283
2284 return( 0 );
2285}
2286
Johan Pascal5ef72d22020-10-28 17:05:47 +01002287void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2288 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002289{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002290 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2291 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002292 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002293 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002294 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002295 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002296 else
2297 {
2298 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002299 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2300 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002301 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002302}
Johan Pascalb62bb512015-12-03 21:56:45 +01002303#endif /* MBEDTLS_SSL_DTLS_SRTP */
2304
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002305void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002306{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002307 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002308}
2309
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002310void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002311{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002312 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002313}
2314
Janos Follath088ce432017-04-10 12:42:31 +01002315#if defined(MBEDTLS_SSL_SRV_C)
2316void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2317 char cert_req_ca_list )
2318{
2319 conf->cert_req_ca_list = cert_req_ca_list;
2320}
2321#endif
2322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002324void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002325{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002326 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002327}
2328#endif
2329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002331void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002332{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002333 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002334}
2335#endif
2336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002338int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002339{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002341 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002342 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002344 }
2345
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002346 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002347
2348 return( 0 );
2349}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002351
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002352void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002353{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002354 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002355}
2356
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002358void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002359{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002360 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002361}
2362
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002363void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002364{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002365 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002366}
2367
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002368void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002369 const unsigned char period[8] )
2370{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002371 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002372}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002376#if defined(MBEDTLS_SSL_CLI_C)
2377void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002378{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002379 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002380}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002381#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002382
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002383#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002384void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2385 mbedtls_ssl_ticket_write_t *f_ticket_write,
2386 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2387 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002388{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002389 conf->f_ticket_write = f_ticket_write;
2390 conf->f_ticket_parse = f_ticket_parse;
2391 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002392}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002393#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002394#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002395
Hanno Becker7e6c1782021-06-08 09:24:55 +01002396void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2397 mbedtls_ssl_export_keys_t *f_export_keys,
2398 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002399{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002400 ssl->f_export_keys = f_export_keys;
2401 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002402}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002403
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002404#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002405void mbedtls_ssl_conf_async_private_cb(
2406 mbedtls_ssl_config *conf,
2407 mbedtls_ssl_async_sign_t *f_async_sign,
2408 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2409 mbedtls_ssl_async_resume_t *f_async_resume,
2410 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002411 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002412{
2413 conf->f_async_sign_start = f_async_sign;
2414 conf->f_async_decrypt_start = f_async_decrypt;
2415 conf->f_async_resume = f_async_resume;
2416 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002417 conf->p_async_config_data = async_config_data;
2418}
2419
Gilles Peskine8f97af72018-04-26 11:46:10 +02002420void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2421{
2422 return( conf->p_async_config_data );
2423}
2424
Gilles Peskine1febfef2018-04-30 11:54:39 +02002425void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002426{
2427 if( ssl->handshake == NULL )
2428 return( NULL );
2429 else
2430 return( ssl->handshake->user_async_ctx );
2431}
2432
Gilles Peskine1febfef2018-04-30 11:54:39 +02002433void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002434 void *ctx )
2435{
2436 if( ssl->handshake != NULL )
2437 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002438}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002439#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002440
Paul Bakker5121ce52009-01-03 21:22:43 +00002441/*
2442 * SSL get accessors
2443 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002444uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002445{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002446 if( ssl->session != NULL )
2447 return( ssl->session->verify_result );
2448
2449 if( ssl->session_negotiate != NULL )
2450 return( ssl->session_negotiate->verify_result );
2451
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002452 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002453}
2454
Glenn Strauss8f526902022-01-13 00:04:49 -05002455int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2456{
2457 if( ssl == NULL || ssl->session == NULL )
2458 return( 0 );
2459
2460 return( ssl->session->ciphersuite );
2461}
2462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002464{
Paul Bakker926c8e42013-03-06 10:23:34 +01002465 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002466 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002469}
2470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002472{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002474 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002475 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002476 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002477 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002478 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002479 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002480 default:
2481 return( "unknown (DTLS)" );
2482 }
2483 }
2484#endif
2485
Glenn Strauss60bfe602022-03-14 19:04:24 -04002486 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002487 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002488 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002489 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002490 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002491 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002492 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002493 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002494 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002495}
2496
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002497#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002498size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2499{
David Horstmann95d516f2021-05-04 18:36:56 +01002500 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002501 size_t read_mfl;
2502
2503 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2504 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2505 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2506 {
2507 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2508 }
2509
2510 /* Check if a smaller max length was negotiated */
2511 if( ssl->session_out != NULL )
2512 {
2513 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2514 if( read_mfl < max_len )
2515 {
2516 max_len = read_mfl;
2517 }
2518 }
2519
2520 // During a handshake, use the value being negotiated
2521 if( ssl->session_negotiate != NULL )
2522 {
2523 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2524 if( read_mfl < max_len )
2525 {
2526 max_len = read_mfl;
2527 }
2528 }
2529
2530 return( max_len );
2531}
2532
2533size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002534{
2535 size_t max_len;
2536
2537 /*
2538 * Assume mfl_code is correct since it was checked when set
2539 */
Angus Grattond8213d02016-05-25 20:56:48 +10002540 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002541
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002542 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002543 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002544 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002545 {
Angus Grattond8213d02016-05-25 20:56:48 +10002546 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002547 }
2548
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002549 /* During a handshake, use the value being negotiated */
2550 if( ssl->session_negotiate != NULL &&
2551 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2552 {
2553 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2554 }
2555
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002556 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002557}
2558#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2559
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002560#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002561size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002562{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002563 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2564 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2565 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2566 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2567 return ( 0 );
2568
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002569 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2570 return( ssl->mtu );
2571
2572 if( ssl->mtu == 0 )
2573 return( ssl->handshake->mtu );
2574
2575 return( ssl->mtu < ssl->handshake->mtu ?
2576 ssl->mtu : ssl->handshake->mtu );
2577}
2578#endif /* MBEDTLS_SSL_PROTO_DTLS */
2579
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002580int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2581{
2582 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2583
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002584#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2585 !defined(MBEDTLS_SSL_PROTO_DTLS)
2586 (void) ssl;
2587#endif
2588
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002589#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002590 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002591
2592 if( max_len > mfl )
2593 max_len = mfl;
2594#endif
2595
2596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002597 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002598 {
Hanno Becker89490712020-02-05 10:50:12 +00002599 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002600 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2601 const size_t overhead = (size_t) ret;
2602
2603 if( ret < 0 )
2604 return( ret );
2605
2606 if( mtu <= overhead )
2607 {
2608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2609 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2610 }
2611
2612 if( max_len > mtu - overhead )
2613 max_len = mtu - overhead;
2614 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002615#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002616
Hanno Becker0defedb2018-08-10 12:35:02 +01002617#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2618 !defined(MBEDTLS_SSL_PROTO_DTLS)
2619 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002620#endif
2621
2622 return( (int) max_len );
2623}
2624
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002625int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2626{
2627 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2628
2629#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2630 (void) ssl;
2631#endif
2632
2633#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2634 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2635
2636 if( max_len > mfl )
2637 max_len = mfl;
2638#endif
2639
2640 return( (int) max_len );
2641}
2642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643#if defined(MBEDTLS_X509_CRT_PARSE_C)
2644const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002645{
2646 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002647 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002648
Hanno Beckere6824572019-02-07 13:18:46 +00002649#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002650 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002651#else
2652 return( NULL );
2653#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002658int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2659 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002660{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002661 int ret;
2662
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002663 if( ssl == NULL ||
2664 dst == NULL ||
2665 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002666 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002669 }
2670
Hanno Beckere810bbc2021-05-14 16:01:05 +01002671 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2672 * idempotent: Each session can only be exported once.
2673 *
2674 * (This is in preparation for TLS 1.3 support where we will
2675 * need the ability to export multiple sessions (aka tickets),
2676 * which will be achieved by calling mbedtls_ssl_get_session()
2677 * multiple times until it fails.)
2678 *
2679 * Check whether we have already exported the current session,
2680 * and fail if so.
2681 */
2682 if( ssl->session->exported == 1 )
2683 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2684
2685 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2686 if( ret != 0 )
2687 return( ret );
2688
2689 /* Remember that we've exported the session. */
2690 ssl->session->exported = 1;
2691 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002692}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002694
Paul Bakker5121ce52009-01-03 21:22:43 +00002695/*
Hanno Beckera835da52019-05-16 12:39:07 +01002696 * Define ticket header determining Mbed TLS version
2697 * and structure of the ticket.
2698 */
2699
Hanno Becker94ef3b32019-05-16 12:50:45 +01002700/*
Hanno Becker50b59662019-05-28 14:30:45 +01002701 * Define bitflag determining compile-time settings influencing
2702 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002703 */
2704
Hanno Becker50b59662019-05-28 14:30:45 +01002705#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002706#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002707#else
Hanno Becker3e088662019-05-29 11:10:18 +01002708#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002709#endif /* MBEDTLS_HAVE_TIME */
2710
2711#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002712#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002713#else
Hanno Becker3e088662019-05-29 11:10:18 +01002714#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002715#endif /* MBEDTLS_X509_CRT_PARSE_C */
2716
2717#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002718#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002719#else
Hanno Becker3e088662019-05-29 11:10:18 +01002720#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002721#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2722
2723#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002724#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002725#else
Hanno Becker3e088662019-05-29 11:10:18 +01002726#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002727#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2728
Hanno Becker94ef3b32019-05-16 12:50:45 +01002729#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002730#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002731#else
Hanno Becker3e088662019-05-29 11:10:18 +01002732#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002733#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2734
Hanno Becker94ef3b32019-05-16 12:50:45 +01002735#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2736#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2737#else
2738#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2739#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2740
Hanno Becker3e088662019-05-29 11:10:18 +01002741#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2742#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2743#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2744#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002745#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2746#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002747
Hanno Becker50b59662019-05-28 14:30:45 +01002748#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002749 ( (uint16_t) ( \
2750 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2751 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2752 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2753 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002754 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002755 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002756
Hanno Beckerf8787072019-05-16 12:41:07 +01002757static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002758 MBEDTLS_VERSION_MAJOR,
2759 MBEDTLS_VERSION_MINOR,
2760 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002761 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2762 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002763};
Hanno Beckera835da52019-05-16 12:39:07 +01002764
2765/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002766 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002767 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002768 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002769 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002770 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002771 * opaque mbedtls_version[3]; // library version: major, minor, patch
2772 * opaque session_format[2]; // library-version specific 16-bit field
2773 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002774 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002775 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002776 * Note: When updating the format, remember to keep
2777 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002778 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002779 * // In this version, `session_format` determines
2780 * // the setting of those compile-time
2781 * // configuration options which influence
2782 * // the structure of mbedtls_ssl_session.
2783 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002784 * uint8_t minor_ver; // Protocol minor version. Possible values:
2785 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002786 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002787 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002788 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002789 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002790 * serialized_session_tls12 data;
2791 *
2792 * };
2793 *
2794 * } serialized_session;
2795 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002796 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002797
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002798MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002799static int ssl_session_save( const mbedtls_ssl_session *session,
2800 unsigned char omit_header,
2801 unsigned char *buf,
2802 size_t buf_len,
2803 size_t *olen )
2804{
2805 unsigned char *p = buf;
2806 size_t used = 0;
2807
2808 if( !omit_header )
2809 {
2810 /*
2811 * Add Mbed TLS version identifier
2812 */
2813
2814 used += sizeof( ssl_serialized_session_header );
2815
2816 if( used <= buf_len )
2817 {
2818 memcpy( p, ssl_serialized_session_header,
2819 sizeof( ssl_serialized_session_header ) );
2820 p += sizeof( ssl_serialized_session_header );
2821 }
2822 }
2823
2824 /*
2825 * TLS version identifier
2826 */
2827 used += 1;
2828 if( used <= buf_len )
2829 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002830 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002831 }
2832
2833 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002834 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002835 {
2836#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002837 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002838 {
2839 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2840 used += ssl_session_save_tls12( session, p, remaining_len );
2841 break;
2842 }
2843#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2844
2845 default:
2846 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2847 }
2848
2849 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002850 if( used > buf_len )
2851 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002852
2853 return( 0 );
2854}
2855
2856/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002857 * Public wrapper for ssl_session_save()
2858 */
2859int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2860 unsigned char *buf,
2861 size_t buf_len,
2862 size_t *olen )
2863{
2864 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2865}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002866
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002867/*
2868 * Deserialize session, see mbedtls_ssl_session_save() for format.
2869 *
2870 * This internal version is wrapped by a public function that cleans up in
2871 * case of error, and has an extra option omit_header.
2872 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002873MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002874static int ssl_session_load( mbedtls_ssl_session *session,
2875 unsigned char omit_header,
2876 const unsigned char *buf,
2877 size_t len )
2878{
2879 const unsigned char *p = buf;
2880 const unsigned char * const end = buf + len;
2881
2882 if( !omit_header )
2883 {
2884 /*
2885 * Check Mbed TLS version identifier
2886 */
2887
2888 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2889 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2890
2891 if( memcmp( p, ssl_serialized_session_header,
2892 sizeof( ssl_serialized_session_header ) ) != 0 )
2893 {
2894 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2895 }
2896 p += sizeof( ssl_serialized_session_header );
2897 }
2898
2899 /*
2900 * TLS version identifier
2901 */
2902 if( 1 > (size_t)( end - p ) )
2903 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002904 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002905
2906 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002907 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002908 {
2909#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002910 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002911 {
2912 size_t remaining_len = ( end - p );
2913 return( ssl_session_load_tls12( session, p, remaining_len ) );
2914 }
2915#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2916
2917 default:
2918 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2919 }
2920}
2921
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002922/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002923 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002924 */
2925int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2926 const unsigned char *buf,
2927 size_t len )
2928{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002929 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002930
2931 if( ret != 0 )
2932 mbedtls_ssl_session_free( session );
2933
2934 return( ret );
2935}
2936
2937/*
Paul Bakker1961b702013-01-25 14:49:24 +01002938 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002939 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002940MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01002941static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2942{
2943 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2944
Ronald Cron66dbf912022-02-02 15:33:46 +01002945 /*
2946 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002947 * that were written into the output buffer by the previous handshake step,
2948 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002949 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2950 * We proceed to the next handshake step only when all data from the
2951 * previous one have been sent to the peer, thus we make sure that this is
2952 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2953 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2954 * we have to wait before to go ahead.
2955 * In the case of TLS 1.3, handshake step handlers do not send data to the
2956 * peer. Data are only sent here and through
2957 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002958 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002959 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002960 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2961 return( ret );
2962
2963#if defined(MBEDTLS_SSL_PROTO_DTLS)
2964 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2965 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2966 {
2967 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2968 return( ret );
2969 }
2970#endif /* MBEDTLS_SSL_PROTO_DTLS */
2971
2972 return( ret );
2973}
2974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002976{
Hanno Becker41934dd2021-08-07 19:13:43 +01002977 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002978
Hanno Becker41934dd2021-08-07 19:13:43 +01002979 if( ssl == NULL ||
2980 ssl->conf == NULL ||
2981 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002982 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002983 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002984 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002985 }
2986
2987 ret = ssl_prepare_handshake_step( ssl );
2988 if( ret != 0 )
2989 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002990
Jerry Yue7047812021-09-13 19:26:39 +08002991 ret = mbedtls_ssl_handle_pending_alert( ssl );
2992 if( ret != 0 )
2993 goto cleanup;
2994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002996 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002997 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2999 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003000
Ronald Cron9f0fba32022-02-10 16:45:15 +01003001 switch( ssl->state )
3002 {
3003 case MBEDTLS_SSL_HELLO_REQUEST:
3004 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3005 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003006
Ronald Cron9f0fba32022-02-10 16:45:15 +01003007 case MBEDTLS_SSL_CLIENT_HELLO:
3008 ret = mbedtls_ssl_write_client_hello( ssl );
3009 break;
3010
3011 default:
3012#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003013 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003014 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3015 else
3016 ret = mbedtls_ssl_handshake_client_step( ssl );
3017#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3018 ret = mbedtls_ssl_handshake_client_step( ssl );
3019#else
3020 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3021#endif
3022 }
Jerry Yub9930e72021-08-06 17:11:51 +08003023 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003024#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003026 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003027 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003028#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003029 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003030 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003031#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003032
3033#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3034 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3035 ret = mbedtls_ssl_handshake_server_step( ssl );
3036#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3037 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003038#endif
3039
Jerry Yue7047812021-09-13 19:26:39 +08003040 if( ret != 0 )
3041 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003042 /* handshake_step return error. And it is same
3043 * with alert_reason.
3044 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003045 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003046 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003047 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003048 goto cleanup;
3049 }
3050 }
3051
3052cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003053 return( ret );
3054}
3055
3056/*
3057 * Perform the SSL handshake
3058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003060{
3061 int ret = 0;
3062
Hanno Beckera817ea42020-10-20 15:20:23 +01003063 /* Sanity checks */
3064
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003065 if( ssl == NULL || ssl->conf == NULL )
3066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3067
Hanno Beckera817ea42020-10-20 15:20:23 +01003068#if defined(MBEDTLS_SSL_PROTO_DTLS)
3069 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3070 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3071 {
3072 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3073 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3074 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3075 }
3076#endif /* MBEDTLS_SSL_PROTO_DTLS */
3077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003079
Hanno Beckera817ea42020-10-20 15:20:23 +01003080 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003081 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003082 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003084
3085 if( ret != 0 )
3086 break;
3087 }
3088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003090
3091 return( ret );
3092}
3093
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094#if defined(MBEDTLS_SSL_RENEGOTIATION)
3095#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003096/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003097 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003098 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003099MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003101{
Janos Follath865b3eb2019-12-16 11:46:15 +00003102 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003105
3106 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3108 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003109
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003110 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003111 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003112 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003113 return( ret );
3114 }
3115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003117
3118 return( 0 );
3119}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003121
3122/*
3123 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 * - any side: calling mbedtls_ssl_renegotiate(),
3125 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3126 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003127 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003128 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003130 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003131int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003132{
Janos Follath865b3eb2019-12-16 11:46:15 +00003133 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003136
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003137 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3138 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003139
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003140 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3141 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003143 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003145 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003146 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003147 ssl->handshake->out_msg_seq = 1;
3148 else
3149 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003150 }
3151#endif
3152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3154 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003157 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003159 return( ret );
3160 }
3161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003163
3164 return( 0 );
3165}
3166
3167/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003168 * Renegotiate current connection on client,
3169 * or request renegotiation on server
3170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003172{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003173 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003174
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003175 if( ssl == NULL || ssl->conf == NULL )
3176 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003179 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003180 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003181 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003182 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003186
3187 /* Did we already try/start sending HelloRequest? */
3188 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003190
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003191 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003192 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003196 /*
3197 * On client, either start the renegotiation process or,
3198 * if already in progress, continue the handshake
3199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003201 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003202 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003204
Hanno Becker40cdaa12020-02-05 10:48:27 +00003205 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003206 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003207 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003208 return( ret );
3209 }
3210 }
3211 else
3212 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003214 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003216 return( ret );
3217 }
3218 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003220
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003221 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003222}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003224
Gilles Peskine9b562d52018-04-25 20:32:43 +02003225void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003226{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003227 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3228
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003229 if( handshake == NULL )
3230 return;
3231
Brett Warrene0edc842021-08-17 09:53:13 +01003232#if defined(MBEDTLS_ECP_C)
3233#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3234 if ( ssl->handshake->group_list_heap_allocated )
3235 mbedtls_free( (void*) handshake->group_list );
3236 handshake->group_list = NULL;
3237#endif /* MBEDTLS_DEPRECATED_REMOVED */
3238#endif /* MBEDTLS_ECP_C */
3239
Jerry Yuf017ee42022-01-12 15:49:48 +08003240#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3241#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3242 if ( ssl->handshake->sig_algs_heap_allocated )
3243 mbedtls_free( (void*) handshake->sig_algs );
3244 handshake->sig_algs = NULL;
3245#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003246#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3247 if( ssl->handshake->certificate_request_context )
3248 {
3249 mbedtls_free( (void*) handshake->certificate_request_context );
3250 }
3251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003252#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3253
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003254#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3255 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3256 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003257 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003258 handshake->async_in_progress = 0;
3259 }
3260#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3261
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003262#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003263#if defined(MBEDTLS_USE_PSA_CRYPTO)
3264 psa_hash_abort( &handshake->fin_sha256_psa );
3265#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003266 mbedtls_sha256_free( &handshake->fin_sha256 );
3267#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003268#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003269#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003270#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003271 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003272#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003273 mbedtls_sha512_free( &handshake->fin_sha512 );
3274#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003275#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277#if defined(MBEDTLS_DHM_C)
3278 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003279#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003280#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003281 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003282#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003283#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003284 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003285#if defined(MBEDTLS_SSL_CLI_C)
3286 mbedtls_free( handshake->ecjpake_cache );
3287 handshake->ecjpake_cache = NULL;
3288 handshake->ecjpake_cache_len = 0;
3289#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003290#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003291
Janos Follath4ae5c292016-02-10 11:27:43 +00003292#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3293 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003294 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003296#endif
3297
Gilles Peskineeccd8882020-03-10 12:19:08 +01003298#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003299#if defined(MBEDTLS_USE_PSA_CRYPTO)
3300 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3301 {
3302 /* The maintenance of the external PSK key slot is the
3303 * user's responsibility. */
3304 if( ssl->handshake->psk_opaque_is_internal )
3305 {
3306 psa_destroy_key( ssl->handshake->psk_opaque );
3307 ssl->handshake->psk_opaque_is_internal = 0;
3308 }
3309 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3310 }
Neil Armstronge952a302022-05-03 10:22:14 +02003311#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003312 if( handshake->psk != NULL )
3313 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003314 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003315 mbedtls_free( handshake->psk );
3316 }
Neil Armstronge952a302022-05-03 10:22:14 +02003317#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003318#endif
3319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3321 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003322 /*
3323 * Free only the linked list wrapper, not the keys themselves
3324 * since the belong to the SNI callback
3325 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003326 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003328
Gilles Peskineeccd8882020-03-10 12:19:08 +01003329#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003330 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003331 if( handshake->ecrs_peer_cert != NULL )
3332 {
3333 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3334 mbedtls_free( handshake->ecrs_peer_cert );
3335 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003336#endif
3337
Hanno Becker75173122019-02-06 16:18:31 +00003338#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3339 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3340 mbedtls_pk_free( &handshake->peer_pubkey );
3341#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3342
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003343#if defined(MBEDTLS_SSL_CLI_C) && \
3344 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3345 mbedtls_free( handshake->cookie );
3346#endif /* MBEDTLS_SSL_CLI_C &&
3347 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003348
3349#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003350 mbedtls_ssl_flight_free( handshake->flight );
3351 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003352#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003353
Ronald Cronf12b81d2022-03-15 10:42:41 +01003354#if defined(MBEDTLS_ECDH_C) && \
3355 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003356 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003357 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003358#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3359
Ronald Cron6f135e12021-12-08 16:57:54 +01003360#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003361 mbedtls_ssl_transform_free( handshake->transform_handshake );
3362 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003363 mbedtls_free( handshake->transform_earlydata );
3364 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003365#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003366
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003367
3368#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3369 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3370 * processes datagrams and the fact that a datagram is allowed to have
3371 * several records in it, it is possible that the I/O buffers are not
3372 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003373 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3374 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003375#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003376
Jerry Yuba9c7272021-10-30 11:54:10 +08003377 /* mbedtls_platform_zeroize MUST be last one in this function */
3378 mbedtls_platform_zeroize( handshake,
3379 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003380}
3381
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003383{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003384 if( session == NULL )
3385 return;
3386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003388 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003389#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003390
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003391#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003393#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003394
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003395 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003396}
3397
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003398#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003399
3400#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3401#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3402#else
3403#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3404#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3405
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003406#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003407
3408#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3409#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3410#else
3411#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3412#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3413
3414#if defined(MBEDTLS_SSL_ALPN)
3415#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3416#else
3417#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3418#endif /* MBEDTLS_SSL_ALPN */
3419
3420#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3421#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3422#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3423#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3424
3425#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3426 ( (uint32_t) ( \
3427 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3428 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3429 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3430 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3431 0u ) )
3432
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003433static unsigned char ssl_serialized_context_header[] = {
3434 MBEDTLS_VERSION_MAJOR,
3435 MBEDTLS_VERSION_MINOR,
3436 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003437 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3438 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3439 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3440 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3441 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003442};
3443
Paul Bakker5121ce52009-01-03 21:22:43 +00003444/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003445 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003446 *
3447 * The format of the serialized data is:
3448 * (in the presentation language of TLS, RFC 8446 section 3)
3449 *
3450 * // header
3451 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003452 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003453 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003454 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003455 * Note: When updating the format, remember to keep these
3456 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003457 *
3458 * // session sub-structure
3459 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3460 * // transform sub-structure
3461 * uint8 random[64]; // ServerHello.random+ClientHello.random
3462 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3463 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3464 * // fields from ssl_context
3465 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3466 * uint64 in_window_top; // DTLS: last validated record seq_num
3467 * uint64 in_window; // DTLS: bitmask for replay protection
3468 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3469 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3470 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3471 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3472 *
3473 * Note that many fields of the ssl_context or sub-structures are not
3474 * serialized, as they fall in one of the following categories:
3475 *
3476 * 1. forced value (eg in_left must be 0)
3477 * 2. pointer to dynamically-allocated memory (eg session, transform)
3478 * 3. value can be re-derived from other data (eg session keys from MS)
3479 * 4. value was temporary (eg content of input buffer)
3480 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003481 */
3482int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3483 unsigned char *buf,
3484 size_t buf_len,
3485 size_t *olen )
3486{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003487 unsigned char *p = buf;
3488 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003489 size_t session_len;
3490 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003491
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003492 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003493 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3494 * this function's documentation.
3495 *
3496 * These are due to assumptions/limitations in the implementation. Some of
3497 * them are likely to stay (no handshake in progress) some might go away
3498 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003499 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003500 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003501 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003502 {
3503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003504 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003505 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003506 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003507 {
3508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003509 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003510 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003511 /* Double-check that sub-structures are indeed ready */
3512 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003513 {
3514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003515 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003516 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003517 /* There must be no pending incoming or outgoing data */
3518 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003519 {
3520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003522 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003523 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003524 {
3525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003526 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003527 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003528 /* Protocol must be DLTS, not TLS */
3529 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003530 {
3531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003532 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003533 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003534 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003535 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003536 {
3537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003538 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003539 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003540 /* We must be using an AEAD ciphersuite */
3541 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003542 {
3543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003544 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003545 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003546 /* Renegotiation must not be enabled */
3547#if defined(MBEDTLS_SSL_RENEGOTIATION)
3548 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003549 {
3550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003551 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003552 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003553#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003554
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003555 /*
3556 * Version and format identifier
3557 */
3558 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003559
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003560 if( used <= buf_len )
3561 {
3562 memcpy( p, ssl_serialized_context_header,
3563 sizeof( ssl_serialized_context_header ) );
3564 p += sizeof( ssl_serialized_context_header );
3565 }
3566
3567 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003568 * Session (length + data)
3569 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003570 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003571 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3572 return( ret );
3573
3574 used += 4 + session_len;
3575 if( used <= buf_len )
3576 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003577 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3578 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003579
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003580 ret = ssl_session_save( ssl->session, 1,
3581 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003582 if( ret != 0 )
3583 return( ret );
3584
3585 p += session_len;
3586 }
3587
3588 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003589 * Transform
3590 */
3591 used += sizeof( ssl->transform->randbytes );
3592 if( used <= buf_len )
3593 {
3594 memcpy( p, ssl->transform->randbytes,
3595 sizeof( ssl->transform->randbytes ) );
3596 p += sizeof( ssl->transform->randbytes );
3597 }
3598
3599#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3600 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3601 if( used <= buf_len )
3602 {
3603 *p++ = ssl->transform->in_cid_len;
3604 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3605 p += ssl->transform->in_cid_len;
3606
3607 *p++ = ssl->transform->out_cid_len;
3608 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3609 p += ssl->transform->out_cid_len;
3610 }
3611#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3612
3613 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003614 * Saved fields from top-level ssl_context structure
3615 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003616 used += 4;
3617 if( used <= buf_len )
3618 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003619 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3620 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003621 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003622
3623#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3624 used += 16;
3625 if( used <= buf_len )
3626 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003627 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3628 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003629
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003630 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3631 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003632 }
3633#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3634
3635#if defined(MBEDTLS_SSL_PROTO_DTLS)
3636 used += 1;
3637 if( used <= buf_len )
3638 {
3639 *p++ = ssl->disable_datagram_packing;
3640 }
3641#endif /* MBEDTLS_SSL_PROTO_DTLS */
3642
Jerry Yuae0b2e22021-10-08 15:21:19 +08003643 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003644 if( used <= buf_len )
3645 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003646 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3647 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003648 }
3649
3650#if defined(MBEDTLS_SSL_PROTO_DTLS)
3651 used += 2;
3652 if( used <= buf_len )
3653 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003654 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3655 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003656 }
3657#endif /* MBEDTLS_SSL_PROTO_DTLS */
3658
3659#if defined(MBEDTLS_SSL_ALPN)
3660 {
3661 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003662 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003663 : 0;
3664
3665 used += 1 + alpn_len;
3666 if( used <= buf_len )
3667 {
3668 *p++ = alpn_len;
3669
3670 if( ssl->alpn_chosen != NULL )
3671 {
3672 memcpy( p, ssl->alpn_chosen, alpn_len );
3673 p += alpn_len;
3674 }
3675 }
3676 }
3677#endif /* MBEDTLS_SSL_ALPN */
3678
3679 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003680 * Done
3681 */
3682 *olen = used;
3683
3684 if( used > buf_len )
3685 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003686
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003687 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3688
Hanno Becker43aefe22020-02-05 10:44:56 +00003689 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003690}
3691
3692/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003693 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003694 *
3695 * This internal version is wrapped by a public function that cleans up in
3696 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003697 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003698MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003699static int ssl_context_load( mbedtls_ssl_context *ssl,
3700 const unsigned char *buf,
3701 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003702{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003703 const unsigned char *p = buf;
3704 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003705 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003706 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003707
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003708 /*
3709 * The context should have been freshly setup or reset.
3710 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003711 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003712 * renegotiating, or if the user mistakenly loaded a session first.)
3713 */
3714 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3715 ssl->session != NULL )
3716 {
3717 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3718 }
3719
3720 /*
3721 * We can't check that the config matches the initial one, but we can at
3722 * least check it matches the requirements for serializing.
3723 */
3724 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003725 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3726 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003727#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003728 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003729#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003730 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003731 {
3732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3733 }
3734
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003735 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3736
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003737 /*
3738 * Check version identifier
3739 */
3740 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3741 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3742
3743 if( memcmp( p, ssl_serialized_context_header,
3744 sizeof( ssl_serialized_context_header ) ) != 0 )
3745 {
3746 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3747 }
3748 p += sizeof( ssl_serialized_context_header );
3749
3750 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003751 * Session
3752 */
3753 if( (size_t)( end - p ) < 4 )
3754 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3755
3756 session_len = ( (size_t) p[0] << 24 ) |
3757 ( (size_t) p[1] << 16 ) |
3758 ( (size_t) p[2] << 8 ) |
3759 ( (size_t) p[3] );
3760 p += 4;
3761
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003762 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003763 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003764 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003765 ssl->session_in = ssl->session;
3766 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003767 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003768
3769 if( (size_t)( end - p ) < session_len )
3770 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3771
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003772 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003773 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003774 {
3775 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003776 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003777 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003778
3779 p += session_len;
3780
3781 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003782 * Transform
3783 */
3784
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003785 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003786 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003787 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003788 ssl->transform_in = ssl->transform;
3789 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003790 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003791
3792 /* Read random bytes and populate structure */
3793 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3794 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003796 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003797 ssl->session->ciphersuite,
3798 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003799#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003800 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003801#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003802 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3803 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003804 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003805 ssl->conf->endpoint,
3806 ssl );
3807 if( ret != 0 )
3808 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003809#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003810 p += sizeof( ssl->transform->randbytes );
3811
3812#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3813 /* Read connection IDs and store them */
3814 if( (size_t)( end - p ) < 1 )
3815 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3816
3817 ssl->transform->in_cid_len = *p++;
3818
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003819 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003820 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3821
3822 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3823 p += ssl->transform->in_cid_len;
3824
3825 ssl->transform->out_cid_len = *p++;
3826
3827 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3828 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3829
3830 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3831 p += ssl->transform->out_cid_len;
3832#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3833
3834 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003835 * Saved fields from top-level ssl_context structure
3836 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003837 if( (size_t)( end - p ) < 4 )
3838 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3839
3840 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3841 ( (uint32_t) p[1] << 16 ) |
3842 ( (uint32_t) p[2] << 8 ) |
3843 ( (uint32_t) p[3] );
3844 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003845
3846#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3847 if( (size_t)( end - p ) < 16 )
3848 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3849
3850 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3851 ( (uint64_t) p[1] << 48 ) |
3852 ( (uint64_t) p[2] << 40 ) |
3853 ( (uint64_t) p[3] << 32 ) |
3854 ( (uint64_t) p[4] << 24 ) |
3855 ( (uint64_t) p[5] << 16 ) |
3856 ( (uint64_t) p[6] << 8 ) |
3857 ( (uint64_t) p[7] );
3858 p += 8;
3859
3860 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3861 ( (uint64_t) p[1] << 48 ) |
3862 ( (uint64_t) p[2] << 40 ) |
3863 ( (uint64_t) p[3] << 32 ) |
3864 ( (uint64_t) p[4] << 24 ) |
3865 ( (uint64_t) p[5] << 16 ) |
3866 ( (uint64_t) p[6] << 8 ) |
3867 ( (uint64_t) p[7] );
3868 p += 8;
3869#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3870
3871#if defined(MBEDTLS_SSL_PROTO_DTLS)
3872 if( (size_t)( end - p ) < 1 )
3873 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3874
3875 ssl->disable_datagram_packing = *p++;
3876#endif /* MBEDTLS_SSL_PROTO_DTLS */
3877
Jerry Yud9a94fe2021-09-28 18:58:59 +08003878 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003879 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003880 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3881 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003882
3883#if defined(MBEDTLS_SSL_PROTO_DTLS)
3884 if( (size_t)( end - p ) < 2 )
3885 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3886
3887 ssl->mtu = ( p[0] << 8 ) | p[1];
3888 p += 2;
3889#endif /* MBEDTLS_SSL_PROTO_DTLS */
3890
3891#if defined(MBEDTLS_SSL_ALPN)
3892 {
3893 uint8_t alpn_len;
3894 const char **cur;
3895
3896 if( (size_t)( end - p ) < 1 )
3897 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3898
3899 alpn_len = *p++;
3900
3901 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3902 {
3903 /* alpn_chosen should point to an item in the configured list */
3904 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3905 {
3906 if( strlen( *cur ) == alpn_len &&
3907 memcmp( p, cur, alpn_len ) == 0 )
3908 {
3909 ssl->alpn_chosen = *cur;
3910 break;
3911 }
3912 }
3913 }
3914
3915 /* can only happen on conf mismatch */
3916 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3917 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3918
3919 p += alpn_len;
3920 }
3921#endif /* MBEDTLS_SSL_ALPN */
3922
3923 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003924 * Forced fields from top-level ssl_context structure
3925 *
3926 * Most of them already set to the correct value by mbedtls_ssl_init() and
3927 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3928 */
3929 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003930 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003931
Hanno Becker361b10d2019-08-30 10:42:49 +01003932 /* Adjust pointers for header fields of outgoing records to
3933 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003934 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003935
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003936#if defined(MBEDTLS_SSL_PROTO_DTLS)
3937 ssl->in_epoch = 1;
3938#endif
3939
3940 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3941 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003942 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3943 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003944 if( ssl->handshake != NULL )
3945 {
3946 mbedtls_ssl_handshake_free( ssl );
3947 mbedtls_free( ssl->handshake );
3948 ssl->handshake = NULL;
3949 }
3950
3951 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003952 * Done - should have consumed entire buffer
3953 */
3954 if( p != end )
3955 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003956
3957 return( 0 );
3958}
3959
3960/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003961 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003962 */
3963int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3964 const unsigned char *buf,
3965 size_t len )
3966{
3967 int ret = ssl_context_load( context, buf, len );
3968
3969 if( ret != 0 )
3970 mbedtls_ssl_free( context );
3971
3972 return( ret );
3973}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003974#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003975
3976/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003977 * Free an SSL context
3978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003979void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003980{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003981 if( ssl == NULL )
3982 return;
3983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003985
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003986 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003987 {
sander-visserb8aa2072020-05-06 22:05:13 +02003988#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3989 size_t out_buf_len = ssl->out_buf_len;
3990#else
3991 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3992#endif
3993
Darryl Greenb33cc762019-11-28 14:29:44 +00003994 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003996 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003997 }
3998
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003999 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004000 {
sander-visserb8aa2072020-05-06 22:05:13 +02004001#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4002 size_t in_buf_len = ssl->in_buf_len;
4003#else
4004 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4005#endif
4006
Darryl Greenb33cc762019-11-28 14:29:44 +00004007 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004009 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004010 }
4011
Paul Bakker48916f92012-09-16 19:57:18 +00004012 if( ssl->transform )
4013 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014 mbedtls_ssl_transform_free( ssl->transform );
4015 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004016 }
4017
4018 if( ssl->handshake )
4019 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004020 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004021 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4022 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004024 mbedtls_free( ssl->handshake );
4025 mbedtls_free( ssl->transform_negotiate );
4026 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004027 }
4028
Ronald Cron6f135e12021-12-08 16:57:54 +01004029#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004030 mbedtls_ssl_transform_free( ssl->transform_application );
4031 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004032#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004033
Paul Bakkerc0463502013-02-14 11:19:38 +01004034 if( ssl->session )
4035 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004036 mbedtls_ssl_session_free( ssl->session );
4037 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004038 }
4039
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004040#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004041 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004042 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004043 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004044 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004045 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004046#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004047
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004048#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004049 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004050#endif
4051
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004052 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004053
Paul Bakker86f04f42013-02-14 11:20:09 +01004054 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004055 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004056}
4057
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004058/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004059 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004060 */
4061void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4062{
4063 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4064}
4065
Gilles Peskineeccd8882020-03-10 12:19:08 +01004066#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004067#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02004068/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02004069 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
4070 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004071 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
4072 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004073static int ssl_preset_default_hashes[] = {
4074#if defined(MBEDTLS_SHA512_C)
4075 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004076#endif
4077#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004078 MBEDTLS_MD_SHA384,
4079#endif
4080#if defined(MBEDTLS_SHA256_C)
4081 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004082#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004083 MBEDTLS_MD_NONE
4084};
Jerry Yuf017ee42022-01-12 15:49:48 +08004085#endif /* !MBEDTLS_DEPRECATED_REMOVED */
4086#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004087
Gilles Peskineae270bf2021-06-02 00:05:29 +02004088/* The selection should be the same as mbedtls_x509_crt_profile_default in
4089 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004090 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004091 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004092 * about this list.
4093 */
Brett Warrene0edc842021-08-17 09:53:13 +01004094static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004095#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004096 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004097#endif
4098#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004099 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004100#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004101#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004102 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004103#endif
4104#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004105 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004106#endif
4107#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004108 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004109#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004110#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004111 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004112#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004113#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004114 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004115#endif
4116#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004117 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004118#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004119 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004120};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004121
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004122static int ssl_preset_suiteb_ciphersuites[] = {
4123 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4124 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4125 0
4126};
4127
Gilles Peskineeccd8882020-03-10 12:19:08 +01004128#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004129#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004130static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08004131#if defined(MBEDTLS_SHA256_C)
4132 MBEDTLS_MD_SHA256,
4133#endif
Jerry Yu713013f2022-01-17 18:16:35 +08004134#if defined(MBEDTLS_SHA384_C)
4135 MBEDTLS_MD_SHA384,
4136#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004137 MBEDTLS_MD_NONE
4138};
Jerry Yuf017ee42022-01-12 15:49:48 +08004139#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004140
Jerry Yu909df7b2022-01-22 11:56:27 +08004141/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004142 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004143 * rules SHOULD be upheld.
4144 * - No duplicate entries.
4145 * - But if there is a good reason, do not change the order of the algorithms.
4146 * - ssl_tls12_present* is for TLS 1.2 use only.
4147 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004148 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004149static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004150
Jerry Yued5e9f42022-01-26 11:21:34 +08004151#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4152 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4153 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4154#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4155 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004156
Jerry Yu909df7b2022-01-22 11:56:27 +08004157#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4158 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4159 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4160#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4161 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4162
Jerry Yued5e9f42022-01-26 11:21:34 +08004163#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4164 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4165 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4166#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4167 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004168
Jerry Yu909df7b2022-01-22 11:56:27 +08004169#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4170 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4171#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4172
Ronald Cron8540cf62022-03-16 08:01:09 +01004173#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4174 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4175#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4176
4177#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4178 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4179#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4180
Jerry Yu53037892022-01-25 11:02:06 +08004181#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4182 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4183#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4184
Gabor Mezei15b95a62022-05-09 16:37:58 +02004185 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004186};
4187
4188/* NOTICE: see above */
4189#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4190static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004191#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004192#if defined(MBEDTLS_ECDSA_C)
4193 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004194#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004195#if defined(MBEDTLS_RSA_C)
4196 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4197#endif
4198#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004199#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004200#if defined(MBEDTLS_ECDSA_C)
4201 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004202#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004203#if defined(MBEDTLS_RSA_C)
4204 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4205#endif
4206#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004207#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004208#if defined(MBEDTLS_ECDSA_C)
4209 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004210#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004211#if defined(MBEDTLS_RSA_C)
4212 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4213#endif
4214#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004215 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004216};
4217#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4218/* NOTICE: see above */
4219static uint16_t ssl_preset_suiteb_sig_algs[] = {
4220
Jerry Yu909df7b2022-01-22 11:56:27 +08004221#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4222 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4223 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4224#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4225 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4226
Jerry Yu53037892022-01-25 11:02:06 +08004227#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4228 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4229 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4230#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4231 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004232
4233#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4234 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4235#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004236
Jerry Yu53037892022-01-25 11:02:06 +08004237#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4238 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4239#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4240
Gabor Mezei15b95a62022-05-09 16:37:58 +02004241 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004242};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004243
Jerry Yu909df7b2022-01-22 11:56:27 +08004244/* NOTICE: see above */
4245#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4246static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004247#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004248#if defined(MBEDTLS_ECDSA_C)
4249 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004250#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004251#if defined(MBEDTLS_RSA_C)
4252 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4253#endif
4254#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004255#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004256#if defined(MBEDTLS_ECDSA_C)
4257 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004258#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004259#if defined(MBEDTLS_RSA_C)
4260 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4261#endif
4262#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004263 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004264};
Jerry Yu909df7b2022-01-22 11:56:27 +08004265#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4266
Jerry Yu1a8b4812022-01-20 17:56:50 +08004267#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004268
Brett Warrene0edc842021-08-17 09:53:13 +01004269static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004270#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004271 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004272#endif
4273#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004274 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004275#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004276 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004277};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004278
Jerry Yu1a8b4812022-01-20 17:56:50 +08004279#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004280/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004281 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004282MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004283static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004284{
4285 size_t i, j;
4286 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004287
Gabor Mezei15b95a62022-05-09 16:37:58 +02004288 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004289 {
Jerry Yuf377d642022-01-25 10:43:59 +08004290 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004291 {
Jerry Yuf377d642022-01-25 10:43:59 +08004292 if( sig_algs[i] != sig_algs[j] )
4293 continue;
4294 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4295 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4296 sig_algs[i], j, i );
4297 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004298 }
4299 }
4300 return( ret );
4301}
4302
4303#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4304
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004305/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004306 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004307 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004308int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004309 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004310{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004311#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004313#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004314
Jerry Yu1a8b4812022-01-20 17:56:50 +08004315#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004316 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004317 {
4318 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4319 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4320 }
4321
Jerry Yuf377d642022-01-25 10:43:59 +08004322 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004323 {
4324 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4325 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4326 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004327
4328#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004329 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004330 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004331 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004332 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4333 }
4334
Jerry Yuf377d642022-01-25 10:43:59 +08004335 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004336 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004337 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004338 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4339 }
4340#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004341#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4342
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004343 /* Use the functions here so that they are covered in tests,
4344 * but otherwise access member directly for efficiency */
4345 mbedtls_ssl_conf_endpoint( conf, endpoint );
4346 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004347
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004348 /*
4349 * Things that are common to all presets
4350 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004351#if defined(MBEDTLS_SSL_CLI_C)
4352 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4353 {
4354 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4355#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4356 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4357#endif
4358 }
4359#endif
4360
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004361#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4362 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4363#endif
4364
4365#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4366 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4367#endif
4368
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004369#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004370 conf->f_cookie_write = ssl_cookie_write_dummy;
4371 conf->f_cookie_check = ssl_cookie_check_dummy;
4372#endif
4373
4374#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4375 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4376#endif
4377
Janos Follath088ce432017-04-10 12:42:31 +01004378#if defined(MBEDTLS_SSL_SRV_C)
4379 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004380 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004381#endif
4382
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004383#if defined(MBEDTLS_SSL_PROTO_DTLS)
4384 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4385 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4386#endif
4387
4388#if defined(MBEDTLS_SSL_RENEGOTIATION)
4389 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004390 memset( conf->renego_period, 0x00, 2 );
4391 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004392#endif
4393
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004394#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004395 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4396 {
4397 const unsigned char dhm_p[] =
4398 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4399 const unsigned char dhm_g[] =
4400 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004401
Hanno Beckere2defad2021-07-24 05:59:17 +01004402 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4403 dhm_p, sizeof( dhm_p ),
4404 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4405 {
4406 return( ret );
4407 }
4408 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004409#endif
4410
Ronald Cron6f135e12021-12-08 16:57:54 +01004411#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004412 /*
4413 * Allow all TLS 1.3 key exchange modes by default.
4414 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004415 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004416#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004417
XiaokangQian4d3a6042022-04-21 13:46:17 +00004418 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4419 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004420#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004421 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004422 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004423#else
XiaokangQian060d8672022-04-21 09:24:56 +00004424 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004425#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004426 }
4427 else
4428 {
4429#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4430 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4431 {
4432 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4433 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4434 }
4435 else
4436 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4437 {
4438 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4439 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4440 }
4441#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4442 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4443 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4444#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4445 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4446 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4447#else
4448 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4449#endif
4450 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004451
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004452 /*
4453 * Preset-specific defaults
4454 */
4455 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004456 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004457 /*
4458 * NSA Suite B
4459 */
4460 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004461
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004462 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004463
4464#if defined(MBEDTLS_X509_CRT_PARSE_C)
4465 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004466#endif
4467
Gilles Peskineeccd8882020-03-10 12:19:08 +01004468#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004469#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004470 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004471#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004472#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4473 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4474 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4475 else
4476#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4477 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004478#endif
4479
Brett Warrene0edc842021-08-17 09:53:13 +01004480#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4481 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004482#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004483 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004484 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004485
4486 /*
4487 * Default
4488 */
4489 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004490
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004491 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004492
4493#if defined(MBEDTLS_X509_CRT_PARSE_C)
4494 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4495#endif
4496
Gilles Peskineeccd8882020-03-10 12:19:08 +01004497#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004498#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004499 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004500#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004501#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4502 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4503 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4504 else
4505#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4506 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004507#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004508
Brett Warrene0edc842021-08-17 09:53:13 +01004509#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4510 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004511#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004512 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004513
4514#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4515 conf->dhm_min_bitlen = 1024;
4516#endif
4517 }
4518
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004519 return( 0 );
4520}
4521
4522/*
4523 * Free mbedtls_ssl_config
4524 */
4525void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4526{
4527#if defined(MBEDTLS_DHM_C)
4528 mbedtls_mpi_free( &conf->dhm_P );
4529 mbedtls_mpi_free( &conf->dhm_G );
4530#endif
4531
Gilles Peskineeccd8882020-03-10 12:19:08 +01004532#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004533#if defined(MBEDTLS_USE_PSA_CRYPTO)
4534 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4535 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004536 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4537 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004538#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004539 if( conf->psk != NULL )
4540 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004541 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004542 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004543 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004544 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004545 }
4546
4547 if( conf->psk_identity != NULL )
4548 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004549 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004550 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004551 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004552 conf->psk_identity_len = 0;
4553 }
4554#endif
4555
4556#if defined(MBEDTLS_X509_CRT_PARSE_C)
4557 ssl_key_cert_free( conf->key_cert );
4558#endif
4559
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004560 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004561}
4562
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004563#if defined(MBEDTLS_PK_C) && \
4564 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004565/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004566 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004569{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570#if defined(MBEDTLS_RSA_C)
4571 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4572 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004573#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574#if defined(MBEDTLS_ECDSA_C)
4575 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4576 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004577#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004579}
4580
Hanno Becker7e5437a2017-04-28 17:15:26 +01004581unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4582{
4583 switch( type ) {
4584 case MBEDTLS_PK_RSA:
4585 return( MBEDTLS_SSL_SIG_RSA );
4586 case MBEDTLS_PK_ECDSA:
4587 case MBEDTLS_PK_ECKEY:
4588 return( MBEDTLS_SSL_SIG_ECDSA );
4589 default:
4590 return( MBEDTLS_SSL_SIG_ANON );
4591 }
4592}
4593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004594mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004595{
4596 switch( sig )
4597 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598#if defined(MBEDTLS_RSA_C)
4599 case MBEDTLS_SSL_SIG_RSA:
4600 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004601#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004602#if defined(MBEDTLS_ECDSA_C)
4603 case MBEDTLS_SSL_SIG_ECDSA:
4604 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004605#endif
4606 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004608 }
4609}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004610#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004611
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004612/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004613 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004616{
4617 switch( hash )
4618 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619#if defined(MBEDTLS_MD5_C)
4620 case MBEDTLS_SSL_HASH_MD5:
4621 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004622#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623#if defined(MBEDTLS_SHA1_C)
4624 case MBEDTLS_SSL_HASH_SHA1:
4625 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004626#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004627#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004628 case MBEDTLS_SSL_HASH_SHA224:
4629 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004630#endif
4631#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632 case MBEDTLS_SSL_HASH_SHA256:
4633 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004634#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004635#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004636 case MBEDTLS_SSL_HASH_SHA384:
4637 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004638#endif
4639#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 case MBEDTLS_SSL_HASH_SHA512:
4641 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004642#endif
4643 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004644 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004645 }
4646}
4647
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004648/*
4649 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4650 */
4651unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4652{
4653 switch( md )
4654 {
4655#if defined(MBEDTLS_MD5_C)
4656 case MBEDTLS_MD_MD5:
4657 return( MBEDTLS_SSL_HASH_MD5 );
4658#endif
4659#if defined(MBEDTLS_SHA1_C)
4660 case MBEDTLS_MD_SHA1:
4661 return( MBEDTLS_SSL_HASH_SHA1 );
4662#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004663#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004664 case MBEDTLS_MD_SHA224:
4665 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004666#endif
4667#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004668 case MBEDTLS_MD_SHA256:
4669 return( MBEDTLS_SSL_HASH_SHA256 );
4670#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004671#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004672 case MBEDTLS_MD_SHA384:
4673 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004674#endif
4675#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004676 case MBEDTLS_MD_SHA512:
4677 return( MBEDTLS_SSL_HASH_SHA512 );
4678#endif
4679 default:
4680 return( MBEDTLS_SSL_HASH_NONE );
4681 }
4682}
4683
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004684/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004685 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004686 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004687 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004688int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004689{
Brett Warrene0edc842021-08-17 09:53:13 +01004690 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004691
Brett Warrene0edc842021-08-17 09:53:13 +01004692 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004693 return( -1 );
4694
Brett Warrene0edc842021-08-17 09:53:13 +01004695 for( ; *group_list != 0; group_list++ )
4696 {
4697 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004698 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004699 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004700
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004701 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004702}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004703
4704#if defined(MBEDTLS_ECP_C)
4705/*
4706 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4707 */
4708int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4709{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004710 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004711 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4712}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004713#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715#if defined(MBEDTLS_X509_CRT_PARSE_C)
4716int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4717 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004718 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004719 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004720{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004721 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004722 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004723 const char *ext_oid;
4724 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004727 {
4728 /* Server part of the key exchange */
4729 switch( ciphersuite->key_exchange )
4730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 case MBEDTLS_KEY_EXCHANGE_RSA:
4732 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004733 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004734 break;
4735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4737 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4738 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4739 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004740 break;
4741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4743 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004744 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004745 break;
4746
4747 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004748 case MBEDTLS_KEY_EXCHANGE_NONE:
4749 case MBEDTLS_KEY_EXCHANGE_PSK:
4750 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4751 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004752 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004753 usage = 0;
4754 }
4755 }
4756 else
4757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4759 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004760 }
4761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004763 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004764 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004765 ret = -1;
4766 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004768 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004769 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4771 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004772 }
4773 else
4774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4776 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004777 }
4778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004780 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004781 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004782 ret = -1;
4783 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004784
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004785 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004786}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004788
Jerry Yu148165c2021-09-24 23:20:59 +08004789#if defined(MBEDTLS_USE_PSA_CRYPTO)
4790int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4791 const mbedtls_md_type_t md,
4792 unsigned char *dst,
4793 size_t dst_len,
4794 size_t *olen )
4795{
Ronald Cronf6893e12022-01-07 22:09:01 +01004796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4797 psa_hash_operation_t *hash_operation_to_clone;
4798 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4799
Jerry Yu148165c2021-09-24 23:20:59 +08004800 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004801
4802 switch( md )
4803 {
4804#if defined(MBEDTLS_SHA384_C)
4805 case MBEDTLS_MD_SHA384:
4806 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4807 break;
4808#endif
4809
4810#if defined(MBEDTLS_SHA256_C)
4811 case MBEDTLS_MD_SHA256:
4812 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4813 break;
4814#endif
4815
4816 default:
4817 goto exit;
4818 }
4819
4820 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4821 if( status != PSA_SUCCESS )
4822 goto exit;
4823
4824 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4825 if( status != PSA_SUCCESS )
4826 goto exit;
4827
4828exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004829 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004830}
4831#else /* MBEDTLS_USE_PSA_CRYPTO */
4832
Jerry Yu24c0ec32021-09-09 14:21:07 +08004833#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004834MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004835static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4836 unsigned char *dst,
4837 size_t dst_len,
4838 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004839{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004840 int ret;
4841 mbedtls_sha512_context sha512;
4842
4843 if( dst_len < 48 )
4844 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4845
4846 mbedtls_sha512_init( &sha512 );
4847 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4848
4849 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4850 {
4851 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4852 goto exit;
4853 }
4854
4855 *olen = 48;
4856
4857exit:
4858
4859 mbedtls_sha512_free( &sha512 );
4860 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004861}
4862#endif /* MBEDTLS_SHA384_C */
4863
4864#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004865MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004866static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4867 unsigned char *dst,
4868 size_t dst_len,
4869 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004870{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004871 int ret;
4872 mbedtls_sha256_context sha256;
4873
4874 if( dst_len < 32 )
4875 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4876
4877 mbedtls_sha256_init( &sha256 );
4878 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004879
Jerry Yu24c0ec32021-09-09 14:21:07 +08004880 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4881 {
4882 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4883 goto exit;
4884 }
4885
4886 *olen = 32;
4887
4888exit:
4889
4890 mbedtls_sha256_free( &sha256 );
4891 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004892}
4893#endif /* MBEDTLS_SHA256_C */
4894
Jerry Yu000f9762021-09-14 11:12:51 +08004895int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4896 const mbedtls_md_type_t md,
4897 unsigned char *dst,
4898 size_t dst_len,
4899 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004900{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004901 switch( md )
4902 {
4903
Jerry Yu24c0ec32021-09-09 14:21:07 +08004904#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004905 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004906 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004907#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004908
Jerry Yu24c0ec32021-09-09 14:21:07 +08004909#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004910 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004911 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004912#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004913
4914 default:
4915 break;
4916 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004917 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004918}
XiaokangQian647719a2021-12-07 09:16:29 +00004919
Jerry Yu148165c2021-09-24 23:20:59 +08004920#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004921
Gabor Mezei078e8032022-04-27 21:17:56 +02004922#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4923/* mbedtls_ssl_parse_sig_alg_ext()
4924 *
4925 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4926 * value (TLS 1.3 RFC8446):
4927 * enum {
4928 * ....
4929 * ecdsa_secp256r1_sha256( 0x0403 ),
4930 * ecdsa_secp384r1_sha384( 0x0503 ),
4931 * ecdsa_secp521r1_sha512( 0x0603 ),
4932 * ....
4933 * } SignatureScheme;
4934 *
4935 * struct {
4936 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4937 * } SignatureSchemeList;
4938 *
4939 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4940 * value (TLS 1.2 RFC5246):
4941 * enum {
4942 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4943 * sha512(6), (255)
4944 * } HashAlgorithm;
4945 *
4946 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4947 * SignatureAlgorithm;
4948 *
4949 * struct {
4950 * HashAlgorithm hash;
4951 * SignatureAlgorithm signature;
4952 * } SignatureAndHashAlgorithm;
4953 *
4954 * SignatureAndHashAlgorithm
4955 * supported_signature_algorithms<2..2^16-2>;
4956 *
4957 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4958 * generalization of the TLS 1.2 signature algorithm extension.
4959 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4960 * `SignatureScheme` field of TLS 1.3
4961 *
4962 */
4963int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4964 const unsigned char *buf,
4965 const unsigned char *end )
4966{
4967 const unsigned char *p = buf;
4968 size_t supported_sig_algs_len = 0;
4969 const unsigned char *supported_sig_algs_end;
4970 uint16_t sig_alg;
4971 uint32_t common_idx = 0;
4972
4973 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4974 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4975 p += 2;
4976
4977 memset( ssl->handshake->received_sig_algs, 0,
4978 sizeof(ssl->handshake->received_sig_algs) );
4979
4980 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4981 supported_sig_algs_end = p + supported_sig_algs_len;
4982 while( p < supported_sig_algs_end )
4983 {
4984 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4985 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4986 p += 2;
4987
4988 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x",
4989 sig_alg ) );
4990
4991 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) ||
4992 ! mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) )
4993 continue;
4994
4995 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4996 {
4997 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4998 common_idx += 1;
4999 }
5000 }
5001 /* Check that we consumed all the message. */
5002 if( p != end )
5003 {
5004 MBEDTLS_SSL_DEBUG_MSG( 1,
5005 ( "Signature algorithms extension length misaligned" ) );
5006 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5007 MBEDTLS_ERR_SSL_DECODE_ERROR );
5008 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5009 }
5010
5011 if( common_idx == 0 )
5012 {
5013 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5014 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5015 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5016 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5017 }
5018
Gabor Mezei15b95a62022-05-09 16:37:58 +02005019 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005020 return( 0 );
5021}
5022
5023#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5024
Jerry Yudc7bd172022-02-17 13:44:15 +08005025#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5026
5027#if defined(MBEDTLS_USE_PSA_CRYPTO)
5028
5029static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5030 mbedtls_svc_key_id_t key,
5031 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005032 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005033 const unsigned char* seed, size_t seed_length,
5034 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005035 const unsigned char* other_secret,
5036 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005037 size_t capacity )
5038{
5039 psa_status_t status;
5040
5041 status = psa_key_derivation_setup( derivation, alg );
5042 if( status != PSA_SUCCESS )
5043 return( status );
5044
5045 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5046 {
5047 status = psa_key_derivation_input_bytes( derivation,
5048 PSA_KEY_DERIVATION_INPUT_SEED,
5049 seed, seed_length );
5050 if( status != PSA_SUCCESS )
5051 return( status );
5052
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005053 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005054 {
5055 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005056 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5057 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005058 if( status != PSA_SUCCESS )
5059 return( status );
5060 }
5061
Jerry Yudc7bd172022-02-17 13:44:15 +08005062 if( mbedtls_svc_key_id_is_null( key ) )
5063 {
5064 status = psa_key_derivation_input_bytes(
5065 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005066 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005067 }
5068 else
5069 {
5070 status = psa_key_derivation_input_key(
5071 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5072 }
5073 if( status != PSA_SUCCESS )
5074 return( status );
5075
5076 status = psa_key_derivation_input_bytes( derivation,
5077 PSA_KEY_DERIVATION_INPUT_LABEL,
5078 label, label_length );
5079 if( status != PSA_SUCCESS )
5080 return( status );
5081 }
5082 else
5083 {
5084 return( PSA_ERROR_NOT_SUPPORTED );
5085 }
5086
5087 status = psa_key_derivation_set_capacity( derivation, capacity );
5088 if( status != PSA_SUCCESS )
5089 return( status );
5090
5091 return( PSA_SUCCESS );
5092}
5093
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005094MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005095static int tls_prf_generic( mbedtls_md_type_t md_type,
5096 const unsigned char *secret, size_t slen,
5097 const char *label,
5098 const unsigned char *random, size_t rlen,
5099 unsigned char *dstbuf, size_t dlen )
5100{
5101 psa_status_t status;
5102 psa_algorithm_t alg;
5103 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5104 psa_key_derivation_operation_t derivation =
5105 PSA_KEY_DERIVATION_OPERATION_INIT;
5106
5107 if( md_type == MBEDTLS_MD_SHA384 )
5108 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5109 else
5110 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5111
5112 /* Normally a "secret" should be long enough to be impossible to
5113 * find by brute force, and in particular should not be empty. But
5114 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5115 * and for this use case it makes sense to have a 0-length "secret".
5116 * Since the key API doesn't allow importing a key of length 0,
5117 * keep master_key=0, which setup_psa_key_derivation() understands
5118 * to mean a 0-length "secret" input. */
5119 if( slen != 0 )
5120 {
5121 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5122 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5123 psa_set_key_algorithm( &key_attributes, alg );
5124 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5125
5126 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5127 if( status != PSA_SUCCESS )
5128 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5129 }
5130
5131 status = setup_psa_key_derivation( &derivation,
5132 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005133 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005134 random, rlen,
5135 (unsigned char const *) label,
5136 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005137 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005138 dlen );
5139 if( status != PSA_SUCCESS )
5140 {
5141 psa_key_derivation_abort( &derivation );
5142 psa_destroy_key( master_key );
5143 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5144 }
5145
5146 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5147 if( status != PSA_SUCCESS )
5148 {
5149 psa_key_derivation_abort( &derivation );
5150 psa_destroy_key( master_key );
5151 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5152 }
5153
5154 status = psa_key_derivation_abort( &derivation );
5155 if( status != PSA_SUCCESS )
5156 {
5157 psa_destroy_key( master_key );
5158 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5159 }
5160
5161 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5162 status = psa_destroy_key( master_key );
5163 if( status != PSA_SUCCESS )
5164 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5165
5166 return( 0 );
5167}
5168
5169#else /* MBEDTLS_USE_PSA_CRYPTO */
5170
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005171MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005172static int tls_prf_generic( mbedtls_md_type_t md_type,
5173 const unsigned char *secret, size_t slen,
5174 const char *label,
5175 const unsigned char *random, size_t rlen,
5176 unsigned char *dstbuf, size_t dlen )
5177{
5178 size_t nb;
5179 size_t i, j, k, md_len;
5180 unsigned char *tmp;
5181 size_t tmp_len = 0;
5182 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5183 const mbedtls_md_info_t *md_info;
5184 mbedtls_md_context_t md_ctx;
5185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5186
5187 mbedtls_md_init( &md_ctx );
5188
5189 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5190 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5191
5192 md_len = mbedtls_md_get_size( md_info );
5193
5194 tmp_len = md_len + strlen( label ) + rlen;
5195 tmp = mbedtls_calloc( 1, tmp_len );
5196 if( tmp == NULL )
5197 {
5198 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5199 goto exit;
5200 }
5201
5202 nb = strlen( label );
5203 memcpy( tmp + md_len, label, nb );
5204 memcpy( tmp + md_len + nb, random, rlen );
5205 nb += rlen;
5206
5207 /*
5208 * Compute P_<hash>(secret, label + random)[0..dlen]
5209 */
5210 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5211 goto exit;
5212
5213 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5214 if( ret != 0 )
5215 goto exit;
5216 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5217 if( ret != 0 )
5218 goto exit;
5219 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5220 if( ret != 0 )
5221 goto exit;
5222
5223 for( i = 0; i < dlen; i += md_len )
5224 {
5225 ret = mbedtls_md_hmac_reset ( &md_ctx );
5226 if( ret != 0 )
5227 goto exit;
5228 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5229 if( ret != 0 )
5230 goto exit;
5231 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5232 if( ret != 0 )
5233 goto exit;
5234
5235 ret = mbedtls_md_hmac_reset ( &md_ctx );
5236 if( ret != 0 )
5237 goto exit;
5238 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5239 if( ret != 0 )
5240 goto exit;
5241 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5242 if( ret != 0 )
5243 goto exit;
5244
5245 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5246
5247 for( j = 0; j < k; j++ )
5248 dstbuf[i + j] = h_i[j];
5249 }
5250
5251exit:
5252 mbedtls_md_free( &md_ctx );
5253
5254 mbedtls_platform_zeroize( tmp, tmp_len );
5255 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5256
5257 mbedtls_free( tmp );
5258
5259 return( ret );
5260}
5261#endif /* MBEDTLS_USE_PSA_CRYPTO */
5262
5263#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005264MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005265static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5266 const char *label,
5267 const unsigned char *random, size_t rlen,
5268 unsigned char *dstbuf, size_t dlen )
5269{
5270 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5271 label, random, rlen, dstbuf, dlen ) );
5272}
5273#endif /* MBEDTLS_SHA256_C */
5274
5275#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005276MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005277static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5278 const char *label,
5279 const unsigned char *random, size_t rlen,
5280 unsigned char *dstbuf, size_t dlen )
5281{
5282 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5283 label, random, rlen, dstbuf, dlen ) );
5284}
5285#endif /* MBEDTLS_SHA384_C */
5286
Jerry Yuf009d862022-02-17 14:01:37 +08005287/*
5288 * Set appropriate PRF function and other SSL / TLS1.2 functions
5289 *
5290 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005291 * - hash associated with the ciphersuite (only used by TLS 1.2)
5292 *
5293 * Outputs:
5294 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5295 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005296MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005297static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005298 mbedtls_md_type_t hash )
5299{
Jerry Yuf009d862022-02-17 14:01:37 +08005300#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005301 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005302 {
5303 handshake->tls_prf = tls_prf_sha384;
5304 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5305 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5306 }
5307 else
5308#endif
5309#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005310 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005311 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005312 handshake->tls_prf = tls_prf_sha256;
5313 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5314 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5315 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005316#else
Jerry Yuf009d862022-02-17 14:01:37 +08005317 {
Jerry Yuf009d862022-02-17 14:01:37 +08005318 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005319 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005320 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5321 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005322#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005323
5324 return( 0 );
5325}
Jerry Yud6ab2352022-02-17 14:03:43 +08005326
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005327/*
5328 * Compute master secret if needed
5329 *
5330 * Parameters:
5331 * [in/out] handshake
5332 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5333 * (PSA-PSK) ciphersuite_info, psk_opaque
5334 * [out] premaster (cleared)
5335 * [out] master
5336 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5337 * debug: conf->f_dbg, conf->p_dbg
5338 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005339 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005340 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005341MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005342static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5343 unsigned char *master,
5344 const mbedtls_ssl_context *ssl )
5345{
5346 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5347
5348 /* cf. RFC 5246, Section 8.1:
5349 * "The master secret is always exactly 48 bytes in length." */
5350 size_t const master_secret_len = 48;
5351
5352#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5353 unsigned char session_hash[48];
5354#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5355
5356 /* The label for the KDF used for key expansion.
5357 * This is either "master secret" or "extended master secret"
5358 * depending on whether the Extended Master Secret extension
5359 * is used. */
5360 char const *lbl = "master secret";
5361
Przemek Stekielae4ed302022-04-05 17:15:55 +02005362 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005363 * - If the Extended Master Secret extension is not used,
5364 * this is ClientHello.Random + ServerHello.Random
5365 * (see Sect. 8.1 in RFC 5246).
5366 * - If the Extended Master Secret extension is used,
5367 * this is the transcript of the handshake so far.
5368 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005369 unsigned char const *seed = handshake->randbytes;
5370 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005371
5372#if !defined(MBEDTLS_DEBUG_C) && \
5373 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5374 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5375 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5376 ssl = NULL; /* make sure we don't use it except for those cases */
5377 (void) ssl;
5378#endif
5379
5380 if( handshake->resume != 0 )
5381 {
5382 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5383 return( 0 );
5384 }
5385
5386#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5387 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5388 {
5389 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005390 seed = session_hash;
5391 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005392
5393 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005394 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005395 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005396#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005397
Przemek Stekiel99114f32022-04-22 11:20:09 +02005398#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005399 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005400 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005401 {
5402 /* Perform PSK-to-MS expansion in a single step. */
5403 psa_status_t status;
5404 psa_algorithm_t alg;
5405 mbedtls_svc_key_id_t psk;
5406 psa_key_derivation_operation_t derivation =
5407 PSA_KEY_DERIVATION_OPERATION_INIT;
5408 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5409
5410 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5411
5412 psk = mbedtls_ssl_get_opaque_psk( ssl );
5413
5414 if( hash_alg == MBEDTLS_MD_SHA384 )
5415 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5416 else
5417 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5418
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005419 size_t other_secret_len = 0;
5420 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005421
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005422 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005423 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005424 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005425 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005426 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005427 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005428 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005429 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005430 other_secret_len = 48;
5431 other_secret = handshake->premaster + 2;
5432 break;
5433 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005434 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005435 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5436 other_secret = handshake->premaster + 2;
5437 break;
5438 default:
5439 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005440 }
5441
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005442 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005443 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005444 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005445 (unsigned char const *) lbl,
5446 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005447 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005448 master_secret_len );
5449 if( status != PSA_SUCCESS )
5450 {
5451 psa_key_derivation_abort( &derivation );
5452 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5453 }
5454
5455 status = psa_key_derivation_output_bytes( &derivation,
5456 master,
5457 master_secret_len );
5458 if( status != PSA_SUCCESS )
5459 {
5460 psa_key_derivation_abort( &derivation );
5461 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5462 }
5463
5464 status = psa_key_derivation_abort( &derivation );
5465 if( status != PSA_SUCCESS )
5466 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5467 }
5468 else
5469#endif
5470 {
5471 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005472 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005473 master,
5474 master_secret_len );
5475 if( ret != 0 )
5476 {
5477 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5478 return( ret );
5479 }
5480
5481 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5482 handshake->premaster,
5483 handshake->pmslen );
5484
5485 mbedtls_platform_zeroize( handshake->premaster,
5486 sizeof(handshake->premaster) );
5487 }
5488
5489 return( 0 );
5490}
5491
Jerry Yud62f87e2022-02-17 14:09:02 +08005492int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5493{
5494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5495 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5496 ssl->handshake->ciphersuite_info;
5497
5498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5499
5500 /* Set PRF, calc_verify and calc_finished function pointers */
5501 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005502 ciphersuite_info->mac );
5503 if( ret != 0 )
5504 {
5505 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5506 return( ret );
5507 }
5508
5509 /* Compute master secret if needed */
5510 ret = ssl_compute_master( ssl->handshake,
5511 ssl->session_negotiate->master,
5512 ssl );
5513 if( ret != 0 )
5514 {
5515 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5516 return( ret );
5517 }
5518
5519 /* Swap the client and server random values:
5520 * - MS derivation wanted client+server (RFC 5246 8.1)
5521 * - key derivation wants server+client (RFC 5246 6.3) */
5522 {
5523 unsigned char tmp[64];
5524 memcpy( tmp, ssl->handshake->randbytes, 64 );
5525 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5526 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5527 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5528 }
5529
5530 /* Populate transform structure */
5531 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5532 ssl->session_negotiate->ciphersuite,
5533 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005534#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005535 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005536#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005537 ssl->handshake->tls_prf,
5538 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005539 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005540 ssl->conf->endpoint,
5541 ssl );
5542 if( ret != 0 )
5543 {
5544 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5545 return( ret );
5546 }
5547
5548 /* We no longer need Server/ClientHello.random values */
5549 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5550 sizeof( ssl->handshake->randbytes ) );
5551
5552 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5553
5554 return( 0 );
5555}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005556
Ronald Cron4dcbca92022-03-07 10:21:40 +01005557int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5558{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005559 switch( md )
5560 {
5561#if defined(MBEDTLS_SHA384_C)
5562 case MBEDTLS_SSL_HASH_SHA384:
5563 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5564 break;
5565#endif
5566#if defined(MBEDTLS_SHA256_C)
5567 case MBEDTLS_SSL_HASH_SHA256:
5568 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5569 break;
5570#endif
5571 default:
5572 return( -1 );
5573 }
5574
Ronald Cronc2f13a02022-03-07 10:25:24 +01005575 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005576}
5577
Jerry Yu8392e0d2022-02-17 14:10:24 +08005578#if defined(MBEDTLS_SHA256_C)
5579void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5580 unsigned char *hash,
5581 size_t *hlen )
5582{
5583#if defined(MBEDTLS_USE_PSA_CRYPTO)
5584 size_t hash_size;
5585 psa_status_t status;
5586 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5587
5588 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5589 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5590 if( status != PSA_SUCCESS )
5591 {
5592 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5593 return;
5594 }
5595
5596 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5597 if( status != PSA_SUCCESS )
5598 {
5599 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5600 return;
5601 }
5602
5603 *hlen = 32;
5604 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5605 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5606#else
5607 mbedtls_sha256_context sha256;
5608
5609 mbedtls_sha256_init( &sha256 );
5610
5611 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5612
5613 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5614 mbedtls_sha256_finish( &sha256, hash );
5615
5616 *hlen = 32;
5617
5618 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5619 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5620
5621 mbedtls_sha256_free( &sha256 );
5622#endif /* MBEDTLS_USE_PSA_CRYPTO */
5623 return;
5624}
5625#endif /* MBEDTLS_SHA256_C */
5626
Jerry Yuc1cb3842022-02-17 14:13:48 +08005627#if defined(MBEDTLS_SHA384_C)
5628void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5629 unsigned char *hash,
5630 size_t *hlen )
5631{
5632#if defined(MBEDTLS_USE_PSA_CRYPTO)
5633 size_t hash_size;
5634 psa_status_t status;
5635 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5636
5637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5638 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5639 if( status != PSA_SUCCESS )
5640 {
5641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5642 return;
5643 }
5644
5645 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5646 if( status != PSA_SUCCESS )
5647 {
5648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5649 return;
5650 }
5651
5652 *hlen = 48;
5653 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5655#else
5656 mbedtls_sha512_context sha512;
5657
5658 mbedtls_sha512_init( &sha512 );
5659
5660 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5661
5662 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5663 mbedtls_sha512_finish( &sha512, hash );
5664
5665 *hlen = 48;
5666
5667 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5668 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5669
5670 mbedtls_sha512_free( &sha512 );
5671#endif /* MBEDTLS_USE_PSA_CRYPTO */
5672 return;
5673}
5674#endif /* MBEDTLS_SHA384_C */
5675
Neil Armstrong80f6f322022-05-03 17:56:38 +02005676#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5677 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005678int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5679{
5680 unsigned char *p = ssl->handshake->premaster;
5681 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5682 const unsigned char *psk = NULL;
5683 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005684 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005685
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005686 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005687 {
5688 /*
5689 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005690 * checked before calling this function.
5691 *
5692 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005693 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005694 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005695 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5696 {
5697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5698 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5699 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005700 }
5701
5702 /*
5703 * PMS = struct {
5704 * opaque other_secret<0..2^16-1>;
5705 * opaque psk<0..2^16-1>;
5706 * };
5707 * with "other_secret" depending on the particular key exchange
5708 */
5709#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5710 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5711 {
5712 if( end - p < 2 )
5713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5714
5715 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5716 p += 2;
5717
5718 if( end < p || (size_t)( end - p ) < psk_len )
5719 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5720
5721 memset( p, 0, psk_len );
5722 p += psk_len;
5723 }
5724 else
5725#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5726#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5727 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5728 {
5729 /*
5730 * other_secret already set by the ClientKeyExchange message,
5731 * and is 48 bytes long
5732 */
5733 if( end - p < 2 )
5734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5735
5736 *p++ = 0;
5737 *p++ = 48;
5738 p += 48;
5739 }
5740 else
5741#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5742#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5743 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5744 {
5745 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5746 size_t len;
5747
5748 /* Write length only when we know the actual value */
5749 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5750 p + 2, end - ( p + 2 ), &len,
5751 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5752 {
5753 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5754 return( ret );
5755 }
5756 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5757 p += 2 + len;
5758
5759 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5760 }
5761 else
5762#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005763#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005764 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5765 {
5766 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5767 size_t zlen;
5768
5769 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5770 p + 2, end - ( p + 2 ),
5771 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5772 {
5773 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5774 return( ret );
5775 }
5776
5777 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5778 p += 2 + zlen;
5779
5780 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5781 MBEDTLS_DEBUG_ECDH_Z );
5782 }
5783 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005784#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005785 {
5786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5787 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5788 }
5789
5790 /* opaque psk<0..2^16-1>; */
5791 if( end - p < 2 )
5792 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5793
5794 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5795 p += 2;
5796
5797 if( end < p || (size_t)( end - p ) < psk_len )
5798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5799
5800 memcpy( p, psk, psk_len );
5801 p += psk_len;
5802
5803 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5804
5805 return( 0 );
5806}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005807#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005808
5809#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005810MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08005811static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5812
5813#if defined(MBEDTLS_SSL_PROTO_DTLS)
5814int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5815{
5816 /* If renegotiation is not enforced, retransmit until we would reach max
5817 * timeout if we were using the usual handshake doubling scheme */
5818 if( ssl->conf->renego_max_records < 0 )
5819 {
5820 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5821 unsigned char doublings = 1;
5822
5823 while( ratio != 0 )
5824 {
5825 ++doublings;
5826 ratio >>= 1;
5827 }
5828
5829 if( ++ssl->renego_records_seen > doublings )
5830 {
5831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5832 return( 0 );
5833 }
5834 }
5835
5836 return( ssl_write_hello_request( ssl ) );
5837}
5838#endif
5839#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005840
Jerry Yud9526692022-02-17 14:23:47 +08005841/*
5842 * Handshake functions
5843 */
5844#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5845/* No certificate support -> dummy functions */
5846int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5847{
5848 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5849 ssl->handshake->ciphersuite_info;
5850
5851 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5852
5853 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5854 {
5855 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5856 ssl->state++;
5857 return( 0 );
5858 }
5859
5860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5861 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5862}
5863
5864int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5865{
5866 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5867 ssl->handshake->ciphersuite_info;
5868
5869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5870
5871 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5872 {
5873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5874 ssl->state++;
5875 return( 0 );
5876 }
5877
5878 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5879 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5880}
5881
5882#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5883/* Some certificate support -> implement write and parse */
5884
5885int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5886{
5887 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5888 size_t i, n;
5889 const mbedtls_x509_crt *crt;
5890 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5891 ssl->handshake->ciphersuite_info;
5892
5893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5894
5895 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5896 {
5897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5898 ssl->state++;
5899 return( 0 );
5900 }
5901
5902#if defined(MBEDTLS_SSL_CLI_C)
5903 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5904 {
5905 if( ssl->handshake->client_auth == 0 )
5906 {
5907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5908 ssl->state++;
5909 return( 0 );
5910 }
5911 }
5912#endif /* MBEDTLS_SSL_CLI_C */
5913#if defined(MBEDTLS_SSL_SRV_C)
5914 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5915 {
5916 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5917 {
5918 /* Should never happen because we shouldn't have picked the
5919 * ciphersuite if we don't have a certificate. */
5920 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5921 }
5922 }
5923#endif
5924
5925 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5926
5927 /*
5928 * 0 . 0 handshake type
5929 * 1 . 3 handshake length
5930 * 4 . 6 length of all certs
5931 * 7 . 9 length of cert. 1
5932 * 10 . n-1 peer certificate
5933 * n . n+2 length of cert. 2
5934 * n+3 . ... upper level cert, etc.
5935 */
5936 i = 7;
5937 crt = mbedtls_ssl_own_cert( ssl );
5938
5939 while( crt != NULL )
5940 {
5941 n = crt->raw.len;
5942 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5943 {
5944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5945 " > %" MBEDTLS_PRINTF_SIZET,
5946 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5947 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5948 }
5949
5950 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5951 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5952 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5953
5954 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5955 i += n; crt = crt->next;
5956 }
5957
5958 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5959 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5960 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5961
5962 ssl->out_msglen = i;
5963 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5964 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5965
5966 ssl->state++;
5967
5968 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5969 {
5970 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5971 return( ret );
5972 }
5973
5974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5975
5976 return( ret );
5977}
5978
5979#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5980
5981#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005982MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08005983static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5984 unsigned char *crt_buf,
5985 size_t crt_buf_len )
5986{
5987 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5988
5989 if( peer_crt == NULL )
5990 return( -1 );
5991
5992 if( peer_crt->raw.len != crt_buf_len )
5993 return( -1 );
5994
5995 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5996}
5997#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005998MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08005999static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6000 unsigned char *crt_buf,
6001 size_t crt_buf_len )
6002{
6003 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6004 unsigned char const * const peer_cert_digest =
6005 ssl->session->peer_cert_digest;
6006 mbedtls_md_type_t const peer_cert_digest_type =
6007 ssl->session->peer_cert_digest_type;
6008 mbedtls_md_info_t const * const digest_info =
6009 mbedtls_md_info_from_type( peer_cert_digest_type );
6010 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6011 size_t digest_len;
6012
6013 if( peer_cert_digest == NULL || digest_info == NULL )
6014 return( -1 );
6015
6016 digest_len = mbedtls_md_get_size( digest_info );
6017 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6018 return( -1 );
6019
6020 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6021 if( ret != 0 )
6022 return( -1 );
6023
6024 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6025}
6026#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6027#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6028
6029/*
6030 * Once the certificate message is read, parse it into a cert chain and
6031 * perform basic checks, but leave actual verification to the caller
6032 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006033MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006034static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6035 mbedtls_x509_crt *chain )
6036{
6037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6038#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6039 int crt_cnt=0;
6040#endif
6041 size_t i, n;
6042 uint8_t alert;
6043
6044 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6045 {
6046 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6047 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6048 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6049 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6050 }
6051
6052 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6053 {
6054 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6055 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6056 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6057 }
6058
6059 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6060 {
6061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6062 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6063 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6064 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6065 }
6066
6067 i = mbedtls_ssl_hs_hdr_len( ssl );
6068
6069 /*
6070 * Same message structure as in mbedtls_ssl_write_certificate()
6071 */
6072 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6073
6074 if( ssl->in_msg[i] != 0 ||
6075 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6076 {
6077 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6078 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6079 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6080 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6081 }
6082
6083 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6084 i += 3;
6085
6086 /* Iterate through and parse the CRTs in the provided chain. */
6087 while( i < ssl->in_hslen )
6088 {
6089 /* Check that there's room for the next CRT's length fields. */
6090 if ( i + 3 > ssl->in_hslen ) {
6091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6092 mbedtls_ssl_send_alert_message( ssl,
6093 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6094 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6095 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6096 }
6097 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6098 * anything beyond 2**16 ~ 64K. */
6099 if( ssl->in_msg[i] != 0 )
6100 {
6101 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6102 mbedtls_ssl_send_alert_message( ssl,
6103 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6104 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6105 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6106 }
6107
6108 /* Read length of the next CRT in the chain. */
6109 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6110 | (unsigned int) ssl->in_msg[i + 2];
6111 i += 3;
6112
6113 if( n < 128 || i + n > ssl->in_hslen )
6114 {
6115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6116 mbedtls_ssl_send_alert_message( ssl,
6117 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6118 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6119 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6120 }
6121
6122 /* Check if we're handling the first CRT in the chain. */
6123#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6124 if( crt_cnt++ == 0 &&
6125 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6126 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6127 {
6128 /* During client-side renegotiation, check that the server's
6129 * end-CRTs hasn't changed compared to the initial handshake,
6130 * mitigating the triple handshake attack. On success, reuse
6131 * the original end-CRT instead of parsing it again. */
6132 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6133 if( ssl_check_peer_crt_unchanged( ssl,
6134 &ssl->in_msg[i],
6135 n ) != 0 )
6136 {
6137 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6138 mbedtls_ssl_send_alert_message( ssl,
6139 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6140 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6141 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6142 }
6143
6144 /* Now we can safely free the original chain. */
6145 ssl_clear_peer_cert( ssl->session );
6146 }
6147#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6148
6149 /* Parse the next certificate in the chain. */
6150#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6151 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6152#else
6153 /* If we don't need to store the CRT chain permanently, parse
6154 * it in-place from the input buffer instead of making a copy. */
6155 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6156#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6157 switch( ret )
6158 {
6159 case 0: /*ok*/
6160 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6161 /* Ignore certificate with an unknown algorithm: maybe a
6162 prior certificate was already trusted. */
6163 break;
6164
6165 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6166 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6167 goto crt_parse_der_failed;
6168
6169 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6170 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6171 goto crt_parse_der_failed;
6172
6173 default:
6174 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6175 crt_parse_der_failed:
6176 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6177 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6178 return( ret );
6179 }
6180
6181 i += n;
6182 }
6183
6184 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6185 return( 0 );
6186}
6187
6188#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006189MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006190static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6191{
6192 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6193 return( -1 );
6194
6195 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6196 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6197 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6198 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6199 {
6200 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
6201 return( 0 );
6202 }
6203 return( -1 );
6204}
6205#endif /* MBEDTLS_SSL_SRV_C */
6206
6207/* Check if a certificate message is expected.
6208 * Return either
6209 * - SSL_CERTIFICATE_EXPECTED, or
6210 * - SSL_CERTIFICATE_SKIP
6211 * indicating whether a Certificate message is expected or not.
6212 */
6213#define SSL_CERTIFICATE_EXPECTED 0
6214#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006215MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006216static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6217 int authmode )
6218{
6219 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6220 ssl->handshake->ciphersuite_info;
6221
6222 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6223 return( SSL_CERTIFICATE_SKIP );
6224
6225#if defined(MBEDTLS_SSL_SRV_C)
6226 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6227 {
6228 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6229 return( SSL_CERTIFICATE_SKIP );
6230
6231 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6232 {
6233 ssl->session_negotiate->verify_result =
6234 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6235 return( SSL_CERTIFICATE_SKIP );
6236 }
6237 }
6238#else
6239 ((void) authmode);
6240#endif /* MBEDTLS_SSL_SRV_C */
6241
6242 return( SSL_CERTIFICATE_EXPECTED );
6243}
6244
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006245MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006246static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6247 int authmode,
6248 mbedtls_x509_crt *chain,
6249 void *rs_ctx )
6250{
6251 int ret = 0;
6252 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6253 ssl->handshake->ciphersuite_info;
6254 int have_ca_chain = 0;
6255
6256 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6257 void *p_vrfy;
6258
6259 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6260 return( 0 );
6261
6262 if( ssl->f_vrfy != NULL )
6263 {
6264 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6265 f_vrfy = ssl->f_vrfy;
6266 p_vrfy = ssl->p_vrfy;
6267 }
6268 else
6269 {
6270 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6271 f_vrfy = ssl->conf->f_vrfy;
6272 p_vrfy = ssl->conf->p_vrfy;
6273 }
6274
6275 /*
6276 * Main check: verify certificate
6277 */
6278#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6279 if( ssl->conf->f_ca_cb != NULL )
6280 {
6281 ((void) rs_ctx);
6282 have_ca_chain = 1;
6283
6284 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6285 ret = mbedtls_x509_crt_verify_with_ca_cb(
6286 chain,
6287 ssl->conf->f_ca_cb,
6288 ssl->conf->p_ca_cb,
6289 ssl->conf->cert_profile,
6290 ssl->hostname,
6291 &ssl->session_negotiate->verify_result,
6292 f_vrfy, p_vrfy );
6293 }
6294 else
6295#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6296 {
6297 mbedtls_x509_crt *ca_chain;
6298 mbedtls_x509_crl *ca_crl;
6299
6300#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6301 if( ssl->handshake->sni_ca_chain != NULL )
6302 {
6303 ca_chain = ssl->handshake->sni_ca_chain;
6304 ca_crl = ssl->handshake->sni_ca_crl;
6305 }
6306 else
6307#endif
6308 {
6309 ca_chain = ssl->conf->ca_chain;
6310 ca_crl = ssl->conf->ca_crl;
6311 }
6312
6313 if( ca_chain != NULL )
6314 have_ca_chain = 1;
6315
6316 ret = mbedtls_x509_crt_verify_restartable(
6317 chain,
6318 ca_chain, ca_crl,
6319 ssl->conf->cert_profile,
6320 ssl->hostname,
6321 &ssl->session_negotiate->verify_result,
6322 f_vrfy, p_vrfy, rs_ctx );
6323 }
6324
6325 if( ret != 0 )
6326 {
6327 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6328 }
6329
6330#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6331 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6332 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6333#endif
6334
6335 /*
6336 * Secondary checks: always done, but change 'ret' only if it was 0
6337 */
6338
6339#if defined(MBEDTLS_ECP_C)
6340 {
6341 const mbedtls_pk_context *pk = &chain->pk;
6342
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006343 /* If certificate uses an EC key, make sure the curve is OK.
6344 * This is a public key, so it can't be opaque, so can_do() is a good
6345 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006346 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6347 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6348 {
6349 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6350
6351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6352 if( ret == 0 )
6353 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6354 }
6355 }
6356#endif /* MBEDTLS_ECP_C */
6357
6358 if( mbedtls_ssl_check_cert_usage( chain,
6359 ciphersuite_info,
6360 ! ssl->conf->endpoint,
6361 &ssl->session_negotiate->verify_result ) != 0 )
6362 {
6363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6364 if( ret == 0 )
6365 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6366 }
6367
6368 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6369 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6370 * with details encoded in the verification flags. All other kinds
6371 * of error codes, including those from the user provided f_vrfy
6372 * functions, are treated as fatal and lead to a failure of
6373 * ssl_parse_certificate even if verification was optional. */
6374 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6375 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6376 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6377 {
6378 ret = 0;
6379 }
6380
6381 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6382 {
6383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6384 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6385 }
6386
6387 if( ret != 0 )
6388 {
6389 uint8_t alert;
6390
6391 /* The certificate may have been rejected for several reasons.
6392 Pick one and send the corresponding alert. Which alert to send
6393 may be a subject of debate in some cases. */
6394 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6395 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6396 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6397 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6398 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6399 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6400 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6401 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6402 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6403 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6404 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6405 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6406 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6407 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6408 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6409 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6410 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6411 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6412 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6413 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6414 else
6415 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6416 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6417 alert );
6418 }
6419
6420#if defined(MBEDTLS_DEBUG_C)
6421 if( ssl->session_negotiate->verify_result != 0 )
6422 {
6423 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6424 (unsigned int) ssl->session_negotiate->verify_result ) );
6425 }
6426 else
6427 {
6428 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6429 }
6430#endif /* MBEDTLS_DEBUG_C */
6431
6432 return( ret );
6433}
6434
6435#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006436MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006437static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6438 unsigned char *start, size_t len )
6439{
6440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6441 /* Remember digest of the peer's end-CRT. */
6442 ssl->session_negotiate->peer_cert_digest =
6443 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6444 if( ssl->session_negotiate->peer_cert_digest == NULL )
6445 {
6446 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6447 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6448 mbedtls_ssl_send_alert_message( ssl,
6449 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6450 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6451
6452 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6453 }
6454
6455 ret = mbedtls_md( mbedtls_md_info_from_type(
6456 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6457 start, len,
6458 ssl->session_negotiate->peer_cert_digest );
6459
6460 ssl->session_negotiate->peer_cert_digest_type =
6461 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6462 ssl->session_negotiate->peer_cert_digest_len =
6463 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6464
6465 return( ret );
6466}
6467
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006468MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006469static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6470 unsigned char *start, size_t len )
6471{
6472 unsigned char *end = start + len;
6473 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6474
6475 /* Make a copy of the peer's raw public key. */
6476 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6477 ret = mbedtls_pk_parse_subpubkey( &start, end,
6478 &ssl->handshake->peer_pubkey );
6479 if( ret != 0 )
6480 {
6481 /* We should have parsed the public key before. */
6482 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6483 }
6484
6485 return( 0 );
6486}
6487#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6488
6489int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6490{
6491 int ret = 0;
6492 int crt_expected;
6493#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6494 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6495 ? ssl->handshake->sni_authmode
6496 : ssl->conf->authmode;
6497#else
6498 const int authmode = ssl->conf->authmode;
6499#endif
6500 void *rs_ctx = NULL;
6501 mbedtls_x509_crt *chain = NULL;
6502
6503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6504
6505 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6506 if( crt_expected == SSL_CERTIFICATE_SKIP )
6507 {
6508 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6509 goto exit;
6510 }
6511
6512#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6513 if( ssl->handshake->ecrs_enabled &&
6514 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6515 {
6516 chain = ssl->handshake->ecrs_peer_cert;
6517 ssl->handshake->ecrs_peer_cert = NULL;
6518 goto crt_verify;
6519 }
6520#endif
6521
6522 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6523 {
6524 /* mbedtls_ssl_read_record may have sent an alert already. We
6525 let it decide whether to alert. */
6526 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6527 goto exit;
6528 }
6529
6530#if defined(MBEDTLS_SSL_SRV_C)
6531 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6532 {
6533 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6534
6535 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6536 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6537
6538 goto exit;
6539 }
6540#endif /* MBEDTLS_SSL_SRV_C */
6541
6542 /* Clear existing peer CRT structure in case we tried to
6543 * reuse a session but it failed, and allocate a new one. */
6544 ssl_clear_peer_cert( ssl->session_negotiate );
6545
6546 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6547 if( chain == NULL )
6548 {
6549 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6550 sizeof( mbedtls_x509_crt ) ) );
6551 mbedtls_ssl_send_alert_message( ssl,
6552 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6553 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6554
6555 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6556 goto exit;
6557 }
6558 mbedtls_x509_crt_init( chain );
6559
6560 ret = ssl_parse_certificate_chain( ssl, chain );
6561 if( ret != 0 )
6562 goto exit;
6563
6564#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6565 if( ssl->handshake->ecrs_enabled)
6566 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6567
6568crt_verify:
6569 if( ssl->handshake->ecrs_enabled)
6570 rs_ctx = &ssl->handshake->ecrs_ctx;
6571#endif
6572
6573 ret = ssl_parse_certificate_verify( ssl, authmode,
6574 chain, rs_ctx );
6575 if( ret != 0 )
6576 goto exit;
6577
6578#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6579 {
6580 unsigned char *crt_start, *pk_start;
6581 size_t crt_len, pk_len;
6582
6583 /* We parse the CRT chain without copying, so
6584 * these pointers point into the input buffer,
6585 * and are hence still valid after freeing the
6586 * CRT chain. */
6587
6588 crt_start = chain->raw.p;
6589 crt_len = chain->raw.len;
6590
6591 pk_start = chain->pk_raw.p;
6592 pk_len = chain->pk_raw.len;
6593
6594 /* Free the CRT structures before computing
6595 * digest and copying the peer's public key. */
6596 mbedtls_x509_crt_free( chain );
6597 mbedtls_free( chain );
6598 chain = NULL;
6599
6600 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6601 if( ret != 0 )
6602 goto exit;
6603
6604 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6605 if( ret != 0 )
6606 goto exit;
6607 }
6608#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6609 /* Pass ownership to session structure. */
6610 ssl->session_negotiate->peer_cert = chain;
6611 chain = NULL;
6612#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6613
6614 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6615
6616exit:
6617
6618 if( ret == 0 )
6619 ssl->state++;
6620
6621#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6622 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6623 {
6624 ssl->handshake->ecrs_peer_cert = chain;
6625 chain = NULL;
6626 }
6627#endif
6628
6629 if( chain != NULL )
6630 {
6631 mbedtls_x509_crt_free( chain );
6632 mbedtls_free( chain );
6633 }
6634
6635 return( ret );
6636}
6637#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6638
Jerry Yu615bd6f2022-02-17 14:25:15 +08006639#if defined(MBEDTLS_SHA256_C)
6640static void ssl_calc_finished_tls_sha256(
6641 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6642{
6643 int len = 12;
6644 const char *sender;
6645 unsigned char padbuf[32];
6646#if defined(MBEDTLS_USE_PSA_CRYPTO)
6647 size_t hash_size;
6648 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6649 psa_status_t status;
6650#else
6651 mbedtls_sha256_context sha256;
6652#endif
6653
6654 mbedtls_ssl_session *session = ssl->session_negotiate;
6655 if( !session )
6656 session = ssl->session;
6657
6658 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6659 ? "client finished"
6660 : "server finished";
6661
6662#if defined(MBEDTLS_USE_PSA_CRYPTO)
6663 sha256_psa = psa_hash_operation_init();
6664
6665 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6666
6667 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6668 if( status != PSA_SUCCESS )
6669 {
6670 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6671 return;
6672 }
6673
6674 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6675 if( status != PSA_SUCCESS )
6676 {
6677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6678 return;
6679 }
6680 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6681#else
6682
6683 mbedtls_sha256_init( &sha256 );
6684
6685 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6686
6687 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6688
6689 /*
6690 * TLSv1.2:
6691 * hash = PRF( master, finished_label,
6692 * Hash( handshake ) )[0.11]
6693 */
6694
6695#if !defined(MBEDTLS_SHA256_ALT)
6696 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6697 sha256.state, sizeof( sha256.state ) );
6698#endif
6699
6700 mbedtls_sha256_finish( &sha256, padbuf );
6701 mbedtls_sha256_free( &sha256 );
6702#endif /* MBEDTLS_USE_PSA_CRYPTO */
6703
6704 ssl->handshake->tls_prf( session->master, 48, sender,
6705 padbuf, 32, buf, len );
6706
6707 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6708
6709 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6710
6711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6712}
6713#endif /* MBEDTLS_SHA256_C */
6714
Jerry Yub7ba49e2022-02-17 14:25:53 +08006715
6716#if defined(MBEDTLS_SHA384_C)
6717
6718static void ssl_calc_finished_tls_sha384(
6719 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6720{
6721 int len = 12;
6722 const char *sender;
6723 unsigned char padbuf[48];
6724#if defined(MBEDTLS_USE_PSA_CRYPTO)
6725 size_t hash_size;
6726 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6727 psa_status_t status;
6728#else
6729 mbedtls_sha512_context sha512;
6730#endif
6731
6732 mbedtls_ssl_session *session = ssl->session_negotiate;
6733 if( !session )
6734 session = ssl->session;
6735
6736 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6737 ? "client finished"
6738 : "server finished";
6739
6740#if defined(MBEDTLS_USE_PSA_CRYPTO)
6741 sha384_psa = psa_hash_operation_init();
6742
6743 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6744
6745 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6746 if( status != PSA_SUCCESS )
6747 {
6748 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6749 return;
6750 }
6751
6752 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6753 if( status != PSA_SUCCESS )
6754 {
6755 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6756 return;
6757 }
6758 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6759#else
6760 mbedtls_sha512_init( &sha512 );
6761
6762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6763
6764 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6765
6766 /*
6767 * TLSv1.2:
6768 * hash = PRF( master, finished_label,
6769 * Hash( handshake ) )[0.11]
6770 */
6771
6772#if !defined(MBEDTLS_SHA512_ALT)
6773 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6774 sha512.state, sizeof( sha512.state ) );
6775#endif
6776 mbedtls_sha512_finish( &sha512, padbuf );
6777
6778 mbedtls_sha512_free( &sha512 );
6779#endif
6780
6781 ssl->handshake->tls_prf( session->master, 48, sender,
6782 padbuf, 48, buf, len );
6783
6784 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6785
6786 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6787
6788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6789}
6790#endif /* MBEDTLS_SHA384_C */
6791
Jerry Yuaef00152022-02-17 14:27:31 +08006792void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6793{
6794 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6795
6796 /*
6797 * Free our handshake params
6798 */
6799 mbedtls_ssl_handshake_free( ssl );
6800 mbedtls_free( ssl->handshake );
6801 ssl->handshake = NULL;
6802
6803 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006804 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006805 */
6806 if( ssl->transform )
6807 {
6808 mbedtls_ssl_transform_free( ssl->transform );
6809 mbedtls_free( ssl->transform );
6810 }
6811 ssl->transform = ssl->transform_negotiate;
6812 ssl->transform_negotiate = NULL;
6813
6814 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6815}
6816
Jerry Yu2a9fff52022-02-17 14:28:51 +08006817void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6818{
6819 int resume = ssl->handshake->resume;
6820
6821 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6822
6823#if defined(MBEDTLS_SSL_RENEGOTIATION)
6824 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6825 {
6826 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6827 ssl->renego_records_seen = 0;
6828 }
6829#endif
6830
6831 /*
6832 * Free the previous session and switch in the current one
6833 */
6834 if( ssl->session )
6835 {
6836#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6837 /* RFC 7366 3.1: keep the EtM state */
6838 ssl->session_negotiate->encrypt_then_mac =
6839 ssl->session->encrypt_then_mac;
6840#endif
6841
6842 mbedtls_ssl_session_free( ssl->session );
6843 mbedtls_free( ssl->session );
6844 }
6845 ssl->session = ssl->session_negotiate;
6846 ssl->session_negotiate = NULL;
6847
6848 /*
6849 * Add cache entry
6850 */
6851 if( ssl->conf->f_set_cache != NULL &&
6852 ssl->session->id_len != 0 &&
6853 resume == 0 )
6854 {
6855 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6856 ssl->session->id,
6857 ssl->session->id_len,
6858 ssl->session ) != 0 )
6859 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6860 }
6861
6862#if defined(MBEDTLS_SSL_PROTO_DTLS)
6863 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6864 ssl->handshake->flight != NULL )
6865 {
6866 /* Cancel handshake timer */
6867 mbedtls_ssl_set_timer( ssl, 0 );
6868
6869 /* Keep last flight around in case we need to resend it:
6870 * we need the handshake and transform structures for that */
6871 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6872 }
6873 else
6874#endif
6875 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6876
6877 ssl->state++;
6878
6879 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6880}
6881
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006882int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6883{
6884 int ret, hash_len;
6885
6886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6887
6888 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6889
6890 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6891
6892 /*
6893 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6894 * may define some other value. Currently (early 2016), no defined
6895 * ciphersuite does this (and this is unlikely to change as activity has
6896 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6897 */
6898 hash_len = 12;
6899
6900#if defined(MBEDTLS_SSL_RENEGOTIATION)
6901 ssl->verify_data_len = hash_len;
6902 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6903#endif
6904
6905 ssl->out_msglen = 4 + hash_len;
6906 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6907 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6908
6909 /*
6910 * In case of session resuming, invert the client and server
6911 * ChangeCipherSpec messages order.
6912 */
6913 if( ssl->handshake->resume != 0 )
6914 {
6915#if defined(MBEDTLS_SSL_CLI_C)
6916 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6917 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6918#endif
6919#if defined(MBEDTLS_SSL_SRV_C)
6920 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6921 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6922#endif
6923 }
6924 else
6925 ssl->state++;
6926
6927 /*
6928 * Switch to our negotiated transform and session parameters for outbound
6929 * data.
6930 */
6931 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6932
6933#if defined(MBEDTLS_SSL_PROTO_DTLS)
6934 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6935 {
6936 unsigned char i;
6937
6938 /* Remember current epoch settings for resending */
6939 ssl->handshake->alt_transform_out = ssl->transform_out;
6940 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6941 sizeof( ssl->handshake->alt_out_ctr ) );
6942
6943 /* Set sequence_number to zero */
6944 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6945
6946
6947 /* Increment epoch */
6948 for( i = 2; i > 0; i-- )
6949 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6950 break;
6951
6952 /* The loop goes to its end iff the counter is wrapping */
6953 if( i == 0 )
6954 {
6955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6956 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6957 }
6958 }
6959 else
6960#endif /* MBEDTLS_SSL_PROTO_DTLS */
6961 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6962
6963 ssl->transform_out = ssl->transform_negotiate;
6964 ssl->session_out = ssl->session_negotiate;
6965
6966#if defined(MBEDTLS_SSL_PROTO_DTLS)
6967 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6968 mbedtls_ssl_send_flight_completed( ssl );
6969#endif
6970
6971 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6972 {
6973 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6974 return( ret );
6975 }
6976
6977#if defined(MBEDTLS_SSL_PROTO_DTLS)
6978 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6979 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6980 {
6981 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6982 return( ret );
6983 }
6984#endif
6985
6986 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6987
6988 return( 0 );
6989}
6990
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006991#define SSL_MAX_HASH_LEN 12
6992
6993int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6994{
6995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6996 unsigned int hash_len = 12;
6997 unsigned char buf[SSL_MAX_HASH_LEN];
6998
6999 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7000
7001 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7002
7003 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7004 {
7005 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7006 goto exit;
7007 }
7008
7009 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7010 {
7011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7012 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7013 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7014 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7015 goto exit;
7016 }
7017
7018 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7019 {
7020 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7021 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7022 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7023 goto exit;
7024 }
7025
7026 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7027 {
7028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7029 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7030 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7031 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7032 goto exit;
7033 }
7034
7035 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7036 buf, hash_len ) != 0 )
7037 {
7038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7039 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7040 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7041 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7042 goto exit;
7043 }
7044
7045#if defined(MBEDTLS_SSL_RENEGOTIATION)
7046 ssl->verify_data_len = hash_len;
7047 memcpy( ssl->peer_verify_data, buf, hash_len );
7048#endif
7049
7050 if( ssl->handshake->resume != 0 )
7051 {
7052#if defined(MBEDTLS_SSL_CLI_C)
7053 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7054 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7055#endif
7056#if defined(MBEDTLS_SSL_SRV_C)
7057 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7058 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7059#endif
7060 }
7061 else
7062 ssl->state++;
7063
7064#if defined(MBEDTLS_SSL_PROTO_DTLS)
7065 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7066 mbedtls_ssl_recv_flight_completed( ssl );
7067#endif
7068
7069 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7070
7071exit:
7072 mbedtls_platform_zeroize( buf, hash_len );
7073 return( ret );
7074}
7075
Jerry Yu392112c2022-02-17 14:34:10 +08007076#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7077/*
7078 * Helper to get TLS 1.2 PRF from ciphersuite
7079 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7080 */
7081static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7082{
7083#if defined(MBEDTLS_SHA384_C)
7084 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7085 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7086
7087 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7088 return( tls_prf_sha384 );
7089#else
7090 (void) ciphersuite_id;
7091#endif
7092 return( tls_prf_sha256 );
7093}
7094#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007095
7096static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7097{
7098 ((void) tls_prf);
7099#if defined(MBEDTLS_SHA384_C)
7100 if( tls_prf == tls_prf_sha384 )
7101 {
7102 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7103 }
7104 else
7105#endif
7106#if defined(MBEDTLS_SHA256_C)
7107 if( tls_prf == tls_prf_sha256 )
7108 {
7109 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7110 }
7111 else
7112#endif
7113 return( MBEDTLS_SSL_TLS_PRF_NONE );
7114}
7115
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007116/*
7117 * Populate a transform structure with session keys and all the other
7118 * necessary information.
7119 *
7120 * Parameters:
7121 * - [in/out]: transform: structure to populate
7122 * [in] must be just initialised with mbedtls_ssl_transform_init()
7123 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7124 * - [in] ciphersuite
7125 * - [in] master
7126 * - [in] encrypt_then_mac
7127 * - [in] compression
7128 * - [in] tls_prf: pointer to PRF to use for key derivation
7129 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007130 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007131 * - [in] endpoint: client or server
7132 * - [in] ssl: used for:
7133 * - ssl->conf->{f,p}_export_keys
7134 * [in] optionally used for:
7135 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7136 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007137MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007138static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7139 int ciphersuite,
7140 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007141#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007142 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007143#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007144 ssl_tls_prf_t tls_prf,
7145 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007146 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007147 unsigned endpoint,
7148 const mbedtls_ssl_context *ssl )
7149{
7150 int ret = 0;
7151 unsigned char keyblk[256];
7152 unsigned char *key1;
7153 unsigned char *key2;
7154 unsigned char *mac_enc;
7155 unsigned char *mac_dec;
7156 size_t mac_key_len = 0;
7157 size_t iv_copy_len;
7158 size_t keylen;
7159 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007160 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007161#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007162 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007163 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007164#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007165
7166#if defined(MBEDTLS_USE_PSA_CRYPTO)
7167 psa_key_type_t key_type;
7168 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7169 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007170 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007171 size_t key_bits;
7172 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7173#endif
7174
7175#if !defined(MBEDTLS_DEBUG_C) && \
7176 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7177 if( ssl->f_export_keys == NULL )
7178 {
7179 ssl = NULL; /* make sure we don't use it except for these cases */
7180 (void) ssl;
7181 }
7182#endif
7183
7184 /*
7185 * Some data just needs copying into the structure
7186 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007187#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007188 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007189#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007190 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007191
7192#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7193 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7194#endif
7195
7196#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007197 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007198 {
7199 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7200 * generation separate. This should never happen. */
7201 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7202 }
7203#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7204
7205 /*
7206 * Get various info structures
7207 */
7208 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7209 if( ciphersuite_info == NULL )
7210 {
7211 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7212 ciphersuite ) );
7213 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7214 }
7215
Neil Armstrongab555e02022-04-04 11:07:59 +02007216 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007217#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007218 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007219#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007220 ciphersuite_info );
7221
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007222 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7223 transform->taglen =
7224 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7225
7226#if defined(MBEDTLS_USE_PSA_CRYPTO)
7227 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7228 transform->taglen,
7229 &alg,
7230 &key_type,
7231 &key_bits ) ) != PSA_SUCCESS )
7232 {
7233 ret = psa_ssl_status_to_mbedtls( status );
7234 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7235 goto end;
7236 }
7237#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007238 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7239 if( cipher_info == NULL )
7240 {
7241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7242 ciphersuite_info->cipher ) );
7243 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7244 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007245#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007246
Neil Armstronge4512952022-03-08 09:08:22 +01007247#if defined(MBEDTLS_USE_PSA_CRYPTO)
7248 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7249 if( mac_alg == 0 )
7250 {
7251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7252 (unsigned) ciphersuite_info->mac ) );
7253 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7254 }
7255#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007256 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7257 if( md_info == NULL )
7258 {
7259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7260 (unsigned) ciphersuite_info->mac ) );
7261 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7262 }
Neil Armstronge4512952022-03-08 09:08:22 +01007263#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007264
7265#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7266 /* Copy own and peer's CID if the use of the CID
7267 * extension has been negotiated. */
7268 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7269 {
7270 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7271
7272 transform->in_cid_len = ssl->own_cid_len;
7273 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7274 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7275 transform->in_cid_len );
7276
7277 transform->out_cid_len = ssl->handshake->peer_cid_len;
7278 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7279 ssl->handshake->peer_cid_len );
7280 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7281 transform->out_cid_len );
7282 }
7283#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7284
7285 /*
7286 * Compute key block using the PRF
7287 */
7288 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7289 if( ret != 0 )
7290 {
7291 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7292 return( ret );
7293 }
7294
7295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7296 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7297 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7298 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7299 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7300
7301 /*
7302 * Determine the appropriate key, IV and MAC length.
7303 */
7304
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007305#if defined(MBEDTLS_USE_PSA_CRYPTO)
7306 keylen = PSA_BITS_TO_BYTES(key_bits);
7307#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007308 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007309#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007310
7311#if defined(MBEDTLS_GCM_C) || \
7312 defined(MBEDTLS_CCM_C) || \
7313 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007314 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007315 {
7316 size_t explicit_ivlen;
7317
7318 transform->maclen = 0;
7319 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007320
7321 /* All modes haves 96-bit IVs, but the length of the static parts vary
7322 * with mode and version:
7323 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7324 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7325 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7326 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7327 * sequence number).
7328 */
7329 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007330#if defined(MBEDTLS_USE_PSA_CRYPTO)
7331 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7332#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007333 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007334#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007335 transform->fixed_ivlen = 12;
7336 else
7337 transform->fixed_ivlen = 4;
7338
7339 /* Minimum length of encrypted record */
7340 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7341 transform->minlen = explicit_ivlen + transform->taglen;
7342 }
7343 else
7344#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7345#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007346 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7347 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7348 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007349 {
Neil Armstronge4512952022-03-08 09:08:22 +01007350#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007351 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007352#else
7353 size_t block_size = cipher_info->block_size;
7354#endif /* MBEDTLS_USE_PSA_CRYPTO */
7355
7356#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007357 /* Get MAC length */
7358 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7359#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007360 /* Initialize HMAC contexts */
7361 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7362 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7363 {
7364 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7365 goto end;
7366 }
7367
7368 /* Get MAC length */
7369 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007370#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007371 transform->maclen = mac_key_len;
7372
7373 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007374#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007375 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007376#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007377 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007378#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007379
7380 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007381 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007382 transform->minlen = transform->maclen;
7383 else
7384 {
7385 /*
7386 * GenericBlockCipher:
7387 * 1. if EtM is in use: one block plus MAC
7388 * otherwise: * first multiple of blocklen greater than maclen
7389 * 2. IV
7390 */
7391#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007392 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007393 {
7394 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007395 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007396 }
7397 else
7398#endif
7399 {
7400 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007401 + block_size
7402 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007403 }
7404
Glenn Strauss07c64162022-03-14 12:34:51 -04007405 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007406 {
7407 transform->minlen += transform->ivlen;
7408 }
7409 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007410 {
7411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7412 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7413 goto end;
7414 }
7415 }
7416 }
7417 else
7418#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7419 {
7420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7421 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7422 }
7423
7424 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7425 (unsigned) keylen,
7426 (unsigned) transform->minlen,
7427 (unsigned) transform->ivlen,
7428 (unsigned) transform->maclen ) );
7429
7430 /*
7431 * Finally setup the cipher contexts, IVs and MAC secrets.
7432 */
7433#if defined(MBEDTLS_SSL_CLI_C)
7434 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7435 {
7436 key1 = keyblk + mac_key_len * 2;
7437 key2 = keyblk + mac_key_len * 2 + keylen;
7438
7439 mac_enc = keyblk;
7440 mac_dec = keyblk + mac_key_len;
7441
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007442 iv_copy_len = ( transform->fixed_ivlen ) ?
7443 transform->fixed_ivlen : transform->ivlen;
7444 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7445 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7446 iv_copy_len );
7447 }
7448 else
7449#endif /* MBEDTLS_SSL_CLI_C */
7450#if defined(MBEDTLS_SSL_SRV_C)
7451 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7452 {
7453 key1 = keyblk + mac_key_len * 2 + keylen;
7454 key2 = keyblk + mac_key_len * 2;
7455
7456 mac_enc = keyblk + mac_key_len;
7457 mac_dec = keyblk;
7458
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007459 iv_copy_len = ( transform->fixed_ivlen ) ?
7460 transform->fixed_ivlen : transform->ivlen;
7461 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7462 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7463 iv_copy_len );
7464 }
7465 else
7466#endif /* MBEDTLS_SSL_SRV_C */
7467 {
7468 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7469 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7470 goto end;
7471 }
7472
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007473 if( ssl != NULL && ssl->f_export_keys != NULL )
7474 {
7475 ssl->f_export_keys( ssl->p_export_keys,
7476 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7477 master, 48,
7478 randbytes + 32,
7479 randbytes,
7480 tls_prf_get_type( tls_prf ) );
7481 }
7482
7483#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007484 transform->psa_alg = alg;
7485
7486 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7487 {
7488 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7489 psa_set_key_algorithm( &attributes, alg );
7490 psa_set_key_type( &attributes, key_type );
7491
7492 if( ( status = psa_import_key( &attributes,
7493 key1,
7494 PSA_BITS_TO_BYTES( key_bits ),
7495 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7496 {
7497 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7498 ret = psa_ssl_status_to_mbedtls( status );
7499 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7500 goto end;
7501 }
7502
7503 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7504
7505 if( ( status = psa_import_key( &attributes,
7506 key2,
7507 PSA_BITS_TO_BYTES( key_bits ),
7508 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7509 {
7510 ret = psa_ssl_status_to_mbedtls( status );
7511 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7512 goto end;
7513 }
7514 }
7515#else
7516 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7517 cipher_info ) ) != 0 )
7518 {
7519 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7520 goto end;
7521 }
7522
7523 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7524 cipher_info ) ) != 0 )
7525 {
7526 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7527 goto end;
7528 }
7529
7530 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7531 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7532 MBEDTLS_ENCRYPT ) ) != 0 )
7533 {
7534 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7535 goto end;
7536 }
7537
7538 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7539 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7540 MBEDTLS_DECRYPT ) ) != 0 )
7541 {
7542 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7543 goto end;
7544 }
7545
7546#if defined(MBEDTLS_CIPHER_MODE_CBC)
7547 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7548 {
7549 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7550 MBEDTLS_PADDING_NONE ) ) != 0 )
7551 {
7552 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7553 goto end;
7554 }
7555
7556 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7557 MBEDTLS_PADDING_NONE ) ) != 0 )
7558 {
7559 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7560 goto end;
7561 }
7562 }
7563#endif /* MBEDTLS_CIPHER_MODE_CBC */
7564#endif /* MBEDTLS_USE_PSA_CRYPTO */
7565
Neil Armstrong29c0c042022-03-17 17:47:28 +01007566#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7567 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7568 For AEAD-based ciphersuites, there is nothing to do here. */
7569 if( mac_key_len != 0 )
7570 {
7571#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007572 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007573
7574 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007575 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007576 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7577
7578 if( ( status = psa_import_key( &attributes,
7579 mac_enc, mac_key_len,
7580 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7581 {
7582 ret = psa_ssl_status_to_mbedtls( status );
7583 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7584 goto end;
7585 }
7586
Ronald Cronfb39f152022-03-25 14:36:28 +01007587 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7588 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7589 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007590 /* mbedtls_ct_hmac() requires the key to be exportable */
7591 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7592 PSA_KEY_USAGE_VERIFY_HASH );
7593 else
7594 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7595
7596 if( ( status = psa_import_key( &attributes,
7597 mac_dec, mac_key_len,
7598 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7599 {
7600 ret = psa_ssl_status_to_mbedtls( status );
7601 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7602 goto end;
7603 }
7604#else
7605 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7606 if( ret != 0 )
7607 goto end;
7608 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7609 if( ret != 0 )
7610 goto end;
7611#endif /* MBEDTLS_USE_PSA_CRYPTO */
7612 }
7613#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7614
7615 ((void) mac_dec);
7616 ((void) mac_enc);
7617
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007618end:
7619 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7620 return( ret );
7621}
7622
Jerry Yuee40f9d2022-02-17 14:55:16 +08007623#if defined(MBEDTLS_USE_PSA_CRYPTO)
7624int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7625 unsigned char *hash, size_t *hashlen,
7626 unsigned char *data, size_t data_len,
7627 mbedtls_md_type_t md_alg )
7628{
7629 psa_status_t status;
7630 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7631 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7632
7633 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7634
7635 if( ( status = psa_hash_setup( &hash_operation,
7636 hash_alg ) ) != PSA_SUCCESS )
7637 {
7638 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7639 goto exit;
7640 }
7641
7642 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7643 64 ) ) != PSA_SUCCESS )
7644 {
7645 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7646 goto exit;
7647 }
7648
7649 if( ( status = psa_hash_update( &hash_operation,
7650 data, data_len ) ) != PSA_SUCCESS )
7651 {
7652 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7653 goto exit;
7654 }
7655
7656 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7657 hashlen ) ) != PSA_SUCCESS )
7658 {
7659 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7660 goto exit;
7661 }
7662
7663exit:
7664 if( status != PSA_SUCCESS )
7665 {
7666 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7667 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7668 switch( status )
7669 {
7670 case PSA_ERROR_NOT_SUPPORTED:
7671 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7672 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7673 case PSA_ERROR_BUFFER_TOO_SMALL:
7674 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7675 case PSA_ERROR_INSUFFICIENT_MEMORY:
7676 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7677 default:
7678 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7679 }
7680 }
7681 return( 0 );
7682}
7683
7684#else
7685
7686int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7687 unsigned char *hash, size_t *hashlen,
7688 unsigned char *data, size_t data_len,
7689 mbedtls_md_type_t md_alg )
7690{
7691 int ret = 0;
7692 mbedtls_md_context_t ctx;
7693 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7694 *hashlen = mbedtls_md_get_size( md_info );
7695
7696 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7697
7698 mbedtls_md_init( &ctx );
7699
7700 /*
7701 * digitally-signed struct {
7702 * opaque client_random[32];
7703 * opaque server_random[32];
7704 * ServerDHParams params;
7705 * };
7706 */
7707 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7708 {
7709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7710 goto exit;
7711 }
7712 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7713 {
7714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7715 goto exit;
7716 }
7717 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7718 {
7719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7720 goto exit;
7721 }
7722 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7723 {
7724 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7725 goto exit;
7726 }
7727 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7728 {
7729 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7730 goto exit;
7731 }
7732
7733exit:
7734 mbedtls_md_free( &ctx );
7735
7736 if( ret != 0 )
7737 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7738 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7739
7740 return( ret );
7741}
7742#endif /* MBEDTLS_USE_PSA_CRYPTO */
7743
Jerry Yud9d91da2022-02-17 14:57:06 +08007744#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7745
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007746/* Find the preferred hash for a given signature algorithm. */
7747unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7748 mbedtls_ssl_context *ssl,
7749 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007750{
Gabor Mezei078e8032022-04-27 21:17:56 +02007751 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007752 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007753
7754 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007755 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007756
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007757 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007758 {
Gabor Mezei3631cf62022-05-10 12:59:00 +02007759 if( sig_alg == MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7760 received_sig_algs[i] ) )
Gabor Mezei696956d2022-05-13 16:27:29 +02007761 return( MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7762 received_sig_algs[i] ) );
Jerry Yud9d91da2022-02-17 14:57:06 +08007763 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007764
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007765 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007766}
7767
7768#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7769
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007770/* Serialization of TLS 1.2 sessions:
7771 *
7772 * struct {
7773 * uint64 start_time;
7774 * uint8 ciphersuite[2]; // defined by the standard
7775 * uint8 compression; // 0 or 1
7776 * uint8 session_id_len; // at most 32
7777 * opaque session_id[32];
7778 * opaque master[48]; // fixed length in the standard
7779 * uint32 verify_result;
7780 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7781 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7782 * uint32 ticket_lifetime;
7783 * uint8 mfl_code; // up to 255 according to standard
7784 * uint8 encrypt_then_mac; // 0 or 1
7785 * } serialized_session_tls12;
7786 *
7787 */
7788static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7789 unsigned char *buf,
7790 size_t buf_len )
7791{
7792 unsigned char *p = buf;
7793 size_t used = 0;
7794
7795#if defined(MBEDTLS_HAVE_TIME)
7796 uint64_t start;
7797#endif
7798#if defined(MBEDTLS_X509_CRT_PARSE_C)
7799#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7800 size_t cert_len;
7801#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7802#endif /* MBEDTLS_X509_CRT_PARSE_C */
7803
7804 /*
7805 * Time
7806 */
7807#if defined(MBEDTLS_HAVE_TIME)
7808 used += 8;
7809
7810 if( used <= buf_len )
7811 {
7812 start = (uint64_t) session->start;
7813
7814 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7815 p += 8;
7816 }
7817#endif /* MBEDTLS_HAVE_TIME */
7818
7819 /*
7820 * Basic mandatory fields
7821 */
7822 used += 2 /* ciphersuite */
7823 + 1 /* compression */
7824 + 1 /* id_len */
7825 + sizeof( session->id )
7826 + sizeof( session->master )
7827 + 4; /* verify_result */
7828
7829 if( used <= buf_len )
7830 {
7831 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7832 p += 2;
7833
7834 *p++ = MBEDTLS_BYTE_0( session->compression );
7835
7836 *p++ = MBEDTLS_BYTE_0( session->id_len );
7837 memcpy( p, session->id, 32 );
7838 p += 32;
7839
7840 memcpy( p, session->master, 48 );
7841 p += 48;
7842
7843 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7844 p += 4;
7845 }
7846
7847 /*
7848 * Peer's end-entity certificate
7849 */
7850#if defined(MBEDTLS_X509_CRT_PARSE_C)
7851#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7852 if( session->peer_cert == NULL )
7853 cert_len = 0;
7854 else
7855 cert_len = session->peer_cert->raw.len;
7856
7857 used += 3 + cert_len;
7858
7859 if( used <= buf_len )
7860 {
7861 *p++ = MBEDTLS_BYTE_2( cert_len );
7862 *p++ = MBEDTLS_BYTE_1( cert_len );
7863 *p++ = MBEDTLS_BYTE_0( cert_len );
7864
7865 if( session->peer_cert != NULL )
7866 {
7867 memcpy( p, session->peer_cert->raw.p, cert_len );
7868 p += cert_len;
7869 }
7870 }
7871#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7872 if( session->peer_cert_digest != NULL )
7873 {
7874 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7875 if( used <= buf_len )
7876 {
7877 *p++ = (unsigned char) session->peer_cert_digest_type;
7878 *p++ = (unsigned char) session->peer_cert_digest_len;
7879 memcpy( p, session->peer_cert_digest,
7880 session->peer_cert_digest_len );
7881 p += session->peer_cert_digest_len;
7882 }
7883 }
7884 else
7885 {
7886 used += 2;
7887 if( used <= buf_len )
7888 {
7889 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7890 *p++ = 0;
7891 }
7892 }
7893#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7894#endif /* MBEDTLS_X509_CRT_PARSE_C */
7895
7896 /*
7897 * Session ticket if any, plus associated data
7898 */
7899#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7900 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7901
7902 if( used <= buf_len )
7903 {
7904 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7905 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7906 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7907
7908 if( session->ticket != NULL )
7909 {
7910 memcpy( p, session->ticket, session->ticket_len );
7911 p += session->ticket_len;
7912 }
7913
7914 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7915 p += 4;
7916 }
7917#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7918
7919 /*
7920 * Misc extension-related info
7921 */
7922#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7923 used += 1;
7924
7925 if( used <= buf_len )
7926 *p++ = session->mfl_code;
7927#endif
7928
7929#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7930 used += 1;
7931
7932 if( used <= buf_len )
7933 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7934#endif
7935
7936 return( used );
7937}
7938
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007939MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007940static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7941 const unsigned char *buf,
7942 size_t len )
7943{
7944#if defined(MBEDTLS_HAVE_TIME)
7945 uint64_t start;
7946#endif
7947#if defined(MBEDTLS_X509_CRT_PARSE_C)
7948#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7949 size_t cert_len;
7950#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7951#endif /* MBEDTLS_X509_CRT_PARSE_C */
7952
7953 const unsigned char *p = buf;
7954 const unsigned char * const end = buf + len;
7955
7956 /*
7957 * Time
7958 */
7959#if defined(MBEDTLS_HAVE_TIME)
7960 if( 8 > (size_t)( end - p ) )
7961 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7962
7963 start = ( (uint64_t) p[0] << 56 ) |
7964 ( (uint64_t) p[1] << 48 ) |
7965 ( (uint64_t) p[2] << 40 ) |
7966 ( (uint64_t) p[3] << 32 ) |
7967 ( (uint64_t) p[4] << 24 ) |
7968 ( (uint64_t) p[5] << 16 ) |
7969 ( (uint64_t) p[6] << 8 ) |
7970 ( (uint64_t) p[7] );
7971 p += 8;
7972
7973 session->start = (time_t) start;
7974#endif /* MBEDTLS_HAVE_TIME */
7975
7976 /*
7977 * Basic mandatory fields
7978 */
7979 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7980 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7981
7982 session->ciphersuite = ( p[0] << 8 ) | p[1];
7983 p += 2;
7984
7985 session->compression = *p++;
7986
7987 session->id_len = *p++;
7988 memcpy( session->id, p, 32 );
7989 p += 32;
7990
7991 memcpy( session->master, p, 48 );
7992 p += 48;
7993
7994 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7995 ( (uint32_t) p[1] << 16 ) |
7996 ( (uint32_t) p[2] << 8 ) |
7997 ( (uint32_t) p[3] );
7998 p += 4;
7999
8000 /* Immediately clear invalid pointer values that have been read, in case
8001 * we exit early before we replaced them with valid ones. */
8002#if defined(MBEDTLS_X509_CRT_PARSE_C)
8003#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8004 session->peer_cert = NULL;
8005#else
8006 session->peer_cert_digest = NULL;
8007#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8008#endif /* MBEDTLS_X509_CRT_PARSE_C */
8009#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8010 session->ticket = NULL;
8011#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8012
8013 /*
8014 * Peer certificate
8015 */
8016#if defined(MBEDTLS_X509_CRT_PARSE_C)
8017#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8018 /* Deserialize CRT from the end of the ticket. */
8019 if( 3 > (size_t)( end - p ) )
8020 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8021
8022 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8023 p += 3;
8024
8025 if( cert_len != 0 )
8026 {
8027 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8028
8029 if( cert_len > (size_t)( end - p ) )
8030 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8031
8032 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8033
8034 if( session->peer_cert == NULL )
8035 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8036
8037 mbedtls_x509_crt_init( session->peer_cert );
8038
8039 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8040 p, cert_len ) ) != 0 )
8041 {
8042 mbedtls_x509_crt_free( session->peer_cert );
8043 mbedtls_free( session->peer_cert );
8044 session->peer_cert = NULL;
8045 return( ret );
8046 }
8047
8048 p += cert_len;
8049 }
8050#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8051 /* Deserialize CRT digest from the end of the ticket. */
8052 if( 2 > (size_t)( end - p ) )
8053 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8054
8055 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8056 session->peer_cert_digest_len = (size_t) *p++;
8057
8058 if( session->peer_cert_digest_len != 0 )
8059 {
8060 const mbedtls_md_info_t *md_info =
8061 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8062 if( md_info == NULL )
8063 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8064 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8065 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8066
8067 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8068 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8069
8070 session->peer_cert_digest =
8071 mbedtls_calloc( 1, session->peer_cert_digest_len );
8072 if( session->peer_cert_digest == NULL )
8073 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8074
8075 memcpy( session->peer_cert_digest, p,
8076 session->peer_cert_digest_len );
8077 p += session->peer_cert_digest_len;
8078 }
8079#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8080#endif /* MBEDTLS_X509_CRT_PARSE_C */
8081
8082 /*
8083 * Session ticket and associated data
8084 */
8085#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8086 if( 3 > (size_t)( end - p ) )
8087 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8088
8089 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8090 p += 3;
8091
8092 if( session->ticket_len != 0 )
8093 {
8094 if( session->ticket_len > (size_t)( end - p ) )
8095 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8096
8097 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8098 if( session->ticket == NULL )
8099 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8100
8101 memcpy( session->ticket, p, session->ticket_len );
8102 p += session->ticket_len;
8103 }
8104
8105 if( 4 > (size_t)( end - p ) )
8106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8107
8108 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8109 ( (uint32_t) p[1] << 16 ) |
8110 ( (uint32_t) p[2] << 8 ) |
8111 ( (uint32_t) p[3] );
8112 p += 4;
8113#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8114
8115 /*
8116 * Misc extension-related info
8117 */
8118#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8119 if( 1 > (size_t)( end - p ) )
8120 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8121
8122 session->mfl_code = *p++;
8123#endif
8124
8125#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8126 if( 1 > (size_t)( end - p ) )
8127 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8128
8129 session->encrypt_then_mac = *p++;
8130#endif
8131
8132 /* Done, should have consumed entire buffer */
8133 if( p != end )
8134 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8135
8136 return( 0 );
8137}
Jerry Yudc7bd172022-02-17 13:44:15 +08008138#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8139
XiaokangQian75d40ef2022-04-20 11:05:24 +00008140int mbedtls_ssl_validate_ciphersuite(
8141 const mbedtls_ssl_context *ssl,
8142 const mbedtls_ssl_ciphersuite_t *suite_info,
8143 mbedtls_ssl_protocol_version min_tls_version,
8144 mbedtls_ssl_protocol_version max_tls_version )
8145{
8146 (void) ssl;
8147
8148 if( suite_info == NULL )
8149 return( -1 );
8150
8151 if( ( suite_info->min_tls_version > max_tls_version ) ||
8152 ( suite_info->max_tls_version < min_tls_version ) )
8153 {
8154 return( -1 );
8155 }
8156
XiaokangQian060d8672022-04-21 09:24:56 +00008157#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008158#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8159 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8160 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8161 {
8162 return( -1 );
8163 }
8164#endif
8165
8166 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8167#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8168 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8169 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8170 {
8171 return( -1 );
8172 }
8173#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8174#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8175
8176 return( 0 );
8177}
8178
XiaokangQianeaf36512022-04-24 09:07:44 +00008179#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8180/*
8181 * Function for writing a signature algorithm extension.
8182 *
8183 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8184 * value (TLS 1.3 RFC8446):
8185 * enum {
8186 * ....
8187 * ecdsa_secp256r1_sha256( 0x0403 ),
8188 * ecdsa_secp384r1_sha384( 0x0503 ),
8189 * ecdsa_secp521r1_sha512( 0x0603 ),
8190 * ....
8191 * } SignatureScheme;
8192 *
8193 * struct {
8194 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8195 * } SignatureSchemeList;
8196 *
8197 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8198 * value (TLS 1.2 RFC5246):
8199 * enum {
8200 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8201 * sha512(6), (255)
8202 * } HashAlgorithm;
8203 *
8204 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8205 * SignatureAlgorithm;
8206 *
8207 * struct {
8208 * HashAlgorithm hash;
8209 * SignatureAlgorithm signature;
8210 * } SignatureAndHashAlgorithm;
8211 *
8212 * SignatureAndHashAlgorithm
8213 * supported_signature_algorithms<2..2^16-2>;
8214 *
8215 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8216 * generalization of the TLS 1.2 signature algorithm extension.
8217 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8218 * `SignatureScheme` field of TLS 1.3
8219 *
8220 */
8221int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8222 const unsigned char *end, size_t *out_len )
8223{
8224 unsigned char *p = buf;
8225 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8226 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8227
8228 *out_len = 0;
8229
8230 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8231
8232 /* Check if we have space for header and length field:
8233 * - extension_type (2 bytes)
8234 * - extension_data_length (2 bytes)
8235 * - supported_signature_algorithms_length (2 bytes)
8236 */
8237 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8238 p += 6;
8239
8240 /*
8241 * Write supported_signature_algorithms
8242 */
8243 supported_sig_alg = p;
8244 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8245 if( sig_alg == NULL )
8246 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8247
8248 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8249 {
8250 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8251 continue;
8252 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8253 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8254 p += 2;
8255 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x]", *sig_alg ) );
8256 }
8257
8258 /* Length of supported_signature_algorithms */
8259 supported_sig_alg_len = p - supported_sig_alg;
8260 if( supported_sig_alg_len == 0 )
8261 {
8262 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8263 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8264 }
8265
XiaokangQianeaf36512022-04-24 09:07:44 +00008266 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008267 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008268 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8269
XiaokangQianeaf36512022-04-24 09:07:44 +00008270 *out_len = p - buf;
8271
8272#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8273 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8274#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8275 return( 0 );
8276}
8277#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008279#endif /* MBEDTLS_SSL_TLS_C */