blob: 12e1c1b03d8b6600d4fafde986e1e879310cc03e [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003247 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003248 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003249 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3250 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003251
Ronald Cron9f0fba32022-02-10 16:45:15 +01003252 switch( ssl->state )
3253 {
3254 case MBEDTLS_SSL_HELLO_REQUEST:
3255 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3256 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003257
Ronald Cron9f0fba32022-02-10 16:45:15 +01003258 case MBEDTLS_SSL_CLIENT_HELLO:
3259 ret = mbedtls_ssl_write_client_hello( ssl );
3260 break;
3261
3262 default:
3263#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003264 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003265 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3266 else
3267 ret = mbedtls_ssl_handshake_client_step( ssl );
3268#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3269 ret = mbedtls_ssl_handshake_client_step( ssl );
3270#else
3271 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3272#endif
3273 }
Jerry Yub9930e72021-08-06 17:11:51 +08003274 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003275#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003276#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003277 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003278 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003279#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003280 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003281 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003282#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003283
3284#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3285 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3286 ret = mbedtls_ssl_handshake_server_step( ssl );
3287#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3288 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003289#endif
3290
Jerry Yue7047812021-09-13 19:26:39 +08003291 if( ret != 0 )
3292 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003293 /* handshake_step return error. And it is same
3294 * with alert_reason.
3295 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003296 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003297 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003298 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003299 goto cleanup;
3300 }
3301 }
3302
3303cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003304 return( ret );
3305}
3306
3307/*
3308 * Perform the SSL handshake
3309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003311{
3312 int ret = 0;
3313
Hanno Beckera817ea42020-10-20 15:20:23 +01003314 /* Sanity checks */
3315
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003316 if( ssl == NULL || ssl->conf == NULL )
3317 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3318
Hanno Beckera817ea42020-10-20 15:20:23 +01003319#if defined(MBEDTLS_SSL_PROTO_DTLS)
3320 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3321 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3322 {
3323 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3324 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3325 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3326 }
3327#endif /* MBEDTLS_SSL_PROTO_DTLS */
3328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003330
Hanno Beckera817ea42020-10-20 15:20:23 +01003331 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003332 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003335
3336 if( ret != 0 )
3337 break;
3338 }
3339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003341
3342 return( ret );
3343}
3344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345#if defined(MBEDTLS_SSL_RENEGOTIATION)
3346#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003347/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003348 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003349 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003350MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003352{
Janos Follath865b3eb2019-12-16 11:46:15 +00003353 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003356
3357 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3359 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003360
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003361 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003362 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003363 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003364 return( ret );
3365 }
3366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003368
3369 return( 0 );
3370}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003372
3373/*
3374 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 * - any side: calling mbedtls_ssl_renegotiate(),
3376 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3377 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003378 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003379 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003381 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003382int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003383{
Janos Follath865b3eb2019-12-16 11:46:15 +00003384 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003387
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003388 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3389 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003390
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003391 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3392 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003394 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003396 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003397 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003398 ssl->handshake->out_msg_seq = 1;
3399 else
3400 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003401 }
3402#endif
3403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3405 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003406
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003408 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003410 return( ret );
3411 }
3412
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003414
3415 return( 0 );
3416}
3417
3418/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003419 * Renegotiate current connection on client,
3420 * or request renegotiation on server
3421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003423{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003425
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003426 if( ssl == NULL || ssl->conf == NULL )
3427 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003430 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003431 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003432 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003433 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003437
3438 /* Did we already try/start sending HelloRequest? */
3439 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003441
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003442 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003443 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003445
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003447 /*
3448 * On client, either start the renegotiation process or,
3449 * if already in progress, continue the handshake
3450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003452 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003453 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003455
Hanno Becker40cdaa12020-02-05 10:48:27 +00003456 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003457 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003458 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003459 return( ret );
3460 }
3461 }
3462 else
3463 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003465 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003467 return( ret );
3468 }
3469 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003471
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003472 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003473}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003475
Gilles Peskine9b562d52018-04-25 20:32:43 +02003476void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003477{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003478 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3479
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003480 if( handshake == NULL )
3481 return;
3482
Brett Warrene0edc842021-08-17 09:53:13 +01003483#if defined(MBEDTLS_ECP_C)
3484#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3485 if ( ssl->handshake->group_list_heap_allocated )
3486 mbedtls_free( (void*) handshake->group_list );
3487 handshake->group_list = NULL;
3488#endif /* MBEDTLS_DEPRECATED_REMOVED */
3489#endif /* MBEDTLS_ECP_C */
3490
Jerry Yuf017ee42022-01-12 15:49:48 +08003491#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3492#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3493 if ( ssl->handshake->sig_algs_heap_allocated )
3494 mbedtls_free( (void*) handshake->sig_algs );
3495 handshake->sig_algs = NULL;
3496#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003497#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3498 if( ssl->handshake->certificate_request_context )
3499 {
3500 mbedtls_free( (void*) handshake->certificate_request_context );
3501 }
3502#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003503#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3504
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003505#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3506 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3507 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003508 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003509 handshake->async_in_progress = 0;
3510 }
3511#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3512
Andrzej Kurek25f27152022-08-17 16:09:31 -04003513#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003514#if defined(MBEDTLS_USE_PSA_CRYPTO)
3515 psa_hash_abort( &handshake->fin_sha256_psa );
3516#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003517 mbedtls_sha256_free( &handshake->fin_sha256 );
3518#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003519#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04003520#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003521#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003522 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003523#else
Andrzej Kureka242e832022-08-11 10:03:14 -04003524 mbedtls_sha512_free( &handshake->fin_sha384 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003525#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003526#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003528#if defined(MBEDTLS_DHM_C)
3529 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003530#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003531#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003533#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003534#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003535 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003536#if defined(MBEDTLS_SSL_CLI_C)
3537 mbedtls_free( handshake->ecjpake_cache );
3538 handshake->ecjpake_cache = NULL;
3539 handshake->ecjpake_cache_len = 0;
3540#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003541#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003542
Janos Follath4ae5c292016-02-10 11:27:43 +00003543#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3544 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003545 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003547#endif
3548
Gilles Peskineeccd8882020-03-10 12:19:08 +01003549#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003550#if defined(MBEDTLS_USE_PSA_CRYPTO)
3551 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3552 {
3553 /* The maintenance of the external PSK key slot is the
3554 * user's responsibility. */
3555 if( ssl->handshake->psk_opaque_is_internal )
3556 {
3557 psa_destroy_key( ssl->handshake->psk_opaque );
3558 ssl->handshake->psk_opaque_is_internal = 0;
3559 }
3560 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3561 }
Neil Armstronge952a302022-05-03 10:22:14 +02003562#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003563 if( handshake->psk != NULL )
3564 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003565 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003566 mbedtls_free( handshake->psk );
3567 }
Neil Armstronge952a302022-05-03 10:22:14 +02003568#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003569#endif
3570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3572 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003573 /*
3574 * Free only the linked list wrapper, not the keys themselves
3575 * since the belong to the SNI callback
3576 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003577 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003579
Gilles Peskineeccd8882020-03-10 12:19:08 +01003580#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003581 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003582 if( handshake->ecrs_peer_cert != NULL )
3583 {
3584 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3585 mbedtls_free( handshake->ecrs_peer_cert );
3586 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003587#endif
3588
Hanno Becker75173122019-02-06 16:18:31 +00003589#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3590 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3591 mbedtls_pk_free( &handshake->peer_pubkey );
3592#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3593
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003594#if defined(MBEDTLS_SSL_CLI_C) && \
3595 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3596 mbedtls_free( handshake->cookie );
3597#endif /* MBEDTLS_SSL_CLI_C &&
3598 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003599
3600#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003601 mbedtls_ssl_flight_free( handshake->flight );
3602 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003603#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003604
Ronald Cronf12b81d2022-03-15 10:42:41 +01003605#if defined(MBEDTLS_ECDH_C) && \
3606 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003607 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003608 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003609#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3610
Ronald Cron6f135e12021-12-08 16:57:54 +01003611#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003612 mbedtls_ssl_transform_free( handshake->transform_handshake );
3613 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003614 mbedtls_free( handshake->transform_earlydata );
3615 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003616#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003617
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003618
3619#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3620 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3621 * processes datagrams and the fact that a datagram is allowed to have
3622 * several records in it, it is possible that the I/O buffers are not
3623 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003624 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3625 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003626#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003627
Jerry Yuba9c7272021-10-30 11:54:10 +08003628 /* mbedtls_platform_zeroize MUST be last one in this function */
3629 mbedtls_platform_zeroize( handshake,
3630 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003631}
3632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003634{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003635 if( session == NULL )
3636 return;
3637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003639 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003640#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003641
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003642#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003644#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003645
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003646 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003647}
3648
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003649#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003650
3651#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3652#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3653#else
3654#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3655#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3656
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003657#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003658
3659#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3660#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3661#else
3662#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3663#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3664
3665#if defined(MBEDTLS_SSL_ALPN)
3666#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3667#else
3668#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3669#endif /* MBEDTLS_SSL_ALPN */
3670
3671#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3672#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3673#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3674#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3675
3676#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3677 ( (uint32_t) ( \
3678 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3679 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3680 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3681 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3682 0u ) )
3683
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003684static unsigned char ssl_serialized_context_header[] = {
3685 MBEDTLS_VERSION_MAJOR,
3686 MBEDTLS_VERSION_MINOR,
3687 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003688 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3689 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3690 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3691 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3692 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003693};
3694
Paul Bakker5121ce52009-01-03 21:22:43 +00003695/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003696 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003697 *
3698 * The format of the serialized data is:
3699 * (in the presentation language of TLS, RFC 8446 section 3)
3700 *
3701 * // header
3702 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003703 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003704 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003705 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003706 * Note: When updating the format, remember to keep these
3707 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003708 *
3709 * // session sub-structure
3710 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3711 * // transform sub-structure
3712 * uint8 random[64]; // ServerHello.random+ClientHello.random
3713 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3714 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3715 * // fields from ssl_context
3716 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3717 * uint64 in_window_top; // DTLS: last validated record seq_num
3718 * uint64 in_window; // DTLS: bitmask for replay protection
3719 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3720 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3721 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3722 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3723 *
3724 * Note that many fields of the ssl_context or sub-structures are not
3725 * serialized, as they fall in one of the following categories:
3726 *
3727 * 1. forced value (eg in_left must be 0)
3728 * 2. pointer to dynamically-allocated memory (eg session, transform)
3729 * 3. value can be re-derived from other data (eg session keys from MS)
3730 * 4. value was temporary (eg content of input buffer)
3731 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003732 */
3733int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3734 unsigned char *buf,
3735 size_t buf_len,
3736 size_t *olen )
3737{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003738 unsigned char *p = buf;
3739 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003740 size_t session_len;
3741 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003742
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003743 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003744 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3745 * this function's documentation.
3746 *
3747 * These are due to assumptions/limitations in the implementation. Some of
3748 * them are likely to stay (no handshake in progress) some might go away
3749 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003750 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003751 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003752 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003753 {
3754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003756 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003757 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003758 {
3759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003760 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003761 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003762 /* Double-check that sub-structures are indeed ready */
3763 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003764 {
3765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003767 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003768 /* There must be no pending incoming or outgoing data */
3769 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003770 {
3771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003773 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003774 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003775 {
3776 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003777 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003778 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003779 /* Protocol must be DLTS, not TLS */
3780 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003781 {
3782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003783 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003784 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003785 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003786 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003787 {
3788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003790 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003791 /* We must be using an AEAD ciphersuite */
3792 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003793 {
3794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003795 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003796 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003797 /* Renegotiation must not be enabled */
3798#if defined(MBEDTLS_SSL_RENEGOTIATION)
3799 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003800 {
3801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003802 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003803 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003804#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003805
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003806 /*
3807 * Version and format identifier
3808 */
3809 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003810
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003811 if( used <= buf_len )
3812 {
3813 memcpy( p, ssl_serialized_context_header,
3814 sizeof( ssl_serialized_context_header ) );
3815 p += sizeof( ssl_serialized_context_header );
3816 }
3817
3818 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003819 * Session (length + data)
3820 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003821 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003822 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3823 return( ret );
3824
3825 used += 4 + session_len;
3826 if( used <= buf_len )
3827 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003828 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3829 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003830
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003831 ret = ssl_session_save( ssl->session, 1,
3832 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003833 if( ret != 0 )
3834 return( ret );
3835
3836 p += session_len;
3837 }
3838
3839 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003840 * Transform
3841 */
3842 used += sizeof( ssl->transform->randbytes );
3843 if( used <= buf_len )
3844 {
3845 memcpy( p, ssl->transform->randbytes,
3846 sizeof( ssl->transform->randbytes ) );
3847 p += sizeof( ssl->transform->randbytes );
3848 }
3849
3850#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3851 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3852 if( used <= buf_len )
3853 {
3854 *p++ = ssl->transform->in_cid_len;
3855 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3856 p += ssl->transform->in_cid_len;
3857
3858 *p++ = ssl->transform->out_cid_len;
3859 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3860 p += ssl->transform->out_cid_len;
3861 }
3862#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3863
3864 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003865 * Saved fields from top-level ssl_context structure
3866 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003867 used += 4;
3868 if( used <= buf_len )
3869 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003870 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3871 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003872 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003873
3874#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3875 used += 16;
3876 if( used <= buf_len )
3877 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003878 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3879 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003880
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003881 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3882 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003883 }
3884#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3885
3886#if defined(MBEDTLS_SSL_PROTO_DTLS)
3887 used += 1;
3888 if( used <= buf_len )
3889 {
3890 *p++ = ssl->disable_datagram_packing;
3891 }
3892#endif /* MBEDTLS_SSL_PROTO_DTLS */
3893
Jerry Yuae0b2e22021-10-08 15:21:19 +08003894 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003895 if( used <= buf_len )
3896 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003897 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3898 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003899 }
3900
3901#if defined(MBEDTLS_SSL_PROTO_DTLS)
3902 used += 2;
3903 if( used <= buf_len )
3904 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003905 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3906 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003907 }
3908#endif /* MBEDTLS_SSL_PROTO_DTLS */
3909
3910#if defined(MBEDTLS_SSL_ALPN)
3911 {
3912 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003913 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003914 : 0;
3915
3916 used += 1 + alpn_len;
3917 if( used <= buf_len )
3918 {
3919 *p++ = alpn_len;
3920
3921 if( ssl->alpn_chosen != NULL )
3922 {
3923 memcpy( p, ssl->alpn_chosen, alpn_len );
3924 p += alpn_len;
3925 }
3926 }
3927 }
3928#endif /* MBEDTLS_SSL_ALPN */
3929
3930 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003931 * Done
3932 */
3933 *olen = used;
3934
3935 if( used > buf_len )
3936 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003937
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003938 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3939
Hanno Becker43aefe22020-02-05 10:44:56 +00003940 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003941}
3942
3943/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003944 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003945 *
3946 * This internal version is wrapped by a public function that cleans up in
3947 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003948 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003949MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003950static int ssl_context_load( mbedtls_ssl_context *ssl,
3951 const unsigned char *buf,
3952 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003953{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003954 const unsigned char *p = buf;
3955 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003956 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003958
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003959 /*
3960 * The context should have been freshly setup or reset.
3961 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003962 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003963 * renegotiating, or if the user mistakenly loaded a session first.)
3964 */
3965 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3966 ssl->session != NULL )
3967 {
3968 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3969 }
3970
3971 /*
3972 * We can't check that the config matches the initial one, but we can at
3973 * least check it matches the requirements for serializing.
3974 */
3975 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003976 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3977 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003978#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003979 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003980#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003981 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003982 {
3983 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3984 }
3985
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003986 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3987
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003988 /*
3989 * Check version identifier
3990 */
3991 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3992 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3993
3994 if( memcmp( p, ssl_serialized_context_header,
3995 sizeof( ssl_serialized_context_header ) ) != 0 )
3996 {
3997 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3998 }
3999 p += sizeof( ssl_serialized_context_header );
4000
4001 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004002 * Session
4003 */
4004 if( (size_t)( end - p ) < 4 )
4005 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4006
4007 session_len = ( (size_t) p[0] << 24 ) |
4008 ( (size_t) p[1] << 16 ) |
4009 ( (size_t) p[2] << 8 ) |
4010 ( (size_t) p[3] );
4011 p += 4;
4012
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004013 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004014 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004015 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004016 ssl->session_in = ssl->session;
4017 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004018 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004019
4020 if( (size_t)( end - p ) < session_len )
4021 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4022
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004023 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004024 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004025 {
4026 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004027 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004028 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004029
4030 p += session_len;
4031
4032 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004033 * Transform
4034 */
4035
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004036 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004037 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004038 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004039 ssl->transform_in = ssl->transform;
4040 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004041 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004042
4043 /* Read random bytes and populate structure */
4044 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4045 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004046#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004047 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004048 ssl->session->ciphersuite,
4049 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004050#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004051 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004052#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004053 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4054 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004055 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004056 ssl->conf->endpoint,
4057 ssl );
4058 if( ret != 0 )
4059 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004060#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004061 p += sizeof( ssl->transform->randbytes );
4062
4063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4064 /* Read connection IDs and store them */
4065 if( (size_t)( end - p ) < 1 )
4066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4067
4068 ssl->transform->in_cid_len = *p++;
4069
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004070 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004071 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4072
4073 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4074 p += ssl->transform->in_cid_len;
4075
4076 ssl->transform->out_cid_len = *p++;
4077
4078 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4079 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4080
4081 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4082 p += ssl->transform->out_cid_len;
4083#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4084
4085 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004086 * Saved fields from top-level ssl_context structure
4087 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004088 if( (size_t)( end - p ) < 4 )
4089 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4090
4091 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4092 ( (uint32_t) p[1] << 16 ) |
4093 ( (uint32_t) p[2] << 8 ) |
4094 ( (uint32_t) p[3] );
4095 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004096
4097#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4098 if( (size_t)( end - p ) < 16 )
4099 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4100
4101 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4102 ( (uint64_t) p[1] << 48 ) |
4103 ( (uint64_t) p[2] << 40 ) |
4104 ( (uint64_t) p[3] << 32 ) |
4105 ( (uint64_t) p[4] << 24 ) |
4106 ( (uint64_t) p[5] << 16 ) |
4107 ( (uint64_t) p[6] << 8 ) |
4108 ( (uint64_t) p[7] );
4109 p += 8;
4110
4111 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4112 ( (uint64_t) p[1] << 48 ) |
4113 ( (uint64_t) p[2] << 40 ) |
4114 ( (uint64_t) p[3] << 32 ) |
4115 ( (uint64_t) p[4] << 24 ) |
4116 ( (uint64_t) p[5] << 16 ) |
4117 ( (uint64_t) p[6] << 8 ) |
4118 ( (uint64_t) p[7] );
4119 p += 8;
4120#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4121
4122#if defined(MBEDTLS_SSL_PROTO_DTLS)
4123 if( (size_t)( end - p ) < 1 )
4124 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4125
4126 ssl->disable_datagram_packing = *p++;
4127#endif /* MBEDTLS_SSL_PROTO_DTLS */
4128
Jerry Yud9a94fe2021-09-28 18:58:59 +08004129 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004130 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004131 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4132 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004133
4134#if defined(MBEDTLS_SSL_PROTO_DTLS)
4135 if( (size_t)( end - p ) < 2 )
4136 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4137
4138 ssl->mtu = ( p[0] << 8 ) | p[1];
4139 p += 2;
4140#endif /* MBEDTLS_SSL_PROTO_DTLS */
4141
4142#if defined(MBEDTLS_SSL_ALPN)
4143 {
4144 uint8_t alpn_len;
4145 const char **cur;
4146
4147 if( (size_t)( end - p ) < 1 )
4148 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4149
4150 alpn_len = *p++;
4151
4152 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4153 {
4154 /* alpn_chosen should point to an item in the configured list */
4155 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4156 {
4157 if( strlen( *cur ) == alpn_len &&
4158 memcmp( p, cur, alpn_len ) == 0 )
4159 {
4160 ssl->alpn_chosen = *cur;
4161 break;
4162 }
4163 }
4164 }
4165
4166 /* can only happen on conf mismatch */
4167 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4169
4170 p += alpn_len;
4171 }
4172#endif /* MBEDTLS_SSL_ALPN */
4173
4174 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004175 * Forced fields from top-level ssl_context structure
4176 *
4177 * Most of them already set to the correct value by mbedtls_ssl_init() and
4178 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4179 */
4180 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004181 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004182
Hanno Becker361b10d2019-08-30 10:42:49 +01004183 /* Adjust pointers for header fields of outgoing records to
4184 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004185 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004186
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004187#if defined(MBEDTLS_SSL_PROTO_DTLS)
4188 ssl->in_epoch = 1;
4189#endif
4190
4191 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4192 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004193 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4194 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004195 if( ssl->handshake != NULL )
4196 {
4197 mbedtls_ssl_handshake_free( ssl );
4198 mbedtls_free( ssl->handshake );
4199 ssl->handshake = NULL;
4200 }
4201
4202 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004203 * Done - should have consumed entire buffer
4204 */
4205 if( p != end )
4206 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004207
4208 return( 0 );
4209}
4210
4211/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004212 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004213 */
4214int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4215 const unsigned char *buf,
4216 size_t len )
4217{
4218 int ret = ssl_context_load( context, buf, len );
4219
4220 if( ret != 0 )
4221 mbedtls_ssl_free( context );
4222
4223 return( ret );
4224}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004225#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004226
4227/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004228 * Free an SSL context
4229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004230void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004231{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004232 if( ssl == NULL )
4233 return;
4234
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004235 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004236
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004237 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004238 {
sander-visserb8aa2072020-05-06 22:05:13 +02004239#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4240 size_t out_buf_len = ssl->out_buf_len;
4241#else
4242 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4243#endif
4244
Darryl Greenb33cc762019-11-28 14:29:44 +00004245 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004246 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004247 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004248 }
4249
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004250 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004251 {
sander-visserb8aa2072020-05-06 22:05:13 +02004252#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4253 size_t in_buf_len = ssl->in_buf_len;
4254#else
4255 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4256#endif
4257
Darryl Greenb33cc762019-11-28 14:29:44 +00004258 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004260 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004261 }
4262
Paul Bakker48916f92012-09-16 19:57:18 +00004263 if( ssl->transform )
4264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004265 mbedtls_ssl_transform_free( ssl->transform );
4266 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004267 }
4268
4269 if( ssl->handshake )
4270 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004271 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004272 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4273 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004275 mbedtls_free( ssl->handshake );
4276 mbedtls_free( ssl->transform_negotiate );
4277 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004278 }
4279
Ronald Cron6f135e12021-12-08 16:57:54 +01004280#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004281 mbedtls_ssl_transform_free( ssl->transform_application );
4282 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004283#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004284
Paul Bakkerc0463502013-02-14 11:19:38 +01004285 if( ssl->session )
4286 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004287 mbedtls_ssl_session_free( ssl->session );
4288 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004289 }
4290
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004291#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004292 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004293 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004294 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004295 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004296 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004297#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004298
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004299#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004300 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004301#endif
4302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004304
Paul Bakker86f04f42013-02-14 11:20:09 +01004305 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004306 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004307}
4308
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004309/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004310 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004311 */
4312void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4313{
4314 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4315}
4316
Gilles Peskineae270bf2021-06-02 00:05:29 +02004317/* The selection should be the same as mbedtls_x509_crt_profile_default in
4318 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004319 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004320 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004321 * about this list.
4322 */
Brett Warrene0edc842021-08-17 09:53:13 +01004323static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004324#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004325 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004326#endif
4327#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004328 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004329#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004330#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004331 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004332#endif
4333#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004334 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004335#endif
4336#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004337 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004338#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004339#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004340 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004341#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004342#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004343 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004344#endif
4345#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004346 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004347#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004348 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004349};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004350
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004351static int ssl_preset_suiteb_ciphersuites[] = {
4352 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4353 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4354 0
4355};
4356
Gilles Peskineeccd8882020-03-10 12:19:08 +01004357#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004358
Jerry Yu909df7b2022-01-22 11:56:27 +08004359/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004360 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004361 * rules SHOULD be upheld.
4362 * - No duplicate entries.
4363 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004364 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004365 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004366 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004367static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004368
Andrzej Kurek25f27152022-08-17 16:09:31 -04004369#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 +08004370 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4371 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004372#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004373 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004374
Andrzej Kurek25f27152022-08-17 16:09:31 -04004375#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 +08004376 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4377 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004378#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004379 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4380
Andrzej Kurek25f27152022-08-17 16:09:31 -04004381#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 +08004382 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4383 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004384#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004385 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004386
Andrzej Kurek25f27152022-08-17 16:09:31 -04004387#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 +08004388 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004389#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 +08004390
Andrzej Kurek25f27152022-08-17 16:09:31 -04004391#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 +08004392 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004393#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 +08004394
Andrzej Kurek25f27152022-08-17 16:09:31 -04004395#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 +08004396 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004397#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 +08004398
Andrzej Kurek25f27152022-08-17 16:09:31 -04004399#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 +08004400 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4401#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4402
Andrzej Kurek25f27152022-08-17 16:09:31 -04004403#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 +08004404 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4405#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4406
Andrzej Kurek25f27152022-08-17 16:09:31 -04004407#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 +08004408 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4409#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4410
Gabor Mezei15b95a62022-05-09 16:37:58 +02004411 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004412};
4413
4414/* NOTICE: see above */
4415#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4416static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004417#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004418#if defined(MBEDTLS_ECDSA_C)
4419 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004420#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004421#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4422 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4423#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004424#if defined(MBEDTLS_RSA_C)
4425 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4426#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004427#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004428#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004429#if defined(MBEDTLS_ECDSA_C)
4430 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004431#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004432#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4433 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4434#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004435#if defined(MBEDTLS_RSA_C)
4436 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4437#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004438#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004439#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004440#if defined(MBEDTLS_ECDSA_C)
4441 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004442#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004443#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4444 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4445#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004446#if defined(MBEDTLS_RSA_C)
4447 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4448#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004449#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004450 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004451};
4452#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4453/* NOTICE: see above */
4454static uint16_t ssl_preset_suiteb_sig_algs[] = {
4455
Andrzej Kurek25f27152022-08-17 16:09:31 -04004456#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 +08004457 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4458 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004459#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004460 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4461
Andrzej Kurek25f27152022-08-17 16:09:31 -04004462#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 +08004463 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4464 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004465#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08004466 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004467
Andrzej Kurek25f27152022-08-17 16:09:31 -04004468#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 +08004469 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004470#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 +08004471
Andrzej Kurek25f27152022-08-17 16:09:31 -04004472#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 +08004473 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004474#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08004475
Gabor Mezei15b95a62022-05-09 16:37:58 +02004476 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004477};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004478
Jerry Yu909df7b2022-01-22 11:56:27 +08004479/* NOTICE: see above */
4480#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4481static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004482#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004483#if defined(MBEDTLS_ECDSA_C)
4484 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004485#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004486#if defined(MBEDTLS_RSA_C)
4487 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4488#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004489#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004490#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004491#if defined(MBEDTLS_ECDSA_C)
4492 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004493#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004494#if defined(MBEDTLS_RSA_C)
4495 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4496#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004497#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004498 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004499};
Jerry Yu909df7b2022-01-22 11:56:27 +08004500#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4501
Jerry Yu1a8b4812022-01-20 17:56:50 +08004502#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004503
Brett Warrene0edc842021-08-17 09:53:13 +01004504static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004505#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004506 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004507#endif
4508#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004509 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004510#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004511 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004512};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004513
Jerry Yu1a8b4812022-01-20 17:56:50 +08004514#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004515/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004516 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004517MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004518static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004519{
4520 size_t i, j;
4521 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004522
Gabor Mezei15b95a62022-05-09 16:37:58 +02004523 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004524 {
Jerry Yuf377d642022-01-25 10:43:59 +08004525 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004526 {
Jerry Yuf377d642022-01-25 10:43:59 +08004527 if( sig_algs[i] != sig_algs[j] )
4528 continue;
4529 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4530 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4531 sig_algs[i], j, i );
4532 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004533 }
4534 }
4535 return( ret );
4536}
4537
4538#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4539
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004540/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004541 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004542 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004543int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004544 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004545{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004546#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004548#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004549
Jerry Yu1a8b4812022-01-20 17:56:50 +08004550#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004551 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004552 {
4553 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4554 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4555 }
4556
Jerry Yuf377d642022-01-25 10:43:59 +08004557 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004558 {
4559 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4560 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4561 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004562
4563#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004564 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004565 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004566 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004567 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4568 }
4569
Jerry Yuf377d642022-01-25 10:43:59 +08004570 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004571 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004572 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004573 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4574 }
4575#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004576#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4577
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004578 /* Use the functions here so that they are covered in tests,
4579 * but otherwise access member directly for efficiency */
4580 mbedtls_ssl_conf_endpoint( conf, endpoint );
4581 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004582
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004583 /*
4584 * Things that are common to all presets
4585 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004586#if defined(MBEDTLS_SSL_CLI_C)
4587 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4588 {
4589 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4590#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4591 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4592#endif
4593 }
4594#endif
4595
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004596#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4597 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4598#endif
4599
4600#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4601 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4602#endif
4603
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004604#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004605 conf->f_cookie_write = ssl_cookie_write_dummy;
4606 conf->f_cookie_check = ssl_cookie_check_dummy;
4607#endif
4608
4609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4610 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4611#endif
4612
Janos Follath088ce432017-04-10 12:42:31 +01004613#if defined(MBEDTLS_SSL_SRV_C)
4614 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004615 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004616#endif
4617
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004618#if defined(MBEDTLS_SSL_PROTO_DTLS)
4619 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4620 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4621#endif
4622
4623#if defined(MBEDTLS_SSL_RENEGOTIATION)
4624 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004625 memset( conf->renego_period, 0x00, 2 );
4626 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004627#endif
4628
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004629#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004630 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4631 {
4632 const unsigned char dhm_p[] =
4633 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4634 const unsigned char dhm_g[] =
4635 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004636
Hanno Beckere2defad2021-07-24 05:59:17 +01004637 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4638 dhm_p, sizeof( dhm_p ),
4639 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4640 {
4641 return( ret );
4642 }
4643 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004644#endif
4645
Ronald Cron6f135e12021-12-08 16:57:54 +01004646#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004647 /*
4648 * Allow all TLS 1.3 key exchange modes by default.
4649 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004650 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004651#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004652
XiaokangQian4d3a6042022-04-21 13:46:17 +00004653 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4654 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004655#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004656 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004657 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004658#else
XiaokangQian060d8672022-04-21 09:24:56 +00004659 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004660#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004661 }
4662 else
4663 {
4664#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4665 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4666 {
4667 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4668 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4669 }
4670 else
4671 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4672 {
4673 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4674 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4675 }
4676#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4677 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4678 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4679#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4680 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4681 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4682#else
4683 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4684#endif
4685 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004686
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004687 /*
4688 * Preset-specific defaults
4689 */
4690 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004691 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004692 /*
4693 * NSA Suite B
4694 */
4695 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004696
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004697 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004698
4699#if defined(MBEDTLS_X509_CRT_PARSE_C)
4700 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004701#endif
4702
Gilles Peskineeccd8882020-03-10 12:19:08 +01004703#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004704#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4705 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4706 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4707 else
4708#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4709 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004710#endif
4711
Brett Warrene0edc842021-08-17 09:53:13 +01004712#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4713 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004714#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004715 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004716 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004717
4718 /*
4719 * Default
4720 */
4721 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004722
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004723 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004724
4725#if defined(MBEDTLS_X509_CRT_PARSE_C)
4726 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4727#endif
4728
Gilles Peskineeccd8882020-03-10 12:19:08 +01004729#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004730#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4731 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4732 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4733 else
4734#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4735 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004736#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004737
Brett Warrene0edc842021-08-17 09:53:13 +01004738#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4739 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004740#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004741 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004742
4743#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4744 conf->dhm_min_bitlen = 1024;
4745#endif
4746 }
4747
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004748 return( 0 );
4749}
4750
4751/*
4752 * Free mbedtls_ssl_config
4753 */
4754void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4755{
4756#if defined(MBEDTLS_DHM_C)
4757 mbedtls_mpi_free( &conf->dhm_P );
4758 mbedtls_mpi_free( &conf->dhm_G );
4759#endif
4760
Gilles Peskineeccd8882020-03-10 12:19:08 +01004761#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004762#if defined(MBEDTLS_USE_PSA_CRYPTO)
4763 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4764 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004765 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4766 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004767#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004768 if( conf->psk != NULL )
4769 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004770 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004771 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004772 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004773 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004774 }
4775
4776 if( conf->psk_identity != NULL )
4777 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004778 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004779 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004780 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004781 conf->psk_identity_len = 0;
4782 }
4783#endif
4784
4785#if defined(MBEDTLS_X509_CRT_PARSE_C)
4786 ssl_key_cert_free( conf->key_cert );
4787#endif
4788
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004789 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004790}
4791
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004792#if defined(MBEDTLS_PK_C) && \
4793 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004794/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004798{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799#if defined(MBEDTLS_RSA_C)
4800 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4801 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004802#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803#if defined(MBEDTLS_ECDSA_C)
4804 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4805 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004806#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004808}
4809
Hanno Becker7e5437a2017-04-28 17:15:26 +01004810unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4811{
4812 switch( type ) {
4813 case MBEDTLS_PK_RSA:
4814 return( MBEDTLS_SSL_SIG_RSA );
4815 case MBEDTLS_PK_ECDSA:
4816 case MBEDTLS_PK_ECKEY:
4817 return( MBEDTLS_SSL_SIG_ECDSA );
4818 default:
4819 return( MBEDTLS_SSL_SIG_ANON );
4820 }
4821}
4822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004824{
4825 switch( sig )
4826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827#if defined(MBEDTLS_RSA_C)
4828 case MBEDTLS_SSL_SIG_RSA:
4829 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004830#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831#if defined(MBEDTLS_ECDSA_C)
4832 case MBEDTLS_SSL_SIG_ECDSA:
4833 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004834#endif
4835 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004837 }
4838}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004839#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004840
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004841/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004842 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004845{
4846 switch( hash )
4847 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004848#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004849 case MBEDTLS_SSL_HASH_MD5:
4850 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004851#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004852#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853 case MBEDTLS_SSL_HASH_SHA1:
4854 return( MBEDTLS_MD_SHA1 );
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_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857 case MBEDTLS_SSL_HASH_SHA224:
4858 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004859#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004860#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004861 case MBEDTLS_SSL_HASH_SHA256:
4862 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004863#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004864#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004865 case MBEDTLS_SSL_HASH_SHA384:
4866 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004867#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004868#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004869 case MBEDTLS_SSL_HASH_SHA512:
4870 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004871#endif
4872 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004874 }
4875}
4876
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004877/*
4878 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4879 */
4880unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4881{
4882 switch( md )
4883 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004884#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004885 case MBEDTLS_MD_MD5:
4886 return( MBEDTLS_SSL_HASH_MD5 );
4887#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004888#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004889 case MBEDTLS_MD_SHA1:
4890 return( MBEDTLS_SSL_HASH_SHA1 );
4891#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004892#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004893 case MBEDTLS_MD_SHA224:
4894 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004895#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004896#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004897 case MBEDTLS_MD_SHA256:
4898 return( MBEDTLS_SSL_HASH_SHA256 );
4899#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004900#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004901 case MBEDTLS_MD_SHA384:
4902 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004903#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004904#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004905 case MBEDTLS_MD_SHA512:
4906 return( MBEDTLS_SSL_HASH_SHA512 );
4907#endif
4908 default:
4909 return( MBEDTLS_SSL_HASH_NONE );
4910 }
4911}
4912
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004913/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004914 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004915 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004916 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004917int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004918{
Brett Warrene0edc842021-08-17 09:53:13 +01004919 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004920
Brett Warrene0edc842021-08-17 09:53:13 +01004921 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004922 return( -1 );
4923
Brett Warrene0edc842021-08-17 09:53:13 +01004924 for( ; *group_list != 0; group_list++ )
4925 {
4926 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004927 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004928 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004929
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004930 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004931}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004932
4933#if defined(MBEDTLS_ECP_C)
4934/*
4935 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4936 */
4937int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4938{
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004939 const mbedtls_ecp_curve_info *grp_info =
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004940 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004941
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004942 if ( grp_info == NULL )
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004943 return -1;
4944
4945 uint16_t tls_id = grp_info->tls_id;
4946
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004947 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4948}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004949#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004951#if defined(MBEDTLS_X509_CRT_PARSE_C)
4952int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4953 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004954 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004955 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004956{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004957 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004958 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004959 const char *ext_oid;
4960 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004962 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004963 {
4964 /* Server part of the key exchange */
4965 switch( ciphersuite->key_exchange )
4966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967 case MBEDTLS_KEY_EXCHANGE_RSA:
4968 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004969 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004970 break;
4971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4973 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4974 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4975 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004976 break;
4977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004978 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4979 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004980 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004981 break;
4982
4983 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004984 case MBEDTLS_KEY_EXCHANGE_NONE:
4985 case MBEDTLS_KEY_EXCHANGE_PSK:
4986 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4987 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004988 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004989 usage = 0;
4990 }
4991 }
4992 else
4993 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004994 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4995 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004996 }
4997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004999 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005000 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005001 ret = -1;
5002 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005004 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005005 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005006 ext_oid = MBEDTLS_OID_SERVER_AUTH;
5007 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005008 }
5009 else
5010 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005011 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5012 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005013 }
5014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005016 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005017 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005018 ret = -1;
5019 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005020
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005021 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005022}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005023#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005024
Jerry Yu148165c2021-09-24 23:20:59 +08005025#if defined(MBEDTLS_USE_PSA_CRYPTO)
5026int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5027 const mbedtls_md_type_t md,
5028 unsigned char *dst,
5029 size_t dst_len,
5030 size_t *olen )
5031{
Ronald Cronf6893e12022-01-07 22:09:01 +01005032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5033 psa_hash_operation_t *hash_operation_to_clone;
5034 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5035
Jerry Yu148165c2021-09-24 23:20:59 +08005036 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005037
5038 switch( md )
5039 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005040#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005041 case MBEDTLS_MD_SHA384:
5042 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5043 break;
5044#endif
5045
Andrzej Kurek25f27152022-08-17 16:09:31 -04005046#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005047 case MBEDTLS_MD_SHA256:
5048 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5049 break;
5050#endif
5051
5052 default:
5053 goto exit;
5054 }
5055
5056 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5057 if( status != PSA_SUCCESS )
5058 goto exit;
5059
5060 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5061 if( status != PSA_SUCCESS )
5062 goto exit;
5063
5064exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005065 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005066}
5067#else /* MBEDTLS_USE_PSA_CRYPTO */
5068
Andrzej Kurek25f27152022-08-17 16:09:31 -04005069#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005070MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005071static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5072 unsigned char *dst,
5073 size_t dst_len,
5074 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005075{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005076 int ret;
5077 mbedtls_sha512_context sha512;
5078
5079 if( dst_len < 48 )
5080 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5081
5082 mbedtls_sha512_init( &sha512 );
Andrzej Kureka242e832022-08-11 10:03:14 -04005083 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005084
5085 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5086 {
5087 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5088 goto exit;
5089 }
5090
5091 *olen = 48;
5092
5093exit:
5094
5095 mbedtls_sha512_free( &sha512 );
5096 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005097}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005098#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005099
Andrzej Kurek25f27152022-08-17 16:09:31 -04005100#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005101MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005102static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5103 unsigned char *dst,
5104 size_t dst_len,
5105 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005106{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005107 int ret;
5108 mbedtls_sha256_context sha256;
5109
5110 if( dst_len < 32 )
5111 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5112
5113 mbedtls_sha256_init( &sha256 );
5114 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005115
Jerry Yu24c0ec32021-09-09 14:21:07 +08005116 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5117 {
5118 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5119 goto exit;
5120 }
5121
5122 *olen = 32;
5123
5124exit:
5125
5126 mbedtls_sha256_free( &sha256 );
5127 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005128}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005129#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005130
Jerry Yu000f9762021-09-14 11:12:51 +08005131int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5132 const mbedtls_md_type_t md,
5133 unsigned char *dst,
5134 size_t dst_len,
5135 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005136{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005137 switch( md )
5138 {
5139
Andrzej Kurek25f27152022-08-17 16:09:31 -04005140#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005141 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005142 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005143#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005144
Andrzej Kurek25f27152022-08-17 16:09:31 -04005145#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005146 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005147 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005148#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005149
5150 default:
5151 break;
5152 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005153 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005154}
XiaokangQian647719a2021-12-07 09:16:29 +00005155
Jerry Yu148165c2021-09-24 23:20:59 +08005156#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005157
Gabor Mezei078e8032022-04-27 21:17:56 +02005158#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5159/* mbedtls_ssl_parse_sig_alg_ext()
5160 *
5161 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5162 * value (TLS 1.3 RFC8446):
5163 * enum {
5164 * ....
5165 * ecdsa_secp256r1_sha256( 0x0403 ),
5166 * ecdsa_secp384r1_sha384( 0x0503 ),
5167 * ecdsa_secp521r1_sha512( 0x0603 ),
5168 * ....
5169 * } SignatureScheme;
5170 *
5171 * struct {
5172 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5173 * } SignatureSchemeList;
5174 *
5175 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5176 * value (TLS 1.2 RFC5246):
5177 * enum {
5178 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5179 * sha512(6), (255)
5180 * } HashAlgorithm;
5181 *
5182 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5183 * SignatureAlgorithm;
5184 *
5185 * struct {
5186 * HashAlgorithm hash;
5187 * SignatureAlgorithm signature;
5188 * } SignatureAndHashAlgorithm;
5189 *
5190 * SignatureAndHashAlgorithm
5191 * supported_signature_algorithms<2..2^16-2>;
5192 *
5193 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5194 * generalization of the TLS 1.2 signature algorithm extension.
5195 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5196 * `SignatureScheme` field of TLS 1.3
5197 *
5198 */
5199int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5200 const unsigned char *buf,
5201 const unsigned char *end )
5202{
5203 const unsigned char *p = buf;
5204 size_t supported_sig_algs_len = 0;
5205 const unsigned char *supported_sig_algs_end;
5206 uint16_t sig_alg;
5207 uint32_t common_idx = 0;
5208
5209 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5210 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5211 p += 2;
5212
5213 memset( ssl->handshake->received_sig_algs, 0,
5214 sizeof(ssl->handshake->received_sig_algs) );
5215
5216 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5217 supported_sig_algs_end = p + supported_sig_algs_len;
5218 while( p < supported_sig_algs_end )
5219 {
5220 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5221 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5222 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005223 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5224 sig_alg,
5225 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005226#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005227 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005228 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5229 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5230 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005231 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005232 }
5233#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005234
Jerry Yuf3b46b52022-06-19 16:52:27 +08005235 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5236 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005237
5238 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5239 {
5240 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5241 common_idx += 1;
5242 }
5243 }
5244 /* Check that we consumed all the message. */
5245 if( p != end )
5246 {
5247 MBEDTLS_SSL_DEBUG_MSG( 1,
5248 ( "Signature algorithms extension length misaligned" ) );
5249 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5250 MBEDTLS_ERR_SSL_DECODE_ERROR );
5251 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5252 }
5253
5254 if( common_idx == 0 )
5255 {
5256 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5257 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5258 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5259 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5260 }
5261
Gabor Mezei15b95a62022-05-09 16:37:58 +02005262 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005263 return( 0 );
5264}
5265
5266#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5267
Jerry Yudc7bd172022-02-17 13:44:15 +08005268#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5269
5270#if defined(MBEDTLS_USE_PSA_CRYPTO)
5271
5272static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5273 mbedtls_svc_key_id_t key,
5274 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005275 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005276 const unsigned char* seed, size_t seed_length,
5277 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005278 const unsigned char* other_secret,
5279 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005280 size_t capacity )
5281{
5282 psa_status_t status;
5283
5284 status = psa_key_derivation_setup( derivation, alg );
5285 if( status != PSA_SUCCESS )
5286 return( status );
5287
5288 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5289 {
5290 status = psa_key_derivation_input_bytes( derivation,
5291 PSA_KEY_DERIVATION_INPUT_SEED,
5292 seed, seed_length );
5293 if( status != PSA_SUCCESS )
5294 return( status );
5295
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005296 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005297 {
5298 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005299 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5300 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005301 if( status != PSA_SUCCESS )
5302 return( status );
5303 }
5304
Jerry Yudc7bd172022-02-17 13:44:15 +08005305 if( mbedtls_svc_key_id_is_null( key ) )
5306 {
5307 status = psa_key_derivation_input_bytes(
5308 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005309 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005310 }
5311 else
5312 {
5313 status = psa_key_derivation_input_key(
5314 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5315 }
5316 if( status != PSA_SUCCESS )
5317 return( status );
5318
5319 status = psa_key_derivation_input_bytes( derivation,
5320 PSA_KEY_DERIVATION_INPUT_LABEL,
5321 label, label_length );
5322 if( status != PSA_SUCCESS )
5323 return( status );
5324 }
5325 else
5326 {
5327 return( PSA_ERROR_NOT_SUPPORTED );
5328 }
5329
5330 status = psa_key_derivation_set_capacity( derivation, capacity );
5331 if( status != PSA_SUCCESS )
5332 return( status );
5333
5334 return( PSA_SUCCESS );
5335}
5336
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005337MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005338static int tls_prf_generic( mbedtls_md_type_t md_type,
5339 const unsigned char *secret, size_t slen,
5340 const char *label,
5341 const unsigned char *random, size_t rlen,
5342 unsigned char *dstbuf, size_t dlen )
5343{
5344 psa_status_t status;
5345 psa_algorithm_t alg;
5346 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5347 psa_key_derivation_operation_t derivation =
5348 PSA_KEY_DERIVATION_OPERATION_INIT;
5349
5350 if( md_type == MBEDTLS_MD_SHA384 )
5351 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5352 else
5353 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5354
5355 /* Normally a "secret" should be long enough to be impossible to
5356 * find by brute force, and in particular should not be empty. But
5357 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5358 * and for this use case it makes sense to have a 0-length "secret".
5359 * Since the key API doesn't allow importing a key of length 0,
5360 * keep master_key=0, which setup_psa_key_derivation() understands
5361 * to mean a 0-length "secret" input. */
5362 if( slen != 0 )
5363 {
5364 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5365 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5366 psa_set_key_algorithm( &key_attributes, alg );
5367 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5368
5369 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5370 if( status != PSA_SUCCESS )
5371 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5372 }
5373
5374 status = setup_psa_key_derivation( &derivation,
5375 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005376 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005377 random, rlen,
5378 (unsigned char const *) label,
5379 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005380 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005381 dlen );
5382 if( status != PSA_SUCCESS )
5383 {
5384 psa_key_derivation_abort( &derivation );
5385 psa_destroy_key( master_key );
5386 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5387 }
5388
5389 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5390 if( status != PSA_SUCCESS )
5391 {
5392 psa_key_derivation_abort( &derivation );
5393 psa_destroy_key( master_key );
5394 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5395 }
5396
5397 status = psa_key_derivation_abort( &derivation );
5398 if( status != PSA_SUCCESS )
5399 {
5400 psa_destroy_key( master_key );
5401 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5402 }
5403
5404 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5405 status = psa_destroy_key( master_key );
5406 if( status != PSA_SUCCESS )
5407 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5408
5409 return( 0 );
5410}
5411
5412#else /* MBEDTLS_USE_PSA_CRYPTO */
5413
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005414MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005415static int tls_prf_generic( mbedtls_md_type_t md_type,
5416 const unsigned char *secret, size_t slen,
5417 const char *label,
5418 const unsigned char *random, size_t rlen,
5419 unsigned char *dstbuf, size_t dlen )
5420{
5421 size_t nb;
5422 size_t i, j, k, md_len;
5423 unsigned char *tmp;
5424 size_t tmp_len = 0;
5425 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5426 const mbedtls_md_info_t *md_info;
5427 mbedtls_md_context_t md_ctx;
5428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5429
5430 mbedtls_md_init( &md_ctx );
5431
5432 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5433 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5434
5435 md_len = mbedtls_md_get_size( md_info );
5436
5437 tmp_len = md_len + strlen( label ) + rlen;
5438 tmp = mbedtls_calloc( 1, tmp_len );
5439 if( tmp == NULL )
5440 {
5441 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5442 goto exit;
5443 }
5444
5445 nb = strlen( label );
5446 memcpy( tmp + md_len, label, nb );
5447 memcpy( tmp + md_len + nb, random, rlen );
5448 nb += rlen;
5449
5450 /*
5451 * Compute P_<hash>(secret, label + random)[0..dlen]
5452 */
5453 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5454 goto exit;
5455
5456 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5457 if( ret != 0 )
5458 goto exit;
5459 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5460 if( ret != 0 )
5461 goto exit;
5462 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5463 if( ret != 0 )
5464 goto exit;
5465
5466 for( i = 0; i < dlen; i += md_len )
5467 {
5468 ret = mbedtls_md_hmac_reset ( &md_ctx );
5469 if( ret != 0 )
5470 goto exit;
5471 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5472 if( ret != 0 )
5473 goto exit;
5474 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5475 if( ret != 0 )
5476 goto exit;
5477
5478 ret = mbedtls_md_hmac_reset ( &md_ctx );
5479 if( ret != 0 )
5480 goto exit;
5481 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5482 if( ret != 0 )
5483 goto exit;
5484 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5485 if( ret != 0 )
5486 goto exit;
5487
5488 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5489
5490 for( j = 0; j < k; j++ )
5491 dstbuf[i + j] = h_i[j];
5492 }
5493
5494exit:
5495 mbedtls_md_free( &md_ctx );
5496
5497 mbedtls_platform_zeroize( tmp, tmp_len );
5498 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5499
5500 mbedtls_free( tmp );
5501
5502 return( ret );
5503}
5504#endif /* MBEDTLS_USE_PSA_CRYPTO */
5505
Andrzej Kurek25f27152022-08-17 16:09:31 -04005506#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005507MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005508static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5509 const char *label,
5510 const unsigned char *random, size_t rlen,
5511 unsigned char *dstbuf, size_t dlen )
5512{
5513 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5514 label, random, rlen, dstbuf, dlen ) );
5515}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005516#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08005517
Andrzej Kurek25f27152022-08-17 16:09:31 -04005518#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005519MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005520static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5521 const char *label,
5522 const unsigned char *random, size_t rlen,
5523 unsigned char *dstbuf, size_t dlen )
5524{
5525 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5526 label, random, rlen, dstbuf, dlen ) );
5527}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005528#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08005529
Jerry Yuf009d862022-02-17 14:01:37 +08005530/*
5531 * Set appropriate PRF function and other SSL / TLS1.2 functions
5532 *
5533 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005534 * - hash associated with the ciphersuite (only used by TLS 1.2)
5535 *
5536 * Outputs:
5537 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5538 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005539MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005540static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005541 mbedtls_md_type_t hash )
5542{
Andrzej Kurek25f27152022-08-17 16:09:31 -04005543#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron81591aa2022-03-07 09:05:51 +01005544 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005545 {
5546 handshake->tls_prf = tls_prf_sha384;
5547 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5548 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5549 }
5550 else
5551#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005552#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08005553 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005554 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005555 handshake->tls_prf = tls_prf_sha256;
5556 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5557 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5558 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005559#else
Jerry Yuf009d862022-02-17 14:01:37 +08005560 {
Jerry Yuf009d862022-02-17 14:01:37 +08005561 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005562 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005563 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5564 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005565#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005566
5567 return( 0 );
5568}
Jerry Yud6ab2352022-02-17 14:03:43 +08005569
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005570/*
5571 * Compute master secret if needed
5572 *
5573 * Parameters:
5574 * [in/out] handshake
5575 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5576 * (PSA-PSK) ciphersuite_info, psk_opaque
5577 * [out] premaster (cleared)
5578 * [out] master
5579 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5580 * debug: conf->f_dbg, conf->p_dbg
5581 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005582 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005583 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005584MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005585static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5586 unsigned char *master,
5587 const mbedtls_ssl_context *ssl )
5588{
5589 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5590
5591 /* cf. RFC 5246, Section 8.1:
5592 * "The master secret is always exactly 48 bytes in length." */
5593 size_t const master_secret_len = 48;
5594
5595#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5596 unsigned char session_hash[48];
5597#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5598
5599 /* The label for the KDF used for key expansion.
5600 * This is either "master secret" or "extended master secret"
5601 * depending on whether the Extended Master Secret extension
5602 * is used. */
5603 char const *lbl = "master secret";
5604
Przemek Stekielae4ed302022-04-05 17:15:55 +02005605 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005606 * - If the Extended Master Secret extension is not used,
5607 * this is ClientHello.Random + ServerHello.Random
5608 * (see Sect. 8.1 in RFC 5246).
5609 * - If the Extended Master Secret extension is used,
5610 * this is the transcript of the handshake so far.
5611 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005612 unsigned char const *seed = handshake->randbytes;
5613 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005614
5615#if !defined(MBEDTLS_DEBUG_C) && \
5616 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5617 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5618 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5619 ssl = NULL; /* make sure we don't use it except for those cases */
5620 (void) ssl;
5621#endif
5622
5623 if( handshake->resume != 0 )
5624 {
5625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5626 return( 0 );
5627 }
5628
5629#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5630 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5631 {
5632 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005633 seed = session_hash;
5634 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005635
5636 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005637 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005638 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005639#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005640
Przemek Stekiel99114f32022-04-22 11:20:09 +02005641#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005642 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005643 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005644 {
5645 /* Perform PSK-to-MS expansion in a single step. */
5646 psa_status_t status;
5647 psa_algorithm_t alg;
5648 mbedtls_svc_key_id_t psk;
5649 psa_key_derivation_operation_t derivation =
5650 PSA_KEY_DERIVATION_OPERATION_INIT;
5651 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5652
5653 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5654
5655 psk = mbedtls_ssl_get_opaque_psk( ssl );
5656
5657 if( hash_alg == MBEDTLS_MD_SHA384 )
5658 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5659 else
5660 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5661
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005662 size_t other_secret_len = 0;
5663 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005664
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005665 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005666 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005667 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005668 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005669 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005670 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005671 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005672 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005673 other_secret_len = 48;
5674 other_secret = handshake->premaster + 2;
5675 break;
5676 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005677 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005678 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5679 other_secret = handshake->premaster + 2;
5680 break;
5681 default:
5682 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005683 }
5684
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005685 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005686 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005687 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005688 (unsigned char const *) lbl,
5689 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005690 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005691 master_secret_len );
5692 if( status != PSA_SUCCESS )
5693 {
5694 psa_key_derivation_abort( &derivation );
5695 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5696 }
5697
5698 status = psa_key_derivation_output_bytes( &derivation,
5699 master,
5700 master_secret_len );
5701 if( status != PSA_SUCCESS )
5702 {
5703 psa_key_derivation_abort( &derivation );
5704 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5705 }
5706
5707 status = psa_key_derivation_abort( &derivation );
5708 if( status != PSA_SUCCESS )
5709 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5710 }
5711 else
5712#endif
5713 {
5714 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005715 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005716 master,
5717 master_secret_len );
5718 if( ret != 0 )
5719 {
5720 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5721 return( ret );
5722 }
5723
5724 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5725 handshake->premaster,
5726 handshake->pmslen );
5727
5728 mbedtls_platform_zeroize( handshake->premaster,
5729 sizeof(handshake->premaster) );
5730 }
5731
5732 return( 0 );
5733}
5734
Jerry Yud62f87e2022-02-17 14:09:02 +08005735int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5736{
5737 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5738 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5739 ssl->handshake->ciphersuite_info;
5740
5741 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5742
5743 /* Set PRF, calc_verify and calc_finished function pointers */
5744 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005745 ciphersuite_info->mac );
5746 if( ret != 0 )
5747 {
5748 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5749 return( ret );
5750 }
5751
5752 /* Compute master secret if needed */
5753 ret = ssl_compute_master( ssl->handshake,
5754 ssl->session_negotiate->master,
5755 ssl );
5756 if( ret != 0 )
5757 {
5758 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5759 return( ret );
5760 }
5761
5762 /* Swap the client and server random values:
5763 * - MS derivation wanted client+server (RFC 5246 8.1)
5764 * - key derivation wants server+client (RFC 5246 6.3) */
5765 {
5766 unsigned char tmp[64];
5767 memcpy( tmp, ssl->handshake->randbytes, 64 );
5768 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5769 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5770 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5771 }
5772
5773 /* Populate transform structure */
5774 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5775 ssl->session_negotiate->ciphersuite,
5776 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005777#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005778 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005779#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005780 ssl->handshake->tls_prf,
5781 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005782 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005783 ssl->conf->endpoint,
5784 ssl );
5785 if( ret != 0 )
5786 {
5787 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5788 return( ret );
5789 }
5790
5791 /* We no longer need Server/ClientHello.random values */
5792 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5793 sizeof( ssl->handshake->randbytes ) );
5794
5795 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5796
5797 return( 0 );
5798}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005799
Ronald Cron4dcbca92022-03-07 10:21:40 +01005800int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5801{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005802 switch( md )
5803 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005804#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01005805 case MBEDTLS_SSL_HASH_SHA384:
5806 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5807 break;
5808#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005809#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01005810 case MBEDTLS_SSL_HASH_SHA256:
5811 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5812 break;
5813#endif
5814 default:
5815 return( -1 );
5816 }
5817
Ronald Cronc2f13a02022-03-07 10:25:24 +01005818 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005819}
5820
Andrzej Kurek25f27152022-08-17 16:09:31 -04005821#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu8392e0d2022-02-17 14:10:24 +08005822void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5823 unsigned char *hash,
5824 size_t *hlen )
5825{
5826#if defined(MBEDTLS_USE_PSA_CRYPTO)
5827 size_t hash_size;
5828 psa_status_t status;
5829 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5830
5831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5832 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5833 if( status != PSA_SUCCESS )
5834 {
5835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5836 return;
5837 }
5838
5839 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5840 if( status != PSA_SUCCESS )
5841 {
5842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5843 return;
5844 }
5845
5846 *hlen = 32;
5847 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5849#else
5850 mbedtls_sha256_context sha256;
5851
5852 mbedtls_sha256_init( &sha256 );
5853
5854 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5855
5856 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5857 mbedtls_sha256_finish( &sha256, hash );
5858
5859 *hlen = 32;
5860
5861 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5863
5864 mbedtls_sha256_free( &sha256 );
5865#endif /* MBEDTLS_USE_PSA_CRYPTO */
5866 return;
5867}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005868#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08005869
Andrzej Kurek25f27152022-08-17 16:09:31 -04005870#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1cb3842022-02-17 14:13:48 +08005871void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5872 unsigned char *hash,
5873 size_t *hlen )
5874{
5875#if defined(MBEDTLS_USE_PSA_CRYPTO)
5876 size_t hash_size;
5877 psa_status_t status;
5878 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5879
5880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5881 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5882 if( status != PSA_SUCCESS )
5883 {
5884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5885 return;
5886 }
5887
5888 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5889 if( status != PSA_SUCCESS )
5890 {
5891 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5892 return;
5893 }
5894
5895 *hlen = 48;
5896 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5898#else
5899 mbedtls_sha512_context sha512;
5900
5901 mbedtls_sha512_init( &sha512 );
5902
5903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5904
Andrzej Kureka242e832022-08-11 10:03:14 -04005905 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yuc1cb3842022-02-17 14:13:48 +08005906 mbedtls_sha512_finish( &sha512, hash );
5907
5908 *hlen = 48;
5909
5910 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5911 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5912
5913 mbedtls_sha512_free( &sha512 );
5914#endif /* MBEDTLS_USE_PSA_CRYPTO */
5915 return;
5916}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005917#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08005918
Neil Armstrong80f6f322022-05-03 17:56:38 +02005919#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5920 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005921int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5922{
5923 unsigned char *p = ssl->handshake->premaster;
5924 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5925 const unsigned char *psk = NULL;
5926 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005927 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005928
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005929 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005930 {
5931 /*
5932 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005933 * checked before calling this function.
5934 *
5935 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005936 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005937 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005938 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5939 {
5940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5941 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5942 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005943 }
5944
5945 /*
5946 * PMS = struct {
5947 * opaque other_secret<0..2^16-1>;
5948 * opaque psk<0..2^16-1>;
5949 * };
5950 * with "other_secret" depending on the particular key exchange
5951 */
5952#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5953 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5954 {
5955 if( end - p < 2 )
5956 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5957
5958 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5959 p += 2;
5960
5961 if( end < p || (size_t)( end - p ) < psk_len )
5962 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5963
5964 memset( p, 0, psk_len );
5965 p += psk_len;
5966 }
5967 else
5968#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5969#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5970 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5971 {
5972 /*
5973 * other_secret already set by the ClientKeyExchange message,
5974 * and is 48 bytes long
5975 */
5976 if( end - p < 2 )
5977 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5978
5979 *p++ = 0;
5980 *p++ = 48;
5981 p += 48;
5982 }
5983 else
5984#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5985#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5986 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5987 {
5988 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5989 size_t len;
5990
5991 /* Write length only when we know the actual value */
5992 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5993 p + 2, end - ( p + 2 ), &len,
5994 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5995 {
5996 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5997 return( ret );
5998 }
5999 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
6000 p += 2 + len;
6001
6002 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
6003 }
6004 else
6005#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006006#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08006007 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
6008 {
6009 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6010 size_t zlen;
6011
6012 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
6013 p + 2, end - ( p + 2 ),
6014 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6015 {
6016 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
6017 return( ret );
6018 }
6019
6020 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6021 p += 2 + zlen;
6022
6023 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6024 MBEDTLS_DEBUG_ECDH_Z );
6025 }
6026 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006027#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006028 {
6029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6030 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6031 }
6032
6033 /* opaque psk<0..2^16-1>; */
6034 if( end - p < 2 )
6035 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6036
6037 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6038 p += 2;
6039
6040 if( end < p || (size_t)( end - p ) < psk_len )
6041 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6042
6043 memcpy( p, psk, psk_len );
6044 p += psk_len;
6045
6046 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6047
6048 return( 0 );
6049}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006050#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006051
6052#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006053MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006054static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6055
6056#if defined(MBEDTLS_SSL_PROTO_DTLS)
6057int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6058{
6059 /* If renegotiation is not enforced, retransmit until we would reach max
6060 * timeout if we were using the usual handshake doubling scheme */
6061 if( ssl->conf->renego_max_records < 0 )
6062 {
6063 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6064 unsigned char doublings = 1;
6065
6066 while( ratio != 0 )
6067 {
6068 ++doublings;
6069 ratio >>= 1;
6070 }
6071
6072 if( ++ssl->renego_records_seen > doublings )
6073 {
6074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6075 return( 0 );
6076 }
6077 }
6078
6079 return( ssl_write_hello_request( ssl ) );
6080}
6081#endif
6082#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006083
Jerry Yud9526692022-02-17 14:23:47 +08006084/*
6085 * Handshake functions
6086 */
6087#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6088/* No certificate support -> dummy functions */
6089int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6090{
6091 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6092 ssl->handshake->ciphersuite_info;
6093
6094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6095
6096 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6097 {
6098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6099 ssl->state++;
6100 return( 0 );
6101 }
6102
6103 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6105}
6106
6107int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6108{
6109 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6110 ssl->handshake->ciphersuite_info;
6111
6112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6113
6114 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6115 {
6116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6117 ssl->state++;
6118 return( 0 );
6119 }
6120
6121 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6122 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6123}
6124
6125#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6126/* Some certificate support -> implement write and parse */
6127
6128int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6129{
6130 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6131 size_t i, n;
6132 const mbedtls_x509_crt *crt;
6133 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6134 ssl->handshake->ciphersuite_info;
6135
6136 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6137
6138 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6139 {
6140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6141 ssl->state++;
6142 return( 0 );
6143 }
6144
6145#if defined(MBEDTLS_SSL_CLI_C)
6146 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6147 {
6148 if( ssl->handshake->client_auth == 0 )
6149 {
6150 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6151 ssl->state++;
6152 return( 0 );
6153 }
6154 }
6155#endif /* MBEDTLS_SSL_CLI_C */
6156#if defined(MBEDTLS_SSL_SRV_C)
6157 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6158 {
6159 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6160 {
6161 /* Should never happen because we shouldn't have picked the
6162 * ciphersuite if we don't have a certificate. */
6163 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6164 }
6165 }
6166#endif
6167
6168 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6169
6170 /*
6171 * 0 . 0 handshake type
6172 * 1 . 3 handshake length
6173 * 4 . 6 length of all certs
6174 * 7 . 9 length of cert. 1
6175 * 10 . n-1 peer certificate
6176 * n . n+2 length of cert. 2
6177 * n+3 . ... upper level cert, etc.
6178 */
6179 i = 7;
6180 crt = mbedtls_ssl_own_cert( ssl );
6181
6182 while( crt != NULL )
6183 {
6184 n = crt->raw.len;
6185 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6186 {
6187 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6188 " > %" MBEDTLS_PRINTF_SIZET,
6189 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6190 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6191 }
6192
6193 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6194 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6195 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6196
6197 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6198 i += n; crt = crt->next;
6199 }
6200
6201 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6202 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6203 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6204
6205 ssl->out_msglen = i;
6206 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6207 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6208
6209 ssl->state++;
6210
6211 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6212 {
6213 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6214 return( ret );
6215 }
6216
6217 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6218
6219 return( ret );
6220}
6221
6222#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6223
6224#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006225MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006226static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6227 unsigned char *crt_buf,
6228 size_t crt_buf_len )
6229{
6230 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6231
6232 if( peer_crt == NULL )
6233 return( -1 );
6234
6235 if( peer_crt->raw.len != crt_buf_len )
6236 return( -1 );
6237
6238 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6239}
6240#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006241MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006242static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6243 unsigned char *crt_buf,
6244 size_t crt_buf_len )
6245{
6246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6247 unsigned char const * const peer_cert_digest =
6248 ssl->session->peer_cert_digest;
6249 mbedtls_md_type_t const peer_cert_digest_type =
6250 ssl->session->peer_cert_digest_type;
6251 mbedtls_md_info_t const * const digest_info =
6252 mbedtls_md_info_from_type( peer_cert_digest_type );
6253 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6254 size_t digest_len;
6255
6256 if( peer_cert_digest == NULL || digest_info == NULL )
6257 return( -1 );
6258
6259 digest_len = mbedtls_md_get_size( digest_info );
6260 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6261 return( -1 );
6262
6263 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6264 if( ret != 0 )
6265 return( -1 );
6266
6267 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6268}
6269#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6270#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6271
6272/*
6273 * Once the certificate message is read, parse it into a cert chain and
6274 * perform basic checks, but leave actual verification to the caller
6275 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006276MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006277static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6278 mbedtls_x509_crt *chain )
6279{
6280 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6281#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6282 int crt_cnt=0;
6283#endif
6284 size_t i, n;
6285 uint8_t alert;
6286
6287 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6288 {
6289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6290 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6291 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6292 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6293 }
6294
6295 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6296 {
6297 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6298 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6299 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6300 }
6301
6302 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6303 {
6304 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6305 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6306 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6307 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6308 }
6309
6310 i = mbedtls_ssl_hs_hdr_len( ssl );
6311
6312 /*
6313 * Same message structure as in mbedtls_ssl_write_certificate()
6314 */
6315 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6316
6317 if( ssl->in_msg[i] != 0 ||
6318 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6319 {
6320 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6321 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6322 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6323 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6324 }
6325
6326 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6327 i += 3;
6328
6329 /* Iterate through and parse the CRTs in the provided chain. */
6330 while( i < ssl->in_hslen )
6331 {
6332 /* Check that there's room for the next CRT's length fields. */
6333 if ( i + 3 > ssl->in_hslen ) {
6334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6335 mbedtls_ssl_send_alert_message( ssl,
6336 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6337 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6338 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6339 }
6340 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6341 * anything beyond 2**16 ~ 64K. */
6342 if( ssl->in_msg[i] != 0 )
6343 {
6344 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6345 mbedtls_ssl_send_alert_message( ssl,
6346 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6347 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6348 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6349 }
6350
6351 /* Read length of the next CRT in the chain. */
6352 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6353 | (unsigned int) ssl->in_msg[i + 2];
6354 i += 3;
6355
6356 if( n < 128 || i + n > ssl->in_hslen )
6357 {
6358 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6359 mbedtls_ssl_send_alert_message( ssl,
6360 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6361 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6362 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6363 }
6364
6365 /* Check if we're handling the first CRT in the chain. */
6366#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6367 if( crt_cnt++ == 0 &&
6368 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6369 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6370 {
6371 /* During client-side renegotiation, check that the server's
6372 * end-CRTs hasn't changed compared to the initial handshake,
6373 * mitigating the triple handshake attack. On success, reuse
6374 * the original end-CRT instead of parsing it again. */
6375 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6376 if( ssl_check_peer_crt_unchanged( ssl,
6377 &ssl->in_msg[i],
6378 n ) != 0 )
6379 {
6380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6381 mbedtls_ssl_send_alert_message( ssl,
6382 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6383 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6384 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6385 }
6386
6387 /* Now we can safely free the original chain. */
6388 ssl_clear_peer_cert( ssl->session );
6389 }
6390#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6391
6392 /* Parse the next certificate in the chain. */
6393#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6394 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6395#else
6396 /* If we don't need to store the CRT chain permanently, parse
6397 * it in-place from the input buffer instead of making a copy. */
6398 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6399#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6400 switch( ret )
6401 {
6402 case 0: /*ok*/
6403 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6404 /* Ignore certificate with an unknown algorithm: maybe a
6405 prior certificate was already trusted. */
6406 break;
6407
6408 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6409 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6410 goto crt_parse_der_failed;
6411
6412 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6413 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6414 goto crt_parse_der_failed;
6415
6416 default:
6417 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6418 crt_parse_der_failed:
6419 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6420 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6421 return( ret );
6422 }
6423
6424 i += n;
6425 }
6426
6427 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6428 return( 0 );
6429}
6430
6431#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006432MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006433static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6434{
6435 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6436 return( -1 );
6437
6438 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6439 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6440 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6441 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6442 {
Ronald Cron19385882022-06-15 16:26:13 +02006443 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006444 return( 0 );
6445 }
6446 return( -1 );
6447}
6448#endif /* MBEDTLS_SSL_SRV_C */
6449
6450/* Check if a certificate message is expected.
6451 * Return either
6452 * - SSL_CERTIFICATE_EXPECTED, or
6453 * - SSL_CERTIFICATE_SKIP
6454 * indicating whether a Certificate message is expected or not.
6455 */
6456#define SSL_CERTIFICATE_EXPECTED 0
6457#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006458MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006459static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6460 int authmode )
6461{
6462 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6463 ssl->handshake->ciphersuite_info;
6464
6465 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6466 return( SSL_CERTIFICATE_SKIP );
6467
6468#if defined(MBEDTLS_SSL_SRV_C)
6469 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6470 {
6471 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6472 return( SSL_CERTIFICATE_SKIP );
6473
6474 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6475 {
6476 ssl->session_negotiate->verify_result =
6477 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6478 return( SSL_CERTIFICATE_SKIP );
6479 }
6480 }
6481#else
6482 ((void) authmode);
6483#endif /* MBEDTLS_SSL_SRV_C */
6484
6485 return( SSL_CERTIFICATE_EXPECTED );
6486}
6487
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006488MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006489static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6490 int authmode,
6491 mbedtls_x509_crt *chain,
6492 void *rs_ctx )
6493{
6494 int ret = 0;
6495 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6496 ssl->handshake->ciphersuite_info;
6497 int have_ca_chain = 0;
6498
6499 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6500 void *p_vrfy;
6501
6502 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6503 return( 0 );
6504
6505 if( ssl->f_vrfy != NULL )
6506 {
6507 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6508 f_vrfy = ssl->f_vrfy;
6509 p_vrfy = ssl->p_vrfy;
6510 }
6511 else
6512 {
6513 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6514 f_vrfy = ssl->conf->f_vrfy;
6515 p_vrfy = ssl->conf->p_vrfy;
6516 }
6517
6518 /*
6519 * Main check: verify certificate
6520 */
6521#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6522 if( ssl->conf->f_ca_cb != NULL )
6523 {
6524 ((void) rs_ctx);
6525 have_ca_chain = 1;
6526
6527 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6528 ret = mbedtls_x509_crt_verify_with_ca_cb(
6529 chain,
6530 ssl->conf->f_ca_cb,
6531 ssl->conf->p_ca_cb,
6532 ssl->conf->cert_profile,
6533 ssl->hostname,
6534 &ssl->session_negotiate->verify_result,
6535 f_vrfy, p_vrfy );
6536 }
6537 else
6538#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6539 {
6540 mbedtls_x509_crt *ca_chain;
6541 mbedtls_x509_crl *ca_crl;
6542
6543#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6544 if( ssl->handshake->sni_ca_chain != NULL )
6545 {
6546 ca_chain = ssl->handshake->sni_ca_chain;
6547 ca_crl = ssl->handshake->sni_ca_crl;
6548 }
6549 else
6550#endif
6551 {
6552 ca_chain = ssl->conf->ca_chain;
6553 ca_crl = ssl->conf->ca_crl;
6554 }
6555
6556 if( ca_chain != NULL )
6557 have_ca_chain = 1;
6558
6559 ret = mbedtls_x509_crt_verify_restartable(
6560 chain,
6561 ca_chain, ca_crl,
6562 ssl->conf->cert_profile,
6563 ssl->hostname,
6564 &ssl->session_negotiate->verify_result,
6565 f_vrfy, p_vrfy, rs_ctx );
6566 }
6567
6568 if( ret != 0 )
6569 {
6570 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6571 }
6572
6573#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6574 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6575 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6576#endif
6577
6578 /*
6579 * Secondary checks: always done, but change 'ret' only if it was 0
6580 */
6581
6582#if defined(MBEDTLS_ECP_C)
6583 {
6584 const mbedtls_pk_context *pk = &chain->pk;
6585
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006586 /* If certificate uses an EC key, make sure the curve is OK.
6587 * This is a public key, so it can't be opaque, so can_do() is a good
6588 * enough check to ensure pk_ec() is safe to use here. */
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006589 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) )
Jerry Yud9526692022-02-17 14:23:47 +08006590 {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006591 /* and in the unlikely case the above assumption no longer holds
6592 * we are making sure that pk_ec() here does not return a NULL
6593 */
6594 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *pk );
6595 if( ec == NULL )
6596 {
Tom Cosgrove20c11372022-08-24 15:06:13 +01006597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_pk_ec() returned NULL" ) );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006598 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6599 }
Jerry Yud9526692022-02-17 14:23:47 +08006600
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006601 if( mbedtls_ssl_check_curve( ssl, ec->grp.id ) != 0 )
6602 {
6603 ssl->session_negotiate->verify_result |=
6604 MBEDTLS_X509_BADCERT_BAD_KEY;
6605
6606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6607 if( ret == 0 )
6608 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6609 }
Jerry Yud9526692022-02-17 14:23:47 +08006610 }
6611 }
6612#endif /* MBEDTLS_ECP_C */
6613
6614 if( mbedtls_ssl_check_cert_usage( chain,
6615 ciphersuite_info,
6616 ! ssl->conf->endpoint,
6617 &ssl->session_negotiate->verify_result ) != 0 )
6618 {
6619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6620 if( ret == 0 )
6621 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6622 }
6623
6624 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6625 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6626 * with details encoded in the verification flags. All other kinds
6627 * of error codes, including those from the user provided f_vrfy
6628 * functions, are treated as fatal and lead to a failure of
6629 * ssl_parse_certificate even if verification was optional. */
6630 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6631 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6632 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6633 {
6634 ret = 0;
6635 }
6636
6637 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6638 {
6639 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6640 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6641 }
6642
6643 if( ret != 0 )
6644 {
6645 uint8_t alert;
6646
6647 /* The certificate may have been rejected for several reasons.
6648 Pick one and send the corresponding alert. Which alert to send
6649 may be a subject of debate in some cases. */
6650 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6651 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6652 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6653 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6654 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6655 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6656 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6657 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6658 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6659 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6660 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6661 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6662 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6663 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6664 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6665 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6666 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6667 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6668 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6669 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6670 else
6671 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6672 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6673 alert );
6674 }
6675
6676#if defined(MBEDTLS_DEBUG_C)
6677 if( ssl->session_negotiate->verify_result != 0 )
6678 {
6679 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6680 (unsigned int) ssl->session_negotiate->verify_result ) );
6681 }
6682 else
6683 {
6684 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6685 }
6686#endif /* MBEDTLS_DEBUG_C */
6687
6688 return( ret );
6689}
6690
6691#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006692MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006693static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6694 unsigned char *start, size_t len )
6695{
6696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6697 /* Remember digest of the peer's end-CRT. */
6698 ssl->session_negotiate->peer_cert_digest =
6699 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6700 if( ssl->session_negotiate->peer_cert_digest == NULL )
6701 {
6702 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6703 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6704 mbedtls_ssl_send_alert_message( ssl,
6705 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6706 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6707
6708 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6709 }
6710
6711 ret = mbedtls_md( mbedtls_md_info_from_type(
6712 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6713 start, len,
6714 ssl->session_negotiate->peer_cert_digest );
6715
6716 ssl->session_negotiate->peer_cert_digest_type =
6717 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6718 ssl->session_negotiate->peer_cert_digest_len =
6719 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6720
6721 return( ret );
6722}
6723
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006724MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006725static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6726 unsigned char *start, size_t len )
6727{
6728 unsigned char *end = start + len;
6729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6730
6731 /* Make a copy of the peer's raw public key. */
6732 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6733 ret = mbedtls_pk_parse_subpubkey( &start, end,
6734 &ssl->handshake->peer_pubkey );
6735 if( ret != 0 )
6736 {
6737 /* We should have parsed the public key before. */
6738 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6739 }
6740
6741 return( 0 );
6742}
6743#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6744
6745int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6746{
6747 int ret = 0;
6748 int crt_expected;
6749#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6750 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6751 ? ssl->handshake->sni_authmode
6752 : ssl->conf->authmode;
6753#else
6754 const int authmode = ssl->conf->authmode;
6755#endif
6756 void *rs_ctx = NULL;
6757 mbedtls_x509_crt *chain = NULL;
6758
6759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6760
6761 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6762 if( crt_expected == SSL_CERTIFICATE_SKIP )
6763 {
6764 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6765 goto exit;
6766 }
6767
6768#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6769 if( ssl->handshake->ecrs_enabled &&
6770 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6771 {
6772 chain = ssl->handshake->ecrs_peer_cert;
6773 ssl->handshake->ecrs_peer_cert = NULL;
6774 goto crt_verify;
6775 }
6776#endif
6777
6778 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6779 {
6780 /* mbedtls_ssl_read_record may have sent an alert already. We
6781 let it decide whether to alert. */
6782 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6783 goto exit;
6784 }
6785
6786#if defined(MBEDTLS_SSL_SRV_C)
6787 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6788 {
6789 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6790
6791 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6792 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6793
6794 goto exit;
6795 }
6796#endif /* MBEDTLS_SSL_SRV_C */
6797
6798 /* Clear existing peer CRT structure in case we tried to
6799 * reuse a session but it failed, and allocate a new one. */
6800 ssl_clear_peer_cert( ssl->session_negotiate );
6801
6802 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6803 if( chain == NULL )
6804 {
6805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6806 sizeof( mbedtls_x509_crt ) ) );
6807 mbedtls_ssl_send_alert_message( ssl,
6808 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6809 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6810
6811 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6812 goto exit;
6813 }
6814 mbedtls_x509_crt_init( chain );
6815
6816 ret = ssl_parse_certificate_chain( ssl, chain );
6817 if( ret != 0 )
6818 goto exit;
6819
6820#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6821 if( ssl->handshake->ecrs_enabled)
6822 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6823
6824crt_verify:
6825 if( ssl->handshake->ecrs_enabled)
6826 rs_ctx = &ssl->handshake->ecrs_ctx;
6827#endif
6828
6829 ret = ssl_parse_certificate_verify( ssl, authmode,
6830 chain, rs_ctx );
6831 if( ret != 0 )
6832 goto exit;
6833
6834#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6835 {
6836 unsigned char *crt_start, *pk_start;
6837 size_t crt_len, pk_len;
6838
6839 /* We parse the CRT chain without copying, so
6840 * these pointers point into the input buffer,
6841 * and are hence still valid after freeing the
6842 * CRT chain. */
6843
6844 crt_start = chain->raw.p;
6845 crt_len = chain->raw.len;
6846
6847 pk_start = chain->pk_raw.p;
6848 pk_len = chain->pk_raw.len;
6849
6850 /* Free the CRT structures before computing
6851 * digest and copying the peer's public key. */
6852 mbedtls_x509_crt_free( chain );
6853 mbedtls_free( chain );
6854 chain = NULL;
6855
6856 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6857 if( ret != 0 )
6858 goto exit;
6859
6860 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6861 if( ret != 0 )
6862 goto exit;
6863 }
6864#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6865 /* Pass ownership to session structure. */
6866 ssl->session_negotiate->peer_cert = chain;
6867 chain = NULL;
6868#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6869
6870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6871
6872exit:
6873
6874 if( ret == 0 )
6875 ssl->state++;
6876
6877#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6878 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6879 {
6880 ssl->handshake->ecrs_peer_cert = chain;
6881 chain = NULL;
6882 }
6883#endif
6884
6885 if( chain != NULL )
6886 {
6887 mbedtls_x509_crt_free( chain );
6888 mbedtls_free( chain );
6889 }
6890
6891 return( ret );
6892}
6893#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6894
Andrzej Kurek25f27152022-08-17 16:09:31 -04006895#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu615bd6f2022-02-17 14:25:15 +08006896static void ssl_calc_finished_tls_sha256(
6897 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6898{
6899 int len = 12;
6900 const char *sender;
6901 unsigned char padbuf[32];
6902#if defined(MBEDTLS_USE_PSA_CRYPTO)
6903 size_t hash_size;
6904 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6905 psa_status_t status;
6906#else
6907 mbedtls_sha256_context sha256;
6908#endif
6909
6910 mbedtls_ssl_session *session = ssl->session_negotiate;
6911 if( !session )
6912 session = ssl->session;
6913
6914 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6915 ? "client finished"
6916 : "server finished";
6917
6918#if defined(MBEDTLS_USE_PSA_CRYPTO)
6919 sha256_psa = psa_hash_operation_init();
6920
6921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6922
6923 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6924 if( status != PSA_SUCCESS )
6925 {
6926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6927 return;
6928 }
6929
6930 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6931 if( status != PSA_SUCCESS )
6932 {
6933 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6934 return;
6935 }
6936 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6937#else
6938
6939 mbedtls_sha256_init( &sha256 );
6940
6941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6942
6943 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6944
6945 /*
6946 * TLSv1.2:
6947 * hash = PRF( master, finished_label,
6948 * Hash( handshake ) )[0.11]
6949 */
6950
6951#if !defined(MBEDTLS_SHA256_ALT)
6952 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6953 sha256.state, sizeof( sha256.state ) );
6954#endif
6955
6956 mbedtls_sha256_finish( &sha256, padbuf );
6957 mbedtls_sha256_free( &sha256 );
6958#endif /* MBEDTLS_USE_PSA_CRYPTO */
6959
6960 ssl->handshake->tls_prf( session->master, 48, sender,
6961 padbuf, 32, buf, len );
6962
6963 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6964
6965 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6966
6967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6968}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006969#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08006970
Jerry Yub7ba49e2022-02-17 14:25:53 +08006971
Andrzej Kurek25f27152022-08-17 16:09:31 -04006972#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yub7ba49e2022-02-17 14:25:53 +08006973static void ssl_calc_finished_tls_sha384(
6974 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6975{
6976 int len = 12;
6977 const char *sender;
6978 unsigned char padbuf[48];
6979#if defined(MBEDTLS_USE_PSA_CRYPTO)
6980 size_t hash_size;
6981 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6982 psa_status_t status;
6983#else
6984 mbedtls_sha512_context sha512;
6985#endif
6986
6987 mbedtls_ssl_session *session = ssl->session_negotiate;
6988 if( !session )
6989 session = ssl->session;
6990
6991 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6992 ? "client finished"
6993 : "server finished";
6994
6995#if defined(MBEDTLS_USE_PSA_CRYPTO)
6996 sha384_psa = psa_hash_operation_init();
6997
6998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6999
7000 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
7001 if( status != PSA_SUCCESS )
7002 {
7003 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7004 return;
7005 }
7006
7007 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
7008 if( status != PSA_SUCCESS )
7009 {
7010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7011 return;
7012 }
7013 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
7014#else
7015 mbedtls_sha512_init( &sha512 );
7016
7017 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
7018
Andrzej Kureka242e832022-08-11 10:03:14 -04007019 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yub7ba49e2022-02-17 14:25:53 +08007020
7021 /*
7022 * TLSv1.2:
7023 * hash = PRF( master, finished_label,
7024 * Hash( handshake ) )[0.11]
7025 */
7026
7027#if !defined(MBEDTLS_SHA512_ALT)
7028 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
7029 sha512.state, sizeof( sha512.state ) );
7030#endif
7031 mbedtls_sha512_finish( &sha512, padbuf );
7032
7033 mbedtls_sha512_free( &sha512 );
7034#endif
7035
7036 ssl->handshake->tls_prf( session->master, 48, sender,
7037 padbuf, 48, buf, len );
7038
7039 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7040
7041 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7042
7043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7044}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007045#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007046
Jerry Yuaef00152022-02-17 14:27:31 +08007047void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7048{
7049 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7050
7051 /*
7052 * Free our handshake params
7053 */
7054 mbedtls_ssl_handshake_free( ssl );
7055 mbedtls_free( ssl->handshake );
7056 ssl->handshake = NULL;
7057
7058 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007059 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007060 */
7061 if( ssl->transform )
7062 {
7063 mbedtls_ssl_transform_free( ssl->transform );
7064 mbedtls_free( ssl->transform );
7065 }
7066 ssl->transform = ssl->transform_negotiate;
7067 ssl->transform_negotiate = NULL;
7068
7069 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7070}
7071
Jerry Yu2a9fff52022-02-17 14:28:51 +08007072void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7073{
7074 int resume = ssl->handshake->resume;
7075
7076 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7077
7078#if defined(MBEDTLS_SSL_RENEGOTIATION)
7079 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7080 {
7081 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7082 ssl->renego_records_seen = 0;
7083 }
7084#endif
7085
7086 /*
7087 * Free the previous session and switch in the current one
7088 */
7089 if( ssl->session )
7090 {
7091#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7092 /* RFC 7366 3.1: keep the EtM state */
7093 ssl->session_negotiate->encrypt_then_mac =
7094 ssl->session->encrypt_then_mac;
7095#endif
7096
7097 mbedtls_ssl_session_free( ssl->session );
7098 mbedtls_free( ssl->session );
7099 }
7100 ssl->session = ssl->session_negotiate;
7101 ssl->session_negotiate = NULL;
7102
7103 /*
7104 * Add cache entry
7105 */
7106 if( ssl->conf->f_set_cache != NULL &&
7107 ssl->session->id_len != 0 &&
7108 resume == 0 )
7109 {
7110 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7111 ssl->session->id,
7112 ssl->session->id_len,
7113 ssl->session ) != 0 )
7114 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7115 }
7116
7117#if defined(MBEDTLS_SSL_PROTO_DTLS)
7118 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7119 ssl->handshake->flight != NULL )
7120 {
7121 /* Cancel handshake timer */
7122 mbedtls_ssl_set_timer( ssl, 0 );
7123
7124 /* Keep last flight around in case we need to resend it:
7125 * we need the handshake and transform structures for that */
7126 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7127 }
7128 else
7129#endif
7130 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7131
7132 ssl->state++;
7133
7134 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7135}
7136
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007137int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7138{
7139 int ret, hash_len;
7140
7141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7142
7143 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7144
7145 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7146
7147 /*
7148 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7149 * may define some other value. Currently (early 2016), no defined
7150 * ciphersuite does this (and this is unlikely to change as activity has
7151 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7152 */
7153 hash_len = 12;
7154
7155#if defined(MBEDTLS_SSL_RENEGOTIATION)
7156 ssl->verify_data_len = hash_len;
7157 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7158#endif
7159
7160 ssl->out_msglen = 4 + hash_len;
7161 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7162 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7163
7164 /*
7165 * In case of session resuming, invert the client and server
7166 * ChangeCipherSpec messages order.
7167 */
7168 if( ssl->handshake->resume != 0 )
7169 {
7170#if defined(MBEDTLS_SSL_CLI_C)
7171 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7172 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7173#endif
7174#if defined(MBEDTLS_SSL_SRV_C)
7175 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7176 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7177#endif
7178 }
7179 else
7180 ssl->state++;
7181
7182 /*
7183 * Switch to our negotiated transform and session parameters for outbound
7184 * data.
7185 */
7186 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7187
7188#if defined(MBEDTLS_SSL_PROTO_DTLS)
7189 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7190 {
7191 unsigned char i;
7192
7193 /* Remember current epoch settings for resending */
7194 ssl->handshake->alt_transform_out = ssl->transform_out;
7195 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7196 sizeof( ssl->handshake->alt_out_ctr ) );
7197
7198 /* Set sequence_number to zero */
7199 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7200
7201
7202 /* Increment epoch */
7203 for( i = 2; i > 0; i-- )
7204 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7205 break;
7206
7207 /* The loop goes to its end iff the counter is wrapping */
7208 if( i == 0 )
7209 {
7210 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7211 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7212 }
7213 }
7214 else
7215#endif /* MBEDTLS_SSL_PROTO_DTLS */
7216 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7217
7218 ssl->transform_out = ssl->transform_negotiate;
7219 ssl->session_out = ssl->session_negotiate;
7220
7221#if defined(MBEDTLS_SSL_PROTO_DTLS)
7222 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7223 mbedtls_ssl_send_flight_completed( ssl );
7224#endif
7225
7226 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7227 {
7228 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7229 return( ret );
7230 }
7231
7232#if defined(MBEDTLS_SSL_PROTO_DTLS)
7233 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7234 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7235 {
7236 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7237 return( ret );
7238 }
7239#endif
7240
7241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7242
7243 return( 0 );
7244}
7245
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007246#define SSL_MAX_HASH_LEN 12
7247
7248int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7249{
7250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7251 unsigned int hash_len = 12;
7252 unsigned char buf[SSL_MAX_HASH_LEN];
7253
7254 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7255
7256 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7257
7258 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7259 {
7260 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7261 goto exit;
7262 }
7263
7264 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7265 {
7266 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7267 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7268 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7269 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7270 goto exit;
7271 }
7272
7273 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7274 {
7275 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7276 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7277 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7278 goto exit;
7279 }
7280
7281 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7282 {
7283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7284 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7285 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7286 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7287 goto exit;
7288 }
7289
7290 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7291 buf, hash_len ) != 0 )
7292 {
7293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7294 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7295 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7296 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7297 goto exit;
7298 }
7299
7300#if defined(MBEDTLS_SSL_RENEGOTIATION)
7301 ssl->verify_data_len = hash_len;
7302 memcpy( ssl->peer_verify_data, buf, hash_len );
7303#endif
7304
7305 if( ssl->handshake->resume != 0 )
7306 {
7307#if defined(MBEDTLS_SSL_CLI_C)
7308 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7309 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7310#endif
7311#if defined(MBEDTLS_SSL_SRV_C)
7312 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7313 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7314#endif
7315 }
7316 else
7317 ssl->state++;
7318
7319#if defined(MBEDTLS_SSL_PROTO_DTLS)
7320 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7321 mbedtls_ssl_recv_flight_completed( ssl );
7322#endif
7323
7324 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7325
7326exit:
7327 mbedtls_platform_zeroize( buf, hash_len );
7328 return( ret );
7329}
7330
Jerry Yu392112c2022-02-17 14:34:10 +08007331#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7332/*
7333 * Helper to get TLS 1.2 PRF from ciphersuite
7334 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7335 */
7336static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7337{
Andrzej Kurek25f27152022-08-17 16:09:31 -04007338#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu392112c2022-02-17 14:34:10 +08007339 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7340 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7341
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007342 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007343 return( tls_prf_sha384 );
7344#else
7345 (void) ciphersuite_id;
7346#endif
7347 return( tls_prf_sha256 );
7348}
7349#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007350
7351static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7352{
7353 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04007354#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007355 if( tls_prf == tls_prf_sha384 )
7356 {
7357 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7358 }
7359 else
7360#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04007361#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007362 if( tls_prf == tls_prf_sha256 )
7363 {
7364 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7365 }
7366 else
7367#endif
7368 return( MBEDTLS_SSL_TLS_PRF_NONE );
7369}
7370
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007371/*
7372 * Populate a transform structure with session keys and all the other
7373 * necessary information.
7374 *
7375 * Parameters:
7376 * - [in/out]: transform: structure to populate
7377 * [in] must be just initialised with mbedtls_ssl_transform_init()
7378 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7379 * - [in] ciphersuite
7380 * - [in] master
7381 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007382 * - [in] tls_prf: pointer to PRF to use for key derivation
7383 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007384 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007385 * - [in] endpoint: client or server
7386 * - [in] ssl: used for:
7387 * - ssl->conf->{f,p}_export_keys
7388 * [in] optionally used for:
7389 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7390 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007391MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007392static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7393 int ciphersuite,
7394 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007395#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007396 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007397#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007398 ssl_tls_prf_t tls_prf,
7399 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007400 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007401 unsigned endpoint,
7402 const mbedtls_ssl_context *ssl )
7403{
7404 int ret = 0;
7405 unsigned char keyblk[256];
7406 unsigned char *key1;
7407 unsigned char *key2;
7408 unsigned char *mac_enc;
7409 unsigned char *mac_dec;
7410 size_t mac_key_len = 0;
7411 size_t iv_copy_len;
7412 size_t keylen;
7413 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007414 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007415#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007416 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007417 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007418#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007419
7420#if defined(MBEDTLS_USE_PSA_CRYPTO)
7421 psa_key_type_t key_type;
7422 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7423 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007424 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007425 size_t key_bits;
7426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7427#endif
7428
7429#if !defined(MBEDTLS_DEBUG_C) && \
7430 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7431 if( ssl->f_export_keys == NULL )
7432 {
7433 ssl = NULL; /* make sure we don't use it except for these cases */
7434 (void) ssl;
7435 }
7436#endif
7437
7438 /*
7439 * Some data just needs copying into the structure
7440 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007441#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007442 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007443#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007444 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007445
7446#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7447 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7448#endif
7449
7450#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007451 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007452 {
7453 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7454 * generation separate. This should never happen. */
7455 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7456 }
7457#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7458
7459 /*
7460 * Get various info structures
7461 */
7462 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7463 if( ciphersuite_info == NULL )
7464 {
7465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7466 ciphersuite ) );
7467 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7468 }
7469
Neil Armstrongab555e02022-04-04 11:07:59 +02007470 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007471#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007472 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007473#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007474 ciphersuite_info );
7475
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007476 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7477 transform->taglen =
7478 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7479
7480#if defined(MBEDTLS_USE_PSA_CRYPTO)
7481 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7482 transform->taglen,
7483 &alg,
7484 &key_type,
7485 &key_bits ) ) != PSA_SUCCESS )
7486 {
7487 ret = psa_ssl_status_to_mbedtls( status );
7488 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7489 goto end;
7490 }
7491#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007492 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7493 if( cipher_info == NULL )
7494 {
7495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7496 ciphersuite_info->cipher ) );
7497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7498 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007499#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007500
Neil Armstronge4512952022-03-08 09:08:22 +01007501#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007502 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007503 if( mac_alg == 0 )
7504 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007506 (unsigned) ciphersuite_info->mac ) );
7507 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7508 }
7509#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007510 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7511 if( md_info == NULL )
7512 {
7513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7514 (unsigned) ciphersuite_info->mac ) );
7515 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7516 }
Neil Armstronge4512952022-03-08 09:08:22 +01007517#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007518
7519#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7520 /* Copy own and peer's CID if the use of the CID
7521 * extension has been negotiated. */
7522 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7523 {
7524 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7525
7526 transform->in_cid_len = ssl->own_cid_len;
7527 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7528 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7529 transform->in_cid_len );
7530
7531 transform->out_cid_len = ssl->handshake->peer_cid_len;
7532 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7533 ssl->handshake->peer_cid_len );
7534 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7535 transform->out_cid_len );
7536 }
7537#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7538
7539 /*
7540 * Compute key block using the PRF
7541 */
7542 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7543 if( ret != 0 )
7544 {
7545 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7546 return( ret );
7547 }
7548
7549 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7550 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7551 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7552 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7553 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7554
7555 /*
7556 * Determine the appropriate key, IV and MAC length.
7557 */
7558
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007559#if defined(MBEDTLS_USE_PSA_CRYPTO)
7560 keylen = PSA_BITS_TO_BYTES(key_bits);
7561#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007562 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007563#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007564
7565#if defined(MBEDTLS_GCM_C) || \
7566 defined(MBEDTLS_CCM_C) || \
7567 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007568 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007569 {
7570 size_t explicit_ivlen;
7571
7572 transform->maclen = 0;
7573 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007574
7575 /* All modes haves 96-bit IVs, but the length of the static parts vary
7576 * with mode and version:
7577 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7578 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7579 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7580 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7581 * sequence number).
7582 */
7583 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007584#if defined(MBEDTLS_USE_PSA_CRYPTO)
7585 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7586#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007587 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007588#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007589 transform->fixed_ivlen = 12;
7590 else
7591 transform->fixed_ivlen = 4;
7592
7593 /* Minimum length of encrypted record */
7594 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7595 transform->minlen = explicit_ivlen + transform->taglen;
7596 }
7597 else
7598#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7599#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007600 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7601 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7602 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007603 {
Neil Armstronge4512952022-03-08 09:08:22 +01007604#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007605 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007606#else
7607 size_t block_size = cipher_info->block_size;
7608#endif /* MBEDTLS_USE_PSA_CRYPTO */
7609
7610#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007611 /* Get MAC length */
7612 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7613#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007614 /* Initialize HMAC contexts */
7615 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7616 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7617 {
7618 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7619 goto end;
7620 }
7621
7622 /* Get MAC length */
7623 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007624#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007625 transform->maclen = mac_key_len;
7626
7627 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007628#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007629 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007630#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007631 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007632#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007633
7634 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007635 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007636 transform->minlen = transform->maclen;
7637 else
7638 {
7639 /*
7640 * GenericBlockCipher:
7641 * 1. if EtM is in use: one block plus MAC
7642 * otherwise: * first multiple of blocklen greater than maclen
7643 * 2. IV
7644 */
7645#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007646 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007647 {
7648 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007649 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007650 }
7651 else
7652#endif
7653 {
7654 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007655 + block_size
7656 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007657 }
7658
Glenn Strauss07c64162022-03-14 12:34:51 -04007659 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007660 {
7661 transform->minlen += transform->ivlen;
7662 }
7663 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007664 {
7665 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7666 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7667 goto end;
7668 }
7669 }
7670 }
7671 else
7672#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7673 {
7674 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7675 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7676 }
7677
7678 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7679 (unsigned) keylen,
7680 (unsigned) transform->minlen,
7681 (unsigned) transform->ivlen,
7682 (unsigned) transform->maclen ) );
7683
7684 /*
7685 * Finally setup the cipher contexts, IVs and MAC secrets.
7686 */
7687#if defined(MBEDTLS_SSL_CLI_C)
7688 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7689 {
7690 key1 = keyblk + mac_key_len * 2;
7691 key2 = keyblk + mac_key_len * 2 + keylen;
7692
7693 mac_enc = keyblk;
7694 mac_dec = keyblk + mac_key_len;
7695
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007696 iv_copy_len = ( transform->fixed_ivlen ) ?
7697 transform->fixed_ivlen : transform->ivlen;
7698 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7699 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7700 iv_copy_len );
7701 }
7702 else
7703#endif /* MBEDTLS_SSL_CLI_C */
7704#if defined(MBEDTLS_SSL_SRV_C)
7705 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7706 {
7707 key1 = keyblk + mac_key_len * 2 + keylen;
7708 key2 = keyblk + mac_key_len * 2;
7709
7710 mac_enc = keyblk + mac_key_len;
7711 mac_dec = keyblk;
7712
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007713 iv_copy_len = ( transform->fixed_ivlen ) ?
7714 transform->fixed_ivlen : transform->ivlen;
7715 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7716 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7717 iv_copy_len );
7718 }
7719 else
7720#endif /* MBEDTLS_SSL_SRV_C */
7721 {
7722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7723 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7724 goto end;
7725 }
7726
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007727 if( ssl != NULL && ssl->f_export_keys != NULL )
7728 {
7729 ssl->f_export_keys( ssl->p_export_keys,
7730 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7731 master, 48,
7732 randbytes + 32,
7733 randbytes,
7734 tls_prf_get_type( tls_prf ) );
7735 }
7736
7737#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007738 transform->psa_alg = alg;
7739
7740 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7741 {
7742 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7743 psa_set_key_algorithm( &attributes, alg );
7744 psa_set_key_type( &attributes, key_type );
7745
7746 if( ( status = psa_import_key( &attributes,
7747 key1,
7748 PSA_BITS_TO_BYTES( key_bits ),
7749 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7750 {
7751 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7752 ret = psa_ssl_status_to_mbedtls( status );
7753 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7754 goto end;
7755 }
7756
7757 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7758
7759 if( ( status = psa_import_key( &attributes,
7760 key2,
7761 PSA_BITS_TO_BYTES( key_bits ),
7762 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7763 {
7764 ret = psa_ssl_status_to_mbedtls( status );
7765 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7766 goto end;
7767 }
7768 }
7769#else
7770 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7771 cipher_info ) ) != 0 )
7772 {
7773 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7774 goto end;
7775 }
7776
7777 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7778 cipher_info ) ) != 0 )
7779 {
7780 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7781 goto end;
7782 }
7783
7784 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7785 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7786 MBEDTLS_ENCRYPT ) ) != 0 )
7787 {
7788 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7789 goto end;
7790 }
7791
7792 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7793 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7794 MBEDTLS_DECRYPT ) ) != 0 )
7795 {
7796 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7797 goto end;
7798 }
7799
7800#if defined(MBEDTLS_CIPHER_MODE_CBC)
7801 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7802 {
7803 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7804 MBEDTLS_PADDING_NONE ) ) != 0 )
7805 {
7806 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7807 goto end;
7808 }
7809
7810 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7811 MBEDTLS_PADDING_NONE ) ) != 0 )
7812 {
7813 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7814 goto end;
7815 }
7816 }
7817#endif /* MBEDTLS_CIPHER_MODE_CBC */
7818#endif /* MBEDTLS_USE_PSA_CRYPTO */
7819
Neil Armstrong29c0c042022-03-17 17:47:28 +01007820#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7821 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7822 For AEAD-based ciphersuites, there is nothing to do here. */
7823 if( mac_key_len != 0 )
7824 {
7825#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007826 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007827
7828 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007829 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007830 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7831
7832 if( ( status = psa_import_key( &attributes,
7833 mac_enc, mac_key_len,
7834 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7835 {
7836 ret = psa_ssl_status_to_mbedtls( status );
7837 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7838 goto end;
7839 }
7840
Ronald Cronfb39f152022-03-25 14:36:28 +01007841 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007842 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
7843#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
7844 && ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED )
7845#endif
7846 ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007847 /* mbedtls_ct_hmac() requires the key to be exportable */
7848 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7849 PSA_KEY_USAGE_VERIFY_HASH );
7850 else
7851 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7852
7853 if( ( status = psa_import_key( &attributes,
7854 mac_dec, mac_key_len,
7855 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7856 {
7857 ret = psa_ssl_status_to_mbedtls( status );
7858 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7859 goto end;
7860 }
7861#else
7862 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7863 if( ret != 0 )
7864 goto end;
7865 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7866 if( ret != 0 )
7867 goto end;
7868#endif /* MBEDTLS_USE_PSA_CRYPTO */
7869 }
7870#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7871
7872 ((void) mac_dec);
7873 ((void) mac_enc);
7874
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007875end:
7876 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7877 return( ret );
7878}
7879
Jerry Yuee40f9d2022-02-17 14:55:16 +08007880#if defined(MBEDTLS_USE_PSA_CRYPTO)
7881int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7882 unsigned char *hash, size_t *hashlen,
7883 unsigned char *data, size_t data_len,
7884 mbedtls_md_type_t md_alg )
7885{
7886 psa_status_t status;
7887 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007888 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007889
7890 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7891
7892 if( ( status = psa_hash_setup( &hash_operation,
7893 hash_alg ) ) != PSA_SUCCESS )
7894 {
7895 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7896 goto exit;
7897 }
7898
7899 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7900 64 ) ) != PSA_SUCCESS )
7901 {
7902 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7903 goto exit;
7904 }
7905
7906 if( ( status = psa_hash_update( &hash_operation,
7907 data, data_len ) ) != PSA_SUCCESS )
7908 {
7909 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7910 goto exit;
7911 }
7912
7913 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7914 hashlen ) ) != PSA_SUCCESS )
7915 {
7916 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7917 goto exit;
7918 }
7919
7920exit:
7921 if( status != PSA_SUCCESS )
7922 {
7923 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7924 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7925 switch( status )
7926 {
7927 case PSA_ERROR_NOT_SUPPORTED:
7928 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7929 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7930 case PSA_ERROR_BUFFER_TOO_SMALL:
7931 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7932 case PSA_ERROR_INSUFFICIENT_MEMORY:
7933 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7934 default:
7935 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7936 }
7937 }
7938 return( 0 );
7939}
7940
7941#else
7942
7943int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7944 unsigned char *hash, size_t *hashlen,
7945 unsigned char *data, size_t data_len,
7946 mbedtls_md_type_t md_alg )
7947{
7948 int ret = 0;
7949 mbedtls_md_context_t ctx;
7950 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7951 *hashlen = mbedtls_md_get_size( md_info );
7952
7953 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7954
7955 mbedtls_md_init( &ctx );
7956
7957 /*
7958 * digitally-signed struct {
7959 * opaque client_random[32];
7960 * opaque server_random[32];
7961 * ServerDHParams params;
7962 * };
7963 */
7964 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7965 {
7966 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7967 goto exit;
7968 }
7969 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7970 {
7971 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7972 goto exit;
7973 }
7974 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7975 {
7976 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7977 goto exit;
7978 }
7979 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7980 {
7981 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7982 goto exit;
7983 }
7984 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7985 {
7986 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7987 goto exit;
7988 }
7989
7990exit:
7991 mbedtls_md_free( &ctx );
7992
7993 if( ret != 0 )
7994 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7995 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7996
7997 return( ret );
7998}
7999#endif /* MBEDTLS_USE_PSA_CRYPTO */
8000
Jerry Yud9d91da2022-02-17 14:57:06 +08008001#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8002
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008003/* Find the preferred hash for a given signature algorithm. */
8004unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
8005 mbedtls_ssl_context *ssl,
8006 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08008007{
Gabor Mezei078e8032022-04-27 21:17:56 +02008008 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008009 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008010
8011 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008012 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02008013
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008014 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08008015 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008016 unsigned int hash_alg_received =
8017 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8018 received_sig_algs[i] );
8019 unsigned int sig_alg_received =
8020 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8021 received_sig_algs[i] );
8022
8023 if( sig_alg == sig_alg_received )
8024 {
8025#if defined(MBEDTLS_USE_PSA_CRYPTO)
8026 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
8027 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008028 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008029 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008030
Neil Armstrong96eceb82022-06-30 18:05:05 +02008031 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8032 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8033 PSA_ALG_ECDSA( psa_hash_alg ),
8034 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008035 continue;
8036
Neil Armstrong96eceb82022-06-30 18:05:05 +02008037 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008038 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8039 PSA_ALG_RSA_PKCS1V15_SIGN(
8040 psa_hash_alg ),
8041 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008042 continue;
8043 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008044#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008045
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008046 return( hash_alg_received );
8047 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008048 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008049
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008050 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008051}
8052
8053#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8054
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008055/* Serialization of TLS 1.2 sessions:
8056 *
8057 * struct {
8058 * uint64 start_time;
8059 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008060 * uint8 session_id_len; // at most 32
8061 * opaque session_id[32];
8062 * opaque master[48]; // fixed length in the standard
8063 * uint32 verify_result;
8064 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8065 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8066 * uint32 ticket_lifetime;
8067 * uint8 mfl_code; // up to 255 according to standard
8068 * uint8 encrypt_then_mac; // 0 or 1
8069 * } serialized_session_tls12;
8070 *
8071 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008072static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008073 unsigned char *buf,
8074 size_t buf_len )
8075{
8076 unsigned char *p = buf;
8077 size_t used = 0;
8078
8079#if defined(MBEDTLS_HAVE_TIME)
8080 uint64_t start;
8081#endif
8082#if defined(MBEDTLS_X509_CRT_PARSE_C)
8083#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8084 size_t cert_len;
8085#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8086#endif /* MBEDTLS_X509_CRT_PARSE_C */
8087
8088 /*
8089 * Time
8090 */
8091#if defined(MBEDTLS_HAVE_TIME)
8092 used += 8;
8093
8094 if( used <= buf_len )
8095 {
8096 start = (uint64_t) session->start;
8097
8098 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8099 p += 8;
8100 }
8101#endif /* MBEDTLS_HAVE_TIME */
8102
8103 /*
8104 * Basic mandatory fields
8105 */
8106 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008107 + 1 /* id_len */
8108 + sizeof( session->id )
8109 + sizeof( session->master )
8110 + 4; /* verify_result */
8111
8112 if( used <= buf_len )
8113 {
8114 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8115 p += 2;
8116
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008117 *p++ = MBEDTLS_BYTE_0( session->id_len );
8118 memcpy( p, session->id, 32 );
8119 p += 32;
8120
8121 memcpy( p, session->master, 48 );
8122 p += 48;
8123
8124 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8125 p += 4;
8126 }
8127
8128 /*
8129 * Peer's end-entity certificate
8130 */
8131#if defined(MBEDTLS_X509_CRT_PARSE_C)
8132#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8133 if( session->peer_cert == NULL )
8134 cert_len = 0;
8135 else
8136 cert_len = session->peer_cert->raw.len;
8137
8138 used += 3 + cert_len;
8139
8140 if( used <= buf_len )
8141 {
8142 *p++ = MBEDTLS_BYTE_2( cert_len );
8143 *p++ = MBEDTLS_BYTE_1( cert_len );
8144 *p++ = MBEDTLS_BYTE_0( cert_len );
8145
8146 if( session->peer_cert != NULL )
8147 {
8148 memcpy( p, session->peer_cert->raw.p, cert_len );
8149 p += cert_len;
8150 }
8151 }
8152#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8153 if( session->peer_cert_digest != NULL )
8154 {
8155 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8156 if( used <= buf_len )
8157 {
8158 *p++ = (unsigned char) session->peer_cert_digest_type;
8159 *p++ = (unsigned char) session->peer_cert_digest_len;
8160 memcpy( p, session->peer_cert_digest,
8161 session->peer_cert_digest_len );
8162 p += session->peer_cert_digest_len;
8163 }
8164 }
8165 else
8166 {
8167 used += 2;
8168 if( used <= buf_len )
8169 {
8170 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8171 *p++ = 0;
8172 }
8173 }
8174#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8175#endif /* MBEDTLS_X509_CRT_PARSE_C */
8176
8177 /*
8178 * Session ticket if any, plus associated data
8179 */
8180#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8181 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8182
8183 if( used <= buf_len )
8184 {
8185 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8186 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8187 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8188
8189 if( session->ticket != NULL )
8190 {
8191 memcpy( p, session->ticket, session->ticket_len );
8192 p += session->ticket_len;
8193 }
8194
8195 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8196 p += 4;
8197 }
8198#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8199
8200 /*
8201 * Misc extension-related info
8202 */
8203#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8204 used += 1;
8205
8206 if( used <= buf_len )
8207 *p++ = session->mfl_code;
8208#endif
8209
8210#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8211 used += 1;
8212
8213 if( used <= buf_len )
8214 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8215#endif
8216
8217 return( used );
8218}
8219
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008220MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008221static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008222 const unsigned char *buf,
8223 size_t len )
8224{
8225#if defined(MBEDTLS_HAVE_TIME)
8226 uint64_t start;
8227#endif
8228#if defined(MBEDTLS_X509_CRT_PARSE_C)
8229#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8230 size_t cert_len;
8231#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8232#endif /* MBEDTLS_X509_CRT_PARSE_C */
8233
8234 const unsigned char *p = buf;
8235 const unsigned char * const end = buf + len;
8236
8237 /*
8238 * Time
8239 */
8240#if defined(MBEDTLS_HAVE_TIME)
8241 if( 8 > (size_t)( end - p ) )
8242 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8243
8244 start = ( (uint64_t) p[0] << 56 ) |
8245 ( (uint64_t) p[1] << 48 ) |
8246 ( (uint64_t) p[2] << 40 ) |
8247 ( (uint64_t) p[3] << 32 ) |
8248 ( (uint64_t) p[4] << 24 ) |
8249 ( (uint64_t) p[5] << 16 ) |
8250 ( (uint64_t) p[6] << 8 ) |
8251 ( (uint64_t) p[7] );
8252 p += 8;
8253
8254 session->start = (time_t) start;
8255#endif /* MBEDTLS_HAVE_TIME */
8256
8257 /*
8258 * Basic mandatory fields
8259 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008260 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008261 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8262
8263 session->ciphersuite = ( p[0] << 8 ) | p[1];
8264 p += 2;
8265
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008266 session->id_len = *p++;
8267 memcpy( session->id, p, 32 );
8268 p += 32;
8269
8270 memcpy( session->master, p, 48 );
8271 p += 48;
8272
8273 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8274 ( (uint32_t) p[1] << 16 ) |
8275 ( (uint32_t) p[2] << 8 ) |
8276 ( (uint32_t) p[3] );
8277 p += 4;
8278
8279 /* Immediately clear invalid pointer values that have been read, in case
8280 * we exit early before we replaced them with valid ones. */
8281#if defined(MBEDTLS_X509_CRT_PARSE_C)
8282#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8283 session->peer_cert = NULL;
8284#else
8285 session->peer_cert_digest = NULL;
8286#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8287#endif /* MBEDTLS_X509_CRT_PARSE_C */
8288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8289 session->ticket = NULL;
8290#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8291
8292 /*
8293 * Peer certificate
8294 */
8295#if defined(MBEDTLS_X509_CRT_PARSE_C)
8296#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8297 /* Deserialize CRT from the end of the ticket. */
8298 if( 3 > (size_t)( end - p ) )
8299 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8300
8301 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8302 p += 3;
8303
8304 if( cert_len != 0 )
8305 {
8306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8307
8308 if( cert_len > (size_t)( end - p ) )
8309 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8310
8311 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8312
8313 if( session->peer_cert == NULL )
8314 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8315
8316 mbedtls_x509_crt_init( session->peer_cert );
8317
8318 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8319 p, cert_len ) ) != 0 )
8320 {
8321 mbedtls_x509_crt_free( session->peer_cert );
8322 mbedtls_free( session->peer_cert );
8323 session->peer_cert = NULL;
8324 return( ret );
8325 }
8326
8327 p += cert_len;
8328 }
8329#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8330 /* Deserialize CRT digest from the end of the ticket. */
8331 if( 2 > (size_t)( end - p ) )
8332 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8333
8334 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8335 session->peer_cert_digest_len = (size_t) *p++;
8336
8337 if( session->peer_cert_digest_len != 0 )
8338 {
8339 const mbedtls_md_info_t *md_info =
8340 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8341 if( md_info == NULL )
8342 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8343 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8344 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8345
8346 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8347 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8348
8349 session->peer_cert_digest =
8350 mbedtls_calloc( 1, session->peer_cert_digest_len );
8351 if( session->peer_cert_digest == NULL )
8352 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8353
8354 memcpy( session->peer_cert_digest, p,
8355 session->peer_cert_digest_len );
8356 p += session->peer_cert_digest_len;
8357 }
8358#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8359#endif /* MBEDTLS_X509_CRT_PARSE_C */
8360
8361 /*
8362 * Session ticket and associated data
8363 */
8364#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8365 if( 3 > (size_t)( end - p ) )
8366 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8367
8368 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8369 p += 3;
8370
8371 if( session->ticket_len != 0 )
8372 {
8373 if( session->ticket_len > (size_t)( end - p ) )
8374 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8375
8376 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8377 if( session->ticket == NULL )
8378 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8379
8380 memcpy( session->ticket, p, session->ticket_len );
8381 p += session->ticket_len;
8382 }
8383
8384 if( 4 > (size_t)( end - p ) )
8385 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8386
8387 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8388 ( (uint32_t) p[1] << 16 ) |
8389 ( (uint32_t) p[2] << 8 ) |
8390 ( (uint32_t) p[3] );
8391 p += 4;
8392#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8393
8394 /*
8395 * Misc extension-related info
8396 */
8397#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8398 if( 1 > (size_t)( end - p ) )
8399 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8400
8401 session->mfl_code = *p++;
8402#endif
8403
8404#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8405 if( 1 > (size_t)( end - p ) )
8406 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8407
8408 session->encrypt_then_mac = *p++;
8409#endif
8410
8411 /* Done, should have consumed entire buffer */
8412 if( p != end )
8413 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8414
8415 return( 0 );
8416}
Jerry Yudc7bd172022-02-17 13:44:15 +08008417#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8418
XiaokangQian75d40ef2022-04-20 11:05:24 +00008419int mbedtls_ssl_validate_ciphersuite(
8420 const mbedtls_ssl_context *ssl,
8421 const mbedtls_ssl_ciphersuite_t *suite_info,
8422 mbedtls_ssl_protocol_version min_tls_version,
8423 mbedtls_ssl_protocol_version max_tls_version )
8424{
8425 (void) ssl;
8426
8427 if( suite_info == NULL )
8428 return( -1 );
8429
8430 if( ( suite_info->min_tls_version > max_tls_version ) ||
8431 ( suite_info->max_tls_version < min_tls_version ) )
8432 {
8433 return( -1 );
8434 }
8435
XiaokangQian060d8672022-04-21 09:24:56 +00008436#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008437#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8438 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8439 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8440 {
8441 return( -1 );
8442 }
8443#endif
8444
8445 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8446#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8447 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8448 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8449 {
8450 return( -1 );
8451 }
8452#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8454
8455 return( 0 );
8456}
8457
XiaokangQianeaf36512022-04-24 09:07:44 +00008458#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8459/*
8460 * Function for writing a signature algorithm extension.
8461 *
8462 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8463 * value (TLS 1.3 RFC8446):
8464 * enum {
8465 * ....
8466 * ecdsa_secp256r1_sha256( 0x0403 ),
8467 * ecdsa_secp384r1_sha384( 0x0503 ),
8468 * ecdsa_secp521r1_sha512( 0x0603 ),
8469 * ....
8470 * } SignatureScheme;
8471 *
8472 * struct {
8473 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8474 * } SignatureSchemeList;
8475 *
8476 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8477 * value (TLS 1.2 RFC5246):
8478 * enum {
8479 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8480 * sha512(6), (255)
8481 * } HashAlgorithm;
8482 *
8483 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8484 * SignatureAlgorithm;
8485 *
8486 * struct {
8487 * HashAlgorithm hash;
8488 * SignatureAlgorithm signature;
8489 * } SignatureAndHashAlgorithm;
8490 *
8491 * SignatureAndHashAlgorithm
8492 * supported_signature_algorithms<2..2^16-2>;
8493 *
8494 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8495 * generalization of the TLS 1.2 signature algorithm extension.
8496 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8497 * `SignatureScheme` field of TLS 1.3
8498 *
8499 */
8500int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8501 const unsigned char *end, size_t *out_len )
8502{
8503 unsigned char *p = buf;
8504 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8505 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8506
8507 *out_len = 0;
8508
8509 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8510
8511 /* Check if we have space for header and length field:
8512 * - extension_type (2 bytes)
8513 * - extension_data_length (2 bytes)
8514 * - supported_signature_algorithms_length (2 bytes)
8515 */
8516 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8517 p += 6;
8518
8519 /*
8520 * Write supported_signature_algorithms
8521 */
8522 supported_sig_alg = p;
8523 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8524 if( sig_alg == NULL )
8525 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8526
8527 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8528 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008529 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8530 *sig_alg,
8531 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008532 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8533 continue;
8534 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8535 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8536 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008537 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008538 *sig_alg,
8539 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008540 }
8541
8542 /* Length of supported_signature_algorithms */
8543 supported_sig_alg_len = p - supported_sig_alg;
8544 if( supported_sig_alg_len == 0 )
8545 {
8546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8547 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8548 }
8549
XiaokangQianeaf36512022-04-24 09:07:44 +00008550 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008551 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008552 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8553
XiaokangQianeaf36512022-04-24 09:07:44 +00008554 *out_len = p - buf;
8555
8556#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8557 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8558#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8559 return( 0 );
8560}
8561#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8562
XiaokangQian40a35232022-05-07 09:02:40 +00008563#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008564/*
8565 * mbedtls_ssl_parse_server_name_ext
8566 *
8567 * Structure of server_name extension:
8568 *
8569 * enum {
8570 * host_name(0), (255)
8571 * } NameType;
8572 * opaque HostName<1..2^16-1>;
8573 *
8574 * struct {
8575 * NameType name_type;
8576 * select (name_type) {
8577 * case host_name: HostName;
8578 * } name;
8579 * } ServerName;
8580 * struct {
8581 * ServerName server_name_list<1..2^16-1>
8582 * } ServerNameList;
8583 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008584MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008585int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8586 const unsigned char *buf,
8587 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008588{
8589 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8590 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008591 size_t server_name_list_len, hostname_len;
8592 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008593
XiaokangQianf2a94202022-05-20 06:44:24 +00008594 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008595
8596 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008597 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008598 p += 2;
8599
XiaokangQian9b2b7712022-05-17 02:57:00 +00008600 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8601 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008602 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008603 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008604 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008605 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008606 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8607 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008608
8609 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8610 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008611 /* sni_name is intended to be used only during the parsing of the
8612 * ClientHello message (it is reset to NULL before the end of
8613 * the message parsing). Thus it is ok to just point to the
8614 * reception buffer and not make a copy of it.
8615 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008616 ssl->handshake->sni_name = p + 3;
8617 ssl->handshake->sni_name_len = hostname_len;
8618 if( ssl->conf->f_sni == NULL )
8619 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008620 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008621 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008622 if( ret != 0 )
8623 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008624 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008625 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8626 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008627 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8628 }
8629 return( 0 );
8630 }
8631
8632 p += hostname_len + 3;
8633 }
8634
8635 return( 0 );
8636}
8637#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8638
XiaokangQianacb39922022-06-17 10:18:48 +00008639#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008640MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008641int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8642 const unsigned char *buf,
8643 const unsigned char *end )
8644{
8645 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008646 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008647 const unsigned char *protocol_name_list;
8648 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008649 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008650
8651 /* If ALPN not configured, just ignore the extension */
8652 if( ssl->conf->alpn_list == NULL )
8653 return( 0 );
8654
8655 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008656 * RFC7301, section 3.1
8657 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008658 *
XiaokangQianc7403452022-06-23 03:24:12 +00008659 * struct {
8660 * ProtocolName protocol_name_list<2..2^16-1>
8661 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008662 */
8663
XiaokangQianc7403452022-06-23 03:24:12 +00008664 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008665 * protocol_name_list_len 2 bytes
8666 * protocol_name_len 1 bytes
8667 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008668 */
XiaokangQianacb39922022-06-17 10:18:48 +00008669 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8670
XiaokangQianc7403452022-06-23 03:24:12 +00008671 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008672 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008673 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008674 protocol_name_list = p;
8675 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008676
8677 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008678 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008679 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008680 protocol_name_len = *p++;
8681 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8682 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008683 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008684 {
8685 MBEDTLS_SSL_PEND_FATAL_ALERT(
8686 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8687 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008688 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008689 }
8690
8691 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008692 }
8693
8694 /* Use our order of preference */
8695 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8696 {
8697 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008698 p = protocol_name_list;
8699 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008700 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008701 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008702 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008703 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008704 {
8705 ssl->alpn_chosen = *alpn;
8706 return( 0 );
8707 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008708
8709 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008710 }
8711 }
8712
XiaokangQian95d5f542022-06-24 02:29:26 +00008713 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008714 MBEDTLS_SSL_PEND_FATAL_ALERT(
8715 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8716 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8717 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8718}
8719
8720int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8721 unsigned char *buf,
8722 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008723 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008724{
8725 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008726 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008727 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008728
8729 if( ssl->alpn_chosen == NULL )
8730 {
8731 return( 0 );
8732 }
8733
XiaokangQian95d5f542022-06-24 02:29:26 +00008734 protocol_name_len = strlen( ssl->alpn_chosen );
8735 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008736
8737 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8738 /*
8739 * 0 . 1 ext identifier
8740 * 2 . 3 ext length
8741 * 4 . 5 protocol list length
8742 * 6 . 6 protocol name length
8743 * 7 . 7+n protocol name
8744 */
8745 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8746
XiaokangQian95d5f542022-06-24 02:29:26 +00008747 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008748
XiaokangQian95d5f542022-06-24 02:29:26 +00008749 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8750 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008751 /* Note: the length of the chosen protocol has been checked to be less
8752 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8753 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008754 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008755
XiaokangQian95d5f542022-06-24 02:29:26 +00008756 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008757 return ( 0 );
8758}
8759#endif /* MBEDTLS_SSL_ALPN */
8760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008761#endif /* MBEDTLS_SSL_TLS_C */