blob: 5ea8afadfc997907cef96d42461001cb2d09d18d [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"
Andrzej Kurek25f27152022-08-17 16:09:31 -040044
Janos Follath73c616b2019-12-18 15:07:04 +000045#include "mbedtls/debug.h"
46#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050047#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010048#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020049#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020050
Rich Evans00ab4702015-02-06 13:43:58 +000051#include <string.h>
52
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
54#include "mbedtls/psa_util.h"
55#include "psa/crypto.h"
56#endif
Manuel Pégourié-Gonnard07018f92022-09-15 11:29:35 +020057#include "mbedtls/legacy_or_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050058
Janos Follath23bdca02016-10-07 14:47:14 +010059#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000060#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020061#endif
62
Ronald Cronad8c17b2022-06-10 17:18:09 +020063#if defined(MBEDTLS_TEST_HOOKS)
64static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
65
66void mbedtls_ssl_set_chk_buf_ptr_fail_args(
67 const uint8_t *cur, const uint8_t *end, size_t need )
68{
69 chk_buf_ptr_fail_args.cur = cur;
70 chk_buf_ptr_fail_args.end = end;
71 chk_buf_ptr_fail_args.need = need;
72}
73
74void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void )
75{
76 memset( &chk_buf_ptr_fail_args, 0, sizeof( chk_buf_ptr_fail_args ) );
77}
78
79int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args )
80{
81 return( ( chk_buf_ptr_fail_args.cur != args->cur ) ||
82 ( chk_buf_ptr_fail_args.end != args->end ) ||
83 ( chk_buf_ptr_fail_args.need != args->need ) );
84}
85#endif /* MBEDTLS_TEST_HOOKS */
86
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010088
Hanno Beckera0e20d02019-05-15 14:03:01 +010089#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010090/* Top-level Connection ID API */
91
Hanno Becker8367ccc2019-05-14 11:30:10 +010092int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
93 size_t len,
94 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010095{
96 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
97 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
98
Hanno Becker611ac772019-05-14 11:45:26 +010099 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
100 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
101 {
102 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
103 }
104
105 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100106 conf->cid_len = len;
107 return( 0 );
108}
109
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100110int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
111 int enable,
112 unsigned char const *own_cid,
113 size_t own_cid_len )
114{
Hanno Becker76a79ab2019-05-03 14:38:32 +0100115 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
116 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
117
Hanno Beckerca092242019-04-25 16:01:49 +0100118 ssl->negotiate_cid = enable;
119 if( enable == MBEDTLS_SSL_CID_DISABLED )
120 {
121 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
122 return( 0 );
123 }
124 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +0100125 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100126
Hanno Beckerad4a1372019-05-03 13:06:44 +0100127 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100128 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100129 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
130 (unsigned) own_cid_len,
131 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100132 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
133 }
134
135 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100136 /* Truncation is not an issue here because
137 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
138 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100139
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100140 return( 0 );
141}
142
Paul Elliott0113cf12022-03-11 20:26:47 +0000143int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
144 int *enabled,
145 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
146 size_t *own_cid_len )
147{
148 *enabled = MBEDTLS_SSL_CID_DISABLED;
149
150 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
151 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
152
153 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
154 * zero as this is indistinguishable from not requesting to use
155 * the CID extension. */
156 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
157 return( 0 );
158
159 if( own_cid_len != NULL )
160 {
161 *own_cid_len = ssl->own_cid_len;
162 if( own_cid != NULL )
163 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
164 }
165
166 *enabled = MBEDTLS_SSL_CID_ENABLED;
167
168 return( 0 );
169}
170
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100171int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
172 int *enabled,
173 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
174 size_t *peer_cid_len )
175{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100176 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
Hanno Becker76a79ab2019-05-03 14:38:32 +0100178 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000179 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100180 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100182 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100183
Hanno Beckerc5f24222019-05-03 12:54:52 +0100184 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
185 * were used, but client and server requested the empty CID.
186 * This is indistinguishable from not using the CID extension
187 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100188 if( ssl->transform_in->in_cid_len == 0 &&
189 ssl->transform_in->out_cid_len == 0 )
190 {
191 return( 0 );
192 }
193
Hanno Becker615ef172019-05-22 16:50:35 +0100194 if( peer_cid_len != NULL )
195 {
196 *peer_cid_len = ssl->transform_in->out_cid_len;
197 if( peer_cid != NULL )
198 {
199 memcpy( peer_cid, ssl->transform_in->out_cid,
200 ssl->transform_in->out_cid_len );
201 }
202 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100203
204 *enabled = MBEDTLS_SSL_CID_ENABLED;
205
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100206 return( 0 );
207}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100208#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200213/*
214 * Convert max_fragment_length codes to length.
215 * RFC 6066 says:
216 * enum{
217 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
218 * } MaxFragmentLength;
219 * and we add 0 -> extension unused
220 */
Angus Grattond8213d02016-05-25 20:56:48 +1000221static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200222{
Angus Grattond8213d02016-05-25 20:56:48 +1000223 switch( mfl )
224 {
225 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
226 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
227 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
228 return 512;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
230 return 1024;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
232 return 2048;
233 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
234 return 4096;
235 default:
236 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
237 }
238}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200240
Hanno Becker52055ae2019-02-06 14:30:46 +0000241int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
242 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200243{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244 mbedtls_ssl_session_free( dst );
245 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200246
吴敬辉0b716112021-11-29 10:46:35 +0800247#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
248 dst->ticket = NULL;
249#endif
250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000252
253#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200254 if( src->peer_cert != NULL )
255 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200257
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200258 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200259 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200260 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200265 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200268 dst->peer_cert = NULL;
269 return( ret );
270 }
271 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000272#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 if( src->peer_cert_digest != NULL )
274 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000275 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000276 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000277 if( dst->peer_cert_digest == NULL )
278 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
279
280 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
281 src->peer_cert_digest_len );
282 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000283 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000284 }
285#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
286
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200290 if( src->ticket != NULL )
291 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200292 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200293 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200294 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
296 memcpy( dst->ticket, src->ticket, src->ticket_len );
297 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
300 return( 0 );
301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500305static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
306{
307 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
308 if( resized_buffer == NULL )
309 return -1;
310
311 /* We want to copy len_new bytes when downsizing the buffer, and
312 * len_old bytes when upsizing, so we choose the smaller of two sizes,
313 * to fit one buffer into another. Size checks, ensuring that no data is
314 * lost, are done outside of this function. */
315 memcpy( resized_buffer, *buffer,
316 ( len_new < *len_old ) ? len_new : *len_old );
317 mbedtls_platform_zeroize( *buffer, *len_old );
318 mbedtls_free( *buffer );
319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
326static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500327 size_t in_buf_new_len,
328 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
333 if( ssl->in_buf != NULL )
334 {
335 written_in = ssl->in_msg - ssl->in_buf;
336 iv_offset_in = ssl->in_iv - ssl->in_buf;
337 len_offset_in = ssl->in_len - ssl->in_buf;
338 if( downsizing ?
339 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
340 ssl->in_buf_len < in_buf_new_len )
341 {
342 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
343 {
344 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
345 }
346 else
347 {
Paul Elliottb7449902021-03-10 18:14:58 +0000348 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
349 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 modified = 1;
351 }
352 }
353 }
354
355 if( ssl->out_buf != NULL )
356 {
357 written_out = ssl->out_msg - ssl->out_buf;
358 iv_offset_out = ssl->out_iv - ssl->out_buf;
359 len_offset_out = ssl->out_len - ssl->out_buf;
360 if( downsizing ?
361 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
362 ssl->out_buf_len < out_buf_new_len )
363 {
364 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
365 {
366 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
367 }
368 else
369 {
Paul Elliottb7449902021-03-10 18:14:58 +0000370 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
371 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200372 modified = 1;
373 }
374 }
375 }
376 if( modified )
377 {
378 /* Update pointers here to avoid doing it twice. */
379 mbedtls_ssl_reset_in_out_pointers( ssl );
380 /* Fields below might not be properly updated with record
381 * splitting or with CID, so they are manually updated here. */
382 ssl->out_msg = ssl->out_buf + written_out;
383 ssl->out_len = ssl->out_buf + len_offset_out;
384 ssl->out_iv = ssl->out_buf + iv_offset_out;
385
386 ssl->in_msg = ssl->in_buf + written_in;
387 ssl->in_len = ssl->in_buf + len_offset_in;
388 ssl->in_iv = ssl->in_buf + iv_offset_in;
389 }
390}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500391#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
392
Jerry Yudb8c48a2022-01-27 14:54:54 +0800393#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800394
395#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
396typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen );
400
401static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
402
403#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
404
405/* Type for the TLS PRF */
406typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
407 const unsigned char *, size_t,
408 unsigned char *, size_t);
409
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200410MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800411static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
412 int ciphersuite,
413 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800415 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200416#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800417 ssl_tls_prf_t tls_prf,
418 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400419 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800420 unsigned endpoint,
421 const mbedtls_ssl_context *ssl );
422
Andrzej Kurek25f27152022-08-17 16:09:31 -0400423#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200424MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800425static int tls_prf_sha256( const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen );
429static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
430static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
431
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400432#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yued14c932022-02-17 13:40:45 +0800433
Andrzej Kurek25f27152022-08-17 16:09:31 -0400434#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200435MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800436static int tls_prf_sha384( const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen );
440
441static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
442static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400443#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yued14c932022-02-17 13:40:45 +0800444
Jerry Yu438ddd82022-07-07 06:55:50 +0000445static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800446 unsigned char *buf,
447 size_t buf_len );
Jerry Yu251a12e2022-07-13 15:15:48 +0800448
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200449MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +0000450static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800451 const unsigned char *buf,
452 size_t len );
453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
454
Jerry Yu53d23e22022-02-09 16:25:09 +0800455static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
456
Andrzej Kurek25f27152022-08-17 16:09:31 -0400457#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yudb8c48a2022-01-27 14:54:54 +0800458static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400459#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudb8c48a2022-01-27 14:54:54 +0800460
Andrzej Kurek25f27152022-08-17 16:09:31 -0400461#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yudb8c48a2022-01-27 14:54:54 +0800462static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400463#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Paul Bakker1ef83d62012-04-11 12:09:53 +0000464
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
466 const unsigned char *secret, size_t slen,
467 const char *label,
468 const unsigned char *random, size_t rlen,
469 unsigned char *dstbuf, size_t dlen )
470{
471 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
472
473 switch( prf )
474 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek25f27152022-08-17 16:09:31 -0400476#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
479 break;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400480#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -0400481#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
484 break;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400485#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300487 default:
488 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
489 }
490
491 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
495static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
498 if( session->peer_cert != NULL )
499 {
500 mbedtls_x509_crt_free( session->peer_cert );
501 mbedtls_free( session->peer_cert );
502 session->peer_cert = NULL;
503 }
504#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
505 if( session->peer_cert_digest != NULL )
506 {
507 /* Zeroization is not necessary. */
508 mbedtls_free( session->peer_cert_digest );
509 session->peer_cert_digest = NULL;
510 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
511 session->peer_cert_digest_len = 0;
512 }
513#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
514}
515#endif /* MBEDTLS_X509_CRT_PARSE_C */
516
517void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
518 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
519{
520 ((void) ciphersuite_info);
521
Andrzej Kurek25f27152022-08-17 16:09:31 -0400522#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800523 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
524 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
525 else
526#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400527#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800528 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
529 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
530 else
531#endif
532 {
533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
534 return;
535 }
536}
537
XiaokangQianadab9a62022-07-18 07:41:26 +0000538void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
539 unsigned hs_type,
540 size_t total_hs_len )
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100541{
542 unsigned char hs_hdr[4];
543
544 /* Build HS header for checksum update. */
545 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
546 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
547 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
548 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
549
550 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
551}
552
553void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
554 unsigned hs_type,
555 unsigned char const *msg,
556 size_t msg_len )
557{
558 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
559 ssl->handshake->update_checksum( ssl, msg, msg_len );
560}
561
Jerry Yuc73c6182022-02-08 20:29:25 +0800562void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
563{
564 ((void) ssl);
Andrzej Kurek25f27152022-08-17 16:09:31 -0400565#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800566#if defined(MBEDTLS_USE_PSA_CRYPTO)
567 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
568 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
569#else
570 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
571#endif
572#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400573#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800574#if defined(MBEDTLS_USE_PSA_CRYPTO)
575 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
576 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
577#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400578 mbedtls_sha512_starts( &ssl->handshake->fin_sha384, 1 );
Jerry Yuc73c6182022-02-08 20:29:25 +0800579#endif
580#endif
581}
582
583static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
584 const unsigned char *buf, size_t len )
585{
Andrzej Kurek25f27152022-08-17 16:09:31 -0400586#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800587#if defined(MBEDTLS_USE_PSA_CRYPTO)
588 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
589#else
590 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
591#endif
592#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400593#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800594#if defined(MBEDTLS_USE_PSA_CRYPTO)
595 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
596#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400597 mbedtls_sha512_update( &ssl->handshake->fin_sha384, buf, len );
Jerry Yuc73c6182022-02-08 20:29:25 +0800598#endif
599#endif
600}
601
Andrzej Kurek25f27152022-08-17 16:09:31 -0400602#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800603static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
604 const unsigned char *buf, size_t len )
605{
606#if defined(MBEDTLS_USE_PSA_CRYPTO)
607 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
608#else
609 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
610#endif
611}
612#endif
613
Andrzej Kurek25f27152022-08-17 16:09:31 -0400614#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800615static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
616 const unsigned char *buf, size_t len )
617{
618#if defined(MBEDTLS_USE_PSA_CRYPTO)
619 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
620#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400621 mbedtls_sha512_update( &ssl->handshake->fin_sha384, buf, len );
Jerry Yuc73c6182022-02-08 20:29:25 +0800622#endif
623}
624#endif
625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200627{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200629
Andrzej Kurek25f27152022-08-17 16:09:31 -0400630#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500631#if defined(MBEDTLS_USE_PSA_CRYPTO)
632 handshake->fin_sha256_psa = psa_hash_operation_init();
633 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
634#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200636 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200637#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500638#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400639#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500640#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500641 handshake->fin_sha384_psa = psa_hash_operation_init();
642 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500643#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400644 mbedtls_sha512_init( &handshake->fin_sha384 );
645 mbedtls_sha512_starts( &handshake->fin_sha384, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200646#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500647#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200648
649 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651#if defined(MBEDTLS_DHM_C)
652 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200653#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200654#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200656#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200657#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200658 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200659#if defined(MBEDTLS_SSL_CLI_C)
660 handshake->ecjpake_cache = NULL;
661 handshake->ecjpake_cache_len = 0;
662#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200663#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200664
Gilles Peskineeccd8882020-03-10 12:19:08 +0100665#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200666 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200667#endif
668
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200669#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
670 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
671#endif
Hanno Becker75173122019-02-06 16:18:31 +0000672
673#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
674 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
675 mbedtls_pk_init( &handshake->peer_pubkey );
676#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200677}
678
Hanno Beckera18d1322018-01-03 14:27:32 +0000679void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200682
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100683#if defined(MBEDTLS_USE_PSA_CRYPTO)
684 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
685 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100686#else
687 mbedtls_cipher_init( &transform->cipher_ctx_enc );
688 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100689#endif
690
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000691#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100692#if defined(MBEDTLS_USE_PSA_CRYPTO)
693 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
694 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100695#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 mbedtls_md_init( &transform->md_ctx_enc );
697 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000698#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100699#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200700}
701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200703{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200704 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200705}
706
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200707MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000709{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200710 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000711 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200713 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200716 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200717
718 /*
719 * Either the pointers are now NULL or cleared properly and can be freed.
720 * Now allocate missing structures.
721 */
722 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200723 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200724 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200725 }
Paul Bakker48916f92012-09-16 19:57:18 +0000726
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200727 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200728 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200729 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200730 }
Paul Bakker48916f92012-09-16 19:57:18 +0000731
Paul Bakker82788fb2014-10-20 13:59:19 +0200732 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200733 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200734 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200735 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500736#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
737 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400738
Andrzej Kurek4a063792020-10-21 15:08:44 +0200739 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
740 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500741#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000742
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200743 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000744 if( ssl->handshake == NULL ||
745 ssl->transform_negotiate == NULL ||
746 ssl->session_negotiate == NULL )
747 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200748 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 mbedtls_free( ssl->handshake );
751 mbedtls_free( ssl->transform_negotiate );
752 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200753
754 ssl->handshake = NULL;
755 ssl->transform_negotiate = NULL;
756 ssl->session_negotiate = NULL;
757
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200758 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000759 }
760
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200761 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000763 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200764 ssl_handshake_params_init( ssl->handshake );
765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200767 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
768 {
769 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200770
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200771 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
772 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
773 else
774 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200775
Hanno Becker0f57a652020-02-05 10:37:26 +0000776 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200777 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200778#endif
779
Brett Warrene0edc842021-08-17 09:53:13 +0100780/*
781 * curve_list is translated to IANA TLS group identifiers here because
782 * mbedtls_ssl_conf_curves returns void and so can't return
783 * any error codes.
784 */
785#if defined(MBEDTLS_ECP_C)
786#if !defined(MBEDTLS_DEPRECATED_REMOVED)
787 /* Heap allocate and translate curve_list from internal to IANA group ids */
788 if ( ssl->conf->curve_list != NULL )
789 {
790 size_t length;
791 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
792
793 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
794 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
795
796 /* Leave room for zero termination */
797 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
798 if ( group_list == NULL )
799 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
800
801 for( size_t i = 0; i < length; i++ )
802 {
803 const mbedtls_ecp_curve_info *info =
804 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
805 if ( info == NULL )
806 {
807 mbedtls_free( group_list );
808 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
809 }
810 group_list[i] = info->tls_id;
811 }
812
813 group_list[length] = 0;
814
815 ssl->handshake->group_list = group_list;
816 ssl->handshake->group_list_heap_allocated = 1;
817 }
818 else
819 {
820 ssl->handshake->group_list = ssl->conf->group_list;
821 ssl->handshake->group_list_heap_allocated = 0;
822 }
823#endif /* MBEDTLS_DEPRECATED_REMOVED */
824#endif /* MBEDTLS_ECP_C */
825
Jerry Yuf017ee42022-01-12 15:49:48 +0800826#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
827#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800828#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800829 /* Heap allocate and translate sig_hashes from internal hash identifiers to
830 signature algorithms IANA identifiers. */
831 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 ssl->conf->sig_hashes != NULL )
833 {
834 const int *md;
835 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800836 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800837 uint16_t *p;
838
Jerry Yub476a442022-01-21 18:14:45 +0800839#if defined(static_assert)
840 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
841 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
842 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800843#endif
844
Jerry Yuf017ee42022-01-12 15:49:48 +0800845 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
846 {
847 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
848 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800849#if defined(MBEDTLS_ECDSA_C)
850 sig_algs_len += sizeof( uint16_t );
851#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800852
Jerry Yub476a442022-01-21 18:14:45 +0800853#if defined(MBEDTLS_RSA_C)
854 sig_algs_len += sizeof( uint16_t );
855#endif
856 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
857 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800858 }
859
Jerry Yub476a442022-01-21 18:14:45 +0800860 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800861 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
862
Jerry Yub476a442022-01-21 18:14:45 +0800863 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
864 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800865 if( ssl->handshake->sig_algs == NULL )
866 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
867
868 p = (uint16_t *)ssl->handshake->sig_algs;
869 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
870 {
871 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
872 if( hash == MBEDTLS_SSL_HASH_NONE )
873 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800874#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800875 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
876 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800877#endif
878#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800879 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
880 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800881#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800882 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200883 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800884 ssl->handshake->sig_algs_heap_allocated = 1;
885 }
886 else
Jerry Yua69269a2022-01-17 21:06:01 +0800887#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800888 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800889 ssl->handshake->sig_algs_heap_allocated = 0;
890 }
Jerry Yucc539102022-06-27 16:27:35 +0800891#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800892#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000893 return( 0 );
894}
895
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200896#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200898MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200899static int ssl_cookie_write_dummy( void *ctx,
900 unsigned char **p, unsigned char *end,
901 const unsigned char *cli_id, size_t cli_id_len )
902{
903 ((void) ctx);
904 ((void) p);
905 ((void) end);
906 ((void) cli_id);
907 ((void) cli_id_len);
908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200910}
911
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200912MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200913static int ssl_cookie_check_dummy( void *ctx,
914 const unsigned char *cookie, size_t cookie_len,
915 const unsigned char *cli_id, size_t cli_id_len )
916{
917 ((void) ctx);
918 ((void) cookie);
919 ((void) cookie_len);
920 ((void) cli_id);
921 ((void) cli_id_len);
922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200924}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200925#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200926
Paul Bakker5121ce52009-01-03 21:22:43 +0000927/*
928 * Initialize an SSL context
929 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200930void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
931{
932 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
933}
934
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200935MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800936static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
937{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100938 const mbedtls_ssl_config *conf = ssl->conf;
939
Ronald Cron6f135e12021-12-08 16:57:54 +0100940#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100941 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
942 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000943 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
946 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
947 }
948
Jerry Yu60835a82021-08-04 10:13:52 +0800949 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
950 return( 0 );
951 }
952#endif
953
954#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100955 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800956 {
957 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
958 return( 0 );
959 }
960#endif
961
Ronald Cron6f135e12021-12-08 16:57:54 +0100962#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100963 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800964 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000965 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
966 {
967 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
968 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
969 }
970
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000971 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
972 {
973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
974 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
975 }
976
977
Ronald Crone1d3f062022-02-10 14:50:54 +0100978 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
979 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800980 }
981#endif
982
983 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
984 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
985}
986
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200987MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800988static int ssl_conf_check(const mbedtls_ssl_context *ssl)
989{
990 int ret;
991 ret = ssl_conf_version_check( ssl );
992 if( ret != 0 )
993 return( ret );
994
995 /* Space for further checks */
996
997 return( 0 );
998}
999
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001000/*
1001 * Setup an SSL context
1002 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001003
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001004int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001005 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001006{
Janos Follath865b3eb2019-12-16 11:46:15 +00001007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001008 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1009 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001010
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001011 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001012
Jerry Yu60835a82021-08-04 10:13:52 +08001013 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1014 return( ret );
1015
Paul Bakker62f2dee2012-09-28 07:31:51 +00001016 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001017 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001018 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001019
1020 /* Set to NULL in case of an error condition */
1021 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001022
Darryl Greenb33cc762019-11-28 14:29:44 +00001023#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1024 ssl->in_buf_len = in_buf_len;
1025#endif
1026 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001027 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001028 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001030 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001031 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001032 }
1033
Darryl Greenb33cc762019-11-28 14:29:44 +00001034#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1035 ssl->out_buf_len = out_buf_len;
1036#endif
1037 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001038 if( ssl->out_buf == NULL )
1039 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001040 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001041 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001042 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001043 }
1044
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001045 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001046
Johan Pascalb62bb512015-12-03 21:56:45 +01001047#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001048 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001049#endif
1050
Paul Bakker48916f92012-09-16 19:57:18 +00001051 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001052 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001053
1054 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001055
1056error:
1057 mbedtls_free( ssl->in_buf );
1058 mbedtls_free( ssl->out_buf );
1059
1060 ssl->conf = NULL;
1061
Darryl Greenb33cc762019-11-28 14:29:44 +00001062#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1063 ssl->in_buf_len = 0;
1064 ssl->out_buf_len = 0;
1065#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001066 ssl->in_buf = NULL;
1067 ssl->out_buf = NULL;
1068
1069 ssl->in_hdr = NULL;
1070 ssl->in_ctr = NULL;
1071 ssl->in_len = NULL;
1072 ssl->in_iv = NULL;
1073 ssl->in_msg = NULL;
1074
1075 ssl->out_hdr = NULL;
1076 ssl->out_ctr = NULL;
1077 ssl->out_len = NULL;
1078 ssl->out_iv = NULL;
1079 ssl->out_msg = NULL;
1080
k-stachowiak9f7798e2018-07-31 16:52:32 +02001081 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001082}
1083
1084/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001085 * Reset an initialized and used SSL context for re-use while retaining
1086 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001087 *
1088 * If partial is non-zero, keep data in the input buffer and client ID.
1089 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001090 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001091void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1092 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001093{
Darryl Greenb33cc762019-11-28 14:29:44 +00001094#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1095 size_t in_buf_len = ssl->in_buf_len;
1096 size_t out_buf_len = ssl->out_buf_len;
1097#else
1098 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1099 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1100#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001101
Hanno Beckerb0302c42021-08-03 09:39:42 +01001102#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1103 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001104#endif
1105
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001106 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001107 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001108
Hanno Beckerb0302c42021-08-03 09:39:42 +01001109 mbedtls_ssl_reset_in_out_pointers( ssl );
1110
1111 /* Reset incoming message parsing */
1112 ssl->in_offt = NULL;
1113 ssl->nb_zero = 0;
1114 ssl->in_msgtype = 0;
1115 ssl->in_msglen = 0;
1116 ssl->in_hslen = 0;
1117 ssl->keep_current_message = 0;
1118 ssl->transform_in = NULL;
1119
1120#if defined(MBEDTLS_SSL_PROTO_DTLS)
1121 ssl->next_record_offset = 0;
1122 ssl->in_epoch = 0;
1123#endif
1124
1125 /* Keep current datagram if partial == 1 */
1126 if( partial == 0 )
1127 {
1128 ssl->in_left = 0;
1129 memset( ssl->in_buf, 0, in_buf_len );
1130 }
1131
Ronald Cronad8c17b2022-06-10 17:18:09 +02001132 ssl->send_alert = 0;
1133
Hanno Beckerb0302c42021-08-03 09:39:42 +01001134 /* Reset outgoing message writing */
1135 ssl->out_msgtype = 0;
1136 ssl->out_msglen = 0;
1137 ssl->out_left = 0;
1138 memset( ssl->out_buf, 0, out_buf_len );
1139 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1140 ssl->transform_out = NULL;
1141
1142#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1143 mbedtls_ssl_dtls_replay_reset( ssl );
1144#endif
1145
XiaokangQian2b01dc32022-01-21 02:53:13 +00001146#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001147 if( ssl->transform )
1148 {
1149 mbedtls_ssl_transform_free( ssl->transform );
1150 mbedtls_free( ssl->transform );
1151 ssl->transform = NULL;
1152 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001153#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1154
XiaokangQian2b01dc32022-01-21 02:53:13 +00001155#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1156 mbedtls_ssl_transform_free( ssl->transform_application );
1157 mbedtls_free( ssl->transform_application );
1158 ssl->transform_application = NULL;
1159
1160 if( ssl->handshake != NULL )
1161 {
1162 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1163 mbedtls_free( ssl->handshake->transform_earlydata );
1164 ssl->handshake->transform_earlydata = NULL;
1165
1166 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1167 mbedtls_free( ssl->handshake->transform_handshake );
1168 ssl->handshake->transform_handshake = NULL;
1169 }
1170
XiaokangQian2b01dc32022-01-21 02:53:13 +00001171#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001172}
1173
1174int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1175{
1176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1177
1178 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1179
XiaokangQian78b1fa72022-01-19 06:56:30 +00001180 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001181
1182 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183#if defined(MBEDTLS_SSL_RENEGOTIATION)
1184 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001185 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001186
1187 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1189 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001190#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001192
Hanno Beckerb0302c42021-08-03 09:39:42 +01001193 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001194 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001195 if( ssl->session )
1196 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 mbedtls_ssl_session_free( ssl->session );
1198 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001199 ssl->session = NULL;
1200 }
1201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001203 ssl->alpn_chosen = NULL;
1204#endif
1205
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001206#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001207#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001208 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001209#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001210 {
1211 mbedtls_free( ssl->cli_id );
1212 ssl->cli_id = NULL;
1213 ssl->cli_id_len = 0;
1214 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001215#endif
1216
Paul Bakker48916f92012-09-16 19:57:18 +00001217 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1218 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001219
1220 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001221}
1222
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001223/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001224 * Reset an initialized and used SSL context for re-use while retaining
1225 * all application-set variables, function pointers and data.
1226 */
1227int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1228{
Hanno Becker43aefe22020-02-05 10:44:56 +00001229 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001230}
1231
1232/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001233 * SSL set accessors
1234 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001235void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001236{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001237 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001238}
1239
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001240void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001243}
1244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001246void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001247{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001248 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001249}
1250#endif
1251
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001252void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001253{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001254 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001255}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001258
Hanno Becker1841b0a2018-08-24 11:13:57 +01001259void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1260 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001261{
1262 ssl->disable_datagram_packing = !allow_packing;
1263}
1264
1265void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1266 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001267{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001268 conf->hs_timeout_min = min;
1269 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001270}
1271#endif
1272
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001273void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001274{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001275 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001276}
1277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001279void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001280 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001281 void *p_vrfy )
1282{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001283 conf->f_vrfy = f_vrfy;
1284 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001285}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001287
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001288void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001289 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001290 void *p_rng )
1291{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001292 conf->f_rng = f_rng;
1293 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001294}
1295
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001296void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001297 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001298 void *p_dbg )
1299{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001300 conf->f_dbg = f_dbg;
1301 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001302}
1303
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001305 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001306 mbedtls_ssl_send_t *f_send,
1307 mbedtls_ssl_recv_t *f_recv,
1308 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001309{
1310 ssl->p_bio = p_bio;
1311 ssl->f_send = f_send;
1312 ssl->f_recv = f_recv;
1313 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001314}
1315
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001316#if defined(MBEDTLS_SSL_PROTO_DTLS)
1317void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1318{
1319 ssl->mtu = mtu;
1320}
1321#endif
1322
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001323void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001324{
1325 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001326}
1327
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001328void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1329 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001330 mbedtls_ssl_set_timer_t *f_set_timer,
1331 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001332{
1333 ssl->p_timer = p_timer;
1334 ssl->f_set_timer = f_set_timer;
1335 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001336
1337 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001338 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001339}
1340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001342void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001343 void *p_cache,
1344 mbedtls_ssl_cache_get_t *f_get_cache,
1345 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001346{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001347 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001348 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001349 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001350}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353#if defined(MBEDTLS_SSL_CLI_C)
1354int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001355{
Janos Follath865b3eb2019-12-16 11:46:15 +00001356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001357
1358 if( ssl == NULL ||
1359 session == NULL ||
1360 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001361 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001362 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001364 }
1365
Hanno Beckere810bbc2021-05-14 16:01:05 +01001366 if( ssl->handshake->resume == 1 )
1367 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1368
Hanno Becker52055ae2019-02-06 14:30:46 +00001369 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1370 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001371 return( ret );
1372
Paul Bakker0a597072012-09-25 21:55:46 +00001373 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001374
1375 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001376}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001378
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001379void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1380 const int *ciphersuites )
1381{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001382 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001383}
1384
Ronald Cron6f135e12021-12-08 16:57:54 +01001385#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001386void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001387 const int kex_modes )
1388{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001389 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001390}
Ronald Cron6f135e12021-12-08 16:57:54 +01001391#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001393#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001394void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001395 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001396{
1397 conf->cert_profile = profile;
1398}
1399
Glenn Strauss36872db2022-01-22 05:06:31 -05001400static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1401{
1402 mbedtls_ssl_key_cert *cur = key_cert, *next;
1403
1404 while( cur != NULL )
1405 {
1406 next = cur->next;
1407 mbedtls_free( cur );
1408 cur = next;
1409 }
1410}
1411
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001412/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001413MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001414static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1415 mbedtls_x509_crt *cert,
1416 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417{
niisato8ee24222018-06-25 19:05:48 +09001418 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001419
Glenn Strauss36872db2022-01-22 05:06:31 -05001420 if( cert == NULL )
1421 {
1422 /* Free list if cert is null */
1423 ssl_key_cert_free( *head );
1424 *head = NULL;
1425 return( 0 );
1426 }
1427
niisato8ee24222018-06-25 19:05:48 +09001428 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1429 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001430 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001431
niisato8ee24222018-06-25 19:05:48 +09001432 new_cert->cert = cert;
1433 new_cert->key = key;
1434 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001435
Glenn Strauss36872db2022-01-22 05:06:31 -05001436 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001437 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001438 {
niisato8ee24222018-06-25 19:05:48 +09001439 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001440 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001441 else
1442 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001443 mbedtls_ssl_key_cert *cur = *head;
1444 while( cur->next != NULL )
1445 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001446 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001447 }
1448
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001449 return( 0 );
1450}
1451
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001452int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001453 mbedtls_x509_crt *own_cert,
1454 mbedtls_pk_context *pk_key )
1455{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001456 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001457}
1458
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001459void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001460 mbedtls_x509_crt *ca_chain,
1461 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001462{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001463 conf->ca_chain = ca_chain;
1464 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001465
1466#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1467 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1468 * cannot be used together. */
1469 conf->f_ca_cb = NULL;
1470 conf->p_ca_cb = NULL;
1471#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001472}
Hanno Becker5adaad92019-03-27 16:54:37 +00001473
1474#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1475void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001476 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001477 void *p_ca_cb )
1478{
1479 conf->f_ca_cb = f_ca_cb;
1480 conf->p_ca_cb = p_ca_cb;
1481
1482 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1483 * cannot be used together. */
1484 conf->ca_chain = NULL;
1485 conf->ca_crl = NULL;
1486}
1487#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001489
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001490#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001491const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1492 size_t *name_len )
1493{
1494 *name_len = ssl->handshake->sni_name_len;
1495 return( ssl->handshake->sni_name );
1496}
1497
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001498int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1499 mbedtls_x509_crt *own_cert,
1500 mbedtls_pk_context *pk_key )
1501{
1502 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1503 own_cert, pk_key ) );
1504}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001505
1506void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1507 mbedtls_x509_crt *ca_chain,
1508 mbedtls_x509_crl *ca_crl )
1509{
1510 ssl->handshake->sni_ca_chain = ca_chain;
1511 ssl->handshake->sni_ca_crl = ca_crl;
1512}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001513
Glenn Strauss999ef702022-03-11 01:37:23 -05001514#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1515void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1516 const mbedtls_x509_crt *crt)
1517{
1518 ssl->handshake->dn_hints = crt;
1519}
1520#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1521
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001522void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1523 int authmode )
1524{
1525 ssl->handshake->sni_authmode = authmode;
1526}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001527#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1528
Hanno Becker8927c832019-04-03 12:52:50 +01001529#if defined(MBEDTLS_X509_CRT_PARSE_C)
1530void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1531 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1532 void *p_vrfy )
1533{
1534 ssl->f_vrfy = f_vrfy;
1535 ssl->p_vrfy = p_vrfy;
1536}
1537#endif
1538
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001539#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001540/*
1541 * Set EC J-PAKE password for current handshake
1542 */
1543int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1544 const unsigned char *pw,
1545 size_t pw_len )
1546{
1547 mbedtls_ecjpake_role role;
1548
Janos Follath8eb64132016-06-03 15:40:57 +01001549 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001550 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1551
1552 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1553 role = MBEDTLS_ECJPAKE_SERVER;
1554 else
1555 role = MBEDTLS_ECJPAKE_CLIENT;
1556
1557 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1558 role,
1559 MBEDTLS_MD_SHA256,
1560 MBEDTLS_ECP_DP_SECP256R1,
1561 pw, pw_len ) );
1562}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001563#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001564
Gilles Peskineeccd8882020-03-10 12:19:08 +01001565#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001566
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001567MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001568static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1569{
1570#if defined(MBEDTLS_USE_PSA_CRYPTO)
1571 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1572 return( 1 );
1573#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001574 if( conf->psk != NULL )
1575 return( 1 );
1576
1577 return( 0 );
1578}
1579
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001580static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1581{
1582 /* Remove reference to existing PSK, if any. */
1583#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001584 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001585 {
1586 /* The maintenance of the PSK key slot is the
1587 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001588 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001589 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001590#endif /* MBEDTLS_USE_PSA_CRYPTO */
1591 if( conf->psk != NULL )
1592 {
1593 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1594
1595 mbedtls_free( conf->psk );
1596 conf->psk = NULL;
1597 conf->psk_len = 0;
1598 }
1599
1600 /* Remove reference to PSK identity, if any. */
1601 if( conf->psk_identity != NULL )
1602 {
1603 mbedtls_free( conf->psk_identity );
1604 conf->psk_identity = NULL;
1605 conf->psk_identity_len = 0;
1606 }
1607}
1608
Hanno Becker7390c712018-11-15 13:33:04 +00001609/* This function assumes that PSK identity in the SSL config is unset.
1610 * It checks that the provided identity is well-formed and attempts
1611 * to make a copy of it in the SSL config.
1612 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001613MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001614static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1615 unsigned char const *psk_identity,
1616 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001617{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001618 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001619 if( psk_identity == NULL ||
1620 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001621 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001622 {
1623 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1624 }
1625
Hanno Becker7390c712018-11-15 13:33:04 +00001626 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1627 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001628 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001629
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001630 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001631 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001632
1633 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001634}
1635
Hanno Becker7390c712018-11-15 13:33:04 +00001636int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1637 const unsigned char *psk, size_t psk_len,
1638 const unsigned char *psk_identity, size_t psk_identity_len )
1639{
Janos Follath865b3eb2019-12-16 11:46:15 +00001640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001641
1642 /* We currently only support one PSK, raw or opaque. */
1643 if( ssl_conf_psk_is_configured( conf ) )
1644 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001645
1646 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001647 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001648 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001649 if( psk_len == 0 )
1650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1651 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1652 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1653
Hanno Becker7390c712018-11-15 13:33:04 +00001654 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1655 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1656 conf->psk_len = psk_len;
1657 memcpy( conf->psk, psk, conf->psk_len );
1658
1659 /* Check and set PSK Identity */
1660 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1661 if( ret != 0 )
1662 ssl_conf_remove_psk( conf );
1663
1664 return( ret );
1665}
1666
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001667static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1668{
1669#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001670 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001671 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001672 /* The maintenance of the external PSK key slot is the
1673 * user's responsibility. */
1674 if( ssl->handshake->psk_opaque_is_internal )
1675 {
1676 psa_destroy_key( ssl->handshake->psk_opaque );
1677 ssl->handshake->psk_opaque_is_internal = 0;
1678 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001679 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680 }
Neil Armstronge952a302022-05-03 10:22:14 +02001681#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001682 if( ssl->handshake->psk != NULL )
1683 {
1684 mbedtls_platform_zeroize( ssl->handshake->psk,
1685 ssl->handshake->psk_len );
1686 mbedtls_free( ssl->handshake->psk );
1687 ssl->handshake->psk_len = 0;
1688 }
Neil Armstronge952a302022-05-03 10:22:14 +02001689#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001690}
1691
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001692int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1693 const unsigned char *psk, size_t psk_len )
1694{
Neil Armstrong501c9322022-05-03 09:35:09 +02001695#if defined(MBEDTLS_USE_PSA_CRYPTO)
1696 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08001697 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08001698 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08001699 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02001700#endif /* MBEDTLS_USE_PSA_CRYPTO */
1701
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001702 if( psk == NULL || ssl->handshake == NULL )
1703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1704
1705 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1706 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1707
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001708 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001709
Neil Armstrong501c9322022-05-03 09:35:09 +02001710#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08001711#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1712 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
1713 {
Jerry Yu6cf6b472022-08-16 14:50:28 +08001714 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yuccc68a42022-07-26 16:39:20 +08001715 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_384 );
1716 else
1717 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_256 );
1718 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1719 }
1720#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02001721
Jerry Yu568ec252022-07-22 21:27:34 +08001722#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yuccc68a42022-07-26 16:39:20 +08001723 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
1724 {
1725 alg = PSA_ALG_HKDF_EXTRACT( PSA_ALG_ANY_HASH );
1726 psa_set_key_usage_flags( &key_attributes,
1727 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
1728 }
1729#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1730
Neil Armstrong501c9322022-05-03 09:35:09 +02001731 psa_set_key_algorithm( &key_attributes, alg );
1732 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1733
1734 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1735 if( status != PSA_SUCCESS )
1736 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1737
1738 /* Allow calling psa_destroy_key() on psk remove */
1739 ssl->handshake->psk_opaque_is_internal = 1;
1740 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1741#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001742 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001743 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001744
1745 ssl->handshake->psk_len = psk_len;
1746 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1747
1748 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001749#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001750}
1751
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001752#if defined(MBEDTLS_USE_PSA_CRYPTO)
1753int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001754 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001755 const unsigned char *psk_identity,
1756 size_t psk_identity_len )
1757{
Janos Follath865b3eb2019-12-16 11:46:15 +00001758 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001759
1760 /* We currently only support one PSK, raw or opaque. */
1761 if( ssl_conf_psk_is_configured( conf ) )
1762 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001763
Hanno Becker7390c712018-11-15 13:33:04 +00001764 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001765 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001767 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001768
1769 /* Check and set PSK Identity */
1770 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1771 psk_identity_len );
1772 if( ret != 0 )
1773 ssl_conf_remove_psk( conf );
1774
1775 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001776}
1777
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001778int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1779 mbedtls_svc_key_id_t psk )
1780{
1781 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1782 ( ssl->handshake == NULL ) )
1783 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1784
1785 ssl_remove_psk( ssl );
1786 ssl->handshake->psk_opaque = psk;
1787 return( 0 );
1788}
1789#endif /* MBEDTLS_USE_PSA_CRYPTO */
1790
1791void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1792 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1793 size_t),
1794 void *p_psk )
1795{
1796 conf->f_psk = f_psk;
1797 conf->p_psk = p_psk;
1798}
1799#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1800
1801#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001802static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1803 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001804{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001805#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001806 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001807 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001808#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001809 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001810 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001811 return( MBEDTLS_SSL_MODE_STREAM );
1812}
1813
1814#else /* MBEDTLS_USE_PSA_CRYPTO */
1815
1816static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1817 mbedtls_cipher_mode_t mode )
1818{
1819#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1820 if( mode == MBEDTLS_MODE_CBC )
1821 return( MBEDTLS_SSL_MODE_CBC );
1822#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1823
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001824#if defined(MBEDTLS_GCM_C) || \
1825 defined(MBEDTLS_CCM_C) || \
1826 defined(MBEDTLS_CHACHAPOLY_C)
1827 if( mode == MBEDTLS_MODE_GCM ||
1828 mode == MBEDTLS_MODE_CCM ||
1829 mode == MBEDTLS_MODE_CHACHAPOLY )
1830 return( MBEDTLS_SSL_MODE_AEAD );
1831#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001832
1833 return( MBEDTLS_SSL_MODE_STREAM );
1834}
Gilles Peskine301711e2022-04-26 16:57:05 +02001835#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001836
Gilles Peskinee108d982022-04-26 16:50:40 +02001837static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1838 mbedtls_ssl_mode_t base_mode,
1839 int encrypt_then_mac )
1840{
1841#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1842 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1843 base_mode == MBEDTLS_SSL_MODE_CBC )
1844 {
1845 return( MBEDTLS_SSL_MODE_CBC_ETM );
1846 }
1847#else
1848 (void) encrypt_then_mac;
1849#endif
1850 return( base_mode );
1851}
1852
Neil Armstrongab555e02022-04-04 11:07:59 +02001853mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001854 const mbedtls_ssl_transform *transform )
1855{
Gilles Peskinee108d982022-04-26 16:50:40 +02001856 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001858 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001859#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001860 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1861#endif
1862 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001863
Gilles Peskinee108d982022-04-26 16:50:40 +02001864 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001865#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001866 encrypt_then_mac = transform->encrypt_then_mac;
1867#endif
1868 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001869}
1870
Neil Armstrongab555e02022-04-04 11:07:59 +02001871mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001872#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001873 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001874#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001875 const mbedtls_ssl_ciphersuite_t *suite )
1876{
Gilles Peskinee108d982022-04-26 16:50:40 +02001877 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1878
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001879#if defined(MBEDTLS_USE_PSA_CRYPTO)
1880 psa_status_t status;
1881 psa_algorithm_t alg;
1882 psa_key_type_t type;
1883 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001884 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1885 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001886 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001887#else
1888 const mbedtls_cipher_info_t *cipher =
1889 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001890 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001891 {
1892 base_mode =
1893 mbedtls_ssl_get_base_mode(
1894 mbedtls_cipher_info_get_mode( cipher ) );
1895 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001896#endif /* MBEDTLS_USE_PSA_CRYPTO */
1897
Gilles Peskinee108d982022-04-26 16:50:40 +02001898#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1899 int encrypt_then_mac = 0;
1900#endif
1901 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001902}
1903
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001904#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001905
1906#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00001907/* Serialization of TLS 1.3 sessions:
1908 *
1909 * struct {
1910 * uint64 ticket_received;
1911 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08001912 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00001913 * } ClientOnlyData;
1914 *
1915 * struct {
1916 * uint8 endpoint;
1917 * uint8 ciphersuite[2];
1918 * uint32 ticket_age_add;
1919 * uint8 ticket_flags;
1920 * opaque resumption_key<0..255>;
1921 * select ( endpoint ) {
1922 * case client: ClientOnlyData;
1923 * case server: uint64 start_time;
1924 * };
1925 * } serialized_session_tls13;
1926 *
1927 */
1928#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08001929MBEDTLS_CHECK_RETURN_CRITICAL
1930static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
1931 unsigned char *buf,
1932 size_t buf_len,
1933 size_t *olen )
Jerry Yu438ddd82022-07-07 06:55:50 +00001934{
1935 unsigned char *p = buf;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001936 size_t needed = 1 /* endpoint */
1937 + 2 /* ciphersuite */
1938 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08001939 + 1 /* ticket_flags */
1940 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08001941 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08001942
1943 if( session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN )
1944 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1945 needed += session->resumption_key_len; /* resumption_key */
1946
Jerry Yu438ddd82022-07-07 06:55:50 +00001947#if defined(MBEDTLS_HAVE_TIME)
1948 needed += 8; /* start_time or ticket_received */
1949#endif
1950
1951#if defined(MBEDTLS_SSL_CLI_C)
1952 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1953 {
1954 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08001955 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08001956
1957 /* Check size_t overflow */
Jerry Yue36fdd62022-08-17 21:31:36 +08001958 if( session->ticket_len > SIZE_MAX - needed )
1959 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu34191072022-08-18 10:32:09 +08001960
Jerry Yue28d9742022-08-18 15:44:03 +08001961 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00001962 }
1963#endif /* MBEDTLS_SSL_CLI_C */
1964
Jerry Yue36fdd62022-08-17 21:31:36 +08001965 *olen = needed;
Jerry Yu438ddd82022-07-07 06:55:50 +00001966 if( needed > buf_len )
Jerry Yue36fdd62022-08-17 21:31:36 +08001967 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Jerry Yu438ddd82022-07-07 06:55:50 +00001968
1969 p[0] = session->endpoint;
1970 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
1971 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
1972 p[7] = session->ticket_flags;
1973
1974 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08001975 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001976 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001977 memcpy( p, session->resumption_key, session->resumption_key_len );
1978 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001979
1980#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
1981 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
1982 {
1983 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
1984 p += 8;
1985 }
1986#endif /* MBEDTLS_HAVE_TIME */
1987
1988#if defined(MBEDTLS_SSL_CLI_C)
1989 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1990 {
1991#if defined(MBEDTLS_HAVE_TIME)
1992 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
1993 p += 8;
1994#endif
1995 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
1996 p += 4;
1997
1998 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
1999 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002000
2001 if( session->ticket != NULL && session->ticket_len > 0 )
Jerry Yu438ddd82022-07-07 06:55:50 +00002002 {
2003 memcpy( p, session->ticket, session->ticket_len );
2004 p += session->ticket_len;
2005 }
2006 }
2007#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yue36fdd62022-08-17 21:31:36 +08002008 return( 0 );
Jerry Yu438ddd82022-07-07 06:55:50 +00002009}
2010
2011MBEDTLS_CHECK_RETURN_CRITICAL
2012static int ssl_tls13_session_load( mbedtls_ssl_session *session,
2013 const unsigned char *buf,
2014 size_t len )
2015{
2016 const unsigned char *p = buf;
2017 const unsigned char *end = buf + len;
2018
2019 if( end - p < 9 )
2020 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2021 session->endpoint = p[0];
2022 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2023 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2024 session->ticket_flags = p[7];
2025
2026 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002027 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002028 p += 9;
2029
Jerry Yubc7c1a42022-07-21 22:57:37 +08002030 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002031 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2032
Jerry Yubc7c1a42022-07-21 22:57:37 +08002033 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002034 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002035 memcpy( session->resumption_key, p, session->resumption_key_len );
2036 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002037
2038#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2039 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2040 {
2041 if( end - p < 8 )
2042 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2043 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2044 p += 8;
2045 }
2046#endif /* MBEDTLS_HAVE_TIME */
2047
2048#if defined(MBEDTLS_SSL_CLI_C)
2049 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2050 {
2051#if defined(MBEDTLS_HAVE_TIME)
2052 if( end - p < 8 )
2053 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2054 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2055 p += 8;
2056#endif
2057 if( end - p < 4 )
2058 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2059 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2060 p += 4;
2061
2062 if( end - p < 2 )
2063 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2064 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2065 p += 2;
2066
2067 if( end - p < ( long int )session->ticket_len )
2068 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2069 if( session->ticket_len > 0 )
2070 {
2071 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2072 if( session->ticket == NULL )
2073 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2074 memcpy( session->ticket, p, session->ticket_len );
2075 p += session->ticket_len;
2076 }
2077 }
2078#endif /* MBEDTLS_SSL_CLI_C */
2079
2080 return( 0 );
2081
2082}
2083#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002084MBEDTLS_CHECK_RETURN_CRITICAL
2085static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2086 unsigned char *buf,
2087 size_t buf_len,
2088 size_t *olen )
Jerry Yu251a12e2022-07-13 15:15:48 +08002089{
2090 ((void) session);
2091 ((void) buf);
2092 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002093 *olen = 0;
2094 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu251a12e2022-07-13 15:15:48 +08002095}
Jerry Yu438ddd82022-07-07 06:55:50 +00002096
2097static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2098 unsigned char *buf,
2099 size_t buf_len )
2100{
2101 ((void) session);
2102 ((void) buf);
2103 ((void) buf_len);
2104 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2105}
2106#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002107#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2108
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002109psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002110 size_t taglen,
2111 psa_algorithm_t *alg,
2112 psa_key_type_t *key_type,
2113 size_t *key_size )
2114{
2115 switch ( mbedtls_cipher_type )
2116 {
2117 case MBEDTLS_CIPHER_AES_128_CBC:
2118 *alg = PSA_ALG_CBC_NO_PADDING;
2119 *key_type = PSA_KEY_TYPE_AES;
2120 *key_size = 128;
2121 break;
2122 case MBEDTLS_CIPHER_AES_128_CCM:
2123 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2124 *key_type = PSA_KEY_TYPE_AES;
2125 *key_size = 128;
2126 break;
2127 case MBEDTLS_CIPHER_AES_128_GCM:
2128 *alg = PSA_ALG_GCM;
2129 *key_type = PSA_KEY_TYPE_AES;
2130 *key_size = 128;
2131 break;
2132 case MBEDTLS_CIPHER_AES_192_CCM:
2133 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2134 *key_type = PSA_KEY_TYPE_AES;
2135 *key_size = 192;
2136 break;
2137 case MBEDTLS_CIPHER_AES_192_GCM:
2138 *alg = PSA_ALG_GCM;
2139 *key_type = PSA_KEY_TYPE_AES;
2140 *key_size = 192;
2141 break;
2142 case MBEDTLS_CIPHER_AES_256_CBC:
2143 *alg = PSA_ALG_CBC_NO_PADDING;
2144 *key_type = PSA_KEY_TYPE_AES;
2145 *key_size = 256;
2146 break;
2147 case MBEDTLS_CIPHER_AES_256_CCM:
2148 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2149 *key_type = PSA_KEY_TYPE_AES;
2150 *key_size = 256;
2151 break;
2152 case MBEDTLS_CIPHER_AES_256_GCM:
2153 *alg = PSA_ALG_GCM;
2154 *key_type = PSA_KEY_TYPE_AES;
2155 *key_size = 256;
2156 break;
2157 case MBEDTLS_CIPHER_ARIA_128_CBC:
2158 *alg = PSA_ALG_CBC_NO_PADDING;
2159 *key_type = PSA_KEY_TYPE_ARIA;
2160 *key_size = 128;
2161 break;
2162 case MBEDTLS_CIPHER_ARIA_128_CCM:
2163 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2164 *key_type = PSA_KEY_TYPE_ARIA;
2165 *key_size = 128;
2166 break;
2167 case MBEDTLS_CIPHER_ARIA_128_GCM:
2168 *alg = PSA_ALG_GCM;
2169 *key_type = PSA_KEY_TYPE_ARIA;
2170 *key_size = 128;
2171 break;
2172 case MBEDTLS_CIPHER_ARIA_192_CCM:
2173 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2174 *key_type = PSA_KEY_TYPE_ARIA;
2175 *key_size = 192;
2176 break;
2177 case MBEDTLS_CIPHER_ARIA_192_GCM:
2178 *alg = PSA_ALG_GCM;
2179 *key_type = PSA_KEY_TYPE_ARIA;
2180 *key_size = 192;
2181 break;
2182 case MBEDTLS_CIPHER_ARIA_256_CBC:
2183 *alg = PSA_ALG_CBC_NO_PADDING;
2184 *key_type = PSA_KEY_TYPE_ARIA;
2185 *key_size = 256;
2186 break;
2187 case MBEDTLS_CIPHER_ARIA_256_CCM:
2188 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2189 *key_type = PSA_KEY_TYPE_ARIA;
2190 *key_size = 256;
2191 break;
2192 case MBEDTLS_CIPHER_ARIA_256_GCM:
2193 *alg = PSA_ALG_GCM;
2194 *key_type = PSA_KEY_TYPE_ARIA;
2195 *key_size = 256;
2196 break;
2197 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2198 *alg = PSA_ALG_CBC_NO_PADDING;
2199 *key_type = PSA_KEY_TYPE_CAMELLIA;
2200 *key_size = 128;
2201 break;
2202 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2203 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2204 *key_type = PSA_KEY_TYPE_CAMELLIA;
2205 *key_size = 128;
2206 break;
2207 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2208 *alg = PSA_ALG_GCM;
2209 *key_type = PSA_KEY_TYPE_CAMELLIA;
2210 *key_size = 128;
2211 break;
2212 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2213 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2214 *key_type = PSA_KEY_TYPE_CAMELLIA;
2215 *key_size = 192;
2216 break;
2217 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2218 *alg = PSA_ALG_GCM;
2219 *key_type = PSA_KEY_TYPE_CAMELLIA;
2220 *key_size = 192;
2221 break;
2222 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2223 *alg = PSA_ALG_CBC_NO_PADDING;
2224 *key_type = PSA_KEY_TYPE_CAMELLIA;
2225 *key_size = 256;
2226 break;
2227 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2228 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2229 *key_type = PSA_KEY_TYPE_CAMELLIA;
2230 *key_size = 256;
2231 break;
2232 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2233 *alg = PSA_ALG_GCM;
2234 *key_type = PSA_KEY_TYPE_CAMELLIA;
2235 *key_size = 256;
2236 break;
2237 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2238 *alg = PSA_ALG_CHACHA20_POLY1305;
2239 *key_type = PSA_KEY_TYPE_CHACHA20;
2240 *key_size = 256;
2241 break;
2242 case MBEDTLS_CIPHER_NULL:
2243 *alg = MBEDTLS_SSL_NULL_CIPHER;
2244 *key_type = 0;
2245 *key_size = 0;
2246 break;
2247 default:
2248 return PSA_ERROR_NOT_SUPPORTED;
2249 }
2250
2251 return PSA_SUCCESS;
2252}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002253#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002254
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002255#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002256int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2257 const unsigned char *dhm_P, size_t P_len,
2258 const unsigned char *dhm_G, size_t G_len )
2259{
Janos Follath865b3eb2019-12-16 11:46:15 +00002260 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002261
Glenn Strausscee11292021-12-20 01:43:17 -05002262 mbedtls_mpi_free( &conf->dhm_P );
2263 mbedtls_mpi_free( &conf->dhm_G );
2264
Hanno Beckera90658f2017-10-04 15:29:08 +01002265 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2266 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2267 {
2268 mbedtls_mpi_free( &conf->dhm_P );
2269 mbedtls_mpi_free( &conf->dhm_G );
2270 return( ret );
2271 }
2272
2273 return( 0 );
2274}
Paul Bakker5121ce52009-01-03 21:22:43 +00002275
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002276int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002277{
Janos Follath865b3eb2019-12-16 11:46:15 +00002278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002279
Glenn Strausscee11292021-12-20 01:43:17 -05002280 mbedtls_mpi_free( &conf->dhm_P );
2281 mbedtls_mpi_free( &conf->dhm_G );
2282
Gilles Peskinee5702482021-06-11 21:59:08 +02002283 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2284 &conf->dhm_P ) ) != 0 ||
2285 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2286 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002287 {
2288 mbedtls_mpi_free( &conf->dhm_P );
2289 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002290 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002291 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002292
2293 return( 0 );
2294}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002295#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002296
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002297#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2298/*
2299 * Set the minimum length for Diffie-Hellman parameters
2300 */
2301void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2302 unsigned int bitlen )
2303{
2304 conf->dhm_min_bitlen = bitlen;
2305}
2306#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2307
Gilles Peskineeccd8882020-03-10 12:19:08 +01002308#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002309#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002310/*
2311 * Set allowed/preferred hashes for handshake signatures
2312 */
2313void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2314 const int *hashes )
2315{
2316 conf->sig_hashes = hashes;
2317}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002318#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002319
Jerry Yuf017ee42022-01-12 15:49:48 +08002320/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002321void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2322 const uint16_t* sig_algs )
2323{
Jerry Yuf017ee42022-01-12 15:49:48 +08002324#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2325 conf->sig_hashes = NULL;
2326#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2327 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002328}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002329#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002330
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002331#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002332#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002333/*
2334 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002335 *
2336 * mbedtls_ssl_setup() takes the provided list
2337 * and translates it to a list of IANA TLS group identifiers,
2338 * stored in ssl->handshake->group_list.
2339 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002340 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002341void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002342 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002343{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002344 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002345 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002346}
Brett Warrene0edc842021-08-17 09:53:13 +01002347#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002348#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002349
Brett Warrene0edc842021-08-17 09:53:13 +01002350/*
2351 * Set the allowed groups
2352 */
2353void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2354 const uint16_t *group_list )
2355{
2356#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2357 conf->curve_list = NULL;
2358#endif
2359 conf->group_list = group_list;
2360}
2361
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002362#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002364{
Hanno Becker947194e2017-04-07 13:25:49 +01002365 /* Initialize to suppress unnecessary compiler warning */
2366 size_t hostname_len = 0;
2367
2368 /* Check if new hostname is valid before
2369 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002370 if( hostname != NULL )
2371 {
2372 hostname_len = strlen( hostname );
2373
2374 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2375 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2376 }
2377
2378 /* Now it's clear that we will overwrite the old hostname,
2379 * so we can free it safely */
2380
2381 if( ssl->hostname != NULL )
2382 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002383 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002384 mbedtls_free( ssl->hostname );
2385 }
2386
2387 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002388
Paul Bakker5121ce52009-01-03 21:22:43 +00002389 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002390 {
2391 ssl->hostname = NULL;
2392 }
2393 else
2394 {
2395 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002396 if( ssl->hostname == NULL )
2397 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002398
Hanno Becker947194e2017-04-07 13:25:49 +01002399 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002400
Hanno Becker947194e2017-04-07 13:25:49 +01002401 ssl->hostname[hostname_len] = '\0';
2402 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002403
2404 return( 0 );
2405}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002406#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002407
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002408#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002409void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002411 const unsigned char *, size_t),
2412 void *p_sni )
2413{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002414 conf->f_sni = f_sni;
2415 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002416}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002417#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002420int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002421{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002422 size_t cur_len, tot_len;
2423 const char **p;
2424
2425 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002426 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2427 * MUST NOT be truncated."
2428 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002429 */
2430 tot_len = 0;
2431 for( p = protos; *p != NULL; p++ )
2432 {
2433 cur_len = strlen( *p );
2434 tot_len += cur_len;
2435
Ronald Cron8216dd32020-04-23 16:41:44 +02002436 if( ( cur_len == 0 ) ||
2437 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2438 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002440 }
2441
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002442 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002443
2444 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002445}
2446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002448{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002449 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002450}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002452
Johan Pascalb62bb512015-12-03 21:56:45 +01002453#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002454void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2455 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002456{
2457 conf->dtls_srtp_mki_support = support_mki_value;
2458}
2459
Ron Eldoref72faf2018-07-12 11:54:20 +03002460int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2461 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002462 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002463{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002464 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002465 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002466 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002467 }
Ron Eldor591f1622018-01-22 12:30:04 +02002468
2469 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002470 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002471 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002472 }
Ron Eldor591f1622018-01-22 12:30:04 +02002473
2474 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2475 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002476 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002477}
2478
Ron Eldoref72faf2018-07-12 11:54:20 +03002479int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002480 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002481{
Johan Pascal253d0262020-09-22 13:04:45 +02002482 const mbedtls_ssl_srtp_profile *p;
2483 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002484
Johan Pascal253d0262020-09-22 13:04:45 +02002485 /* check the profiles list: all entry must be valid,
2486 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002487 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2488 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2489 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002490 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002491 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002492 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002493 list_size++;
2494 }
2495 else
2496 {
2497 /* unsupported value, stop parsing and set the size to an error value */
2498 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002499 }
2500 }
2501
Johan Pascal5ef72d22020-10-28 17:05:47 +01002502 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002503 {
Johan Pascal253d0262020-09-22 13:04:45 +02002504 conf->dtls_srtp_profile_list = NULL;
2505 conf->dtls_srtp_profile_list_len = 0;
2506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2507 }
2508
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002509 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002510 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002511
2512 return( 0 );
2513}
2514
Johan Pascal5ef72d22020-10-28 17:05:47 +01002515void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2516 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002517{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002518 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2519 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002520 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002521 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002522 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002523 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002524 else
2525 {
2526 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002527 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2528 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002529 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002530}
Johan Pascalb62bb512015-12-03 21:56:45 +01002531#endif /* MBEDTLS_SSL_DTLS_SRTP */
2532
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302533#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002534void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002535{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002536 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002537}
2538
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002539void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002540{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002541 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002542}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302543#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002544
Janos Follath088ce432017-04-10 12:42:31 +01002545#if defined(MBEDTLS_SSL_SRV_C)
2546void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2547 char cert_req_ca_list )
2548{
2549 conf->cert_req_ca_list = cert_req_ca_list;
2550}
2551#endif
2552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002554void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002555{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002556 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002557}
2558#endif
2559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002561void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002562{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002563 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002564}
2565#endif
2566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002568int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002569{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002571 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002572 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002574 }
2575
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002576 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002577
2578 return( 0 );
2579}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002581
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002582void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002583{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002584 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002585}
2586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002588void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002589{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002590 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002591}
2592
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002593void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002594{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002595 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002596}
2597
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002598void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002599 const unsigned char period[8] )
2600{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002601 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002602}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002606#if defined(MBEDTLS_SSL_CLI_C)
2607void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002608{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002609 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002610}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002611#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002612
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002613#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002614void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2615 mbedtls_ssl_ticket_write_t *f_ticket_write,
2616 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2617 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002618{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002619 conf->f_ticket_write = f_ticket_write;
2620 conf->f_ticket_parse = f_ticket_parse;
2621 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002622}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002623#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002625
Hanno Becker7e6c1782021-06-08 09:24:55 +01002626void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2627 mbedtls_ssl_export_keys_t *f_export_keys,
2628 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002629{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002630 ssl->f_export_keys = f_export_keys;
2631 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002632}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002633
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002634#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002635void mbedtls_ssl_conf_async_private_cb(
2636 mbedtls_ssl_config *conf,
2637 mbedtls_ssl_async_sign_t *f_async_sign,
2638 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2639 mbedtls_ssl_async_resume_t *f_async_resume,
2640 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002641 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002642{
2643 conf->f_async_sign_start = f_async_sign;
2644 conf->f_async_decrypt_start = f_async_decrypt;
2645 conf->f_async_resume = f_async_resume;
2646 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002647 conf->p_async_config_data = async_config_data;
2648}
2649
Gilles Peskine8f97af72018-04-26 11:46:10 +02002650void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2651{
2652 return( conf->p_async_config_data );
2653}
2654
Gilles Peskine1febfef2018-04-30 11:54:39 +02002655void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002656{
2657 if( ssl->handshake == NULL )
2658 return( NULL );
2659 else
2660 return( ssl->handshake->user_async_ctx );
2661}
2662
Gilles Peskine1febfef2018-04-30 11:54:39 +02002663void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002664 void *ctx )
2665{
2666 if( ssl->handshake != NULL )
2667 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002668}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002669#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002670
Paul Bakker5121ce52009-01-03 21:22:43 +00002671/*
2672 * SSL get accessors
2673 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002674uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002675{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002676 if( ssl->session != NULL )
2677 return( ssl->session->verify_result );
2678
2679 if( ssl->session_negotiate != NULL )
2680 return( ssl->session_negotiate->verify_result );
2681
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002682 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002683}
2684
Glenn Strauss8f526902022-01-13 00:04:49 -05002685int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2686{
2687 if( ssl == NULL || ssl->session == NULL )
2688 return( 0 );
2689
2690 return( ssl->session->ciphersuite );
2691}
2692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002694{
Paul Bakker926c8e42013-03-06 10:23:34 +01002695 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002696 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002699}
2700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002702{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002703#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002704 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002705 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002706 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002707 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002708 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002709 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002710 default:
2711 return( "unknown (DTLS)" );
2712 }
2713 }
2714#endif
2715
Glenn Strauss60bfe602022-03-14 19:04:24 -04002716 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002717 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002718 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002719 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002720 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002721 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002722 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002723 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002724 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002725}
2726
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002727#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002728size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2729{
David Horstmann95d516f2021-05-04 18:36:56 +01002730 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002731 size_t read_mfl;
2732
2733 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2734 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2735 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2736 {
2737 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2738 }
2739
2740 /* Check if a smaller max length was negotiated */
2741 if( ssl->session_out != NULL )
2742 {
2743 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2744 if( read_mfl < max_len )
2745 {
2746 max_len = read_mfl;
2747 }
2748 }
2749
2750 // During a handshake, use the value being negotiated
2751 if( ssl->session_negotiate != NULL )
2752 {
2753 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2754 if( read_mfl < max_len )
2755 {
2756 max_len = read_mfl;
2757 }
2758 }
2759
2760 return( max_len );
2761}
2762
2763size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002764{
2765 size_t max_len;
2766
2767 /*
2768 * Assume mfl_code is correct since it was checked when set
2769 */
Angus Grattond8213d02016-05-25 20:56:48 +10002770 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002771
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002772 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002773 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002774 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002775 {
Angus Grattond8213d02016-05-25 20:56:48 +10002776 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002777 }
2778
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002779 /* During a handshake, use the value being negotiated */
2780 if( ssl->session_negotiate != NULL &&
2781 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2782 {
2783 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2784 }
2785
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002786 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002787}
2788#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2789
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002790#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002791size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002792{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002793 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2794 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2795 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2796 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2797 return ( 0 );
2798
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002799 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2800 return( ssl->mtu );
2801
2802 if( ssl->mtu == 0 )
2803 return( ssl->handshake->mtu );
2804
2805 return( ssl->mtu < ssl->handshake->mtu ?
2806 ssl->mtu : ssl->handshake->mtu );
2807}
2808#endif /* MBEDTLS_SSL_PROTO_DTLS */
2809
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002810int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2811{
2812 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2813
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002814#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2815 !defined(MBEDTLS_SSL_PROTO_DTLS)
2816 (void) ssl;
2817#endif
2818
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002819#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002820 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002821
2822 if( max_len > mfl )
2823 max_len = mfl;
2824#endif
2825
2826#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002827 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002828 {
Hanno Becker89490712020-02-05 10:50:12 +00002829 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002830 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2831 const size_t overhead = (size_t) ret;
2832
2833 if( ret < 0 )
2834 return( ret );
2835
2836 if( mtu <= overhead )
2837 {
2838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2839 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2840 }
2841
2842 if( max_len > mtu - overhead )
2843 max_len = mtu - overhead;
2844 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002845#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002846
Hanno Becker0defedb2018-08-10 12:35:02 +01002847#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2848 !defined(MBEDTLS_SSL_PROTO_DTLS)
2849 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002850#endif
2851
2852 return( (int) max_len );
2853}
2854
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002855int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2856{
2857 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2858
2859#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2860 (void) ssl;
2861#endif
2862
2863#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2864 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2865
2866 if( max_len > mfl )
2867 max_len = mfl;
2868#endif
2869
2870 return( (int) max_len );
2871}
2872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#if defined(MBEDTLS_X509_CRT_PARSE_C)
2874const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002875{
2876 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002877 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002878
Hanno Beckere6824572019-02-07 13:18:46 +00002879#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002880 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002881#else
2882 return( NULL );
2883#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002884}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002886
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002888int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2889 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002890{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002891 int ret;
2892
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002893 if( ssl == NULL ||
2894 dst == NULL ||
2895 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002896 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002897 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002899 }
2900
Hanno Beckere810bbc2021-05-14 16:01:05 +01002901 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2902 * idempotent: Each session can only be exported once.
2903 *
2904 * (This is in preparation for TLS 1.3 support where we will
2905 * need the ability to export multiple sessions (aka tickets),
2906 * which will be achieved by calling mbedtls_ssl_get_session()
2907 * multiple times until it fails.)
2908 *
2909 * Check whether we have already exported the current session,
2910 * and fail if so.
2911 */
2912 if( ssl->session->exported == 1 )
2913 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2914
2915 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2916 if( ret != 0 )
2917 return( ret );
2918
2919 /* Remember that we've exported the session. */
2920 ssl->session->exported = 1;
2921 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002922}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002924
Paul Bakker5121ce52009-01-03 21:22:43 +00002925/*
Hanno Beckera835da52019-05-16 12:39:07 +01002926 * Define ticket header determining Mbed TLS version
2927 * and structure of the ticket.
2928 */
2929
Hanno Becker94ef3b32019-05-16 12:50:45 +01002930/*
Hanno Becker50b59662019-05-28 14:30:45 +01002931 * Define bitflag determining compile-time settings influencing
2932 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002933 */
2934
Hanno Becker50b59662019-05-28 14:30:45 +01002935#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002936#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002937#else
Hanno Becker3e088662019-05-29 11:10:18 +01002938#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002939#endif /* MBEDTLS_HAVE_TIME */
2940
2941#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002942#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002943#else
Hanno Becker3e088662019-05-29 11:10:18 +01002944#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002945#endif /* MBEDTLS_X509_CRT_PARSE_C */
2946
2947#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002948#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002949#else
Hanno Becker3e088662019-05-29 11:10:18 +01002950#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002951#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2952
2953#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002954#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002955#else
Hanno Becker3e088662019-05-29 11:10:18 +01002956#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002957#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2958
Hanno Becker94ef3b32019-05-16 12:50:45 +01002959#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002960#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002961#else
Hanno Becker3e088662019-05-29 11:10:18 +01002962#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002963#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2964
Hanno Becker94ef3b32019-05-16 12:50:45 +01002965#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2966#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2967#else
2968#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2969#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2970
Hanno Becker3e088662019-05-29 11:10:18 +01002971#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2972#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2973#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2974#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002975#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2976#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002977
Hanno Becker50b59662019-05-28 14:30:45 +01002978#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002979 ( (uint16_t) ( \
2980 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2981 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2982 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2983 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002984 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002985 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002986
Hanno Beckerf8787072019-05-16 12:41:07 +01002987static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002988 MBEDTLS_VERSION_MAJOR,
2989 MBEDTLS_VERSION_MINOR,
2990 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002991 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2992 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002993};
Hanno Beckera835da52019-05-16 12:39:07 +01002994
2995/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002996 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002997 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002998 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002999 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003000 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003001 * opaque mbedtls_version[3]; // library version: major, minor, patch
3002 * opaque session_format[2]; // library-version specific 16-bit field
3003 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003004 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003005 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003006 * Note: When updating the format, remember to keep
3007 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003008 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003009 * // In this version, `session_format` determines
3010 * // the setting of those compile-time
3011 * // configuration options which influence
3012 * // the structure of mbedtls_ssl_session.
3013 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003014 * uint8_t minor_ver; // Protocol minor version. Possible values:
3015 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003016 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003017 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003018 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003019 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003020 * serialized_session_tls12 data;
3021 *
3022 * };
3023 *
3024 * } serialized_session;
3025 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003026 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003027
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003028MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003029static int ssl_session_save( const mbedtls_ssl_session *session,
3030 unsigned char omit_header,
3031 unsigned char *buf,
3032 size_t buf_len,
3033 size_t *olen )
3034{
3035 unsigned char *p = buf;
3036 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003037 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003038#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3039 size_t out_len;
3040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3041#endif
Jerry Yu438ddd82022-07-07 06:55:50 +00003042 if( session == NULL )
3043 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3044
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003045 if( !omit_header )
3046 {
3047 /*
3048 * Add Mbed TLS version identifier
3049 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003050 used += sizeof( ssl_serialized_session_header );
3051
3052 if( used <= buf_len )
3053 {
3054 memcpy( p, ssl_serialized_session_header,
3055 sizeof( ssl_serialized_session_header ) );
3056 p += sizeof( ssl_serialized_session_header );
3057 }
3058 }
3059
3060 /*
3061 * TLS version identifier
3062 */
3063 used += 1;
3064 if( used <= buf_len )
3065 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003066 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003067 }
3068
3069 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003070 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003071 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003072 {
3073#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003074 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003075 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003076 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003077#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3078
Jerry Yu251a12e2022-07-13 15:15:48 +08003079#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3080 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yue36fdd62022-08-17 21:31:36 +08003081 ret = ssl_tls13_session_save( session, p, remaining_len, &out_len );
3082 if( ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
Jerry Yue36fdd62022-08-17 21:31:36 +08003083 return( ret );
Jerry Yue36fdd62022-08-17 21:31:36 +08003084 used += out_len;
Jerry Yu251a12e2022-07-13 15:15:48 +08003085 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003086#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3087
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003088 default:
3089 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3090 }
3091
3092 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003093 if( used > buf_len )
3094 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003095
3096 return( 0 );
3097}
3098
3099/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003100 * Public wrapper for ssl_session_save()
3101 */
3102int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3103 unsigned char *buf,
3104 size_t buf_len,
3105 size_t *olen )
3106{
3107 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3108}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003109
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003110/*
3111 * Deserialize session, see mbedtls_ssl_session_save() for format.
3112 *
3113 * This internal version is wrapped by a public function that cleans up in
3114 * case of error, and has an extra option omit_header.
3115 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003116MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003117static int ssl_session_load( mbedtls_ssl_session *session,
3118 unsigned char omit_header,
3119 const unsigned char *buf,
3120 size_t len )
3121{
3122 const unsigned char *p = buf;
3123 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003124 size_t remaining_len;
3125
3126
3127 if( session == NULL )
3128 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003129
3130 if( !omit_header )
3131 {
3132 /*
3133 * Check Mbed TLS version identifier
3134 */
3135
3136 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3137 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3138
3139 if( memcmp( p, ssl_serialized_session_header,
3140 sizeof( ssl_serialized_session_header ) ) != 0 )
3141 {
3142 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3143 }
3144 p += sizeof( ssl_serialized_session_header );
3145 }
3146
3147 /*
3148 * TLS version identifier
3149 */
3150 if( 1 > (size_t)( end - p ) )
3151 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003152 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003153
3154 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003155 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003156 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003157 {
3158#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003159 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003160 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003161#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3162
Jerry Yu438ddd82022-07-07 06:55:50 +00003163#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3164 case MBEDTLS_SSL_VERSION_TLS1_3:
3165 return( ssl_tls13_session_load( session, p, remaining_len ) );
3166#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3167
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003168 default:
3169 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3170 }
3171}
3172
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003173/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003174 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003175 */
3176int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3177 const unsigned char *buf,
3178 size_t len )
3179{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003180 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003181
3182 if( ret != 0 )
3183 mbedtls_ssl_session_free( session );
3184
3185 return( ret );
3186}
3187
3188/*
Paul Bakker1961b702013-01-25 14:49:24 +01003189 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003190 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003191MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003192static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3193{
3194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3195
Ronald Cron66dbf912022-02-02 15:33:46 +01003196 /*
3197 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003198 * that were written into the output buffer by the previous handshake step,
3199 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003200 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3201 * We proceed to the next handshake step only when all data from the
3202 * previous one have been sent to the peer, thus we make sure that this is
3203 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3204 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3205 * we have to wait before to go ahead.
3206 * In the case of TLS 1.3, handshake step handlers do not send data to the
3207 * peer. Data are only sent here and through
3208 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003209 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003210 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003211 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3212 return( ret );
3213
3214#if defined(MBEDTLS_SSL_PROTO_DTLS)
3215 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3216 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3217 {
3218 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3219 return( ret );
3220 }
3221#endif /* MBEDTLS_SSL_PROTO_DTLS */
3222
3223 return( ret );
3224}
3225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003227{
Hanno Becker41934dd2021-08-07 19:13:43 +01003228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003229
Hanno Becker41934dd2021-08-07 19:13:43 +01003230 if( ssl == NULL ||
3231 ssl->conf == NULL ||
3232 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003233 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003234 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003235 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003236 }
3237
3238 ret = ssl_prepare_handshake_step( ssl );
3239 if( ret != 0 )
3240 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003241
Jerry Yue7047812021-09-13 19:26:39 +08003242 ret = mbedtls_ssl_handle_pending_alert( ssl );
3243 if( ret != 0 )
3244 goto cleanup;
3245
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003246 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3247 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3248 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3249
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003251 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003252 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003253 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3254 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003255
Ronald Cron9f0fba32022-02-10 16:45:15 +01003256 switch( ssl->state )
3257 {
3258 case MBEDTLS_SSL_HELLO_REQUEST:
3259 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3260 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003261
Ronald Cron9f0fba32022-02-10 16:45:15 +01003262 case MBEDTLS_SSL_CLIENT_HELLO:
3263 ret = mbedtls_ssl_write_client_hello( ssl );
3264 break;
3265
3266 default:
3267#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003268 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003269 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3270 else
3271 ret = mbedtls_ssl_handshake_client_step( ssl );
3272#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3273 ret = mbedtls_ssl_handshake_client_step( ssl );
3274#else
3275 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3276#endif
3277 }
Jerry Yub9930e72021-08-06 17:11:51 +08003278 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003279#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003281 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003282 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003283#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003284 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003285 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003286#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003287
3288#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3289 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3290 ret = mbedtls_ssl_handshake_server_step( ssl );
3291#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3292 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003293#endif
3294
Jerry Yue7047812021-09-13 19:26:39 +08003295 if( ret != 0 )
3296 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003297 /* handshake_step return error. And it is same
3298 * with alert_reason.
3299 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003300 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003301 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003302 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003303 goto cleanup;
3304 }
3305 }
3306
3307cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003308 return( ret );
3309}
3310
3311/*
3312 * Perform the SSL handshake
3313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003315{
3316 int ret = 0;
3317
Hanno Beckera817ea42020-10-20 15:20:23 +01003318 /* Sanity checks */
3319
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003320 if( ssl == NULL || ssl->conf == NULL )
3321 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3322
Hanno Beckera817ea42020-10-20 15:20:23 +01003323#if defined(MBEDTLS_SSL_PROTO_DTLS)
3324 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3325 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3326 {
3327 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3328 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3329 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3330 }
3331#endif /* MBEDTLS_SSL_PROTO_DTLS */
3332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003334
Hanno Beckera817ea42020-10-20 15:20:23 +01003335 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003336 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003337 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003339
3340 if( ret != 0 )
3341 break;
3342 }
3343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003345
3346 return( ret );
3347}
3348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349#if defined(MBEDTLS_SSL_RENEGOTIATION)
3350#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003351/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003352 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003353 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003354MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003356{
Janos Follath865b3eb2019-12-16 11:46:15 +00003357 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003360
3361 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3363 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003364
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003365 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003366 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003367 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003368 return( ret );
3369 }
3370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003372
3373 return( 0 );
3374}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003376
3377/*
3378 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 * - any side: calling mbedtls_ssl_renegotiate(),
3380 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3381 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003382 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003383 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003385 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003386int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003387{
Janos Follath865b3eb2019-12-16 11:46:15 +00003388 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003391
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003392 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3393 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003394
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003395 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3396 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003398 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003400 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003401 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003402 ssl->handshake->out_msg_seq = 1;
3403 else
3404 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003405 }
3406#endif
3407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3409 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003414 return( ret );
3415 }
3416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003418
3419 return( 0 );
3420}
3421
3422/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003423 * Renegotiate current connection on client,
3424 * or request renegotiation on server
3425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003427{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003429
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003430 if( ssl == NULL || ssl->conf == NULL )
3431 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003434 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003435 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003436 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003437 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003441
3442 /* Did we already try/start sending HelloRequest? */
3443 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003445
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003446 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003447 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003451 /*
3452 * On client, either start the renegotiation process or,
3453 * if already in progress, continue the handshake
3454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003456 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003457 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003459
Hanno Becker40cdaa12020-02-05 10:48:27 +00003460 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003461 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003462 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003463 return( ret );
3464 }
3465 }
3466 else
3467 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003471 return( ret );
3472 }
3473 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003475
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003476 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003477}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003479
Gilles Peskine9b562d52018-04-25 20:32:43 +02003480void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003481{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003482 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3483
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003484 if( handshake == NULL )
3485 return;
3486
Brett Warrene0edc842021-08-17 09:53:13 +01003487#if defined(MBEDTLS_ECP_C)
3488#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3489 if ( ssl->handshake->group_list_heap_allocated )
3490 mbedtls_free( (void*) handshake->group_list );
3491 handshake->group_list = NULL;
3492#endif /* MBEDTLS_DEPRECATED_REMOVED */
3493#endif /* MBEDTLS_ECP_C */
3494
Jerry Yuf017ee42022-01-12 15:49:48 +08003495#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3496#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3497 if ( ssl->handshake->sig_algs_heap_allocated )
3498 mbedtls_free( (void*) handshake->sig_algs );
3499 handshake->sig_algs = NULL;
3500#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003501#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3502 if( ssl->handshake->certificate_request_context )
3503 {
3504 mbedtls_free( (void*) handshake->certificate_request_context );
3505 }
3506#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003507#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3508
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003509#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3510 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3511 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003512 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003513 handshake->async_in_progress = 0;
3514 }
3515#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3516
Andrzej Kurek25f27152022-08-17 16:09:31 -04003517#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003518#if defined(MBEDTLS_USE_PSA_CRYPTO)
3519 psa_hash_abort( &handshake->fin_sha256_psa );
3520#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003521 mbedtls_sha256_free( &handshake->fin_sha256 );
3522#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003523#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04003524#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003525#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003526 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003527#else
Andrzej Kureka242e832022-08-11 10:03:14 -04003528 mbedtls_sha512_free( &handshake->fin_sha384 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003529#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003530#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532#if defined(MBEDTLS_DHM_C)
3533 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003534#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003535#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003537#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003538#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003539 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003540#if defined(MBEDTLS_SSL_CLI_C)
3541 mbedtls_free( handshake->ecjpake_cache );
3542 handshake->ecjpake_cache = NULL;
3543 handshake->ecjpake_cache_len = 0;
3544#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003545#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003546
Janos Follath4ae5c292016-02-10 11:27:43 +00003547#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3548 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003549 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003551#endif
3552
Gilles Peskineeccd8882020-03-10 12:19:08 +01003553#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003554#if defined(MBEDTLS_USE_PSA_CRYPTO)
3555 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3556 {
3557 /* The maintenance of the external PSK key slot is the
3558 * user's responsibility. */
3559 if( ssl->handshake->psk_opaque_is_internal )
3560 {
3561 psa_destroy_key( ssl->handshake->psk_opaque );
3562 ssl->handshake->psk_opaque_is_internal = 0;
3563 }
3564 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3565 }
Neil Armstronge952a302022-05-03 10:22:14 +02003566#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003567 if( handshake->psk != NULL )
3568 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003569 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003570 mbedtls_free( handshake->psk );
3571 }
Neil Armstronge952a302022-05-03 10:22:14 +02003572#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003573#endif
3574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3576 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003577 /*
3578 * Free only the linked list wrapper, not the keys themselves
3579 * since the belong to the SNI callback
3580 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003581 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003583
Gilles Peskineeccd8882020-03-10 12:19:08 +01003584#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003585 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003586 if( handshake->ecrs_peer_cert != NULL )
3587 {
3588 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3589 mbedtls_free( handshake->ecrs_peer_cert );
3590 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003591#endif
3592
Hanno Becker75173122019-02-06 16:18:31 +00003593#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3594 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3595 mbedtls_pk_free( &handshake->peer_pubkey );
3596#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3597
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003598#if defined(MBEDTLS_SSL_CLI_C) && \
3599 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3600 mbedtls_free( handshake->cookie );
3601#endif /* MBEDTLS_SSL_CLI_C &&
3602 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003603
3604#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003605 mbedtls_ssl_flight_free( handshake->flight );
3606 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003607#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003608
Ronald Cronf12b81d2022-03-15 10:42:41 +01003609#if defined(MBEDTLS_ECDH_C) && \
3610 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003611 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003612 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003613#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3614
Ronald Cron6f135e12021-12-08 16:57:54 +01003615#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003616 mbedtls_ssl_transform_free( handshake->transform_handshake );
3617 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003618 mbedtls_free( handshake->transform_earlydata );
3619 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003620#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003621
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003622
3623#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3624 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3625 * processes datagrams and the fact that a datagram is allowed to have
3626 * several records in it, it is possible that the I/O buffers are not
3627 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003628 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3629 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003630#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003631
Jerry Yuba9c7272021-10-30 11:54:10 +08003632 /* mbedtls_platform_zeroize MUST be last one in this function */
3633 mbedtls_platform_zeroize( handshake,
3634 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003635}
3636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003637void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003638{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003639 if( session == NULL )
3640 return;
3641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003642#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003643 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003644#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003645
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003646#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003648#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003649
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003650 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003651}
3652
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003653#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003654
3655#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3656#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3657#else
3658#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3659#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3660
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003661#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003662
3663#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3664#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3665#else
3666#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3667#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3668
3669#if defined(MBEDTLS_SSL_ALPN)
3670#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3671#else
3672#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3673#endif /* MBEDTLS_SSL_ALPN */
3674
3675#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3676#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3677#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3678#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3679
3680#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3681 ( (uint32_t) ( \
3682 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3683 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3684 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3685 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3686 0u ) )
3687
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003688static unsigned char ssl_serialized_context_header[] = {
3689 MBEDTLS_VERSION_MAJOR,
3690 MBEDTLS_VERSION_MINOR,
3691 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003692 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3693 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3694 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3695 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3696 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003697};
3698
Paul Bakker5121ce52009-01-03 21:22:43 +00003699/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003700 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003701 *
3702 * The format of the serialized data is:
3703 * (in the presentation language of TLS, RFC 8446 section 3)
3704 *
3705 * // header
3706 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003707 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003708 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003709 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003710 * Note: When updating the format, remember to keep these
3711 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003712 *
3713 * // session sub-structure
3714 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3715 * // transform sub-structure
3716 * uint8 random[64]; // ServerHello.random+ClientHello.random
3717 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3718 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3719 * // fields from ssl_context
3720 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3721 * uint64 in_window_top; // DTLS: last validated record seq_num
3722 * uint64 in_window; // DTLS: bitmask for replay protection
3723 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3724 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3725 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3726 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3727 *
3728 * Note that many fields of the ssl_context or sub-structures are not
3729 * serialized, as they fall in one of the following categories:
3730 *
3731 * 1. forced value (eg in_left must be 0)
3732 * 2. pointer to dynamically-allocated memory (eg session, transform)
3733 * 3. value can be re-derived from other data (eg session keys from MS)
3734 * 4. value was temporary (eg content of input buffer)
3735 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003736 */
3737int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3738 unsigned char *buf,
3739 size_t buf_len,
3740 size_t *olen )
3741{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003742 unsigned char *p = buf;
3743 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003744 size_t session_len;
3745 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003746
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003747 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003748 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3749 * this function's documentation.
3750 *
3751 * These are due to assumptions/limitations in the implementation. Some of
3752 * them are likely to stay (no handshake in progress) some might go away
3753 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003754 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003755 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003756 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003757 {
3758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003760 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003761 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003762 {
3763 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003764 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003765 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003766 /* Double-check that sub-structures are indeed ready */
3767 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003768 {
3769 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003770 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003771 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003772 /* There must be no pending incoming or outgoing data */
3773 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003774 {
3775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003777 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003778 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003779 {
3780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003781 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003782 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003783 /* Protocol must be DLTS, not TLS */
3784 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003785 {
3786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003787 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003788 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003789 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003790 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003791 {
3792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003793 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003794 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003795 /* We must be using an AEAD ciphersuite */
3796 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003797 {
3798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003799 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003800 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003801 /* Renegotiation must not be enabled */
3802#if defined(MBEDTLS_SSL_RENEGOTIATION)
3803 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003804 {
3805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003806 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003807 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003808#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003809
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003810 /*
3811 * Version and format identifier
3812 */
3813 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003814
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003815 if( used <= buf_len )
3816 {
3817 memcpy( p, ssl_serialized_context_header,
3818 sizeof( ssl_serialized_context_header ) );
3819 p += sizeof( ssl_serialized_context_header );
3820 }
3821
3822 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003823 * Session (length + data)
3824 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003825 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003826 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3827 return( ret );
3828
3829 used += 4 + session_len;
3830 if( used <= buf_len )
3831 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003832 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3833 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003834
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003835 ret = ssl_session_save( ssl->session, 1,
3836 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003837 if( ret != 0 )
3838 return( ret );
3839
3840 p += session_len;
3841 }
3842
3843 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003844 * Transform
3845 */
3846 used += sizeof( ssl->transform->randbytes );
3847 if( used <= buf_len )
3848 {
3849 memcpy( p, ssl->transform->randbytes,
3850 sizeof( ssl->transform->randbytes ) );
3851 p += sizeof( ssl->transform->randbytes );
3852 }
3853
3854#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3855 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3856 if( used <= buf_len )
3857 {
3858 *p++ = ssl->transform->in_cid_len;
3859 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3860 p += ssl->transform->in_cid_len;
3861
3862 *p++ = ssl->transform->out_cid_len;
3863 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3864 p += ssl->transform->out_cid_len;
3865 }
3866#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3867
3868 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003869 * Saved fields from top-level ssl_context structure
3870 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003871 used += 4;
3872 if( used <= buf_len )
3873 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003874 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3875 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003876 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003877
3878#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3879 used += 16;
3880 if( used <= buf_len )
3881 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003882 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3883 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003884
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003885 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3886 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003887 }
3888#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3889
3890#if defined(MBEDTLS_SSL_PROTO_DTLS)
3891 used += 1;
3892 if( used <= buf_len )
3893 {
3894 *p++ = ssl->disable_datagram_packing;
3895 }
3896#endif /* MBEDTLS_SSL_PROTO_DTLS */
3897
Jerry Yuae0b2e22021-10-08 15:21:19 +08003898 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003899 if( used <= buf_len )
3900 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003901 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3902 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003903 }
3904
3905#if defined(MBEDTLS_SSL_PROTO_DTLS)
3906 used += 2;
3907 if( used <= buf_len )
3908 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003909 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3910 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003911 }
3912#endif /* MBEDTLS_SSL_PROTO_DTLS */
3913
3914#if defined(MBEDTLS_SSL_ALPN)
3915 {
3916 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003917 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003918 : 0;
3919
3920 used += 1 + alpn_len;
3921 if( used <= buf_len )
3922 {
3923 *p++ = alpn_len;
3924
3925 if( ssl->alpn_chosen != NULL )
3926 {
3927 memcpy( p, ssl->alpn_chosen, alpn_len );
3928 p += alpn_len;
3929 }
3930 }
3931 }
3932#endif /* MBEDTLS_SSL_ALPN */
3933
3934 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003935 * Done
3936 */
3937 *olen = used;
3938
3939 if( used > buf_len )
3940 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003941
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003942 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3943
Hanno Becker43aefe22020-02-05 10:44:56 +00003944 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003945}
3946
3947/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003948 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003949 *
3950 * This internal version is wrapped by a public function that cleans up in
3951 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003952 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003953MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003954static int ssl_context_load( mbedtls_ssl_context *ssl,
3955 const unsigned char *buf,
3956 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003957{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003958 const unsigned char *p = buf;
3959 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003960 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003962
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003963 /*
3964 * The context should have been freshly setup or reset.
3965 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003966 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003967 * renegotiating, or if the user mistakenly loaded a session first.)
3968 */
3969 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3970 ssl->session != NULL )
3971 {
3972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3973 }
3974
3975 /*
3976 * We can't check that the config matches the initial one, but we can at
3977 * least check it matches the requirements for serializing.
3978 */
3979 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003980 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3981 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003982#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003983 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003984#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003985 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003986 {
3987 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3988 }
3989
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003990 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3991
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003992 /*
3993 * Check version identifier
3994 */
3995 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3996 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3997
3998 if( memcmp( p, ssl_serialized_context_header,
3999 sizeof( ssl_serialized_context_header ) ) != 0 )
4000 {
4001 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
4002 }
4003 p += sizeof( ssl_serialized_context_header );
4004
4005 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004006 * Session
4007 */
4008 if( (size_t)( end - p ) < 4 )
4009 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4010
4011 session_len = ( (size_t) p[0] << 24 ) |
4012 ( (size_t) p[1] << 16 ) |
4013 ( (size_t) p[2] << 8 ) |
4014 ( (size_t) p[3] );
4015 p += 4;
4016
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004017 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004018 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004019 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004020 ssl->session_in = ssl->session;
4021 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004022 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004023
4024 if( (size_t)( end - p ) < session_len )
4025 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4026
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004027 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004028 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004029 {
4030 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004031 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004032 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004033
4034 p += session_len;
4035
4036 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004037 * Transform
4038 */
4039
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004040 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004041 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004042 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004043 ssl->transform_in = ssl->transform;
4044 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004045 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004046
4047 /* Read random bytes and populate structure */
4048 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4049 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004050#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004051 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004052 ssl->session->ciphersuite,
4053 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004054#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004055 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004056#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004057 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4058 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004059 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004060 ssl->conf->endpoint,
4061 ssl );
4062 if( ret != 0 )
4063 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004064#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004065 p += sizeof( ssl->transform->randbytes );
4066
4067#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4068 /* Read connection IDs and store them */
4069 if( (size_t)( end - p ) < 1 )
4070 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4071
4072 ssl->transform->in_cid_len = *p++;
4073
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004074 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004075 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4076
4077 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4078 p += ssl->transform->in_cid_len;
4079
4080 ssl->transform->out_cid_len = *p++;
4081
4082 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4083 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4084
4085 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4086 p += ssl->transform->out_cid_len;
4087#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4088
4089 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004090 * Saved fields from top-level ssl_context structure
4091 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004092 if( (size_t)( end - p ) < 4 )
4093 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4094
4095 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4096 ( (uint32_t) p[1] << 16 ) |
4097 ( (uint32_t) p[2] << 8 ) |
4098 ( (uint32_t) p[3] );
4099 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004100
4101#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4102 if( (size_t)( end - p ) < 16 )
4103 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4104
4105 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4106 ( (uint64_t) p[1] << 48 ) |
4107 ( (uint64_t) p[2] << 40 ) |
4108 ( (uint64_t) p[3] << 32 ) |
4109 ( (uint64_t) p[4] << 24 ) |
4110 ( (uint64_t) p[5] << 16 ) |
4111 ( (uint64_t) p[6] << 8 ) |
4112 ( (uint64_t) p[7] );
4113 p += 8;
4114
4115 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4116 ( (uint64_t) p[1] << 48 ) |
4117 ( (uint64_t) p[2] << 40 ) |
4118 ( (uint64_t) p[3] << 32 ) |
4119 ( (uint64_t) p[4] << 24 ) |
4120 ( (uint64_t) p[5] << 16 ) |
4121 ( (uint64_t) p[6] << 8 ) |
4122 ( (uint64_t) p[7] );
4123 p += 8;
4124#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4125
4126#if defined(MBEDTLS_SSL_PROTO_DTLS)
4127 if( (size_t)( end - p ) < 1 )
4128 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4129
4130 ssl->disable_datagram_packing = *p++;
4131#endif /* MBEDTLS_SSL_PROTO_DTLS */
4132
Jerry Yud9a94fe2021-09-28 18:58:59 +08004133 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004134 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004135 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4136 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004137
4138#if defined(MBEDTLS_SSL_PROTO_DTLS)
4139 if( (size_t)( end - p ) < 2 )
4140 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4141
4142 ssl->mtu = ( p[0] << 8 ) | p[1];
4143 p += 2;
4144#endif /* MBEDTLS_SSL_PROTO_DTLS */
4145
4146#if defined(MBEDTLS_SSL_ALPN)
4147 {
4148 uint8_t alpn_len;
4149 const char **cur;
4150
4151 if( (size_t)( end - p ) < 1 )
4152 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4153
4154 alpn_len = *p++;
4155
4156 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4157 {
4158 /* alpn_chosen should point to an item in the configured list */
4159 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4160 {
4161 if( strlen( *cur ) == alpn_len &&
4162 memcmp( p, cur, alpn_len ) == 0 )
4163 {
4164 ssl->alpn_chosen = *cur;
4165 break;
4166 }
4167 }
4168 }
4169
4170 /* can only happen on conf mismatch */
4171 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4172 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4173
4174 p += alpn_len;
4175 }
4176#endif /* MBEDTLS_SSL_ALPN */
4177
4178 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004179 * Forced fields from top-level ssl_context structure
4180 *
4181 * Most of them already set to the correct value by mbedtls_ssl_init() and
4182 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4183 */
4184 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004185 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004186
Hanno Becker361b10d2019-08-30 10:42:49 +01004187 /* Adjust pointers for header fields of outgoing records to
4188 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004189 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004190
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004191#if defined(MBEDTLS_SSL_PROTO_DTLS)
4192 ssl->in_epoch = 1;
4193#endif
4194
4195 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4196 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004197 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4198 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004199 if( ssl->handshake != NULL )
4200 {
4201 mbedtls_ssl_handshake_free( ssl );
4202 mbedtls_free( ssl->handshake );
4203 ssl->handshake = NULL;
4204 }
4205
4206 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004207 * Done - should have consumed entire buffer
4208 */
4209 if( p != end )
4210 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004211
4212 return( 0 );
4213}
4214
4215/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004216 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004217 */
4218int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4219 const unsigned char *buf,
4220 size_t len )
4221{
4222 int ret = ssl_context_load( context, buf, len );
4223
4224 if( ret != 0 )
4225 mbedtls_ssl_free( context );
4226
4227 return( ret );
4228}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004229#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004230
4231/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004232 * Free an SSL context
4233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004234void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004235{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004236 if( ssl == NULL )
4237 return;
4238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004239 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004240
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004241 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004242 {
sander-visserb8aa2072020-05-06 22:05:13 +02004243#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4244 size_t out_buf_len = ssl->out_buf_len;
4245#else
4246 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4247#endif
4248
Darryl Greenb33cc762019-11-28 14:29:44 +00004249 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004250 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004251 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004252 }
4253
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004254 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004255 {
sander-visserb8aa2072020-05-06 22:05:13 +02004256#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4257 size_t in_buf_len = ssl->in_buf_len;
4258#else
4259 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4260#endif
4261
Darryl Greenb33cc762019-11-28 14:29:44 +00004262 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004263 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004264 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004265 }
4266
Paul Bakker48916f92012-09-16 19:57:18 +00004267 if( ssl->transform )
4268 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004269 mbedtls_ssl_transform_free( ssl->transform );
4270 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004271 }
4272
4273 if( ssl->handshake )
4274 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004275 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004276 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4277 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004279 mbedtls_free( ssl->handshake );
4280 mbedtls_free( ssl->transform_negotiate );
4281 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004282 }
4283
Ronald Cron6f135e12021-12-08 16:57:54 +01004284#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004285 mbedtls_ssl_transform_free( ssl->transform_application );
4286 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004287#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004288
Paul Bakkerc0463502013-02-14 11:19:38 +01004289 if( ssl->session )
4290 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004291 mbedtls_ssl_session_free( ssl->session );
4292 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004293 }
4294
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004295#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004296 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004297 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004298 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004299 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004300 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004301#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004302
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004303#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004304 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004305#endif
4306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004308
Paul Bakker86f04f42013-02-14 11:20:09 +01004309 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004310 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004311}
4312
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004313/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004314 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004315 */
4316void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4317{
4318 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4319}
4320
Gilles Peskineae270bf2021-06-02 00:05:29 +02004321/* The selection should be the same as mbedtls_x509_crt_profile_default in
4322 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004323 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004324 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004325 * about this list.
4326 */
Brett Warrene0edc842021-08-17 09:53:13 +01004327static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004328#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004329 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004330#endif
4331#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004332 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004333#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004334#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004335 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004336#endif
4337#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004338 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004339#endif
4340#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004341 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004342#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004343#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004344 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004345#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004346#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004347 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004348#endif
4349#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004350 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004351#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004352 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004353};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004354
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004355static int ssl_preset_suiteb_ciphersuites[] = {
4356 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4357 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4358 0
4359};
4360
Gilles Peskineeccd8882020-03-10 12:19:08 +01004361#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004362
Jerry Yu909df7b2022-01-22 11:56:27 +08004363/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004364 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004365 * rules SHOULD be upheld.
4366 * - No duplicate entries.
4367 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004368 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004369 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004370 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004371static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004372
Andrzej Kurek25f27152022-08-17 16:09:31 -04004373#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004374 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4375 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004376#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004377 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004378
Andrzej Kurek25f27152022-08-17 16:09:31 -04004379#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004380 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4381 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004382#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004383 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4384
Andrzej Kurek25f27152022-08-17 16:09:31 -04004385#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004386 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4387 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004388#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004389 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004390
Andrzej Kurek25f27152022-08-17 16:09:31 -04004391#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004392 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004393#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004394
Andrzej Kurek25f27152022-08-17 16:09:31 -04004395#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004396 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004397#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004398
Andrzej Kurek25f27152022-08-17 16:09:31 -04004399#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004400 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004401#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004402
Andrzej Kurek25f27152022-08-17 16:09:31 -04004403#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08004404 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4405#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4406
Andrzej Kurek25f27152022-08-17 16:09:31 -04004407#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08004408 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4409#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4410
Andrzej Kurek25f27152022-08-17 16:09:31 -04004411#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08004412 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4413#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4414
Gabor Mezei15b95a62022-05-09 16:37:58 +02004415 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004416};
4417
4418/* NOTICE: see above */
4419#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4420static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004421#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004422#if defined(MBEDTLS_ECDSA_C)
4423 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004424#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004425#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4426 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4427#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004428#if defined(MBEDTLS_RSA_C)
4429 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4430#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004431#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004432#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004433#if defined(MBEDTLS_ECDSA_C)
4434 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004435#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004436#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4437 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4438#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004439#if defined(MBEDTLS_RSA_C)
4440 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4441#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004442#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004443#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004444#if defined(MBEDTLS_ECDSA_C)
4445 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004446#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004447#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4448 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4449#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004450#if defined(MBEDTLS_RSA_C)
4451 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4452#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004453#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004454 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004455};
4456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4457/* NOTICE: see above */
4458static uint16_t ssl_preset_suiteb_sig_algs[] = {
4459
Andrzej Kurek25f27152022-08-17 16:09:31 -04004460#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004461 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4462 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004463#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004464 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4465
Andrzej Kurek25f27152022-08-17 16:09:31 -04004466#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu53037892022-01-25 11:02:06 +08004467 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4468 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004469#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08004470 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004471
Andrzej Kurek25f27152022-08-17 16:09:31 -04004472#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu909df7b2022-01-22 11:56:27 +08004473 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004474#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08004475
Andrzej Kurek25f27152022-08-17 16:09:31 -04004476#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu53037892022-01-25 11:02:06 +08004477 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004478#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08004479
Gabor Mezei15b95a62022-05-09 16:37:58 +02004480 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004481};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004482
Jerry Yu909df7b2022-01-22 11:56:27 +08004483/* NOTICE: see above */
4484#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4485static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004486#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004487#if defined(MBEDTLS_ECDSA_C)
4488 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004489#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004490#if defined(MBEDTLS_RSA_C)
4491 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4492#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004493#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004494#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004495#if defined(MBEDTLS_ECDSA_C)
4496 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004497#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004498#if defined(MBEDTLS_RSA_C)
4499 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4500#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004501#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004502 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004503};
Jerry Yu909df7b2022-01-22 11:56:27 +08004504#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4505
Jerry Yu1a8b4812022-01-20 17:56:50 +08004506#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004507
Brett Warrene0edc842021-08-17 09:53:13 +01004508static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004509#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004510 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004511#endif
4512#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004513 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004514#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004515 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004516};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004517
Jerry Yu1a8b4812022-01-20 17:56:50 +08004518#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004519/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004520 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004521MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004522static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004523{
4524 size_t i, j;
4525 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004526
Gabor Mezei15b95a62022-05-09 16:37:58 +02004527 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004528 {
Jerry Yuf377d642022-01-25 10:43:59 +08004529 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004530 {
Jerry Yuf377d642022-01-25 10:43:59 +08004531 if( sig_algs[i] != sig_algs[j] )
4532 continue;
4533 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4534 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4535 sig_algs[i], j, i );
4536 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004537 }
4538 }
4539 return( ret );
4540}
4541
4542#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4543
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004544/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004545 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004546 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004547int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004548 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004549{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004550#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004552#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004553
Jerry Yu1a8b4812022-01-20 17:56:50 +08004554#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004555 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004556 {
4557 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4558 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4559 }
4560
Jerry Yuf377d642022-01-25 10:43:59 +08004561 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004562 {
4563 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4564 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4565 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004566
4567#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004568 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004569 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004570 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004571 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4572 }
4573
Jerry Yuf377d642022-01-25 10:43:59 +08004574 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004575 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004576 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004577 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4578 }
4579#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004580#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4581
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004582 /* Use the functions here so that they are covered in tests,
4583 * but otherwise access member directly for efficiency */
4584 mbedtls_ssl_conf_endpoint( conf, endpoint );
4585 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004586
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004587 /*
4588 * Things that are common to all presets
4589 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004590#if defined(MBEDTLS_SSL_CLI_C)
4591 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4592 {
4593 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4594#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4595 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4596#endif
4597 }
4598#endif
4599
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004600#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4601 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4602#endif
4603
4604#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4605 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4606#endif
4607
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004608#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004609 conf->f_cookie_write = ssl_cookie_write_dummy;
4610 conf->f_cookie_check = ssl_cookie_check_dummy;
4611#endif
4612
4613#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4614 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4615#endif
4616
Janos Follath088ce432017-04-10 12:42:31 +01004617#if defined(MBEDTLS_SSL_SRV_C)
4618 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004619 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004620#endif
4621
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004622#if defined(MBEDTLS_SSL_PROTO_DTLS)
4623 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4624 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4625#endif
4626
4627#if defined(MBEDTLS_SSL_RENEGOTIATION)
4628 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004629 memset( conf->renego_period, 0x00, 2 );
4630 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004631#endif
4632
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004633#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004634 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4635 {
4636 const unsigned char dhm_p[] =
4637 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4638 const unsigned char dhm_g[] =
4639 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004640
Hanno Beckere2defad2021-07-24 05:59:17 +01004641 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4642 dhm_p, sizeof( dhm_p ),
4643 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4644 {
4645 return( ret );
4646 }
4647 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004648#endif
4649
Ronald Cron6f135e12021-12-08 16:57:54 +01004650#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004651 /*
4652 * Allow all TLS 1.3 key exchange modes by default.
4653 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004654 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004655#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004656
XiaokangQian4d3a6042022-04-21 13:46:17 +00004657 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4658 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004659#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004660 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004661 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004662#else
XiaokangQian060d8672022-04-21 09:24:56 +00004663 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004664#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004665 }
4666 else
4667 {
4668#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4669 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4670 {
4671 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4672 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4673 }
4674 else
4675 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4676 {
4677 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4678 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4679 }
4680#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4681 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4682 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4683#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4684 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4685 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4686#else
4687 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4688#endif
4689 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004690
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004691 /*
4692 * Preset-specific defaults
4693 */
4694 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004695 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004696 /*
4697 * NSA Suite B
4698 */
4699 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004700
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004701 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004702
4703#if defined(MBEDTLS_X509_CRT_PARSE_C)
4704 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004705#endif
4706
Gilles Peskineeccd8882020-03-10 12:19:08 +01004707#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004708#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4709 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4710 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4711 else
4712#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4713 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004714#endif
4715
Brett Warrene0edc842021-08-17 09:53:13 +01004716#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4717 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004718#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004719 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004720 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004721
4722 /*
4723 * Default
4724 */
4725 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004726
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004727 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004728
4729#if defined(MBEDTLS_X509_CRT_PARSE_C)
4730 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4731#endif
4732
Gilles Peskineeccd8882020-03-10 12:19:08 +01004733#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004734#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4735 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4736 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4737 else
4738#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4739 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004740#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004741
Brett Warrene0edc842021-08-17 09:53:13 +01004742#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4743 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004744#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004745 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004746
4747#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4748 conf->dhm_min_bitlen = 1024;
4749#endif
4750 }
4751
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004752 return( 0 );
4753}
4754
4755/*
4756 * Free mbedtls_ssl_config
4757 */
4758void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4759{
4760#if defined(MBEDTLS_DHM_C)
4761 mbedtls_mpi_free( &conf->dhm_P );
4762 mbedtls_mpi_free( &conf->dhm_G );
4763#endif
4764
Gilles Peskineeccd8882020-03-10 12:19:08 +01004765#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004766#if defined(MBEDTLS_USE_PSA_CRYPTO)
4767 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4768 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004769 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4770 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004771#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004772 if( conf->psk != NULL )
4773 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004774 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004775 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004776 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004777 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004778 }
4779
4780 if( conf->psk_identity != NULL )
4781 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004782 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004783 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004784 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004785 conf->psk_identity_len = 0;
4786 }
4787#endif
4788
4789#if defined(MBEDTLS_X509_CRT_PARSE_C)
4790 ssl_key_cert_free( conf->key_cert );
4791#endif
4792
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004793 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004794}
4795
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004796#if defined(MBEDTLS_PK_C) && \
4797 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004798/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004801unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004802{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803#if defined(MBEDTLS_RSA_C)
4804 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4805 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004806#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807#if defined(MBEDTLS_ECDSA_C)
4808 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4809 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004810#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004812}
4813
Hanno Becker7e5437a2017-04-28 17:15:26 +01004814unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4815{
4816 switch( type ) {
4817 case MBEDTLS_PK_RSA:
4818 return( MBEDTLS_SSL_SIG_RSA );
4819 case MBEDTLS_PK_ECDSA:
4820 case MBEDTLS_PK_ECKEY:
4821 return( MBEDTLS_SSL_SIG_ECDSA );
4822 default:
4823 return( MBEDTLS_SSL_SIG_ANON );
4824 }
4825}
4826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004828{
4829 switch( sig )
4830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831#if defined(MBEDTLS_RSA_C)
4832 case MBEDTLS_SSL_SIG_RSA:
4833 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004834#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835#if defined(MBEDTLS_ECDSA_C)
4836 case MBEDTLS_SSL_SIG_ECDSA:
4837 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004838#endif
4839 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004840 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004841 }
4842}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004843#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004844
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004845/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004846 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004848mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004849{
4850 switch( hash )
4851 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004852#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853 case MBEDTLS_SSL_HASH_MD5:
4854 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004855#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004856#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857 case MBEDTLS_SSL_HASH_SHA1:
4858 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004859#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004860#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004861 case MBEDTLS_SSL_HASH_SHA224:
4862 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004863#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004864#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004865 case MBEDTLS_SSL_HASH_SHA256:
4866 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004867#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004868#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004869 case MBEDTLS_SSL_HASH_SHA384:
4870 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004871#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004872#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873 case MBEDTLS_SSL_HASH_SHA512:
4874 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004875#endif
4876 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004877 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004878 }
4879}
4880
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004881/*
4882 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4883 */
4884unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4885{
4886 switch( md )
4887 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004888#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004889 case MBEDTLS_MD_MD5:
4890 return( MBEDTLS_SSL_HASH_MD5 );
4891#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004892#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004893 case MBEDTLS_MD_SHA1:
4894 return( MBEDTLS_SSL_HASH_SHA1 );
4895#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004896#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004897 case MBEDTLS_MD_SHA224:
4898 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004899#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004900#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004901 case MBEDTLS_MD_SHA256:
4902 return( MBEDTLS_SSL_HASH_SHA256 );
4903#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004904#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004905 case MBEDTLS_MD_SHA384:
4906 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004907#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004908#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004909 case MBEDTLS_MD_SHA512:
4910 return( MBEDTLS_SSL_HASH_SHA512 );
4911#endif
4912 default:
4913 return( MBEDTLS_SSL_HASH_NONE );
4914 }
4915}
4916
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004917/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004918 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004919 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004920 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004921int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004922{
Brett Warrene0edc842021-08-17 09:53:13 +01004923 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004924
Brett Warrene0edc842021-08-17 09:53:13 +01004925 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004926 return( -1 );
4927
Brett Warrene0edc842021-08-17 09:53:13 +01004928 for( ; *group_list != 0; group_list++ )
4929 {
4930 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004931 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004932 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004933
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004934 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004935}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004936
4937#if defined(MBEDTLS_ECP_C)
4938/*
4939 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4940 */
4941int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4942{
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004943 const mbedtls_ecp_curve_info *grp_info =
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004944 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004945
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004946 if ( grp_info == NULL )
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004947 return -1;
4948
4949 uint16_t tls_id = grp_info->tls_id;
4950
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004951 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4952}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004953#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955#if defined(MBEDTLS_X509_CRT_PARSE_C)
4956int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4957 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004958 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004959 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004960{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004961 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004962 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004963 const char *ext_oid;
4964 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004967 {
4968 /* Server part of the key exchange */
4969 switch( ciphersuite->key_exchange )
4970 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004971 case MBEDTLS_KEY_EXCHANGE_RSA:
4972 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004973 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004974 break;
4975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004976 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4977 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4978 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4979 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004980 break;
4981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004982 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4983 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004984 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004985 break;
4986
4987 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988 case MBEDTLS_KEY_EXCHANGE_NONE:
4989 case MBEDTLS_KEY_EXCHANGE_PSK:
4990 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4991 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004992 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004993 usage = 0;
4994 }
4995 }
4996 else
4997 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4999 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005000 }
5001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005002 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005003 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005004 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005005 ret = -1;
5006 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005008 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005009 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 ext_oid = MBEDTLS_OID_SERVER_AUTH;
5011 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005012 }
5013 else
5014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5016 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005017 }
5018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005019 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005020 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005021 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005022 ret = -1;
5023 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005024
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005025 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005026}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005027#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005028
Jerry Yu148165c2021-09-24 23:20:59 +08005029#if defined(MBEDTLS_USE_PSA_CRYPTO)
5030int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5031 const mbedtls_md_type_t md,
5032 unsigned char *dst,
5033 size_t dst_len,
5034 size_t *olen )
5035{
Ronald Cronf6893e12022-01-07 22:09:01 +01005036 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5037 psa_hash_operation_t *hash_operation_to_clone;
5038 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5039
Jerry Yu148165c2021-09-24 23:20:59 +08005040 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005041
5042 switch( md )
5043 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005044#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005045 case MBEDTLS_MD_SHA384:
5046 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5047 break;
5048#endif
5049
Andrzej Kurek25f27152022-08-17 16:09:31 -04005050#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005051 case MBEDTLS_MD_SHA256:
5052 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5053 break;
5054#endif
5055
5056 default:
5057 goto exit;
5058 }
5059
5060 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5061 if( status != PSA_SUCCESS )
5062 goto exit;
5063
5064 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5065 if( status != PSA_SUCCESS )
5066 goto exit;
5067
5068exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005069 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005070}
5071#else /* MBEDTLS_USE_PSA_CRYPTO */
5072
Andrzej Kurek25f27152022-08-17 16:09:31 -04005073#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005074MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005075static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5076 unsigned char *dst,
5077 size_t dst_len,
5078 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005079{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005080 int ret;
5081 mbedtls_sha512_context sha512;
5082
5083 if( dst_len < 48 )
5084 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5085
5086 mbedtls_sha512_init( &sha512 );
Andrzej Kureka242e832022-08-11 10:03:14 -04005087 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005088
5089 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5090 {
5091 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5092 goto exit;
5093 }
5094
5095 *olen = 48;
5096
5097exit:
5098
5099 mbedtls_sha512_free( &sha512 );
5100 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005101}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005102#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005103
Andrzej Kurek25f27152022-08-17 16:09:31 -04005104#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005105MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005106static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5107 unsigned char *dst,
5108 size_t dst_len,
5109 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005110{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005111 int ret;
5112 mbedtls_sha256_context sha256;
5113
5114 if( dst_len < 32 )
5115 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5116
5117 mbedtls_sha256_init( &sha256 );
5118 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005119
Jerry Yu24c0ec32021-09-09 14:21:07 +08005120 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5121 {
5122 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5123 goto exit;
5124 }
5125
5126 *olen = 32;
5127
5128exit:
5129
5130 mbedtls_sha256_free( &sha256 );
5131 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005132}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005133#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005134
Jerry Yu000f9762021-09-14 11:12:51 +08005135int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5136 const mbedtls_md_type_t md,
5137 unsigned char *dst,
5138 size_t dst_len,
5139 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005140{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005141 switch( md )
5142 {
5143
Andrzej Kurek25f27152022-08-17 16:09:31 -04005144#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005145 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005146 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005147#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005148
Andrzej Kurek25f27152022-08-17 16:09:31 -04005149#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005150 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005151 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005152#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005153
5154 default:
5155 break;
5156 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005157 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005158}
XiaokangQian647719a2021-12-07 09:16:29 +00005159
Jerry Yu148165c2021-09-24 23:20:59 +08005160#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005161
Gabor Mezei078e8032022-04-27 21:17:56 +02005162#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5163/* mbedtls_ssl_parse_sig_alg_ext()
5164 *
5165 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5166 * value (TLS 1.3 RFC8446):
5167 * enum {
5168 * ....
5169 * ecdsa_secp256r1_sha256( 0x0403 ),
5170 * ecdsa_secp384r1_sha384( 0x0503 ),
5171 * ecdsa_secp521r1_sha512( 0x0603 ),
5172 * ....
5173 * } SignatureScheme;
5174 *
5175 * struct {
5176 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5177 * } SignatureSchemeList;
5178 *
5179 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5180 * value (TLS 1.2 RFC5246):
5181 * enum {
5182 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5183 * sha512(6), (255)
5184 * } HashAlgorithm;
5185 *
5186 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5187 * SignatureAlgorithm;
5188 *
5189 * struct {
5190 * HashAlgorithm hash;
5191 * SignatureAlgorithm signature;
5192 * } SignatureAndHashAlgorithm;
5193 *
5194 * SignatureAndHashAlgorithm
5195 * supported_signature_algorithms<2..2^16-2>;
5196 *
5197 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5198 * generalization of the TLS 1.2 signature algorithm extension.
5199 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5200 * `SignatureScheme` field of TLS 1.3
5201 *
5202 */
5203int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5204 const unsigned char *buf,
5205 const unsigned char *end )
5206{
5207 const unsigned char *p = buf;
5208 size_t supported_sig_algs_len = 0;
5209 const unsigned char *supported_sig_algs_end;
5210 uint16_t sig_alg;
5211 uint32_t common_idx = 0;
5212
5213 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5214 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5215 p += 2;
5216
5217 memset( ssl->handshake->received_sig_algs, 0,
5218 sizeof(ssl->handshake->received_sig_algs) );
5219
5220 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5221 supported_sig_algs_end = p + supported_sig_algs_len;
5222 while( p < supported_sig_algs_end )
5223 {
5224 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5225 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5226 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005227 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5228 sig_alg,
5229 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005230#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005231 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005232 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5233 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5234 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005235 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005236 }
5237#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005238
Jerry Yuf3b46b52022-06-19 16:52:27 +08005239 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5240 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005241
5242 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5243 {
5244 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5245 common_idx += 1;
5246 }
5247 }
5248 /* Check that we consumed all the message. */
5249 if( p != end )
5250 {
5251 MBEDTLS_SSL_DEBUG_MSG( 1,
5252 ( "Signature algorithms extension length misaligned" ) );
5253 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5254 MBEDTLS_ERR_SSL_DECODE_ERROR );
5255 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5256 }
5257
5258 if( common_idx == 0 )
5259 {
5260 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5261 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5262 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5263 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5264 }
5265
Gabor Mezei15b95a62022-05-09 16:37:58 +02005266 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005267 return( 0 );
5268}
5269
5270#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5271
Jerry Yudc7bd172022-02-17 13:44:15 +08005272#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5273
5274#if defined(MBEDTLS_USE_PSA_CRYPTO)
5275
5276static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5277 mbedtls_svc_key_id_t key,
5278 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005279 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005280 const unsigned char* seed, size_t seed_length,
5281 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005282 const unsigned char* other_secret,
5283 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005284 size_t capacity )
5285{
5286 psa_status_t status;
5287
5288 status = psa_key_derivation_setup( derivation, alg );
5289 if( status != PSA_SUCCESS )
5290 return( status );
5291
5292 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5293 {
5294 status = psa_key_derivation_input_bytes( derivation,
5295 PSA_KEY_DERIVATION_INPUT_SEED,
5296 seed, seed_length );
5297 if( status != PSA_SUCCESS )
5298 return( status );
5299
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005300 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005301 {
5302 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005303 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5304 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005305 if( status != PSA_SUCCESS )
5306 return( status );
5307 }
5308
Jerry Yudc7bd172022-02-17 13:44:15 +08005309 if( mbedtls_svc_key_id_is_null( key ) )
5310 {
5311 status = psa_key_derivation_input_bytes(
5312 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005313 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005314 }
5315 else
5316 {
5317 status = psa_key_derivation_input_key(
5318 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5319 }
5320 if( status != PSA_SUCCESS )
5321 return( status );
5322
5323 status = psa_key_derivation_input_bytes( derivation,
5324 PSA_KEY_DERIVATION_INPUT_LABEL,
5325 label, label_length );
5326 if( status != PSA_SUCCESS )
5327 return( status );
5328 }
5329 else
5330 {
5331 return( PSA_ERROR_NOT_SUPPORTED );
5332 }
5333
5334 status = psa_key_derivation_set_capacity( derivation, capacity );
5335 if( status != PSA_SUCCESS )
5336 return( status );
5337
5338 return( PSA_SUCCESS );
5339}
5340
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005341MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005342static int tls_prf_generic( mbedtls_md_type_t md_type,
5343 const unsigned char *secret, size_t slen,
5344 const char *label,
5345 const unsigned char *random, size_t rlen,
5346 unsigned char *dstbuf, size_t dlen )
5347{
5348 psa_status_t status;
5349 psa_algorithm_t alg;
5350 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5351 psa_key_derivation_operation_t derivation =
5352 PSA_KEY_DERIVATION_OPERATION_INIT;
5353
5354 if( md_type == MBEDTLS_MD_SHA384 )
5355 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5356 else
5357 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5358
5359 /* Normally a "secret" should be long enough to be impossible to
5360 * find by brute force, and in particular should not be empty. But
5361 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5362 * and for this use case it makes sense to have a 0-length "secret".
5363 * Since the key API doesn't allow importing a key of length 0,
5364 * keep master_key=0, which setup_psa_key_derivation() understands
5365 * to mean a 0-length "secret" input. */
5366 if( slen != 0 )
5367 {
5368 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5369 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5370 psa_set_key_algorithm( &key_attributes, alg );
5371 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5372
5373 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5374 if( status != PSA_SUCCESS )
5375 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5376 }
5377
5378 status = setup_psa_key_derivation( &derivation,
5379 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005380 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005381 random, rlen,
5382 (unsigned char const *) label,
5383 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005384 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005385 dlen );
5386 if( status != PSA_SUCCESS )
5387 {
5388 psa_key_derivation_abort( &derivation );
5389 psa_destroy_key( master_key );
5390 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5391 }
5392
5393 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5394 if( status != PSA_SUCCESS )
5395 {
5396 psa_key_derivation_abort( &derivation );
5397 psa_destroy_key( master_key );
5398 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5399 }
5400
5401 status = psa_key_derivation_abort( &derivation );
5402 if( status != PSA_SUCCESS )
5403 {
5404 psa_destroy_key( master_key );
5405 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5406 }
5407
5408 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5409 status = psa_destroy_key( master_key );
5410 if( status != PSA_SUCCESS )
5411 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5412
5413 return( 0 );
5414}
5415
5416#else /* MBEDTLS_USE_PSA_CRYPTO */
5417
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005418MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005419static int tls_prf_generic( mbedtls_md_type_t md_type,
5420 const unsigned char *secret, size_t slen,
5421 const char *label,
5422 const unsigned char *random, size_t rlen,
5423 unsigned char *dstbuf, size_t dlen )
5424{
5425 size_t nb;
5426 size_t i, j, k, md_len;
5427 unsigned char *tmp;
5428 size_t tmp_len = 0;
5429 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5430 const mbedtls_md_info_t *md_info;
5431 mbedtls_md_context_t md_ctx;
5432 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5433
5434 mbedtls_md_init( &md_ctx );
5435
5436 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5437 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5438
5439 md_len = mbedtls_md_get_size( md_info );
5440
5441 tmp_len = md_len + strlen( label ) + rlen;
5442 tmp = mbedtls_calloc( 1, tmp_len );
5443 if( tmp == NULL )
5444 {
5445 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5446 goto exit;
5447 }
5448
5449 nb = strlen( label );
5450 memcpy( tmp + md_len, label, nb );
5451 memcpy( tmp + md_len + nb, random, rlen );
5452 nb += rlen;
5453
5454 /*
5455 * Compute P_<hash>(secret, label + random)[0..dlen]
5456 */
5457 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5458 goto exit;
5459
5460 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5461 if( ret != 0 )
5462 goto exit;
5463 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5464 if( ret != 0 )
5465 goto exit;
5466 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5467 if( ret != 0 )
5468 goto exit;
5469
5470 for( i = 0; i < dlen; i += md_len )
5471 {
5472 ret = mbedtls_md_hmac_reset ( &md_ctx );
5473 if( ret != 0 )
5474 goto exit;
5475 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5476 if( ret != 0 )
5477 goto exit;
5478 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5479 if( ret != 0 )
5480 goto exit;
5481
5482 ret = mbedtls_md_hmac_reset ( &md_ctx );
5483 if( ret != 0 )
5484 goto exit;
5485 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5486 if( ret != 0 )
5487 goto exit;
5488 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5489 if( ret != 0 )
5490 goto exit;
5491
5492 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5493
5494 for( j = 0; j < k; j++ )
5495 dstbuf[i + j] = h_i[j];
5496 }
5497
5498exit:
5499 mbedtls_md_free( &md_ctx );
5500
5501 mbedtls_platform_zeroize( tmp, tmp_len );
5502 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5503
5504 mbedtls_free( tmp );
5505
5506 return( ret );
5507}
5508#endif /* MBEDTLS_USE_PSA_CRYPTO */
5509
Andrzej Kurek25f27152022-08-17 16:09:31 -04005510#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005511MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005512static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5513 const char *label,
5514 const unsigned char *random, size_t rlen,
5515 unsigned char *dstbuf, size_t dlen )
5516{
5517 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5518 label, random, rlen, dstbuf, dlen ) );
5519}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005520#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08005521
Andrzej Kurek25f27152022-08-17 16:09:31 -04005522#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005523MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005524static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5525 const char *label,
5526 const unsigned char *random, size_t rlen,
5527 unsigned char *dstbuf, size_t dlen )
5528{
5529 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5530 label, random, rlen, dstbuf, dlen ) );
5531}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005532#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08005533
Jerry Yuf009d862022-02-17 14:01:37 +08005534/*
5535 * Set appropriate PRF function and other SSL / TLS1.2 functions
5536 *
5537 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005538 * - hash associated with the ciphersuite (only used by TLS 1.2)
5539 *
5540 * Outputs:
5541 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5542 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005543MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005544static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005545 mbedtls_md_type_t hash )
5546{
Andrzej Kurek25f27152022-08-17 16:09:31 -04005547#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron81591aa2022-03-07 09:05:51 +01005548 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005549 {
5550 handshake->tls_prf = tls_prf_sha384;
5551 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5552 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5553 }
5554 else
5555#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005556#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08005557 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005558 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005559 handshake->tls_prf = tls_prf_sha256;
5560 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5561 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5562 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005563#else
Jerry Yuf009d862022-02-17 14:01:37 +08005564 {
Jerry Yuf009d862022-02-17 14:01:37 +08005565 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005566 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005567 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5568 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005569#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005570
5571 return( 0 );
5572}
Jerry Yud6ab2352022-02-17 14:03:43 +08005573
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005574/*
5575 * Compute master secret if needed
5576 *
5577 * Parameters:
5578 * [in/out] handshake
5579 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5580 * (PSA-PSK) ciphersuite_info, psk_opaque
5581 * [out] premaster (cleared)
5582 * [out] master
5583 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5584 * debug: conf->f_dbg, conf->p_dbg
5585 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005586 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005587 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005588MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005589static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5590 unsigned char *master,
5591 const mbedtls_ssl_context *ssl )
5592{
5593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5594
5595 /* cf. RFC 5246, Section 8.1:
5596 * "The master secret is always exactly 48 bytes in length." */
5597 size_t const master_secret_len = 48;
5598
5599#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5600 unsigned char session_hash[48];
5601#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5602
5603 /* The label for the KDF used for key expansion.
5604 * This is either "master secret" or "extended master secret"
5605 * depending on whether the Extended Master Secret extension
5606 * is used. */
5607 char const *lbl = "master secret";
5608
Przemek Stekielae4ed302022-04-05 17:15:55 +02005609 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005610 * - If the Extended Master Secret extension is not used,
5611 * this is ClientHello.Random + ServerHello.Random
5612 * (see Sect. 8.1 in RFC 5246).
5613 * - If the Extended Master Secret extension is used,
5614 * this is the transcript of the handshake so far.
5615 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005616 unsigned char const *seed = handshake->randbytes;
5617 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005618
5619#if !defined(MBEDTLS_DEBUG_C) && \
5620 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5621 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5622 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5623 ssl = NULL; /* make sure we don't use it except for those cases */
5624 (void) ssl;
5625#endif
5626
5627 if( handshake->resume != 0 )
5628 {
5629 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5630 return( 0 );
5631 }
5632
5633#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5634 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5635 {
5636 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005637 seed = session_hash;
5638 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005639
5640 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005641 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005642 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005643#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005644
Przemek Stekiel99114f32022-04-22 11:20:09 +02005645#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005646 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005647 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005648 {
5649 /* Perform PSK-to-MS expansion in a single step. */
5650 psa_status_t status;
5651 psa_algorithm_t alg;
5652 mbedtls_svc_key_id_t psk;
5653 psa_key_derivation_operation_t derivation =
5654 PSA_KEY_DERIVATION_OPERATION_INIT;
5655 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5656
5657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5658
5659 psk = mbedtls_ssl_get_opaque_psk( ssl );
5660
5661 if( hash_alg == MBEDTLS_MD_SHA384 )
5662 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5663 else
5664 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5665
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005666 size_t other_secret_len = 0;
5667 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005668
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005669 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005670 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005671 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005672 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005673 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005674 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005675 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005676 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005677 other_secret_len = 48;
5678 other_secret = handshake->premaster + 2;
5679 break;
5680 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005681 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005682 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5683 other_secret = handshake->premaster + 2;
5684 break;
5685 default:
5686 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005687 }
5688
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005689 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005690 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005691 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005692 (unsigned char const *) lbl,
5693 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005694 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005695 master_secret_len );
5696 if( status != PSA_SUCCESS )
5697 {
5698 psa_key_derivation_abort( &derivation );
5699 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5700 }
5701
5702 status = psa_key_derivation_output_bytes( &derivation,
5703 master,
5704 master_secret_len );
5705 if( status != PSA_SUCCESS )
5706 {
5707 psa_key_derivation_abort( &derivation );
5708 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5709 }
5710
5711 status = psa_key_derivation_abort( &derivation );
5712 if( status != PSA_SUCCESS )
5713 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5714 }
5715 else
5716#endif
5717 {
5718 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005719 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005720 master,
5721 master_secret_len );
5722 if( ret != 0 )
5723 {
5724 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5725 return( ret );
5726 }
5727
5728 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5729 handshake->premaster,
5730 handshake->pmslen );
5731
5732 mbedtls_platform_zeroize( handshake->premaster,
5733 sizeof(handshake->premaster) );
5734 }
5735
5736 return( 0 );
5737}
5738
Jerry Yud62f87e2022-02-17 14:09:02 +08005739int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5740{
5741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5742 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5743 ssl->handshake->ciphersuite_info;
5744
5745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5746
5747 /* Set PRF, calc_verify and calc_finished function pointers */
5748 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005749 ciphersuite_info->mac );
5750 if( ret != 0 )
5751 {
5752 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5753 return( ret );
5754 }
5755
5756 /* Compute master secret if needed */
5757 ret = ssl_compute_master( ssl->handshake,
5758 ssl->session_negotiate->master,
5759 ssl );
5760 if( ret != 0 )
5761 {
5762 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5763 return( ret );
5764 }
5765
5766 /* Swap the client and server random values:
5767 * - MS derivation wanted client+server (RFC 5246 8.1)
5768 * - key derivation wants server+client (RFC 5246 6.3) */
5769 {
5770 unsigned char tmp[64];
5771 memcpy( tmp, ssl->handshake->randbytes, 64 );
5772 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5773 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5774 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5775 }
5776
5777 /* Populate transform structure */
5778 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5779 ssl->session_negotiate->ciphersuite,
5780 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005781#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005782 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005783#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005784 ssl->handshake->tls_prf,
5785 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005786 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005787 ssl->conf->endpoint,
5788 ssl );
5789 if( ret != 0 )
5790 {
5791 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5792 return( ret );
5793 }
5794
5795 /* We no longer need Server/ClientHello.random values */
5796 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5797 sizeof( ssl->handshake->randbytes ) );
5798
5799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5800
5801 return( 0 );
5802}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005803
Ronald Cron4dcbca92022-03-07 10:21:40 +01005804int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5805{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005806 switch( md )
5807 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005808#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01005809 case MBEDTLS_SSL_HASH_SHA384:
5810 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5811 break;
5812#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005813#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01005814 case MBEDTLS_SSL_HASH_SHA256:
5815 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5816 break;
5817#endif
5818 default:
5819 return( -1 );
5820 }
5821
Ronald Cronc2f13a02022-03-07 10:25:24 +01005822 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005823}
5824
Andrzej Kurek25f27152022-08-17 16:09:31 -04005825#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu8392e0d2022-02-17 14:10:24 +08005826void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5827 unsigned char *hash,
5828 size_t *hlen )
5829{
5830#if defined(MBEDTLS_USE_PSA_CRYPTO)
5831 size_t hash_size;
5832 psa_status_t status;
5833 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5834
5835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5836 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5837 if( status != PSA_SUCCESS )
5838 {
5839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5840 return;
5841 }
5842
5843 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5844 if( status != PSA_SUCCESS )
5845 {
5846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5847 return;
5848 }
5849
5850 *hlen = 32;
5851 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5853#else
5854 mbedtls_sha256_context sha256;
5855
5856 mbedtls_sha256_init( &sha256 );
5857
5858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5859
5860 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5861 mbedtls_sha256_finish( &sha256, hash );
5862
5863 *hlen = 32;
5864
5865 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5867
5868 mbedtls_sha256_free( &sha256 );
5869#endif /* MBEDTLS_USE_PSA_CRYPTO */
5870 return;
5871}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005872#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08005873
Andrzej Kurek25f27152022-08-17 16:09:31 -04005874#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1cb3842022-02-17 14:13:48 +08005875void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5876 unsigned char *hash,
5877 size_t *hlen )
5878{
5879#if defined(MBEDTLS_USE_PSA_CRYPTO)
5880 size_t hash_size;
5881 psa_status_t status;
5882 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5883
5884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5885 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5886 if( status != PSA_SUCCESS )
5887 {
5888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5889 return;
5890 }
5891
5892 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5893 if( status != PSA_SUCCESS )
5894 {
5895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5896 return;
5897 }
5898
5899 *hlen = 48;
5900 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5902#else
5903 mbedtls_sha512_context sha512;
5904
5905 mbedtls_sha512_init( &sha512 );
5906
5907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5908
Andrzej Kureka242e832022-08-11 10:03:14 -04005909 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yuc1cb3842022-02-17 14:13:48 +08005910 mbedtls_sha512_finish( &sha512, hash );
5911
5912 *hlen = 48;
5913
5914 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5916
5917 mbedtls_sha512_free( &sha512 );
5918#endif /* MBEDTLS_USE_PSA_CRYPTO */
5919 return;
5920}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005921#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08005922
Neil Armstrong80f6f322022-05-03 17:56:38 +02005923#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5924 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005925int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5926{
5927 unsigned char *p = ssl->handshake->premaster;
5928 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5929 const unsigned char *psk = NULL;
5930 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005931 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005932
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005933 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005934 {
5935 /*
5936 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005937 * checked before calling this function.
5938 *
5939 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005940 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005941 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005942 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5943 {
5944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5945 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5946 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005947 }
5948
5949 /*
5950 * PMS = struct {
5951 * opaque other_secret<0..2^16-1>;
5952 * opaque psk<0..2^16-1>;
5953 * };
5954 * with "other_secret" depending on the particular key exchange
5955 */
5956#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5957 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5958 {
5959 if( end - p < 2 )
5960 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5961
5962 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5963 p += 2;
5964
5965 if( end < p || (size_t)( end - p ) < psk_len )
5966 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5967
5968 memset( p, 0, psk_len );
5969 p += psk_len;
5970 }
5971 else
5972#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5973#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5974 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5975 {
5976 /*
5977 * other_secret already set by the ClientKeyExchange message,
5978 * and is 48 bytes long
5979 */
5980 if( end - p < 2 )
5981 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5982
5983 *p++ = 0;
5984 *p++ = 48;
5985 p += 48;
5986 }
5987 else
5988#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5989#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5990 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5991 {
5992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5993 size_t len;
5994
5995 /* Write length only when we know the actual value */
5996 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5997 p + 2, end - ( p + 2 ), &len,
5998 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5999 {
6000 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
6001 return( ret );
6002 }
6003 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
6004 p += 2 + len;
6005
6006 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
6007 }
6008 else
6009#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006010#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08006011 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
6012 {
6013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6014 size_t zlen;
6015
6016 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
6017 p + 2, end - ( p + 2 ),
6018 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6019 {
6020 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
6021 return( ret );
6022 }
6023
6024 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6025 p += 2 + zlen;
6026
6027 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6028 MBEDTLS_DEBUG_ECDH_Z );
6029 }
6030 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006031#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006032 {
6033 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6034 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6035 }
6036
6037 /* opaque psk<0..2^16-1>; */
6038 if( end - p < 2 )
6039 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6040
6041 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6042 p += 2;
6043
6044 if( end < p || (size_t)( end - p ) < psk_len )
6045 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6046
6047 memcpy( p, psk, psk_len );
6048 p += psk_len;
6049
6050 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6051
6052 return( 0 );
6053}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006054#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006055
6056#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006057MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006058static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6059
6060#if defined(MBEDTLS_SSL_PROTO_DTLS)
6061int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6062{
6063 /* If renegotiation is not enforced, retransmit until we would reach max
6064 * timeout if we were using the usual handshake doubling scheme */
6065 if( ssl->conf->renego_max_records < 0 )
6066 {
6067 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6068 unsigned char doublings = 1;
6069
6070 while( ratio != 0 )
6071 {
6072 ++doublings;
6073 ratio >>= 1;
6074 }
6075
6076 if( ++ssl->renego_records_seen > doublings )
6077 {
6078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6079 return( 0 );
6080 }
6081 }
6082
6083 return( ssl_write_hello_request( ssl ) );
6084}
6085#endif
6086#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006087
Jerry Yud9526692022-02-17 14:23:47 +08006088/*
6089 * Handshake functions
6090 */
6091#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6092/* No certificate support -> dummy functions */
6093int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6094{
6095 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6096 ssl->handshake->ciphersuite_info;
6097
6098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6099
6100 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6101 {
6102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6103 ssl->state++;
6104 return( 0 );
6105 }
6106
6107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6109}
6110
6111int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6112{
6113 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6114 ssl->handshake->ciphersuite_info;
6115
6116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6117
6118 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6119 {
6120 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6121 ssl->state++;
6122 return( 0 );
6123 }
6124
6125 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6126 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6127}
6128
6129#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6130/* Some certificate support -> implement write and parse */
6131
6132int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6133{
6134 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6135 size_t i, n;
6136 const mbedtls_x509_crt *crt;
6137 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6138 ssl->handshake->ciphersuite_info;
6139
6140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6141
6142 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6143 {
6144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6145 ssl->state++;
6146 return( 0 );
6147 }
6148
6149#if defined(MBEDTLS_SSL_CLI_C)
6150 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6151 {
6152 if( ssl->handshake->client_auth == 0 )
6153 {
6154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6155 ssl->state++;
6156 return( 0 );
6157 }
6158 }
6159#endif /* MBEDTLS_SSL_CLI_C */
6160#if defined(MBEDTLS_SSL_SRV_C)
6161 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6162 {
6163 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6164 {
6165 /* Should never happen because we shouldn't have picked the
6166 * ciphersuite if we don't have a certificate. */
6167 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6168 }
6169 }
6170#endif
6171
6172 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6173
6174 /*
6175 * 0 . 0 handshake type
6176 * 1 . 3 handshake length
6177 * 4 . 6 length of all certs
6178 * 7 . 9 length of cert. 1
6179 * 10 . n-1 peer certificate
6180 * n . n+2 length of cert. 2
6181 * n+3 . ... upper level cert, etc.
6182 */
6183 i = 7;
6184 crt = mbedtls_ssl_own_cert( ssl );
6185
6186 while( crt != NULL )
6187 {
6188 n = crt->raw.len;
6189 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6190 {
6191 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6192 " > %" MBEDTLS_PRINTF_SIZET,
6193 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6194 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6195 }
6196
6197 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6198 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6199 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6200
6201 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6202 i += n; crt = crt->next;
6203 }
6204
6205 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6206 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6207 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6208
6209 ssl->out_msglen = i;
6210 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6211 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6212
6213 ssl->state++;
6214
6215 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6216 {
6217 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6218 return( ret );
6219 }
6220
6221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6222
6223 return( ret );
6224}
6225
6226#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6227
6228#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006229MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006230static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6231 unsigned char *crt_buf,
6232 size_t crt_buf_len )
6233{
6234 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6235
6236 if( peer_crt == NULL )
6237 return( -1 );
6238
6239 if( peer_crt->raw.len != crt_buf_len )
6240 return( -1 );
6241
6242 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6243}
6244#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006245MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006246static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6247 unsigned char *crt_buf,
6248 size_t crt_buf_len )
6249{
6250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6251 unsigned char const * const peer_cert_digest =
6252 ssl->session->peer_cert_digest;
6253 mbedtls_md_type_t const peer_cert_digest_type =
6254 ssl->session->peer_cert_digest_type;
6255 mbedtls_md_info_t const * const digest_info =
6256 mbedtls_md_info_from_type( peer_cert_digest_type );
6257 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6258 size_t digest_len;
6259
6260 if( peer_cert_digest == NULL || digest_info == NULL )
6261 return( -1 );
6262
6263 digest_len = mbedtls_md_get_size( digest_info );
6264 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6265 return( -1 );
6266
6267 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6268 if( ret != 0 )
6269 return( -1 );
6270
6271 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6272}
6273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6274#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6275
6276/*
6277 * Once the certificate message is read, parse it into a cert chain and
6278 * perform basic checks, but leave actual verification to the caller
6279 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006280MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006281static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6282 mbedtls_x509_crt *chain )
6283{
6284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6285#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6286 int crt_cnt=0;
6287#endif
6288 size_t i, n;
6289 uint8_t alert;
6290
6291 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6292 {
6293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6294 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6295 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6296 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6297 }
6298
6299 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6300 {
6301 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6302 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6303 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6304 }
6305
6306 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6307 {
6308 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6309 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6310 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6311 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6312 }
6313
6314 i = mbedtls_ssl_hs_hdr_len( ssl );
6315
6316 /*
6317 * Same message structure as in mbedtls_ssl_write_certificate()
6318 */
6319 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6320
6321 if( ssl->in_msg[i] != 0 ||
6322 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6323 {
6324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6325 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6326 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6327 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6328 }
6329
6330 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6331 i += 3;
6332
6333 /* Iterate through and parse the CRTs in the provided chain. */
6334 while( i < ssl->in_hslen )
6335 {
6336 /* Check that there's room for the next CRT's length fields. */
6337 if ( i + 3 > ssl->in_hslen ) {
6338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6339 mbedtls_ssl_send_alert_message( ssl,
6340 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6341 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6342 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6343 }
6344 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6345 * anything beyond 2**16 ~ 64K. */
6346 if( ssl->in_msg[i] != 0 )
6347 {
6348 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6349 mbedtls_ssl_send_alert_message( ssl,
6350 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6351 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6352 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6353 }
6354
6355 /* Read length of the next CRT in the chain. */
6356 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6357 | (unsigned int) ssl->in_msg[i + 2];
6358 i += 3;
6359
6360 if( n < 128 || i + n > ssl->in_hslen )
6361 {
6362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6363 mbedtls_ssl_send_alert_message( ssl,
6364 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6365 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6366 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6367 }
6368
6369 /* Check if we're handling the first CRT in the chain. */
6370#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6371 if( crt_cnt++ == 0 &&
6372 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6373 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6374 {
6375 /* During client-side renegotiation, check that the server's
6376 * end-CRTs hasn't changed compared to the initial handshake,
6377 * mitigating the triple handshake attack. On success, reuse
6378 * the original end-CRT instead of parsing it again. */
6379 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6380 if( ssl_check_peer_crt_unchanged( ssl,
6381 &ssl->in_msg[i],
6382 n ) != 0 )
6383 {
6384 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6385 mbedtls_ssl_send_alert_message( ssl,
6386 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6387 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6388 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6389 }
6390
6391 /* Now we can safely free the original chain. */
6392 ssl_clear_peer_cert( ssl->session );
6393 }
6394#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6395
6396 /* Parse the next certificate in the chain. */
6397#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6398 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6399#else
6400 /* If we don't need to store the CRT chain permanently, parse
6401 * it in-place from the input buffer instead of making a copy. */
6402 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6403#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6404 switch( ret )
6405 {
6406 case 0: /*ok*/
6407 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6408 /* Ignore certificate with an unknown algorithm: maybe a
6409 prior certificate was already trusted. */
6410 break;
6411
6412 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6413 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6414 goto crt_parse_der_failed;
6415
6416 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6417 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6418 goto crt_parse_der_failed;
6419
6420 default:
6421 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6422 crt_parse_der_failed:
6423 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6424 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6425 return( ret );
6426 }
6427
6428 i += n;
6429 }
6430
6431 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6432 return( 0 );
6433}
6434
6435#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006436MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006437static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6438{
6439 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6440 return( -1 );
6441
6442 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6443 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6444 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6445 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6446 {
Ronald Cron19385882022-06-15 16:26:13 +02006447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006448 return( 0 );
6449 }
6450 return( -1 );
6451}
6452#endif /* MBEDTLS_SSL_SRV_C */
6453
6454/* Check if a certificate message is expected.
6455 * Return either
6456 * - SSL_CERTIFICATE_EXPECTED, or
6457 * - SSL_CERTIFICATE_SKIP
6458 * indicating whether a Certificate message is expected or not.
6459 */
6460#define SSL_CERTIFICATE_EXPECTED 0
6461#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006462MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006463static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6464 int authmode )
6465{
6466 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6467 ssl->handshake->ciphersuite_info;
6468
6469 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6470 return( SSL_CERTIFICATE_SKIP );
6471
6472#if defined(MBEDTLS_SSL_SRV_C)
6473 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6474 {
6475 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6476 return( SSL_CERTIFICATE_SKIP );
6477
6478 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6479 {
6480 ssl->session_negotiate->verify_result =
6481 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6482 return( SSL_CERTIFICATE_SKIP );
6483 }
6484 }
6485#else
6486 ((void) authmode);
6487#endif /* MBEDTLS_SSL_SRV_C */
6488
6489 return( SSL_CERTIFICATE_EXPECTED );
6490}
6491
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006492MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006493static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6494 int authmode,
6495 mbedtls_x509_crt *chain,
6496 void *rs_ctx )
6497{
6498 int ret = 0;
6499 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6500 ssl->handshake->ciphersuite_info;
6501 int have_ca_chain = 0;
6502
6503 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6504 void *p_vrfy;
6505
6506 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6507 return( 0 );
6508
6509 if( ssl->f_vrfy != NULL )
6510 {
6511 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6512 f_vrfy = ssl->f_vrfy;
6513 p_vrfy = ssl->p_vrfy;
6514 }
6515 else
6516 {
6517 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6518 f_vrfy = ssl->conf->f_vrfy;
6519 p_vrfy = ssl->conf->p_vrfy;
6520 }
6521
6522 /*
6523 * Main check: verify certificate
6524 */
6525#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6526 if( ssl->conf->f_ca_cb != NULL )
6527 {
6528 ((void) rs_ctx);
6529 have_ca_chain = 1;
6530
6531 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6532 ret = mbedtls_x509_crt_verify_with_ca_cb(
6533 chain,
6534 ssl->conf->f_ca_cb,
6535 ssl->conf->p_ca_cb,
6536 ssl->conf->cert_profile,
6537 ssl->hostname,
6538 &ssl->session_negotiate->verify_result,
6539 f_vrfy, p_vrfy );
6540 }
6541 else
6542#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6543 {
6544 mbedtls_x509_crt *ca_chain;
6545 mbedtls_x509_crl *ca_crl;
6546
6547#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6548 if( ssl->handshake->sni_ca_chain != NULL )
6549 {
6550 ca_chain = ssl->handshake->sni_ca_chain;
6551 ca_crl = ssl->handshake->sni_ca_crl;
6552 }
6553 else
6554#endif
6555 {
6556 ca_chain = ssl->conf->ca_chain;
6557 ca_crl = ssl->conf->ca_crl;
6558 }
6559
6560 if( ca_chain != NULL )
6561 have_ca_chain = 1;
6562
6563 ret = mbedtls_x509_crt_verify_restartable(
6564 chain,
6565 ca_chain, ca_crl,
6566 ssl->conf->cert_profile,
6567 ssl->hostname,
6568 &ssl->session_negotiate->verify_result,
6569 f_vrfy, p_vrfy, rs_ctx );
6570 }
6571
6572 if( ret != 0 )
6573 {
6574 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6575 }
6576
6577#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6578 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6579 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6580#endif
6581
6582 /*
6583 * Secondary checks: always done, but change 'ret' only if it was 0
6584 */
6585
6586#if defined(MBEDTLS_ECP_C)
6587 {
6588 const mbedtls_pk_context *pk = &chain->pk;
6589
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006590 /* If certificate uses an EC key, make sure the curve is OK.
6591 * This is a public key, so it can't be opaque, so can_do() is a good
6592 * enough check to ensure pk_ec() is safe to use here. */
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006593 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) )
Jerry Yud9526692022-02-17 14:23:47 +08006594 {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006595 /* and in the unlikely case the above assumption no longer holds
6596 * we are making sure that pk_ec() here does not return a NULL
6597 */
6598 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *pk );
6599 if( ec == NULL )
6600 {
Tom Cosgrove20c11372022-08-24 15:06:13 +01006601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_pk_ec() returned NULL" ) );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6603 }
Jerry Yud9526692022-02-17 14:23:47 +08006604
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006605 if( mbedtls_ssl_check_curve( ssl, ec->grp.id ) != 0 )
6606 {
6607 ssl->session_negotiate->verify_result |=
6608 MBEDTLS_X509_BADCERT_BAD_KEY;
6609
6610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6611 if( ret == 0 )
6612 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6613 }
Jerry Yud9526692022-02-17 14:23:47 +08006614 }
6615 }
6616#endif /* MBEDTLS_ECP_C */
6617
6618 if( mbedtls_ssl_check_cert_usage( chain,
6619 ciphersuite_info,
6620 ! ssl->conf->endpoint,
6621 &ssl->session_negotiate->verify_result ) != 0 )
6622 {
6623 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6624 if( ret == 0 )
6625 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6626 }
6627
6628 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6629 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6630 * with details encoded in the verification flags. All other kinds
6631 * of error codes, including those from the user provided f_vrfy
6632 * functions, are treated as fatal and lead to a failure of
6633 * ssl_parse_certificate even if verification was optional. */
6634 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6635 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6636 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6637 {
6638 ret = 0;
6639 }
6640
6641 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6642 {
6643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6644 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6645 }
6646
6647 if( ret != 0 )
6648 {
6649 uint8_t alert;
6650
6651 /* The certificate may have been rejected for several reasons.
6652 Pick one and send the corresponding alert. Which alert to send
6653 may be a subject of debate in some cases. */
6654 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6655 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6656 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6657 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6658 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6659 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6660 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6661 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6662 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6663 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6664 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6665 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6666 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6667 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6668 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6669 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6670 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6671 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6672 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6673 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6674 else
6675 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6676 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6677 alert );
6678 }
6679
6680#if defined(MBEDTLS_DEBUG_C)
6681 if( ssl->session_negotiate->verify_result != 0 )
6682 {
6683 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6684 (unsigned int) ssl->session_negotiate->verify_result ) );
6685 }
6686 else
6687 {
6688 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6689 }
6690#endif /* MBEDTLS_DEBUG_C */
6691
6692 return( ret );
6693}
6694
6695#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006696MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006697static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6698 unsigned char *start, size_t len )
6699{
6700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6701 /* Remember digest of the peer's end-CRT. */
6702 ssl->session_negotiate->peer_cert_digest =
6703 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6704 if( ssl->session_negotiate->peer_cert_digest == NULL )
6705 {
6706 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6707 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6708 mbedtls_ssl_send_alert_message( ssl,
6709 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6710 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6711
6712 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6713 }
6714
6715 ret = mbedtls_md( mbedtls_md_info_from_type(
6716 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6717 start, len,
6718 ssl->session_negotiate->peer_cert_digest );
6719
6720 ssl->session_negotiate->peer_cert_digest_type =
6721 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6722 ssl->session_negotiate->peer_cert_digest_len =
6723 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6724
6725 return( ret );
6726}
6727
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006728MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006729static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6730 unsigned char *start, size_t len )
6731{
6732 unsigned char *end = start + len;
6733 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6734
6735 /* Make a copy of the peer's raw public key. */
6736 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6737 ret = mbedtls_pk_parse_subpubkey( &start, end,
6738 &ssl->handshake->peer_pubkey );
6739 if( ret != 0 )
6740 {
6741 /* We should have parsed the public key before. */
6742 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6743 }
6744
6745 return( 0 );
6746}
6747#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6748
6749int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6750{
6751 int ret = 0;
6752 int crt_expected;
6753#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6754 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6755 ? ssl->handshake->sni_authmode
6756 : ssl->conf->authmode;
6757#else
6758 const int authmode = ssl->conf->authmode;
6759#endif
6760 void *rs_ctx = NULL;
6761 mbedtls_x509_crt *chain = NULL;
6762
6763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6764
6765 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6766 if( crt_expected == SSL_CERTIFICATE_SKIP )
6767 {
6768 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6769 goto exit;
6770 }
6771
6772#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6773 if( ssl->handshake->ecrs_enabled &&
6774 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6775 {
6776 chain = ssl->handshake->ecrs_peer_cert;
6777 ssl->handshake->ecrs_peer_cert = NULL;
6778 goto crt_verify;
6779 }
6780#endif
6781
6782 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6783 {
6784 /* mbedtls_ssl_read_record may have sent an alert already. We
6785 let it decide whether to alert. */
6786 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6787 goto exit;
6788 }
6789
6790#if defined(MBEDTLS_SSL_SRV_C)
6791 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6792 {
6793 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6794
6795 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6796 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6797
6798 goto exit;
6799 }
6800#endif /* MBEDTLS_SSL_SRV_C */
6801
6802 /* Clear existing peer CRT structure in case we tried to
6803 * reuse a session but it failed, and allocate a new one. */
6804 ssl_clear_peer_cert( ssl->session_negotiate );
6805
6806 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6807 if( chain == NULL )
6808 {
6809 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6810 sizeof( mbedtls_x509_crt ) ) );
6811 mbedtls_ssl_send_alert_message( ssl,
6812 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6813 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6814
6815 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6816 goto exit;
6817 }
6818 mbedtls_x509_crt_init( chain );
6819
6820 ret = ssl_parse_certificate_chain( ssl, chain );
6821 if( ret != 0 )
6822 goto exit;
6823
6824#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6825 if( ssl->handshake->ecrs_enabled)
6826 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6827
6828crt_verify:
6829 if( ssl->handshake->ecrs_enabled)
6830 rs_ctx = &ssl->handshake->ecrs_ctx;
6831#endif
6832
6833 ret = ssl_parse_certificate_verify( ssl, authmode,
6834 chain, rs_ctx );
6835 if( ret != 0 )
6836 goto exit;
6837
6838#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6839 {
6840 unsigned char *crt_start, *pk_start;
6841 size_t crt_len, pk_len;
6842
6843 /* We parse the CRT chain without copying, so
6844 * these pointers point into the input buffer,
6845 * and are hence still valid after freeing the
6846 * CRT chain. */
6847
6848 crt_start = chain->raw.p;
6849 crt_len = chain->raw.len;
6850
6851 pk_start = chain->pk_raw.p;
6852 pk_len = chain->pk_raw.len;
6853
6854 /* Free the CRT structures before computing
6855 * digest and copying the peer's public key. */
6856 mbedtls_x509_crt_free( chain );
6857 mbedtls_free( chain );
6858 chain = NULL;
6859
6860 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6861 if( ret != 0 )
6862 goto exit;
6863
6864 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6865 if( ret != 0 )
6866 goto exit;
6867 }
6868#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6869 /* Pass ownership to session structure. */
6870 ssl->session_negotiate->peer_cert = chain;
6871 chain = NULL;
6872#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6873
6874 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6875
6876exit:
6877
6878 if( ret == 0 )
6879 ssl->state++;
6880
6881#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6882 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6883 {
6884 ssl->handshake->ecrs_peer_cert = chain;
6885 chain = NULL;
6886 }
6887#endif
6888
6889 if( chain != NULL )
6890 {
6891 mbedtls_x509_crt_free( chain );
6892 mbedtls_free( chain );
6893 }
6894
6895 return( ret );
6896}
6897#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6898
Andrzej Kurek25f27152022-08-17 16:09:31 -04006899#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu615bd6f2022-02-17 14:25:15 +08006900static void ssl_calc_finished_tls_sha256(
6901 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6902{
6903 int len = 12;
6904 const char *sender;
6905 unsigned char padbuf[32];
6906#if defined(MBEDTLS_USE_PSA_CRYPTO)
6907 size_t hash_size;
6908 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6909 psa_status_t status;
6910#else
6911 mbedtls_sha256_context sha256;
6912#endif
6913
6914 mbedtls_ssl_session *session = ssl->session_negotiate;
6915 if( !session )
6916 session = ssl->session;
6917
6918 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6919 ? "client finished"
6920 : "server finished";
6921
6922#if defined(MBEDTLS_USE_PSA_CRYPTO)
6923 sha256_psa = psa_hash_operation_init();
6924
6925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6926
6927 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6928 if( status != PSA_SUCCESS )
6929 {
6930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6931 return;
6932 }
6933
6934 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6935 if( status != PSA_SUCCESS )
6936 {
6937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6938 return;
6939 }
6940 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6941#else
6942
6943 mbedtls_sha256_init( &sha256 );
6944
6945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6946
6947 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6948
6949 /*
6950 * TLSv1.2:
6951 * hash = PRF( master, finished_label,
6952 * Hash( handshake ) )[0.11]
6953 */
6954
6955#if !defined(MBEDTLS_SHA256_ALT)
6956 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6957 sha256.state, sizeof( sha256.state ) );
6958#endif
6959
6960 mbedtls_sha256_finish( &sha256, padbuf );
6961 mbedtls_sha256_free( &sha256 );
6962#endif /* MBEDTLS_USE_PSA_CRYPTO */
6963
6964 ssl->handshake->tls_prf( session->master, 48, sender,
6965 padbuf, 32, buf, len );
6966
6967 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6968
6969 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6970
6971 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6972}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006973#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08006974
Jerry Yub7ba49e2022-02-17 14:25:53 +08006975
Andrzej Kurek25f27152022-08-17 16:09:31 -04006976#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yub7ba49e2022-02-17 14:25:53 +08006977static void ssl_calc_finished_tls_sha384(
6978 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6979{
6980 int len = 12;
6981 const char *sender;
6982 unsigned char padbuf[48];
6983#if defined(MBEDTLS_USE_PSA_CRYPTO)
6984 size_t hash_size;
6985 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6986 psa_status_t status;
6987#else
6988 mbedtls_sha512_context sha512;
6989#endif
6990
6991 mbedtls_ssl_session *session = ssl->session_negotiate;
6992 if( !session )
6993 session = ssl->session;
6994
6995 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6996 ? "client finished"
6997 : "server finished";
6998
6999#if defined(MBEDTLS_USE_PSA_CRYPTO)
7000 sha384_psa = psa_hash_operation_init();
7001
7002 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
7003
7004 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
7005 if( status != PSA_SUCCESS )
7006 {
7007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7008 return;
7009 }
7010
7011 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
7012 if( status != PSA_SUCCESS )
7013 {
7014 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7015 return;
7016 }
7017 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
7018#else
7019 mbedtls_sha512_init( &sha512 );
7020
7021 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
7022
Andrzej Kureka242e832022-08-11 10:03:14 -04007023 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yub7ba49e2022-02-17 14:25:53 +08007024
7025 /*
7026 * TLSv1.2:
7027 * hash = PRF( master, finished_label,
7028 * Hash( handshake ) )[0.11]
7029 */
7030
7031#if !defined(MBEDTLS_SHA512_ALT)
7032 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
7033 sha512.state, sizeof( sha512.state ) );
7034#endif
7035 mbedtls_sha512_finish( &sha512, padbuf );
7036
7037 mbedtls_sha512_free( &sha512 );
7038#endif
7039
7040 ssl->handshake->tls_prf( session->master, 48, sender,
7041 padbuf, 48, buf, len );
7042
7043 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7044
7045 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7046
7047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7048}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007049#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007050
Jerry Yuaef00152022-02-17 14:27:31 +08007051void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7052{
7053 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7054
7055 /*
7056 * Free our handshake params
7057 */
7058 mbedtls_ssl_handshake_free( ssl );
7059 mbedtls_free( ssl->handshake );
7060 ssl->handshake = NULL;
7061
7062 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007063 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007064 */
7065 if( ssl->transform )
7066 {
7067 mbedtls_ssl_transform_free( ssl->transform );
7068 mbedtls_free( ssl->transform );
7069 }
7070 ssl->transform = ssl->transform_negotiate;
7071 ssl->transform_negotiate = NULL;
7072
7073 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7074}
7075
Jerry Yu2a9fff52022-02-17 14:28:51 +08007076void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7077{
7078 int resume = ssl->handshake->resume;
7079
7080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7081
7082#if defined(MBEDTLS_SSL_RENEGOTIATION)
7083 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7084 {
7085 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7086 ssl->renego_records_seen = 0;
7087 }
7088#endif
7089
7090 /*
7091 * Free the previous session and switch in the current one
7092 */
7093 if( ssl->session )
7094 {
7095#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7096 /* RFC 7366 3.1: keep the EtM state */
7097 ssl->session_negotiate->encrypt_then_mac =
7098 ssl->session->encrypt_then_mac;
7099#endif
7100
7101 mbedtls_ssl_session_free( ssl->session );
7102 mbedtls_free( ssl->session );
7103 }
7104 ssl->session = ssl->session_negotiate;
7105 ssl->session_negotiate = NULL;
7106
7107 /*
7108 * Add cache entry
7109 */
7110 if( ssl->conf->f_set_cache != NULL &&
7111 ssl->session->id_len != 0 &&
7112 resume == 0 )
7113 {
7114 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7115 ssl->session->id,
7116 ssl->session->id_len,
7117 ssl->session ) != 0 )
7118 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7119 }
7120
7121#if defined(MBEDTLS_SSL_PROTO_DTLS)
7122 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7123 ssl->handshake->flight != NULL )
7124 {
7125 /* Cancel handshake timer */
7126 mbedtls_ssl_set_timer( ssl, 0 );
7127
7128 /* Keep last flight around in case we need to resend it:
7129 * we need the handshake and transform structures for that */
7130 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7131 }
7132 else
7133#endif
7134 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7135
7136 ssl->state++;
7137
7138 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7139}
7140
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007141int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7142{
7143 int ret, hash_len;
7144
7145 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7146
7147 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7148
7149 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7150
7151 /*
7152 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7153 * may define some other value. Currently (early 2016), no defined
7154 * ciphersuite does this (and this is unlikely to change as activity has
7155 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7156 */
7157 hash_len = 12;
7158
7159#if defined(MBEDTLS_SSL_RENEGOTIATION)
7160 ssl->verify_data_len = hash_len;
7161 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7162#endif
7163
7164 ssl->out_msglen = 4 + hash_len;
7165 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7166 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7167
7168 /*
7169 * In case of session resuming, invert the client and server
7170 * ChangeCipherSpec messages order.
7171 */
7172 if( ssl->handshake->resume != 0 )
7173 {
7174#if defined(MBEDTLS_SSL_CLI_C)
7175 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7176 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7177#endif
7178#if defined(MBEDTLS_SSL_SRV_C)
7179 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7180 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7181#endif
7182 }
7183 else
7184 ssl->state++;
7185
7186 /*
7187 * Switch to our negotiated transform and session parameters for outbound
7188 * data.
7189 */
7190 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7191
7192#if defined(MBEDTLS_SSL_PROTO_DTLS)
7193 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7194 {
7195 unsigned char i;
7196
7197 /* Remember current epoch settings for resending */
7198 ssl->handshake->alt_transform_out = ssl->transform_out;
7199 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7200 sizeof( ssl->handshake->alt_out_ctr ) );
7201
7202 /* Set sequence_number to zero */
7203 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7204
7205
7206 /* Increment epoch */
7207 for( i = 2; i > 0; i-- )
7208 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7209 break;
7210
7211 /* The loop goes to its end iff the counter is wrapping */
7212 if( i == 0 )
7213 {
7214 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7215 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7216 }
7217 }
7218 else
7219#endif /* MBEDTLS_SSL_PROTO_DTLS */
7220 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7221
7222 ssl->transform_out = ssl->transform_negotiate;
7223 ssl->session_out = ssl->session_negotiate;
7224
7225#if defined(MBEDTLS_SSL_PROTO_DTLS)
7226 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7227 mbedtls_ssl_send_flight_completed( ssl );
7228#endif
7229
7230 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7231 {
7232 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7233 return( ret );
7234 }
7235
7236#if defined(MBEDTLS_SSL_PROTO_DTLS)
7237 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7238 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7239 {
7240 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7241 return( ret );
7242 }
7243#endif
7244
7245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7246
7247 return( 0 );
7248}
7249
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007250#define SSL_MAX_HASH_LEN 12
7251
7252int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7253{
7254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7255 unsigned int hash_len = 12;
7256 unsigned char buf[SSL_MAX_HASH_LEN];
7257
7258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7259
7260 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7261
7262 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7263 {
7264 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7265 goto exit;
7266 }
7267
7268 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7269 {
7270 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7271 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7272 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7273 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7274 goto exit;
7275 }
7276
7277 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7278 {
7279 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7280 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7281 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7282 goto exit;
7283 }
7284
7285 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7286 {
7287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7288 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7289 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7290 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7291 goto exit;
7292 }
7293
7294 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7295 buf, hash_len ) != 0 )
7296 {
7297 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7298 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7299 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7300 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7301 goto exit;
7302 }
7303
7304#if defined(MBEDTLS_SSL_RENEGOTIATION)
7305 ssl->verify_data_len = hash_len;
7306 memcpy( ssl->peer_verify_data, buf, hash_len );
7307#endif
7308
7309 if( ssl->handshake->resume != 0 )
7310 {
7311#if defined(MBEDTLS_SSL_CLI_C)
7312 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7313 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7314#endif
7315#if defined(MBEDTLS_SSL_SRV_C)
7316 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7317 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7318#endif
7319 }
7320 else
7321 ssl->state++;
7322
7323#if defined(MBEDTLS_SSL_PROTO_DTLS)
7324 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7325 mbedtls_ssl_recv_flight_completed( ssl );
7326#endif
7327
7328 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7329
7330exit:
7331 mbedtls_platform_zeroize( buf, hash_len );
7332 return( ret );
7333}
7334
Jerry Yu392112c2022-02-17 14:34:10 +08007335#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7336/*
7337 * Helper to get TLS 1.2 PRF from ciphersuite
7338 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7339 */
7340static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7341{
Andrzej Kurek25f27152022-08-17 16:09:31 -04007342#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu392112c2022-02-17 14:34:10 +08007343 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7344 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7345
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007346 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007347 return( tls_prf_sha384 );
7348#else
7349 (void) ciphersuite_id;
7350#endif
7351 return( tls_prf_sha256 );
7352}
7353#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007354
7355static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7356{
7357 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04007358#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007359 if( tls_prf == tls_prf_sha384 )
7360 {
7361 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7362 }
7363 else
7364#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04007365#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007366 if( tls_prf == tls_prf_sha256 )
7367 {
7368 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7369 }
7370 else
7371#endif
7372 return( MBEDTLS_SSL_TLS_PRF_NONE );
7373}
7374
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007375/*
7376 * Populate a transform structure with session keys and all the other
7377 * necessary information.
7378 *
7379 * Parameters:
7380 * - [in/out]: transform: structure to populate
7381 * [in] must be just initialised with mbedtls_ssl_transform_init()
7382 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7383 * - [in] ciphersuite
7384 * - [in] master
7385 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007386 * - [in] tls_prf: pointer to PRF to use for key derivation
7387 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007388 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007389 * - [in] endpoint: client or server
7390 * - [in] ssl: used for:
7391 * - ssl->conf->{f,p}_export_keys
7392 * [in] optionally used for:
7393 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7394 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007395MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007396static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7397 int ciphersuite,
7398 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007400 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007401#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007402 ssl_tls_prf_t tls_prf,
7403 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007404 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007405 unsigned endpoint,
7406 const mbedtls_ssl_context *ssl )
7407{
7408 int ret = 0;
7409 unsigned char keyblk[256];
7410 unsigned char *key1;
7411 unsigned char *key2;
7412 unsigned char *mac_enc;
7413 unsigned char *mac_dec;
7414 size_t mac_key_len = 0;
7415 size_t iv_copy_len;
7416 size_t keylen;
7417 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007418 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007419#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007420 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007421 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007422#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007423
7424#if defined(MBEDTLS_USE_PSA_CRYPTO)
7425 psa_key_type_t key_type;
7426 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7427 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007428 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007429 size_t key_bits;
7430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7431#endif
7432
7433#if !defined(MBEDTLS_DEBUG_C) && \
7434 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7435 if( ssl->f_export_keys == NULL )
7436 {
7437 ssl = NULL; /* make sure we don't use it except for these cases */
7438 (void) ssl;
7439 }
7440#endif
7441
7442 /*
7443 * Some data just needs copying into the structure
7444 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007445#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007446 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007447#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007448 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007449
7450#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7451 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7452#endif
7453
7454#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007455 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007456 {
7457 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7458 * generation separate. This should never happen. */
7459 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7460 }
7461#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7462
7463 /*
7464 * Get various info structures
7465 */
7466 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7467 if( ciphersuite_info == NULL )
7468 {
7469 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7470 ciphersuite ) );
7471 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7472 }
7473
Neil Armstrongab555e02022-04-04 11:07:59 +02007474 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007475#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007476 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007477#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007478 ciphersuite_info );
7479
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007480 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7481 transform->taglen =
7482 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7483
7484#if defined(MBEDTLS_USE_PSA_CRYPTO)
7485 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7486 transform->taglen,
7487 &alg,
7488 &key_type,
7489 &key_bits ) ) != PSA_SUCCESS )
7490 {
7491 ret = psa_ssl_status_to_mbedtls( status );
7492 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7493 goto end;
7494 }
7495#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007496 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7497 if( cipher_info == NULL )
7498 {
7499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7500 ciphersuite_info->cipher ) );
7501 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7502 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007503#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007504
Neil Armstronge4512952022-03-08 09:08:22 +01007505#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007506 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007507 if( mac_alg == 0 )
7508 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007509 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007510 (unsigned) ciphersuite_info->mac ) );
7511 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7512 }
7513#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007514 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7515 if( md_info == NULL )
7516 {
7517 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7518 (unsigned) ciphersuite_info->mac ) );
7519 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7520 }
Neil Armstronge4512952022-03-08 09:08:22 +01007521#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007522
7523#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7524 /* Copy own and peer's CID if the use of the CID
7525 * extension has been negotiated. */
7526 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7527 {
7528 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7529
7530 transform->in_cid_len = ssl->own_cid_len;
7531 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7532 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7533 transform->in_cid_len );
7534
7535 transform->out_cid_len = ssl->handshake->peer_cid_len;
7536 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7537 ssl->handshake->peer_cid_len );
7538 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7539 transform->out_cid_len );
7540 }
7541#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7542
7543 /*
7544 * Compute key block using the PRF
7545 */
7546 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7547 if( ret != 0 )
7548 {
7549 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7550 return( ret );
7551 }
7552
7553 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7554 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7555 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7556 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7557 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7558
7559 /*
7560 * Determine the appropriate key, IV and MAC length.
7561 */
7562
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007563#if defined(MBEDTLS_USE_PSA_CRYPTO)
7564 keylen = PSA_BITS_TO_BYTES(key_bits);
7565#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007566 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007567#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007568
7569#if defined(MBEDTLS_GCM_C) || \
7570 defined(MBEDTLS_CCM_C) || \
7571 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007572 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007573 {
7574 size_t explicit_ivlen;
7575
7576 transform->maclen = 0;
7577 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007578
7579 /* All modes haves 96-bit IVs, but the length of the static parts vary
7580 * with mode and version:
7581 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7582 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7583 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7584 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7585 * sequence number).
7586 */
7587 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007588#if defined(MBEDTLS_USE_PSA_CRYPTO)
7589 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7590#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007591 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007592#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007593 transform->fixed_ivlen = 12;
7594 else
7595 transform->fixed_ivlen = 4;
7596
7597 /* Minimum length of encrypted record */
7598 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7599 transform->minlen = explicit_ivlen + transform->taglen;
7600 }
7601 else
7602#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7603#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007604 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7605 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7606 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007607 {
Neil Armstronge4512952022-03-08 09:08:22 +01007608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007609 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007610#else
7611 size_t block_size = cipher_info->block_size;
7612#endif /* MBEDTLS_USE_PSA_CRYPTO */
7613
7614#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007615 /* Get MAC length */
7616 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7617#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007618 /* Initialize HMAC contexts */
7619 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7620 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7621 {
7622 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7623 goto end;
7624 }
7625
7626 /* Get MAC length */
7627 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007628#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007629 transform->maclen = mac_key_len;
7630
7631 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007632#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007633 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007634#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007635 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007636#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007637
7638 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007639 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007640 transform->minlen = transform->maclen;
7641 else
7642 {
7643 /*
7644 * GenericBlockCipher:
7645 * 1. if EtM is in use: one block plus MAC
7646 * otherwise: * first multiple of blocklen greater than maclen
7647 * 2. IV
7648 */
7649#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007650 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007651 {
7652 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007653 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007654 }
7655 else
7656#endif
7657 {
7658 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007659 + block_size
7660 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007661 }
7662
Glenn Strauss07c64162022-03-14 12:34:51 -04007663 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007664 {
7665 transform->minlen += transform->ivlen;
7666 }
7667 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007668 {
7669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7670 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7671 goto end;
7672 }
7673 }
7674 }
7675 else
7676#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7677 {
7678 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7679 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7680 }
7681
7682 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7683 (unsigned) keylen,
7684 (unsigned) transform->minlen,
7685 (unsigned) transform->ivlen,
7686 (unsigned) transform->maclen ) );
7687
7688 /*
7689 * Finally setup the cipher contexts, IVs and MAC secrets.
7690 */
7691#if defined(MBEDTLS_SSL_CLI_C)
7692 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7693 {
7694 key1 = keyblk + mac_key_len * 2;
7695 key2 = keyblk + mac_key_len * 2 + keylen;
7696
7697 mac_enc = keyblk;
7698 mac_dec = keyblk + mac_key_len;
7699
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007700 iv_copy_len = ( transform->fixed_ivlen ) ?
7701 transform->fixed_ivlen : transform->ivlen;
7702 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7703 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7704 iv_copy_len );
7705 }
7706 else
7707#endif /* MBEDTLS_SSL_CLI_C */
7708#if defined(MBEDTLS_SSL_SRV_C)
7709 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7710 {
7711 key1 = keyblk + mac_key_len * 2 + keylen;
7712 key2 = keyblk + mac_key_len * 2;
7713
7714 mac_enc = keyblk + mac_key_len;
7715 mac_dec = keyblk;
7716
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007717 iv_copy_len = ( transform->fixed_ivlen ) ?
7718 transform->fixed_ivlen : transform->ivlen;
7719 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7720 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7721 iv_copy_len );
7722 }
7723 else
7724#endif /* MBEDTLS_SSL_SRV_C */
7725 {
7726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7727 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7728 goto end;
7729 }
7730
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007731 if( ssl != NULL && ssl->f_export_keys != NULL )
7732 {
7733 ssl->f_export_keys( ssl->p_export_keys,
7734 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7735 master, 48,
7736 randbytes + 32,
7737 randbytes,
7738 tls_prf_get_type( tls_prf ) );
7739 }
7740
7741#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007742 transform->psa_alg = alg;
7743
7744 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7745 {
7746 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7747 psa_set_key_algorithm( &attributes, alg );
7748 psa_set_key_type( &attributes, key_type );
7749
7750 if( ( status = psa_import_key( &attributes,
7751 key1,
7752 PSA_BITS_TO_BYTES( key_bits ),
7753 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7754 {
7755 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7756 ret = psa_ssl_status_to_mbedtls( status );
7757 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7758 goto end;
7759 }
7760
7761 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7762
7763 if( ( status = psa_import_key( &attributes,
7764 key2,
7765 PSA_BITS_TO_BYTES( key_bits ),
7766 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7767 {
7768 ret = psa_ssl_status_to_mbedtls( status );
7769 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7770 goto end;
7771 }
7772 }
7773#else
7774 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7775 cipher_info ) ) != 0 )
7776 {
7777 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7778 goto end;
7779 }
7780
7781 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7782 cipher_info ) ) != 0 )
7783 {
7784 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7785 goto end;
7786 }
7787
7788 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7789 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7790 MBEDTLS_ENCRYPT ) ) != 0 )
7791 {
7792 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7793 goto end;
7794 }
7795
7796 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7797 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7798 MBEDTLS_DECRYPT ) ) != 0 )
7799 {
7800 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7801 goto end;
7802 }
7803
7804#if defined(MBEDTLS_CIPHER_MODE_CBC)
7805 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7806 {
7807 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7808 MBEDTLS_PADDING_NONE ) ) != 0 )
7809 {
7810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7811 goto end;
7812 }
7813
7814 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7815 MBEDTLS_PADDING_NONE ) ) != 0 )
7816 {
7817 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7818 goto end;
7819 }
7820 }
7821#endif /* MBEDTLS_CIPHER_MODE_CBC */
7822#endif /* MBEDTLS_USE_PSA_CRYPTO */
7823
Neil Armstrong29c0c042022-03-17 17:47:28 +01007824#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7825 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7826 For AEAD-based ciphersuites, there is nothing to do here. */
7827 if( mac_key_len != 0 )
7828 {
7829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007830 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007831
7832 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007833 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007834 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7835
7836 if( ( status = psa_import_key( &attributes,
7837 mac_enc, mac_key_len,
7838 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7839 {
7840 ret = psa_ssl_status_to_mbedtls( status );
7841 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7842 goto end;
7843 }
7844
Ronald Cronfb39f152022-03-25 14:36:28 +01007845 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007846 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
7847#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
7848 && ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED )
7849#endif
7850 ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007851 /* mbedtls_ct_hmac() requires the key to be exportable */
7852 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7853 PSA_KEY_USAGE_VERIFY_HASH );
7854 else
7855 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7856
7857 if( ( status = psa_import_key( &attributes,
7858 mac_dec, mac_key_len,
7859 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7860 {
7861 ret = psa_ssl_status_to_mbedtls( status );
7862 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7863 goto end;
7864 }
7865#else
7866 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7867 if( ret != 0 )
7868 goto end;
7869 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7870 if( ret != 0 )
7871 goto end;
7872#endif /* MBEDTLS_USE_PSA_CRYPTO */
7873 }
7874#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7875
7876 ((void) mac_dec);
7877 ((void) mac_enc);
7878
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007879end:
7880 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7881 return( ret );
7882}
7883
Jerry Yuee40f9d2022-02-17 14:55:16 +08007884#if defined(MBEDTLS_USE_PSA_CRYPTO)
7885int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7886 unsigned char *hash, size_t *hashlen,
7887 unsigned char *data, size_t data_len,
7888 mbedtls_md_type_t md_alg )
7889{
7890 psa_status_t status;
7891 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007892 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007893
7894 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7895
7896 if( ( status = psa_hash_setup( &hash_operation,
7897 hash_alg ) ) != PSA_SUCCESS )
7898 {
7899 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7900 goto exit;
7901 }
7902
7903 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7904 64 ) ) != PSA_SUCCESS )
7905 {
7906 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7907 goto exit;
7908 }
7909
7910 if( ( status = psa_hash_update( &hash_operation,
7911 data, data_len ) ) != PSA_SUCCESS )
7912 {
7913 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7914 goto exit;
7915 }
7916
7917 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7918 hashlen ) ) != PSA_SUCCESS )
7919 {
7920 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7921 goto exit;
7922 }
7923
7924exit:
7925 if( status != PSA_SUCCESS )
7926 {
7927 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7928 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7929 switch( status )
7930 {
7931 case PSA_ERROR_NOT_SUPPORTED:
7932 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7933 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7934 case PSA_ERROR_BUFFER_TOO_SMALL:
7935 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7936 case PSA_ERROR_INSUFFICIENT_MEMORY:
7937 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7938 default:
7939 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7940 }
7941 }
7942 return( 0 );
7943}
7944
7945#else
7946
7947int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7948 unsigned char *hash, size_t *hashlen,
7949 unsigned char *data, size_t data_len,
7950 mbedtls_md_type_t md_alg )
7951{
7952 int ret = 0;
7953 mbedtls_md_context_t ctx;
7954 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7955 *hashlen = mbedtls_md_get_size( md_info );
7956
7957 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7958
7959 mbedtls_md_init( &ctx );
7960
7961 /*
7962 * digitally-signed struct {
7963 * opaque client_random[32];
7964 * opaque server_random[32];
7965 * ServerDHParams params;
7966 * };
7967 */
7968 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7969 {
7970 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7971 goto exit;
7972 }
7973 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7974 {
7975 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7976 goto exit;
7977 }
7978 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7979 {
7980 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7981 goto exit;
7982 }
7983 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7984 {
7985 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7986 goto exit;
7987 }
7988 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7989 {
7990 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7991 goto exit;
7992 }
7993
7994exit:
7995 mbedtls_md_free( &ctx );
7996
7997 if( ret != 0 )
7998 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7999 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
8000
8001 return( ret );
8002}
8003#endif /* MBEDTLS_USE_PSA_CRYPTO */
8004
Jerry Yud9d91da2022-02-17 14:57:06 +08008005#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8006
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008007/* Find the preferred hash for a given signature algorithm. */
8008unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
8009 mbedtls_ssl_context *ssl,
8010 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08008011{
Gabor Mezei078e8032022-04-27 21:17:56 +02008012 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008013 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008014
8015 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008016 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02008017
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008018 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08008019 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008020 unsigned int hash_alg_received =
8021 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8022 received_sig_algs[i] );
8023 unsigned int sig_alg_received =
8024 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8025 received_sig_algs[i] );
8026
8027 if( sig_alg == sig_alg_received )
8028 {
8029#if defined(MBEDTLS_USE_PSA_CRYPTO)
8030 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
8031 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008032 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008033 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008034
Neil Armstrong96eceb82022-06-30 18:05:05 +02008035 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8036 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8037 PSA_ALG_ECDSA( psa_hash_alg ),
8038 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008039 continue;
8040
Neil Armstrong96eceb82022-06-30 18:05:05 +02008041 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008042 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8043 PSA_ALG_RSA_PKCS1V15_SIGN(
8044 psa_hash_alg ),
8045 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008046 continue;
8047 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008048#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008049
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008050 return( hash_alg_received );
8051 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008052 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008053
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008054 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008055}
8056
8057#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8058
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008059/* Serialization of TLS 1.2 sessions:
8060 *
8061 * struct {
8062 * uint64 start_time;
8063 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008064 * uint8 session_id_len; // at most 32
8065 * opaque session_id[32];
8066 * opaque master[48]; // fixed length in the standard
8067 * uint32 verify_result;
8068 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8069 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8070 * uint32 ticket_lifetime;
8071 * uint8 mfl_code; // up to 255 according to standard
8072 * uint8 encrypt_then_mac; // 0 or 1
8073 * } serialized_session_tls12;
8074 *
8075 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008076static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008077 unsigned char *buf,
8078 size_t buf_len )
8079{
8080 unsigned char *p = buf;
8081 size_t used = 0;
8082
8083#if defined(MBEDTLS_HAVE_TIME)
8084 uint64_t start;
8085#endif
8086#if defined(MBEDTLS_X509_CRT_PARSE_C)
8087#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8088 size_t cert_len;
8089#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8090#endif /* MBEDTLS_X509_CRT_PARSE_C */
8091
8092 /*
8093 * Time
8094 */
8095#if defined(MBEDTLS_HAVE_TIME)
8096 used += 8;
8097
8098 if( used <= buf_len )
8099 {
8100 start = (uint64_t) session->start;
8101
8102 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8103 p += 8;
8104 }
8105#endif /* MBEDTLS_HAVE_TIME */
8106
8107 /*
8108 * Basic mandatory fields
8109 */
8110 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008111 + 1 /* id_len */
8112 + sizeof( session->id )
8113 + sizeof( session->master )
8114 + 4; /* verify_result */
8115
8116 if( used <= buf_len )
8117 {
8118 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8119 p += 2;
8120
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008121 *p++ = MBEDTLS_BYTE_0( session->id_len );
8122 memcpy( p, session->id, 32 );
8123 p += 32;
8124
8125 memcpy( p, session->master, 48 );
8126 p += 48;
8127
8128 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8129 p += 4;
8130 }
8131
8132 /*
8133 * Peer's end-entity certificate
8134 */
8135#if defined(MBEDTLS_X509_CRT_PARSE_C)
8136#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8137 if( session->peer_cert == NULL )
8138 cert_len = 0;
8139 else
8140 cert_len = session->peer_cert->raw.len;
8141
8142 used += 3 + cert_len;
8143
8144 if( used <= buf_len )
8145 {
8146 *p++ = MBEDTLS_BYTE_2( cert_len );
8147 *p++ = MBEDTLS_BYTE_1( cert_len );
8148 *p++ = MBEDTLS_BYTE_0( cert_len );
8149
8150 if( session->peer_cert != NULL )
8151 {
8152 memcpy( p, session->peer_cert->raw.p, cert_len );
8153 p += cert_len;
8154 }
8155 }
8156#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8157 if( session->peer_cert_digest != NULL )
8158 {
8159 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8160 if( used <= buf_len )
8161 {
8162 *p++ = (unsigned char) session->peer_cert_digest_type;
8163 *p++ = (unsigned char) session->peer_cert_digest_len;
8164 memcpy( p, session->peer_cert_digest,
8165 session->peer_cert_digest_len );
8166 p += session->peer_cert_digest_len;
8167 }
8168 }
8169 else
8170 {
8171 used += 2;
8172 if( used <= buf_len )
8173 {
8174 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8175 *p++ = 0;
8176 }
8177 }
8178#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8179#endif /* MBEDTLS_X509_CRT_PARSE_C */
8180
8181 /*
8182 * Session ticket if any, plus associated data
8183 */
8184#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8185 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8186
8187 if( used <= buf_len )
8188 {
8189 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8190 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8191 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8192
8193 if( session->ticket != NULL )
8194 {
8195 memcpy( p, session->ticket, session->ticket_len );
8196 p += session->ticket_len;
8197 }
8198
8199 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8200 p += 4;
8201 }
8202#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8203
8204 /*
8205 * Misc extension-related info
8206 */
8207#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8208 used += 1;
8209
8210 if( used <= buf_len )
8211 *p++ = session->mfl_code;
8212#endif
8213
8214#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8215 used += 1;
8216
8217 if( used <= buf_len )
8218 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8219#endif
8220
8221 return( used );
8222}
8223
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008224MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008225static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008226 const unsigned char *buf,
8227 size_t len )
8228{
8229#if defined(MBEDTLS_HAVE_TIME)
8230 uint64_t start;
8231#endif
8232#if defined(MBEDTLS_X509_CRT_PARSE_C)
8233#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8234 size_t cert_len;
8235#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8236#endif /* MBEDTLS_X509_CRT_PARSE_C */
8237
8238 const unsigned char *p = buf;
8239 const unsigned char * const end = buf + len;
8240
8241 /*
8242 * Time
8243 */
8244#if defined(MBEDTLS_HAVE_TIME)
8245 if( 8 > (size_t)( end - p ) )
8246 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8247
8248 start = ( (uint64_t) p[0] << 56 ) |
8249 ( (uint64_t) p[1] << 48 ) |
8250 ( (uint64_t) p[2] << 40 ) |
8251 ( (uint64_t) p[3] << 32 ) |
8252 ( (uint64_t) p[4] << 24 ) |
8253 ( (uint64_t) p[5] << 16 ) |
8254 ( (uint64_t) p[6] << 8 ) |
8255 ( (uint64_t) p[7] );
8256 p += 8;
8257
8258 session->start = (time_t) start;
8259#endif /* MBEDTLS_HAVE_TIME */
8260
8261 /*
8262 * Basic mandatory fields
8263 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008264 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008265 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8266
8267 session->ciphersuite = ( p[0] << 8 ) | p[1];
8268 p += 2;
8269
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008270 session->id_len = *p++;
8271 memcpy( session->id, p, 32 );
8272 p += 32;
8273
8274 memcpy( session->master, p, 48 );
8275 p += 48;
8276
8277 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8278 ( (uint32_t) p[1] << 16 ) |
8279 ( (uint32_t) p[2] << 8 ) |
8280 ( (uint32_t) p[3] );
8281 p += 4;
8282
8283 /* Immediately clear invalid pointer values that have been read, in case
8284 * we exit early before we replaced them with valid ones. */
8285#if defined(MBEDTLS_X509_CRT_PARSE_C)
8286#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8287 session->peer_cert = NULL;
8288#else
8289 session->peer_cert_digest = NULL;
8290#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8291#endif /* MBEDTLS_X509_CRT_PARSE_C */
8292#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8293 session->ticket = NULL;
8294#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8295
8296 /*
8297 * Peer certificate
8298 */
8299#if defined(MBEDTLS_X509_CRT_PARSE_C)
8300#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8301 /* Deserialize CRT from the end of the ticket. */
8302 if( 3 > (size_t)( end - p ) )
8303 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8304
8305 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8306 p += 3;
8307
8308 if( cert_len != 0 )
8309 {
8310 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8311
8312 if( cert_len > (size_t)( end - p ) )
8313 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8314
8315 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8316
8317 if( session->peer_cert == NULL )
8318 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8319
8320 mbedtls_x509_crt_init( session->peer_cert );
8321
8322 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8323 p, cert_len ) ) != 0 )
8324 {
8325 mbedtls_x509_crt_free( session->peer_cert );
8326 mbedtls_free( session->peer_cert );
8327 session->peer_cert = NULL;
8328 return( ret );
8329 }
8330
8331 p += cert_len;
8332 }
8333#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8334 /* Deserialize CRT digest from the end of the ticket. */
8335 if( 2 > (size_t)( end - p ) )
8336 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8337
8338 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8339 session->peer_cert_digest_len = (size_t) *p++;
8340
8341 if( session->peer_cert_digest_len != 0 )
8342 {
8343 const mbedtls_md_info_t *md_info =
8344 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8345 if( md_info == NULL )
8346 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8347 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8348 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8349
8350 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8351 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8352
8353 session->peer_cert_digest =
8354 mbedtls_calloc( 1, session->peer_cert_digest_len );
8355 if( session->peer_cert_digest == NULL )
8356 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8357
8358 memcpy( session->peer_cert_digest, p,
8359 session->peer_cert_digest_len );
8360 p += session->peer_cert_digest_len;
8361 }
8362#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8363#endif /* MBEDTLS_X509_CRT_PARSE_C */
8364
8365 /*
8366 * Session ticket and associated data
8367 */
8368#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8369 if( 3 > (size_t)( end - p ) )
8370 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8371
8372 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8373 p += 3;
8374
8375 if( session->ticket_len != 0 )
8376 {
8377 if( session->ticket_len > (size_t)( end - p ) )
8378 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8379
8380 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8381 if( session->ticket == NULL )
8382 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8383
8384 memcpy( session->ticket, p, session->ticket_len );
8385 p += session->ticket_len;
8386 }
8387
8388 if( 4 > (size_t)( end - p ) )
8389 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8390
8391 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8392 ( (uint32_t) p[1] << 16 ) |
8393 ( (uint32_t) p[2] << 8 ) |
8394 ( (uint32_t) p[3] );
8395 p += 4;
8396#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8397
8398 /*
8399 * Misc extension-related info
8400 */
8401#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8402 if( 1 > (size_t)( end - p ) )
8403 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8404
8405 session->mfl_code = *p++;
8406#endif
8407
8408#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8409 if( 1 > (size_t)( end - p ) )
8410 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8411
8412 session->encrypt_then_mac = *p++;
8413#endif
8414
8415 /* Done, should have consumed entire buffer */
8416 if( p != end )
8417 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8418
8419 return( 0 );
8420}
Jerry Yudc7bd172022-02-17 13:44:15 +08008421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8422
XiaokangQian75d40ef2022-04-20 11:05:24 +00008423int mbedtls_ssl_validate_ciphersuite(
8424 const mbedtls_ssl_context *ssl,
8425 const mbedtls_ssl_ciphersuite_t *suite_info,
8426 mbedtls_ssl_protocol_version min_tls_version,
8427 mbedtls_ssl_protocol_version max_tls_version )
8428{
8429 (void) ssl;
8430
8431 if( suite_info == NULL )
8432 return( -1 );
8433
8434 if( ( suite_info->min_tls_version > max_tls_version ) ||
8435 ( suite_info->max_tls_version < min_tls_version ) )
8436 {
8437 return( -1 );
8438 }
8439
XiaokangQian060d8672022-04-21 09:24:56 +00008440#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008441#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8442 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8443 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8444 {
8445 return( -1 );
8446 }
8447#endif
8448
8449 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8450#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8451 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8452 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8453 {
8454 return( -1 );
8455 }
8456#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8457#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8458
8459 return( 0 );
8460}
8461
XiaokangQianeaf36512022-04-24 09:07:44 +00008462#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8463/*
8464 * Function for writing a signature algorithm extension.
8465 *
8466 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8467 * value (TLS 1.3 RFC8446):
8468 * enum {
8469 * ....
8470 * ecdsa_secp256r1_sha256( 0x0403 ),
8471 * ecdsa_secp384r1_sha384( 0x0503 ),
8472 * ecdsa_secp521r1_sha512( 0x0603 ),
8473 * ....
8474 * } SignatureScheme;
8475 *
8476 * struct {
8477 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8478 * } SignatureSchemeList;
8479 *
8480 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8481 * value (TLS 1.2 RFC5246):
8482 * enum {
8483 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8484 * sha512(6), (255)
8485 * } HashAlgorithm;
8486 *
8487 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8488 * SignatureAlgorithm;
8489 *
8490 * struct {
8491 * HashAlgorithm hash;
8492 * SignatureAlgorithm signature;
8493 * } SignatureAndHashAlgorithm;
8494 *
8495 * SignatureAndHashAlgorithm
8496 * supported_signature_algorithms<2..2^16-2>;
8497 *
8498 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8499 * generalization of the TLS 1.2 signature algorithm extension.
8500 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8501 * `SignatureScheme` field of TLS 1.3
8502 *
8503 */
8504int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8505 const unsigned char *end, size_t *out_len )
8506{
8507 unsigned char *p = buf;
8508 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8509 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8510
8511 *out_len = 0;
8512
8513 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8514
8515 /* Check if we have space for header and length field:
8516 * - extension_type (2 bytes)
8517 * - extension_data_length (2 bytes)
8518 * - supported_signature_algorithms_length (2 bytes)
8519 */
8520 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8521 p += 6;
8522
8523 /*
8524 * Write supported_signature_algorithms
8525 */
8526 supported_sig_alg = p;
8527 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8528 if( sig_alg == NULL )
8529 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8530
8531 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8532 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008533 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8534 *sig_alg,
8535 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008536 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8537 continue;
8538 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8539 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8540 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008541 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008542 *sig_alg,
8543 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008544 }
8545
8546 /* Length of supported_signature_algorithms */
8547 supported_sig_alg_len = p - supported_sig_alg;
8548 if( supported_sig_alg_len == 0 )
8549 {
8550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8552 }
8553
XiaokangQianeaf36512022-04-24 09:07:44 +00008554 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008555 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008556 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8557
XiaokangQianeaf36512022-04-24 09:07:44 +00008558 *out_len = p - buf;
8559
8560#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8561 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8562#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8563 return( 0 );
8564}
8565#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8566
XiaokangQian40a35232022-05-07 09:02:40 +00008567#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008568/*
8569 * mbedtls_ssl_parse_server_name_ext
8570 *
8571 * Structure of server_name extension:
8572 *
8573 * enum {
8574 * host_name(0), (255)
8575 * } NameType;
8576 * opaque HostName<1..2^16-1>;
8577 *
8578 * struct {
8579 * NameType name_type;
8580 * select (name_type) {
8581 * case host_name: HostName;
8582 * } name;
8583 * } ServerName;
8584 * struct {
8585 * ServerName server_name_list<1..2^16-1>
8586 * } ServerNameList;
8587 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008588MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008589int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8590 const unsigned char *buf,
8591 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008592{
8593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8594 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008595 size_t server_name_list_len, hostname_len;
8596 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008597
XiaokangQianf2a94202022-05-20 06:44:24 +00008598 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008599
8600 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008601 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008602 p += 2;
8603
XiaokangQian9b2b7712022-05-17 02:57:00 +00008604 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8605 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008606 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008607 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008608 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008609 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008610 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8611 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008612
8613 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8614 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008615 /* sni_name is intended to be used only during the parsing of the
8616 * ClientHello message (it is reset to NULL before the end of
8617 * the message parsing). Thus it is ok to just point to the
8618 * reception buffer and not make a copy of it.
8619 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008620 ssl->handshake->sni_name = p + 3;
8621 ssl->handshake->sni_name_len = hostname_len;
8622 if( ssl->conf->f_sni == NULL )
8623 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008624 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008625 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008626 if( ret != 0 )
8627 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008628 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008629 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8630 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008631 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8632 }
8633 return( 0 );
8634 }
8635
8636 p += hostname_len + 3;
8637 }
8638
8639 return( 0 );
8640}
8641#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8642
XiaokangQianacb39922022-06-17 10:18:48 +00008643#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008644MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008645int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8646 const unsigned char *buf,
8647 const unsigned char *end )
8648{
8649 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008650 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008651 const unsigned char *protocol_name_list;
8652 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008653 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008654
8655 /* If ALPN not configured, just ignore the extension */
8656 if( ssl->conf->alpn_list == NULL )
8657 return( 0 );
8658
8659 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008660 * RFC7301, section 3.1
8661 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008662 *
XiaokangQianc7403452022-06-23 03:24:12 +00008663 * struct {
8664 * ProtocolName protocol_name_list<2..2^16-1>
8665 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008666 */
8667
XiaokangQianc7403452022-06-23 03:24:12 +00008668 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008669 * protocol_name_list_len 2 bytes
8670 * protocol_name_len 1 bytes
8671 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008672 */
XiaokangQianacb39922022-06-17 10:18:48 +00008673 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8674
XiaokangQianc7403452022-06-23 03:24:12 +00008675 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008676 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008677 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008678 protocol_name_list = p;
8679 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008680
8681 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008682 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008683 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008684 protocol_name_len = *p++;
8685 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8686 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008687 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008688 {
8689 MBEDTLS_SSL_PEND_FATAL_ALERT(
8690 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8691 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008692 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008693 }
8694
8695 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008696 }
8697
8698 /* Use our order of preference */
8699 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8700 {
8701 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008702 p = protocol_name_list;
8703 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008704 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008705 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008706 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008707 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008708 {
8709 ssl->alpn_chosen = *alpn;
8710 return( 0 );
8711 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008712
8713 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008714 }
8715 }
8716
XiaokangQian95d5f542022-06-24 02:29:26 +00008717 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008718 MBEDTLS_SSL_PEND_FATAL_ALERT(
8719 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8720 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8721 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8722}
8723
8724int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8725 unsigned char *buf,
8726 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008727 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008728{
8729 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008730 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008731 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008732
8733 if( ssl->alpn_chosen == NULL )
8734 {
8735 return( 0 );
8736 }
8737
XiaokangQian95d5f542022-06-24 02:29:26 +00008738 protocol_name_len = strlen( ssl->alpn_chosen );
8739 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008740
8741 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8742 /*
8743 * 0 . 1 ext identifier
8744 * 2 . 3 ext length
8745 * 4 . 5 protocol list length
8746 * 6 . 6 protocol name length
8747 * 7 . 7+n protocol name
8748 */
8749 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8750
XiaokangQian95d5f542022-06-24 02:29:26 +00008751 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008752
XiaokangQian95d5f542022-06-24 02:29:26 +00008753 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8754 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008755 /* Note: the length of the chosen protocol has been checked to be less
8756 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8757 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008758 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008759
XiaokangQian95d5f542022-06-24 02:29:26 +00008760 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008761 return ( 0 );
8762}
8763#endif /* MBEDTLS_SSL_ALPN */
8764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008765#endif /* MBEDTLS_SSL_TLS_C */