blob: 435d772fd98c65a10b21a112c5ff30c957f6983b [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
Andrzej Kurek25f27152022-08-17 16:09:31 -040057#include "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();
1697 psa_status_t status;
1698 psa_algorithm_t alg;
1699 mbedtls_svc_key_id_t key;
1700#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)
1711 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1712 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1713 else
1714 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1715
Jerry Yu568ec252022-07-22 21:27:34 +08001716#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1c105562022-07-10 06:32:38 +00001717 psa_set_key_usage_flags( &key_attributes,
1718 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
Jerry Yu568ec252022-07-22 21:27:34 +08001719#else
Neil Armstrong501c9322022-05-03 09:35:09 +02001720 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
Jerry Yu568ec252022-07-22 21:27:34 +08001721#endif
Neil Armstrong501c9322022-05-03 09:35:09 +02001722 psa_set_key_algorithm( &key_attributes, alg );
1723 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1724
1725 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1726 if( status != PSA_SUCCESS )
1727 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1728
1729 /* Allow calling psa_destroy_key() on psk remove */
1730 ssl->handshake->psk_opaque_is_internal = 1;
1731 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1732#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001733 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001734 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001735
1736 ssl->handshake->psk_len = psk_len;
1737 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1738
1739 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001740#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001741}
1742
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001743#if defined(MBEDTLS_USE_PSA_CRYPTO)
1744int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001745 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001746 const unsigned char *psk_identity,
1747 size_t psk_identity_len )
1748{
Janos Follath865b3eb2019-12-16 11:46:15 +00001749 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001750
1751 /* We currently only support one PSK, raw or opaque. */
1752 if( ssl_conf_psk_is_configured( conf ) )
1753 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001754
Hanno Becker7390c712018-11-15 13:33:04 +00001755 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001756 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001758 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001759
1760 /* Check and set PSK Identity */
1761 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1762 psk_identity_len );
1763 if( ret != 0 )
1764 ssl_conf_remove_psk( conf );
1765
1766 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001767}
1768
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001769int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1770 mbedtls_svc_key_id_t psk )
1771{
1772 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1773 ( ssl->handshake == NULL ) )
1774 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1775
1776 ssl_remove_psk( ssl );
1777 ssl->handshake->psk_opaque = psk;
1778 return( 0 );
1779}
1780#endif /* MBEDTLS_USE_PSA_CRYPTO */
1781
1782void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1783 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1784 size_t),
1785 void *p_psk )
1786{
1787 conf->f_psk = f_psk;
1788 conf->p_psk = p_psk;
1789}
1790#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1791
1792#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001793static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1794 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001795{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001796#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001797 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001798 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001799#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001800 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001801 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001802 return( MBEDTLS_SSL_MODE_STREAM );
1803}
1804
1805#else /* MBEDTLS_USE_PSA_CRYPTO */
1806
1807static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1808 mbedtls_cipher_mode_t mode )
1809{
1810#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1811 if( mode == MBEDTLS_MODE_CBC )
1812 return( MBEDTLS_SSL_MODE_CBC );
1813#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1814
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001815#if defined(MBEDTLS_GCM_C) || \
1816 defined(MBEDTLS_CCM_C) || \
1817 defined(MBEDTLS_CHACHAPOLY_C)
1818 if( mode == MBEDTLS_MODE_GCM ||
1819 mode == MBEDTLS_MODE_CCM ||
1820 mode == MBEDTLS_MODE_CHACHAPOLY )
1821 return( MBEDTLS_SSL_MODE_AEAD );
1822#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001823
1824 return( MBEDTLS_SSL_MODE_STREAM );
1825}
Gilles Peskine301711e2022-04-26 16:57:05 +02001826#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001827
Gilles Peskinee108d982022-04-26 16:50:40 +02001828static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1829 mbedtls_ssl_mode_t base_mode,
1830 int encrypt_then_mac )
1831{
1832#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1833 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1834 base_mode == MBEDTLS_SSL_MODE_CBC )
1835 {
1836 return( MBEDTLS_SSL_MODE_CBC_ETM );
1837 }
1838#else
1839 (void) encrypt_then_mac;
1840#endif
1841 return( base_mode );
1842}
1843
Neil Armstrongab555e02022-04-04 11:07:59 +02001844mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001845 const mbedtls_ssl_transform *transform )
1846{
Gilles Peskinee108d982022-04-26 16:50:40 +02001847 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001848#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001849 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001850#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001851 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1852#endif
1853 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001854
Gilles Peskinee108d982022-04-26 16:50:40 +02001855 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001856#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001857 encrypt_then_mac = transform->encrypt_then_mac;
1858#endif
1859 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001860}
1861
Neil Armstrongab555e02022-04-04 11:07:59 +02001862mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001863#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001864 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001865#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001866 const mbedtls_ssl_ciphersuite_t *suite )
1867{
Gilles Peskinee108d982022-04-26 16:50:40 +02001868 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1869
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001870#if defined(MBEDTLS_USE_PSA_CRYPTO)
1871 psa_status_t status;
1872 psa_algorithm_t alg;
1873 psa_key_type_t type;
1874 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001875 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1876 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001877 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001878#else
1879 const mbedtls_cipher_info_t *cipher =
1880 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001881 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001882 {
1883 base_mode =
1884 mbedtls_ssl_get_base_mode(
1885 mbedtls_cipher_info_get_mode( cipher ) );
1886 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001887#endif /* MBEDTLS_USE_PSA_CRYPTO */
1888
Gilles Peskinee108d982022-04-26 16:50:40 +02001889#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1890 int encrypt_then_mac = 0;
1891#endif
1892 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001893}
1894
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001895#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001896
1897#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00001898/* Serialization of TLS 1.3 sessions:
1899 *
1900 * struct {
1901 * uint64 ticket_received;
1902 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08001903 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00001904 * } ClientOnlyData;
1905 *
1906 * struct {
1907 * uint8 endpoint;
1908 * uint8 ciphersuite[2];
1909 * uint32 ticket_age_add;
1910 * uint8 ticket_flags;
1911 * opaque resumption_key<0..255>;
1912 * select ( endpoint ) {
1913 * case client: ClientOnlyData;
1914 * case server: uint64 start_time;
1915 * };
1916 * } serialized_session_tls13;
1917 *
1918 */
1919#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08001920MBEDTLS_CHECK_RETURN_CRITICAL
1921static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
1922 unsigned char *buf,
1923 size_t buf_len,
1924 size_t *olen )
Jerry Yu438ddd82022-07-07 06:55:50 +00001925{
1926 unsigned char *p = buf;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001927 size_t needed = 1 /* endpoint */
1928 + 2 /* ciphersuite */
1929 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08001930 + 1 /* ticket_flags */
1931 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08001932 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08001933
1934 if( session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN )
1935 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1936 needed += session->resumption_key_len; /* resumption_key */
1937
Jerry Yu438ddd82022-07-07 06:55:50 +00001938#if defined(MBEDTLS_HAVE_TIME)
1939 needed += 8; /* start_time or ticket_received */
1940#endif
1941
1942#if defined(MBEDTLS_SSL_CLI_C)
1943 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1944 {
1945 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08001946 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08001947
1948 /* Check size_t overflow */
Jerry Yue36fdd62022-08-17 21:31:36 +08001949 if( session->ticket_len > SIZE_MAX - needed )
1950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu34191072022-08-18 10:32:09 +08001951
Jerry Yue28d9742022-08-18 15:44:03 +08001952 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00001953 }
1954#endif /* MBEDTLS_SSL_CLI_C */
1955
Jerry Yue36fdd62022-08-17 21:31:36 +08001956 *olen = needed;
Jerry Yu438ddd82022-07-07 06:55:50 +00001957 if( needed > buf_len )
Jerry Yue36fdd62022-08-17 21:31:36 +08001958 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Jerry Yu438ddd82022-07-07 06:55:50 +00001959
1960 p[0] = session->endpoint;
1961 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
1962 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
1963 p[7] = session->ticket_flags;
1964
1965 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08001966 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001967 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001968 memcpy( p, session->resumption_key, session->resumption_key_len );
1969 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001970
1971#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
1972 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
1973 {
1974 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
1975 p += 8;
1976 }
1977#endif /* MBEDTLS_HAVE_TIME */
1978
1979#if defined(MBEDTLS_SSL_CLI_C)
1980 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1981 {
1982#if defined(MBEDTLS_HAVE_TIME)
1983 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
1984 p += 8;
1985#endif
1986 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
1987 p += 4;
1988
1989 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
1990 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08001991
1992 if( session->ticket != NULL && session->ticket_len > 0 )
Jerry Yu438ddd82022-07-07 06:55:50 +00001993 {
1994 memcpy( p, session->ticket, session->ticket_len );
1995 p += session->ticket_len;
1996 }
1997 }
1998#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yue36fdd62022-08-17 21:31:36 +08001999 return( 0 );
Jerry Yu438ddd82022-07-07 06:55:50 +00002000}
2001
2002MBEDTLS_CHECK_RETURN_CRITICAL
2003static int ssl_tls13_session_load( mbedtls_ssl_session *session,
2004 const unsigned char *buf,
2005 size_t len )
2006{
2007 const unsigned char *p = buf;
2008 const unsigned char *end = buf + len;
2009
2010 if( end - p < 9 )
2011 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2012 session->endpoint = p[0];
2013 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2014 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2015 session->ticket_flags = p[7];
2016
2017 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002018 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002019 p += 9;
2020
Jerry Yubc7c1a42022-07-21 22:57:37 +08002021 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002022 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2023
Jerry Yubc7c1a42022-07-21 22:57:37 +08002024 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002025 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002026 memcpy( session->resumption_key, p, session->resumption_key_len );
2027 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002028
2029#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2030 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2031 {
2032 if( end - p < 8 )
2033 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2034 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2035 p += 8;
2036 }
2037#endif /* MBEDTLS_HAVE_TIME */
2038
2039#if defined(MBEDTLS_SSL_CLI_C)
2040 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2041 {
2042#if defined(MBEDTLS_HAVE_TIME)
2043 if( end - p < 8 )
2044 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2045 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2046 p += 8;
2047#endif
2048 if( end - p < 4 )
2049 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2050 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2051 p += 4;
2052
2053 if( end - p < 2 )
2054 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2055 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2056 p += 2;
2057
2058 if( end - p < ( long int )session->ticket_len )
2059 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2060 if( session->ticket_len > 0 )
2061 {
2062 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2063 if( session->ticket == NULL )
2064 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2065 memcpy( session->ticket, p, session->ticket_len );
2066 p += session->ticket_len;
2067 }
2068 }
2069#endif /* MBEDTLS_SSL_CLI_C */
2070
2071 return( 0 );
2072
2073}
2074#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002075MBEDTLS_CHECK_RETURN_CRITICAL
2076static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2077 unsigned char *buf,
2078 size_t buf_len,
2079 size_t *olen )
Jerry Yu251a12e2022-07-13 15:15:48 +08002080{
2081 ((void) session);
2082 ((void) buf);
2083 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002084 *olen = 0;
2085 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu251a12e2022-07-13 15:15:48 +08002086}
Jerry Yu438ddd82022-07-07 06:55:50 +00002087
2088static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2089 unsigned char *buf,
2090 size_t buf_len )
2091{
2092 ((void) session);
2093 ((void) buf);
2094 ((void) buf_len);
2095 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2096}
2097#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002098#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2099
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002100psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002101 size_t taglen,
2102 psa_algorithm_t *alg,
2103 psa_key_type_t *key_type,
2104 size_t *key_size )
2105{
2106 switch ( mbedtls_cipher_type )
2107 {
2108 case MBEDTLS_CIPHER_AES_128_CBC:
2109 *alg = PSA_ALG_CBC_NO_PADDING;
2110 *key_type = PSA_KEY_TYPE_AES;
2111 *key_size = 128;
2112 break;
2113 case MBEDTLS_CIPHER_AES_128_CCM:
2114 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2115 *key_type = PSA_KEY_TYPE_AES;
2116 *key_size = 128;
2117 break;
2118 case MBEDTLS_CIPHER_AES_128_GCM:
2119 *alg = PSA_ALG_GCM;
2120 *key_type = PSA_KEY_TYPE_AES;
2121 *key_size = 128;
2122 break;
2123 case MBEDTLS_CIPHER_AES_192_CCM:
2124 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2125 *key_type = PSA_KEY_TYPE_AES;
2126 *key_size = 192;
2127 break;
2128 case MBEDTLS_CIPHER_AES_192_GCM:
2129 *alg = PSA_ALG_GCM;
2130 *key_type = PSA_KEY_TYPE_AES;
2131 *key_size = 192;
2132 break;
2133 case MBEDTLS_CIPHER_AES_256_CBC:
2134 *alg = PSA_ALG_CBC_NO_PADDING;
2135 *key_type = PSA_KEY_TYPE_AES;
2136 *key_size = 256;
2137 break;
2138 case MBEDTLS_CIPHER_AES_256_CCM:
2139 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2140 *key_type = PSA_KEY_TYPE_AES;
2141 *key_size = 256;
2142 break;
2143 case MBEDTLS_CIPHER_AES_256_GCM:
2144 *alg = PSA_ALG_GCM;
2145 *key_type = PSA_KEY_TYPE_AES;
2146 *key_size = 256;
2147 break;
2148 case MBEDTLS_CIPHER_ARIA_128_CBC:
2149 *alg = PSA_ALG_CBC_NO_PADDING;
2150 *key_type = PSA_KEY_TYPE_ARIA;
2151 *key_size = 128;
2152 break;
2153 case MBEDTLS_CIPHER_ARIA_128_CCM:
2154 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2155 *key_type = PSA_KEY_TYPE_ARIA;
2156 *key_size = 128;
2157 break;
2158 case MBEDTLS_CIPHER_ARIA_128_GCM:
2159 *alg = PSA_ALG_GCM;
2160 *key_type = PSA_KEY_TYPE_ARIA;
2161 *key_size = 128;
2162 break;
2163 case MBEDTLS_CIPHER_ARIA_192_CCM:
2164 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2165 *key_type = PSA_KEY_TYPE_ARIA;
2166 *key_size = 192;
2167 break;
2168 case MBEDTLS_CIPHER_ARIA_192_GCM:
2169 *alg = PSA_ALG_GCM;
2170 *key_type = PSA_KEY_TYPE_ARIA;
2171 *key_size = 192;
2172 break;
2173 case MBEDTLS_CIPHER_ARIA_256_CBC:
2174 *alg = PSA_ALG_CBC_NO_PADDING;
2175 *key_type = PSA_KEY_TYPE_ARIA;
2176 *key_size = 256;
2177 break;
2178 case MBEDTLS_CIPHER_ARIA_256_CCM:
2179 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2180 *key_type = PSA_KEY_TYPE_ARIA;
2181 *key_size = 256;
2182 break;
2183 case MBEDTLS_CIPHER_ARIA_256_GCM:
2184 *alg = PSA_ALG_GCM;
2185 *key_type = PSA_KEY_TYPE_ARIA;
2186 *key_size = 256;
2187 break;
2188 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2189 *alg = PSA_ALG_CBC_NO_PADDING;
2190 *key_type = PSA_KEY_TYPE_CAMELLIA;
2191 *key_size = 128;
2192 break;
2193 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2194 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2195 *key_type = PSA_KEY_TYPE_CAMELLIA;
2196 *key_size = 128;
2197 break;
2198 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2199 *alg = PSA_ALG_GCM;
2200 *key_type = PSA_KEY_TYPE_CAMELLIA;
2201 *key_size = 128;
2202 break;
2203 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2204 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2205 *key_type = PSA_KEY_TYPE_CAMELLIA;
2206 *key_size = 192;
2207 break;
2208 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2209 *alg = PSA_ALG_GCM;
2210 *key_type = PSA_KEY_TYPE_CAMELLIA;
2211 *key_size = 192;
2212 break;
2213 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2214 *alg = PSA_ALG_CBC_NO_PADDING;
2215 *key_type = PSA_KEY_TYPE_CAMELLIA;
2216 *key_size = 256;
2217 break;
2218 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2219 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2220 *key_type = PSA_KEY_TYPE_CAMELLIA;
2221 *key_size = 256;
2222 break;
2223 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2224 *alg = PSA_ALG_GCM;
2225 *key_type = PSA_KEY_TYPE_CAMELLIA;
2226 *key_size = 256;
2227 break;
2228 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2229 *alg = PSA_ALG_CHACHA20_POLY1305;
2230 *key_type = PSA_KEY_TYPE_CHACHA20;
2231 *key_size = 256;
2232 break;
2233 case MBEDTLS_CIPHER_NULL:
2234 *alg = MBEDTLS_SSL_NULL_CIPHER;
2235 *key_type = 0;
2236 *key_size = 0;
2237 break;
2238 default:
2239 return PSA_ERROR_NOT_SUPPORTED;
2240 }
2241
2242 return PSA_SUCCESS;
2243}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002244#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002245
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002246#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002247int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2248 const unsigned char *dhm_P, size_t P_len,
2249 const unsigned char *dhm_G, size_t G_len )
2250{
Janos Follath865b3eb2019-12-16 11:46:15 +00002251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002252
Glenn Strausscee11292021-12-20 01:43:17 -05002253 mbedtls_mpi_free( &conf->dhm_P );
2254 mbedtls_mpi_free( &conf->dhm_G );
2255
Hanno Beckera90658f2017-10-04 15:29:08 +01002256 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2257 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2258 {
2259 mbedtls_mpi_free( &conf->dhm_P );
2260 mbedtls_mpi_free( &conf->dhm_G );
2261 return( ret );
2262 }
2263
2264 return( 0 );
2265}
Paul Bakker5121ce52009-01-03 21:22:43 +00002266
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002267int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002268{
Janos Follath865b3eb2019-12-16 11:46:15 +00002269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002270
Glenn Strausscee11292021-12-20 01:43:17 -05002271 mbedtls_mpi_free( &conf->dhm_P );
2272 mbedtls_mpi_free( &conf->dhm_G );
2273
Gilles Peskinee5702482021-06-11 21:59:08 +02002274 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2275 &conf->dhm_P ) ) != 0 ||
2276 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2277 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002278 {
2279 mbedtls_mpi_free( &conf->dhm_P );
2280 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002281 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002282 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002283
2284 return( 0 );
2285}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002286#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002287
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002288#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2289/*
2290 * Set the minimum length for Diffie-Hellman parameters
2291 */
2292void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2293 unsigned int bitlen )
2294{
2295 conf->dhm_min_bitlen = bitlen;
2296}
2297#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2298
Gilles Peskineeccd8882020-03-10 12:19:08 +01002299#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002300#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002301/*
2302 * Set allowed/preferred hashes for handshake signatures
2303 */
2304void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2305 const int *hashes )
2306{
2307 conf->sig_hashes = hashes;
2308}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002309#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002310
Jerry Yuf017ee42022-01-12 15:49:48 +08002311/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002312void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2313 const uint16_t* sig_algs )
2314{
Jerry Yuf017ee42022-01-12 15:49:48 +08002315#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2316 conf->sig_hashes = NULL;
2317#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2318 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002319}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002320#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002321
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002322#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002323#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002324/*
2325 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002326 *
2327 * mbedtls_ssl_setup() takes the provided list
2328 * and translates it to a list of IANA TLS group identifiers,
2329 * stored in ssl->handshake->group_list.
2330 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002331 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002332void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002333 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002334{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002335 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002336 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002337}
Brett Warrene0edc842021-08-17 09:53:13 +01002338#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002339#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002340
Brett Warrene0edc842021-08-17 09:53:13 +01002341/*
2342 * Set the allowed groups
2343 */
2344void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2345 const uint16_t *group_list )
2346{
2347#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2348 conf->curve_list = NULL;
2349#endif
2350 conf->group_list = group_list;
2351}
2352
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002353#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002355{
Hanno Becker947194e2017-04-07 13:25:49 +01002356 /* Initialize to suppress unnecessary compiler warning */
2357 size_t hostname_len = 0;
2358
2359 /* Check if new hostname is valid before
2360 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002361 if( hostname != NULL )
2362 {
2363 hostname_len = strlen( hostname );
2364
2365 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2366 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2367 }
2368
2369 /* Now it's clear that we will overwrite the old hostname,
2370 * so we can free it safely */
2371
2372 if( ssl->hostname != NULL )
2373 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002374 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002375 mbedtls_free( ssl->hostname );
2376 }
2377
2378 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002379
Paul Bakker5121ce52009-01-03 21:22:43 +00002380 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002381 {
2382 ssl->hostname = NULL;
2383 }
2384 else
2385 {
2386 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002387 if( ssl->hostname == NULL )
2388 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002389
Hanno Becker947194e2017-04-07 13:25:49 +01002390 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002391
Hanno Becker947194e2017-04-07 13:25:49 +01002392 ssl->hostname[hostname_len] = '\0';
2393 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002394
2395 return( 0 );
2396}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002397#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002398
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002399#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002400void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002402 const unsigned char *, size_t),
2403 void *p_sni )
2404{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002405 conf->f_sni = f_sni;
2406 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002407}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002411int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002412{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002413 size_t cur_len, tot_len;
2414 const char **p;
2415
2416 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002417 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2418 * MUST NOT be truncated."
2419 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002420 */
2421 tot_len = 0;
2422 for( p = protos; *p != NULL; p++ )
2423 {
2424 cur_len = strlen( *p );
2425 tot_len += cur_len;
2426
Ronald Cron8216dd32020-04-23 16:41:44 +02002427 if( ( cur_len == 0 ) ||
2428 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2429 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002431 }
2432
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002433 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002434
2435 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002436}
2437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002439{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002440 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002441}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002443
Johan Pascalb62bb512015-12-03 21:56:45 +01002444#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002445void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2446 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002447{
2448 conf->dtls_srtp_mki_support = support_mki_value;
2449}
2450
Ron Eldoref72faf2018-07-12 11:54:20 +03002451int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2452 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002453 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002454{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002455 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002456 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002457 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002458 }
Ron Eldor591f1622018-01-22 12:30:04 +02002459
2460 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002461 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002462 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002463 }
Ron Eldor591f1622018-01-22 12:30:04 +02002464
2465 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2466 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002467 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002468}
2469
Ron Eldoref72faf2018-07-12 11:54:20 +03002470int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002471 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002472{
Johan Pascal253d0262020-09-22 13:04:45 +02002473 const mbedtls_ssl_srtp_profile *p;
2474 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002475
Johan Pascal253d0262020-09-22 13:04:45 +02002476 /* check the profiles list: all entry must be valid,
2477 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002478 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2479 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2480 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002481 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002482 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002483 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002484 list_size++;
2485 }
2486 else
2487 {
2488 /* unsupported value, stop parsing and set the size to an error value */
2489 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002490 }
2491 }
2492
Johan Pascal5ef72d22020-10-28 17:05:47 +01002493 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002494 {
Johan Pascal253d0262020-09-22 13:04:45 +02002495 conf->dtls_srtp_profile_list = NULL;
2496 conf->dtls_srtp_profile_list_len = 0;
2497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2498 }
2499
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002500 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002501 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002502
2503 return( 0 );
2504}
2505
Johan Pascal5ef72d22020-10-28 17:05:47 +01002506void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2507 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002508{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002509 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2510 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002511 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002512 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002513 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002514 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002515 else
2516 {
2517 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002518 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2519 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002520 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002521}
Johan Pascalb62bb512015-12-03 21:56:45 +01002522#endif /* MBEDTLS_SSL_DTLS_SRTP */
2523
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302524#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002525void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002526{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002527 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002528}
2529
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002530void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002531{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002532 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002533}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302534#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002535
Janos Follath088ce432017-04-10 12:42:31 +01002536#if defined(MBEDTLS_SSL_SRV_C)
2537void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2538 char cert_req_ca_list )
2539{
2540 conf->cert_req_ca_list = cert_req_ca_list;
2541}
2542#endif
2543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002545void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002546{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002547 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002548}
2549#endif
2550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002552void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002553{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002554 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002555}
2556#endif
2557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002559int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002560{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002562 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002565 }
2566
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002567 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002568
2569 return( 0 );
2570}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002572
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002573void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002574{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002575 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002576}
2577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002579void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002580{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002581 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002582}
2583
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002584void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002585{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002586 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002587}
2588
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002589void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002590 const unsigned char period[8] )
2591{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002592 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002593}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002597#if defined(MBEDTLS_SSL_CLI_C)
2598void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002599{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002600 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002601}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002602#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002603
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002604#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002605void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2606 mbedtls_ssl_ticket_write_t *f_ticket_write,
2607 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2608 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002609{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002610 conf->f_ticket_write = f_ticket_write;
2611 conf->f_ticket_parse = f_ticket_parse;
2612 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002613}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002614#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002616
Hanno Becker7e6c1782021-06-08 09:24:55 +01002617void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2618 mbedtls_ssl_export_keys_t *f_export_keys,
2619 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002620{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002621 ssl->f_export_keys = f_export_keys;
2622 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002623}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002624
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002625#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002626void mbedtls_ssl_conf_async_private_cb(
2627 mbedtls_ssl_config *conf,
2628 mbedtls_ssl_async_sign_t *f_async_sign,
2629 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2630 mbedtls_ssl_async_resume_t *f_async_resume,
2631 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002632 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002633{
2634 conf->f_async_sign_start = f_async_sign;
2635 conf->f_async_decrypt_start = f_async_decrypt;
2636 conf->f_async_resume = f_async_resume;
2637 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002638 conf->p_async_config_data = async_config_data;
2639}
2640
Gilles Peskine8f97af72018-04-26 11:46:10 +02002641void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2642{
2643 return( conf->p_async_config_data );
2644}
2645
Gilles Peskine1febfef2018-04-30 11:54:39 +02002646void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002647{
2648 if( ssl->handshake == NULL )
2649 return( NULL );
2650 else
2651 return( ssl->handshake->user_async_ctx );
2652}
2653
Gilles Peskine1febfef2018-04-30 11:54:39 +02002654void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002655 void *ctx )
2656{
2657 if( ssl->handshake != NULL )
2658 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002659}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002660#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002661
Paul Bakker5121ce52009-01-03 21:22:43 +00002662/*
2663 * SSL get accessors
2664 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002665uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002666{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002667 if( ssl->session != NULL )
2668 return( ssl->session->verify_result );
2669
2670 if( ssl->session_negotiate != NULL )
2671 return( ssl->session_negotiate->verify_result );
2672
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002673 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002674}
2675
Glenn Strauss8f526902022-01-13 00:04:49 -05002676int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2677{
2678 if( ssl == NULL || ssl->session == NULL )
2679 return( 0 );
2680
2681 return( ssl->session->ciphersuite );
2682}
2683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002685{
Paul Bakker926c8e42013-03-06 10:23:34 +01002686 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002687 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002690}
2691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002693{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002695 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002696 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002697 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002698 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002699 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002700 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002701 default:
2702 return( "unknown (DTLS)" );
2703 }
2704 }
2705#endif
2706
Glenn Strauss60bfe602022-03-14 19:04:24 -04002707 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002708 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002709 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002710 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002711 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002712 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002713 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002714 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002715 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002716}
2717
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002718#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002719size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2720{
David Horstmann95d516f2021-05-04 18:36:56 +01002721 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002722 size_t read_mfl;
2723
2724 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2725 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2726 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2727 {
2728 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2729 }
2730
2731 /* Check if a smaller max length was negotiated */
2732 if( ssl->session_out != NULL )
2733 {
2734 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2735 if( read_mfl < max_len )
2736 {
2737 max_len = read_mfl;
2738 }
2739 }
2740
2741 // During a handshake, use the value being negotiated
2742 if( ssl->session_negotiate != NULL )
2743 {
2744 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2745 if( read_mfl < max_len )
2746 {
2747 max_len = read_mfl;
2748 }
2749 }
2750
2751 return( max_len );
2752}
2753
2754size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002755{
2756 size_t max_len;
2757
2758 /*
2759 * Assume mfl_code is correct since it was checked when set
2760 */
Angus Grattond8213d02016-05-25 20:56:48 +10002761 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002762
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002763 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002764 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002765 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002766 {
Angus Grattond8213d02016-05-25 20:56:48 +10002767 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002768 }
2769
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002770 /* During a handshake, use the value being negotiated */
2771 if( ssl->session_negotiate != NULL &&
2772 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2773 {
2774 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2775 }
2776
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002777 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002778}
2779#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2780
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002781#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002782size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002783{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002784 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2785 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2786 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2787 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2788 return ( 0 );
2789
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002790 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2791 return( ssl->mtu );
2792
2793 if( ssl->mtu == 0 )
2794 return( ssl->handshake->mtu );
2795
2796 return( ssl->mtu < ssl->handshake->mtu ?
2797 ssl->mtu : ssl->handshake->mtu );
2798}
2799#endif /* MBEDTLS_SSL_PROTO_DTLS */
2800
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002801int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2802{
2803 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2804
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002805#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2806 !defined(MBEDTLS_SSL_PROTO_DTLS)
2807 (void) ssl;
2808#endif
2809
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002810#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002811 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002812
2813 if( max_len > mfl )
2814 max_len = mfl;
2815#endif
2816
2817#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002818 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002819 {
Hanno Becker89490712020-02-05 10:50:12 +00002820 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002821 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2822 const size_t overhead = (size_t) ret;
2823
2824 if( ret < 0 )
2825 return( ret );
2826
2827 if( mtu <= overhead )
2828 {
2829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2830 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2831 }
2832
2833 if( max_len > mtu - overhead )
2834 max_len = mtu - overhead;
2835 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002836#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002837
Hanno Becker0defedb2018-08-10 12:35:02 +01002838#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2839 !defined(MBEDTLS_SSL_PROTO_DTLS)
2840 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002841#endif
2842
2843 return( (int) max_len );
2844}
2845
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002846int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2847{
2848 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2849
2850#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2851 (void) ssl;
2852#endif
2853
2854#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2855 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2856
2857 if( max_len > mfl )
2858 max_len = mfl;
2859#endif
2860
2861 return( (int) max_len );
2862}
2863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864#if defined(MBEDTLS_X509_CRT_PARSE_C)
2865const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002866{
2867 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002868 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002869
Hanno Beckere6824572019-02-07 13:18:46 +00002870#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002871 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002872#else
2873 return( NULL );
2874#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002875}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002879int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2880 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002881{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002882 int ret;
2883
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002884 if( ssl == NULL ||
2885 dst == NULL ||
2886 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002887 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002888 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002890 }
2891
Hanno Beckere810bbc2021-05-14 16:01:05 +01002892 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2893 * idempotent: Each session can only be exported once.
2894 *
2895 * (This is in preparation for TLS 1.3 support where we will
2896 * need the ability to export multiple sessions (aka tickets),
2897 * which will be achieved by calling mbedtls_ssl_get_session()
2898 * multiple times until it fails.)
2899 *
2900 * Check whether we have already exported the current session,
2901 * and fail if so.
2902 */
2903 if( ssl->session->exported == 1 )
2904 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2905
2906 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2907 if( ret != 0 )
2908 return( ret );
2909
2910 /* Remember that we've exported the session. */
2911 ssl->session->exported = 1;
2912 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002913}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002915
Paul Bakker5121ce52009-01-03 21:22:43 +00002916/*
Hanno Beckera835da52019-05-16 12:39:07 +01002917 * Define ticket header determining Mbed TLS version
2918 * and structure of the ticket.
2919 */
2920
Hanno Becker94ef3b32019-05-16 12:50:45 +01002921/*
Hanno Becker50b59662019-05-28 14:30:45 +01002922 * Define bitflag determining compile-time settings influencing
2923 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002924 */
2925
Hanno Becker50b59662019-05-28 14:30:45 +01002926#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002927#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002928#else
Hanno Becker3e088662019-05-29 11:10:18 +01002929#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002930#endif /* MBEDTLS_HAVE_TIME */
2931
2932#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002933#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002934#else
Hanno Becker3e088662019-05-29 11:10:18 +01002935#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002936#endif /* MBEDTLS_X509_CRT_PARSE_C */
2937
2938#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002939#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002940#else
Hanno Becker3e088662019-05-29 11:10:18 +01002941#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002942#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2943
2944#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002945#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002946#else
Hanno Becker3e088662019-05-29 11:10:18 +01002947#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002948#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2949
Hanno Becker94ef3b32019-05-16 12:50:45 +01002950#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002951#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002952#else
Hanno Becker3e088662019-05-29 11:10:18 +01002953#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002954#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2955
Hanno Becker94ef3b32019-05-16 12:50:45 +01002956#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2957#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2958#else
2959#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2960#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2961
Hanno Becker3e088662019-05-29 11:10:18 +01002962#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2963#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2964#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2965#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002966#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2967#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002968
Hanno Becker50b59662019-05-28 14:30:45 +01002969#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002970 ( (uint16_t) ( \
2971 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2972 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2973 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2974 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002975 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002976 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002977
Hanno Beckerf8787072019-05-16 12:41:07 +01002978static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002979 MBEDTLS_VERSION_MAJOR,
2980 MBEDTLS_VERSION_MINOR,
2981 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002982 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2983 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002984};
Hanno Beckera835da52019-05-16 12:39:07 +01002985
2986/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002987 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002988 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002989 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002990 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002991 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002992 * opaque mbedtls_version[3]; // library version: major, minor, patch
2993 * opaque session_format[2]; // library-version specific 16-bit field
2994 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002995 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002996 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002997 * Note: When updating the format, remember to keep
2998 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002999 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003000 * // In this version, `session_format` determines
3001 * // the setting of those compile-time
3002 * // configuration options which influence
3003 * // the structure of mbedtls_ssl_session.
3004 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003005 * uint8_t minor_ver; // Protocol minor version. Possible values:
3006 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003007 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003008 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003009 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003010 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003011 * serialized_session_tls12 data;
3012 *
3013 * };
3014 *
3015 * } serialized_session;
3016 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003017 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003018
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003019MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003020static int ssl_session_save( const mbedtls_ssl_session *session,
3021 unsigned char omit_header,
3022 unsigned char *buf,
3023 size_t buf_len,
3024 size_t *olen )
3025{
3026 unsigned char *p = buf;
3027 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003028 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003029#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3030 size_t out_len;
3031 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3032#endif
Jerry Yu438ddd82022-07-07 06:55:50 +00003033 if( session == NULL )
3034 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3035
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003036 if( !omit_header )
3037 {
3038 /*
3039 * Add Mbed TLS version identifier
3040 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003041 used += sizeof( ssl_serialized_session_header );
3042
3043 if( used <= buf_len )
3044 {
3045 memcpy( p, ssl_serialized_session_header,
3046 sizeof( ssl_serialized_session_header ) );
3047 p += sizeof( ssl_serialized_session_header );
3048 }
3049 }
3050
3051 /*
3052 * TLS version identifier
3053 */
3054 used += 1;
3055 if( used <= buf_len )
3056 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003057 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003058 }
3059
3060 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003061 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003062 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003063 {
3064#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003065 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003066 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003067 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3069
Jerry Yu251a12e2022-07-13 15:15:48 +08003070#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3071 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yue36fdd62022-08-17 21:31:36 +08003072 ret = ssl_tls13_session_save( session, p, remaining_len, &out_len );
3073 if( ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
Jerry Yue36fdd62022-08-17 21:31:36 +08003074 return( ret );
Jerry Yue36fdd62022-08-17 21:31:36 +08003075 used += out_len;
Jerry Yu251a12e2022-07-13 15:15:48 +08003076 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003077#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3078
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003079 default:
3080 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3081 }
3082
3083 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003084 if( used > buf_len )
3085 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003086
3087 return( 0 );
3088}
3089
3090/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003091 * Public wrapper for ssl_session_save()
3092 */
3093int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3094 unsigned char *buf,
3095 size_t buf_len,
3096 size_t *olen )
3097{
3098 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3099}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003100
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003101/*
3102 * Deserialize session, see mbedtls_ssl_session_save() for format.
3103 *
3104 * This internal version is wrapped by a public function that cleans up in
3105 * case of error, and has an extra option omit_header.
3106 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003107MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003108static int ssl_session_load( mbedtls_ssl_session *session,
3109 unsigned char omit_header,
3110 const unsigned char *buf,
3111 size_t len )
3112{
3113 const unsigned char *p = buf;
3114 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003115 size_t remaining_len;
3116
3117
3118 if( session == NULL )
3119 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003120
3121 if( !omit_header )
3122 {
3123 /*
3124 * Check Mbed TLS version identifier
3125 */
3126
3127 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3128 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3129
3130 if( memcmp( p, ssl_serialized_session_header,
3131 sizeof( ssl_serialized_session_header ) ) != 0 )
3132 {
3133 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3134 }
3135 p += sizeof( ssl_serialized_session_header );
3136 }
3137
3138 /*
3139 * TLS version identifier
3140 */
3141 if( 1 > (size_t)( end - p ) )
3142 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003143 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003144
3145 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003146 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003147 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003148 {
3149#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003150 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003151 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003152#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3153
Jerry Yu438ddd82022-07-07 06:55:50 +00003154#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3155 case MBEDTLS_SSL_VERSION_TLS1_3:
3156 return( ssl_tls13_session_load( session, p, remaining_len ) );
3157#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3158
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003159 default:
3160 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3161 }
3162}
3163
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003164/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003165 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003166 */
3167int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3168 const unsigned char *buf,
3169 size_t len )
3170{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003171 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003172
3173 if( ret != 0 )
3174 mbedtls_ssl_session_free( session );
3175
3176 return( ret );
3177}
3178
3179/*
Paul Bakker1961b702013-01-25 14:49:24 +01003180 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003181 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003182MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003183static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3184{
3185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3186
Ronald Cron66dbf912022-02-02 15:33:46 +01003187 /*
3188 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003189 * that were written into the output buffer by the previous handshake step,
3190 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003191 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3192 * We proceed to the next handshake step only when all data from the
3193 * previous one have been sent to the peer, thus we make sure that this is
3194 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3195 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3196 * we have to wait before to go ahead.
3197 * In the case of TLS 1.3, handshake step handlers do not send data to the
3198 * peer. Data are only sent here and through
3199 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003200 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003201 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003202 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3203 return( ret );
3204
3205#if defined(MBEDTLS_SSL_PROTO_DTLS)
3206 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3207 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3208 {
3209 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3210 return( ret );
3211 }
3212#endif /* MBEDTLS_SSL_PROTO_DTLS */
3213
3214 return( ret );
3215}
3216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003218{
Hanno Becker41934dd2021-08-07 19:13:43 +01003219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003220
Hanno Becker41934dd2021-08-07 19:13:43 +01003221 if( ssl == NULL ||
3222 ssl->conf == NULL ||
3223 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003224 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003225 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003226 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003227 }
3228
3229 ret = ssl_prepare_handshake_step( ssl );
3230 if( ret != 0 )
3231 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003232
Jerry Yue7047812021-09-13 19:26:39 +08003233 ret = mbedtls_ssl_handle_pending_alert( ssl );
3234 if( ret != 0 )
3235 goto cleanup;
3236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003238 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003239 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003240 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3241 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003242
Ronald Cron9f0fba32022-02-10 16:45:15 +01003243 switch( ssl->state )
3244 {
3245 case MBEDTLS_SSL_HELLO_REQUEST:
3246 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3247 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003248
Ronald Cron9f0fba32022-02-10 16:45:15 +01003249 case MBEDTLS_SSL_CLIENT_HELLO:
3250 ret = mbedtls_ssl_write_client_hello( ssl );
3251 break;
3252
3253 default:
3254#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003255 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003256 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3257 else
3258 ret = mbedtls_ssl_handshake_client_step( ssl );
3259#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3260 ret = mbedtls_ssl_handshake_client_step( ssl );
3261#else
3262 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3263#endif
3264 }
Jerry Yub9930e72021-08-06 17:11:51 +08003265 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003266#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003267#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003268 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003269 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003270#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003271 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003272 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003273#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003274
3275#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3276 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3277 ret = mbedtls_ssl_handshake_server_step( ssl );
3278#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3279 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003280#endif
3281
Jerry Yue7047812021-09-13 19:26:39 +08003282 if( ret != 0 )
3283 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003284 /* handshake_step return error. And it is same
3285 * with alert_reason.
3286 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003287 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003288 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003289 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003290 goto cleanup;
3291 }
3292 }
3293
3294cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003295 return( ret );
3296}
3297
3298/*
3299 * Perform the SSL handshake
3300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003302{
3303 int ret = 0;
3304
Hanno Beckera817ea42020-10-20 15:20:23 +01003305 /* Sanity checks */
3306
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003307 if( ssl == NULL || ssl->conf == NULL )
3308 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3309
Hanno Beckera817ea42020-10-20 15:20:23 +01003310#if defined(MBEDTLS_SSL_PROTO_DTLS)
3311 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3312 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3313 {
3314 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3315 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3316 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3317 }
3318#endif /* MBEDTLS_SSL_PROTO_DTLS */
3319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003321
Hanno Beckera817ea42020-10-20 15:20:23 +01003322 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003323 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003324 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003326
3327 if( ret != 0 )
3328 break;
3329 }
3330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003332
3333 return( ret );
3334}
3335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336#if defined(MBEDTLS_SSL_RENEGOTIATION)
3337#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003338/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003339 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003340 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003341MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003343{
Janos Follath865b3eb2019-12-16 11:46:15 +00003344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003347
3348 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3350 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003351
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003352 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003353 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003354 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003355 return( ret );
3356 }
3357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003359
3360 return( 0 );
3361}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003363
3364/*
3365 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * - any side: calling mbedtls_ssl_renegotiate(),
3367 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3368 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003369 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003370 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003372 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003373int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003374{
Janos Follath865b3eb2019-12-16 11:46:15 +00003375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003378
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003379 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3380 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003381
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003382 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3383 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003385 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003387 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003388 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003389 ssl->handshake->out_msg_seq = 1;
3390 else
3391 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003392 }
3393#endif
3394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3396 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003397
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003399 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003401 return( ret );
3402 }
3403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003405
3406 return( 0 );
3407}
3408
3409/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003410 * Renegotiate current connection on client,
3411 * or request renegotiation on server
3412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003414{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003416
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003417 if( ssl == NULL || ssl->conf == NULL )
3418 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3419
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003421 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003422 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003423 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003424 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003426
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003428
3429 /* Did we already try/start sending HelloRequest? */
3430 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003432
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003433 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003434 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003438 /*
3439 * On client, either start the renegotiation process or,
3440 * if already in progress, continue the handshake
3441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003443 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003444 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003446
Hanno Becker40cdaa12020-02-05 10:48:27 +00003447 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003448 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003449 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003450 return( ret );
3451 }
3452 }
3453 else
3454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003458 return( ret );
3459 }
3460 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003462
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003463 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003464}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003466
Gilles Peskine9b562d52018-04-25 20:32:43 +02003467void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003468{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003469 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3470
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003471 if( handshake == NULL )
3472 return;
3473
Brett Warrene0edc842021-08-17 09:53:13 +01003474#if defined(MBEDTLS_ECP_C)
3475#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3476 if ( ssl->handshake->group_list_heap_allocated )
3477 mbedtls_free( (void*) handshake->group_list );
3478 handshake->group_list = NULL;
3479#endif /* MBEDTLS_DEPRECATED_REMOVED */
3480#endif /* MBEDTLS_ECP_C */
3481
Jerry Yuf017ee42022-01-12 15:49:48 +08003482#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3483#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3484 if ( ssl->handshake->sig_algs_heap_allocated )
3485 mbedtls_free( (void*) handshake->sig_algs );
3486 handshake->sig_algs = NULL;
3487#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003488#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3489 if( ssl->handshake->certificate_request_context )
3490 {
3491 mbedtls_free( (void*) handshake->certificate_request_context );
3492 }
3493#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003494#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3495
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003496#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3497 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3498 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003499 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003500 handshake->async_in_progress = 0;
3501 }
3502#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3503
Andrzej Kurek25f27152022-08-17 16:09:31 -04003504#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003505#if defined(MBEDTLS_USE_PSA_CRYPTO)
3506 psa_hash_abort( &handshake->fin_sha256_psa );
3507#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003508 mbedtls_sha256_free( &handshake->fin_sha256 );
3509#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003510#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04003511#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003512#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003513 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003514#else
Andrzej Kureka242e832022-08-11 10:03:14 -04003515 mbedtls_sha512_free( &handshake->fin_sha384 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003516#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003517#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519#if defined(MBEDTLS_DHM_C)
3520 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003521#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003522#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003524#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003525#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003526 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003527#if defined(MBEDTLS_SSL_CLI_C)
3528 mbedtls_free( handshake->ecjpake_cache );
3529 handshake->ecjpake_cache = NULL;
3530 handshake->ecjpake_cache_len = 0;
3531#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003532#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003533
Janos Follath4ae5c292016-02-10 11:27:43 +00003534#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3535 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003536 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003538#endif
3539
Gilles Peskineeccd8882020-03-10 12:19:08 +01003540#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003541#if defined(MBEDTLS_USE_PSA_CRYPTO)
3542 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3543 {
3544 /* The maintenance of the external PSK key slot is the
3545 * user's responsibility. */
3546 if( ssl->handshake->psk_opaque_is_internal )
3547 {
3548 psa_destroy_key( ssl->handshake->psk_opaque );
3549 ssl->handshake->psk_opaque_is_internal = 0;
3550 }
3551 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3552 }
Neil Armstronge952a302022-05-03 10:22:14 +02003553#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003554 if( handshake->psk != NULL )
3555 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003556 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003557 mbedtls_free( handshake->psk );
3558 }
Neil Armstronge952a302022-05-03 10:22:14 +02003559#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003560#endif
3561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3563 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003564 /*
3565 * Free only the linked list wrapper, not the keys themselves
3566 * since the belong to the SNI callback
3567 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003568 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003570
Gilles Peskineeccd8882020-03-10 12:19:08 +01003571#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003572 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003573 if( handshake->ecrs_peer_cert != NULL )
3574 {
3575 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3576 mbedtls_free( handshake->ecrs_peer_cert );
3577 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003578#endif
3579
Hanno Becker75173122019-02-06 16:18:31 +00003580#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3581 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3582 mbedtls_pk_free( &handshake->peer_pubkey );
3583#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3584
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003585#if defined(MBEDTLS_SSL_CLI_C) && \
3586 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3587 mbedtls_free( handshake->cookie );
3588#endif /* MBEDTLS_SSL_CLI_C &&
3589 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003590
3591#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003592 mbedtls_ssl_flight_free( handshake->flight );
3593 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003594#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003595
Ronald Cronf12b81d2022-03-15 10:42:41 +01003596#if defined(MBEDTLS_ECDH_C) && \
3597 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003598 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003599 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003600#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3601
Ronald Cron6f135e12021-12-08 16:57:54 +01003602#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003603 mbedtls_ssl_transform_free( handshake->transform_handshake );
3604 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003605 mbedtls_free( handshake->transform_earlydata );
3606 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003607#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003608
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003609
3610#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3611 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3612 * processes datagrams and the fact that a datagram is allowed to have
3613 * several records in it, it is possible that the I/O buffers are not
3614 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003615 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3616 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003617#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003618
Jerry Yuba9c7272021-10-30 11:54:10 +08003619 /* mbedtls_platform_zeroize MUST be last one in this function */
3620 mbedtls_platform_zeroize( handshake,
3621 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003622}
3623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003625{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003626 if( session == NULL )
3627 return;
3628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003630 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003631#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003632
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003633#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003635#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003636
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003637 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003638}
3639
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003640#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003641
3642#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3643#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3644#else
3645#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3647
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003648#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003649
3650#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3651#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3652#else
3653#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3654#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3655
3656#if defined(MBEDTLS_SSL_ALPN)
3657#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3658#else
3659#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3660#endif /* MBEDTLS_SSL_ALPN */
3661
3662#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3663#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3664#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3665#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3666
3667#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3668 ( (uint32_t) ( \
3669 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3670 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3671 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3672 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3673 0u ) )
3674
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003675static unsigned char ssl_serialized_context_header[] = {
3676 MBEDTLS_VERSION_MAJOR,
3677 MBEDTLS_VERSION_MINOR,
3678 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003679 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3680 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3681 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3682 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3683 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003684};
3685
Paul Bakker5121ce52009-01-03 21:22:43 +00003686/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003687 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003688 *
3689 * The format of the serialized data is:
3690 * (in the presentation language of TLS, RFC 8446 section 3)
3691 *
3692 * // header
3693 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003694 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003695 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003696 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003697 * Note: When updating the format, remember to keep these
3698 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003699 *
3700 * // session sub-structure
3701 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3702 * // transform sub-structure
3703 * uint8 random[64]; // ServerHello.random+ClientHello.random
3704 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3705 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3706 * // fields from ssl_context
3707 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3708 * uint64 in_window_top; // DTLS: last validated record seq_num
3709 * uint64 in_window; // DTLS: bitmask for replay protection
3710 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3711 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3712 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3713 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3714 *
3715 * Note that many fields of the ssl_context or sub-structures are not
3716 * serialized, as they fall in one of the following categories:
3717 *
3718 * 1. forced value (eg in_left must be 0)
3719 * 2. pointer to dynamically-allocated memory (eg session, transform)
3720 * 3. value can be re-derived from other data (eg session keys from MS)
3721 * 4. value was temporary (eg content of input buffer)
3722 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003723 */
3724int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3725 unsigned char *buf,
3726 size_t buf_len,
3727 size_t *olen )
3728{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003729 unsigned char *p = buf;
3730 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003731 size_t session_len;
3732 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003733
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003734 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003735 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3736 * this function's documentation.
3737 *
3738 * These are due to assumptions/limitations in the implementation. Some of
3739 * them are likely to stay (no handshake in progress) some might go away
3740 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003741 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003742 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003743 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003744 {
3745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003746 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003747 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003748 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003749 {
3750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003751 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003752 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003753 /* Double-check that sub-structures are indeed ready */
3754 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003755 {
3756 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003758 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003759 /* There must be no pending incoming or outgoing data */
3760 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003761 {
3762 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003763 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003764 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003765 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003766 {
3767 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003768 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003769 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003770 /* Protocol must be DLTS, not TLS */
3771 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003772 {
3773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003774 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003775 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003776 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003777 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003778 {
3779 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003780 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003781 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003782 /* We must be using an AEAD ciphersuite */
3783 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003784 {
3785 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003786 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003787 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003788 /* Renegotiation must not be enabled */
3789#if defined(MBEDTLS_SSL_RENEGOTIATION)
3790 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003791 {
3792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003793 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003794 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003795#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003796
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003797 /*
3798 * Version and format identifier
3799 */
3800 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003801
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003802 if( used <= buf_len )
3803 {
3804 memcpy( p, ssl_serialized_context_header,
3805 sizeof( ssl_serialized_context_header ) );
3806 p += sizeof( ssl_serialized_context_header );
3807 }
3808
3809 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003810 * Session (length + data)
3811 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003812 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003813 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3814 return( ret );
3815
3816 used += 4 + session_len;
3817 if( used <= buf_len )
3818 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003819 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3820 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003821
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003822 ret = ssl_session_save( ssl->session, 1,
3823 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003824 if( ret != 0 )
3825 return( ret );
3826
3827 p += session_len;
3828 }
3829
3830 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003831 * Transform
3832 */
3833 used += sizeof( ssl->transform->randbytes );
3834 if( used <= buf_len )
3835 {
3836 memcpy( p, ssl->transform->randbytes,
3837 sizeof( ssl->transform->randbytes ) );
3838 p += sizeof( ssl->transform->randbytes );
3839 }
3840
3841#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3842 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3843 if( used <= buf_len )
3844 {
3845 *p++ = ssl->transform->in_cid_len;
3846 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3847 p += ssl->transform->in_cid_len;
3848
3849 *p++ = ssl->transform->out_cid_len;
3850 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3851 p += ssl->transform->out_cid_len;
3852 }
3853#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3854
3855 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003856 * Saved fields from top-level ssl_context structure
3857 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003858 used += 4;
3859 if( used <= buf_len )
3860 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003861 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3862 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003863 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003864
3865#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3866 used += 16;
3867 if( used <= buf_len )
3868 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003869 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3870 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003871
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003872 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3873 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003874 }
3875#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3876
3877#if defined(MBEDTLS_SSL_PROTO_DTLS)
3878 used += 1;
3879 if( used <= buf_len )
3880 {
3881 *p++ = ssl->disable_datagram_packing;
3882 }
3883#endif /* MBEDTLS_SSL_PROTO_DTLS */
3884
Jerry Yuae0b2e22021-10-08 15:21:19 +08003885 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003886 if( used <= buf_len )
3887 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003888 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3889 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003890 }
3891
3892#if defined(MBEDTLS_SSL_PROTO_DTLS)
3893 used += 2;
3894 if( used <= buf_len )
3895 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003896 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3897 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003898 }
3899#endif /* MBEDTLS_SSL_PROTO_DTLS */
3900
3901#if defined(MBEDTLS_SSL_ALPN)
3902 {
3903 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003904 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003905 : 0;
3906
3907 used += 1 + alpn_len;
3908 if( used <= buf_len )
3909 {
3910 *p++ = alpn_len;
3911
3912 if( ssl->alpn_chosen != NULL )
3913 {
3914 memcpy( p, ssl->alpn_chosen, alpn_len );
3915 p += alpn_len;
3916 }
3917 }
3918 }
3919#endif /* MBEDTLS_SSL_ALPN */
3920
3921 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003922 * Done
3923 */
3924 *olen = used;
3925
3926 if( used > buf_len )
3927 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003928
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003929 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3930
Hanno Becker43aefe22020-02-05 10:44:56 +00003931 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003932}
3933
3934/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003935 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003936 *
3937 * This internal version is wrapped by a public function that cleans up in
3938 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003939 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003940MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003941static int ssl_context_load( mbedtls_ssl_context *ssl,
3942 const unsigned char *buf,
3943 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003944{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003945 const unsigned char *p = buf;
3946 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003947 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003948 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003949
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003950 /*
3951 * The context should have been freshly setup or reset.
3952 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003953 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003954 * renegotiating, or if the user mistakenly loaded a session first.)
3955 */
3956 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3957 ssl->session != NULL )
3958 {
3959 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3960 }
3961
3962 /*
3963 * We can't check that the config matches the initial one, but we can at
3964 * least check it matches the requirements for serializing.
3965 */
3966 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003967 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3968 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003969#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003970 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003971#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003972 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003973 {
3974 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3975 }
3976
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003977 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3978
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003979 /*
3980 * Check version identifier
3981 */
3982 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3983 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3984
3985 if( memcmp( p, ssl_serialized_context_header,
3986 sizeof( ssl_serialized_context_header ) ) != 0 )
3987 {
3988 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3989 }
3990 p += sizeof( ssl_serialized_context_header );
3991
3992 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003993 * Session
3994 */
3995 if( (size_t)( end - p ) < 4 )
3996 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3997
3998 session_len = ( (size_t) p[0] << 24 ) |
3999 ( (size_t) p[1] << 16 ) |
4000 ( (size_t) p[2] << 8 ) |
4001 ( (size_t) p[3] );
4002 p += 4;
4003
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004004 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004005 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004006 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004007 ssl->session_in = ssl->session;
4008 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004009 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004010
4011 if( (size_t)( end - p ) < session_len )
4012 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4013
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004014 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004015 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004016 {
4017 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004018 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004019 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004020
4021 p += session_len;
4022
4023 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004024 * Transform
4025 */
4026
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004027 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004028 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004029 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004030 ssl->transform_in = ssl->transform;
4031 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004032 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004033
4034 /* Read random bytes and populate structure */
4035 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4036 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004037#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004038 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004039 ssl->session->ciphersuite,
4040 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004041#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004042 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004043#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004044 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4045 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004046 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004047 ssl->conf->endpoint,
4048 ssl );
4049 if( ret != 0 )
4050 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004051#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004052 p += sizeof( ssl->transform->randbytes );
4053
4054#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4055 /* Read connection IDs and store them */
4056 if( (size_t)( end - p ) < 1 )
4057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4058
4059 ssl->transform->in_cid_len = *p++;
4060
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004061 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004062 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4063
4064 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4065 p += ssl->transform->in_cid_len;
4066
4067 ssl->transform->out_cid_len = *p++;
4068
4069 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4070 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4071
4072 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4073 p += ssl->transform->out_cid_len;
4074#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4075
4076 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004077 * Saved fields from top-level ssl_context structure
4078 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004079 if( (size_t)( end - p ) < 4 )
4080 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4081
4082 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4083 ( (uint32_t) p[1] << 16 ) |
4084 ( (uint32_t) p[2] << 8 ) |
4085 ( (uint32_t) p[3] );
4086 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004087
4088#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4089 if( (size_t)( end - p ) < 16 )
4090 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4091
4092 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4093 ( (uint64_t) p[1] << 48 ) |
4094 ( (uint64_t) p[2] << 40 ) |
4095 ( (uint64_t) p[3] << 32 ) |
4096 ( (uint64_t) p[4] << 24 ) |
4097 ( (uint64_t) p[5] << 16 ) |
4098 ( (uint64_t) p[6] << 8 ) |
4099 ( (uint64_t) p[7] );
4100 p += 8;
4101
4102 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4103 ( (uint64_t) p[1] << 48 ) |
4104 ( (uint64_t) p[2] << 40 ) |
4105 ( (uint64_t) p[3] << 32 ) |
4106 ( (uint64_t) p[4] << 24 ) |
4107 ( (uint64_t) p[5] << 16 ) |
4108 ( (uint64_t) p[6] << 8 ) |
4109 ( (uint64_t) p[7] );
4110 p += 8;
4111#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4112
4113#if defined(MBEDTLS_SSL_PROTO_DTLS)
4114 if( (size_t)( end - p ) < 1 )
4115 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4116
4117 ssl->disable_datagram_packing = *p++;
4118#endif /* MBEDTLS_SSL_PROTO_DTLS */
4119
Jerry Yud9a94fe2021-09-28 18:58:59 +08004120 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004121 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004122 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4123 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004124
4125#if defined(MBEDTLS_SSL_PROTO_DTLS)
4126 if( (size_t)( end - p ) < 2 )
4127 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4128
4129 ssl->mtu = ( p[0] << 8 ) | p[1];
4130 p += 2;
4131#endif /* MBEDTLS_SSL_PROTO_DTLS */
4132
4133#if defined(MBEDTLS_SSL_ALPN)
4134 {
4135 uint8_t alpn_len;
4136 const char **cur;
4137
4138 if( (size_t)( end - p ) < 1 )
4139 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4140
4141 alpn_len = *p++;
4142
4143 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4144 {
4145 /* alpn_chosen should point to an item in the configured list */
4146 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4147 {
4148 if( strlen( *cur ) == alpn_len &&
4149 memcmp( p, cur, alpn_len ) == 0 )
4150 {
4151 ssl->alpn_chosen = *cur;
4152 break;
4153 }
4154 }
4155 }
4156
4157 /* can only happen on conf mismatch */
4158 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4159 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4160
4161 p += alpn_len;
4162 }
4163#endif /* MBEDTLS_SSL_ALPN */
4164
4165 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004166 * Forced fields from top-level ssl_context structure
4167 *
4168 * Most of them already set to the correct value by mbedtls_ssl_init() and
4169 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4170 */
4171 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004172 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004173
Hanno Becker361b10d2019-08-30 10:42:49 +01004174 /* Adjust pointers for header fields of outgoing records to
4175 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004176 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004177
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004178#if defined(MBEDTLS_SSL_PROTO_DTLS)
4179 ssl->in_epoch = 1;
4180#endif
4181
4182 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4183 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004184 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4185 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004186 if( ssl->handshake != NULL )
4187 {
4188 mbedtls_ssl_handshake_free( ssl );
4189 mbedtls_free( ssl->handshake );
4190 ssl->handshake = NULL;
4191 }
4192
4193 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004194 * Done - should have consumed entire buffer
4195 */
4196 if( p != end )
4197 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004198
4199 return( 0 );
4200}
4201
4202/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004203 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004204 */
4205int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4206 const unsigned char *buf,
4207 size_t len )
4208{
4209 int ret = ssl_context_load( context, buf, len );
4210
4211 if( ret != 0 )
4212 mbedtls_ssl_free( context );
4213
4214 return( ret );
4215}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004216#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004217
4218/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004219 * Free an SSL context
4220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004221void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004222{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004223 if( ssl == NULL )
4224 return;
4225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004226 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004227
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004228 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004229 {
sander-visserb8aa2072020-05-06 22:05:13 +02004230#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4231 size_t out_buf_len = ssl->out_buf_len;
4232#else
4233 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4234#endif
4235
Darryl Greenb33cc762019-11-28 14:29:44 +00004236 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004237 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004238 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004239 }
4240
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004241 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004242 {
sander-visserb8aa2072020-05-06 22:05:13 +02004243#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4244 size_t in_buf_len = ssl->in_buf_len;
4245#else
4246 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4247#endif
4248
Darryl Greenb33cc762019-11-28 14:29:44 +00004249 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004250 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004251 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004252 }
4253
Paul Bakker48916f92012-09-16 19:57:18 +00004254 if( ssl->transform )
4255 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004256 mbedtls_ssl_transform_free( ssl->transform );
4257 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004258 }
4259
4260 if( ssl->handshake )
4261 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004262 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004263 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4264 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004265
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004266 mbedtls_free( ssl->handshake );
4267 mbedtls_free( ssl->transform_negotiate );
4268 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004269 }
4270
Ronald Cron6f135e12021-12-08 16:57:54 +01004271#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004272 mbedtls_ssl_transform_free( ssl->transform_application );
4273 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004274#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004275
Paul Bakkerc0463502013-02-14 11:19:38 +01004276 if( ssl->session )
4277 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004278 mbedtls_ssl_session_free( ssl->session );
4279 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004280 }
4281
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004282#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004283 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004284 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004285 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004286 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004287 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004288#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004289
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004290#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004291 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004292#endif
4293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004294 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004295
Paul Bakker86f04f42013-02-14 11:20:09 +01004296 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004297 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004298}
4299
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004300/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004301 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004302 */
4303void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4304{
4305 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4306}
4307
Gilles Peskineae270bf2021-06-02 00:05:29 +02004308/* The selection should be the same as mbedtls_x509_crt_profile_default in
4309 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004310 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004311 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004312 * about this list.
4313 */
Brett Warrene0edc842021-08-17 09:53:13 +01004314static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004315#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004316 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004317#endif
4318#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004319 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004320#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004321#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004322 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004323#endif
4324#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004325 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004326#endif
4327#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004328 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004329#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004330#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004331 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004332#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004333#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004334 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004335#endif
4336#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004337 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004338#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004339 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004340};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004341
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004342static int ssl_preset_suiteb_ciphersuites[] = {
4343 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4344 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4345 0
4346};
4347
Gilles Peskineeccd8882020-03-10 12:19:08 +01004348#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004349
Jerry Yu909df7b2022-01-22 11:56:27 +08004350/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004351 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004352 * rules SHOULD be upheld.
4353 * - No duplicate entries.
4354 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004355 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004356 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004357 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004358static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004359
Andrzej Kurek25f27152022-08-17 16:09:31 -04004360#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 +08004361 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4362 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004363#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004364 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004365
Andrzej Kurek25f27152022-08-17 16:09:31 -04004366#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 +08004367 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4368 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004369#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004370 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4371
Andrzej Kurek25f27152022-08-17 16:09:31 -04004372#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 +08004373 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4374 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004375#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004376 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004377
Andrzej Kurek25f27152022-08-17 16:09:31 -04004378#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 +08004379 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004380#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 +08004381
Andrzej Kurek25f27152022-08-17 16:09:31 -04004382#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 +08004383 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004384#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 +08004385
Andrzej Kurek25f27152022-08-17 16:09:31 -04004386#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 +08004387 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004388#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 +08004389
Andrzej Kurek25f27152022-08-17 16:09:31 -04004390#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 +08004391 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4392#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4393
Andrzej Kurek25f27152022-08-17 16:09:31 -04004394#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 +08004395 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4396#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4397
Andrzej Kurek25f27152022-08-17 16:09:31 -04004398#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 +08004399 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4400#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4401
Gabor Mezei15b95a62022-05-09 16:37:58 +02004402 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004403};
4404
4405/* NOTICE: see above */
4406#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4407static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004408#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004409#if defined(MBEDTLS_ECDSA_C)
4410 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004411#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004412#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4413 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4414#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004415#if defined(MBEDTLS_RSA_C)
4416 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4417#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004418#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004419#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004420#if defined(MBEDTLS_ECDSA_C)
4421 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004422#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004423#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4424 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4425#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004426#if defined(MBEDTLS_RSA_C)
4427 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4428#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004429#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004430#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004431#if defined(MBEDTLS_ECDSA_C)
4432 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004433#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004434#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4435 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4436#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004437#if defined(MBEDTLS_RSA_C)
4438 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4439#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004440#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004441 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004442};
4443#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4444/* NOTICE: see above */
4445static uint16_t ssl_preset_suiteb_sig_algs[] = {
4446
Andrzej Kurek25f27152022-08-17 16:09:31 -04004447#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 +08004448 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4449 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004450#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004451 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4452
Andrzej Kurek25f27152022-08-17 16:09:31 -04004453#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 +08004454 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4455 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004456#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08004457 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004458
Andrzej Kurek25f27152022-08-17 16:09:31 -04004459#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 +08004460 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004461#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 +08004462
Andrzej Kurek25f27152022-08-17 16:09:31 -04004463#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 +08004464 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004465#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08004466
Gabor Mezei15b95a62022-05-09 16:37:58 +02004467 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004468};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004469
Jerry Yu909df7b2022-01-22 11:56:27 +08004470/* NOTICE: see above */
4471#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4472static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004473#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004474#if defined(MBEDTLS_ECDSA_C)
4475 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004476#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004477#if defined(MBEDTLS_RSA_C)
4478 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4479#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004480#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004481#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004482#if defined(MBEDTLS_ECDSA_C)
4483 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004484#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004485#if defined(MBEDTLS_RSA_C)
4486 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4487#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004488#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004489 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004490};
Jerry Yu909df7b2022-01-22 11:56:27 +08004491#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4492
Jerry Yu1a8b4812022-01-20 17:56:50 +08004493#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004494
Brett Warrene0edc842021-08-17 09:53:13 +01004495static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004496#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004497 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004498#endif
4499#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004500 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004501#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004502 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004503};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004504
Jerry Yu1a8b4812022-01-20 17:56:50 +08004505#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004506/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004507 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004508MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004509static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004510{
4511 size_t i, j;
4512 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004513
Gabor Mezei15b95a62022-05-09 16:37:58 +02004514 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004515 {
Jerry Yuf377d642022-01-25 10:43:59 +08004516 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004517 {
Jerry Yuf377d642022-01-25 10:43:59 +08004518 if( sig_algs[i] != sig_algs[j] )
4519 continue;
4520 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4521 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4522 sig_algs[i], j, i );
4523 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004524 }
4525 }
4526 return( ret );
4527}
4528
4529#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4530
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004531/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004532 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004533 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004534int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004535 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004536{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004537#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004538 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004539#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004540
Jerry Yu1a8b4812022-01-20 17:56:50 +08004541#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004542 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004543 {
4544 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4545 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4546 }
4547
Jerry Yuf377d642022-01-25 10:43:59 +08004548 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004549 {
4550 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4551 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4552 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004553
4554#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004555 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004556 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004557 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004558 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4559 }
4560
Jerry Yuf377d642022-01-25 10:43:59 +08004561 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004562 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004563 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004564 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4565 }
4566#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004567#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4568
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004569 /* Use the functions here so that they are covered in tests,
4570 * but otherwise access member directly for efficiency */
4571 mbedtls_ssl_conf_endpoint( conf, endpoint );
4572 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004573
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004574 /*
4575 * Things that are common to all presets
4576 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004577#if defined(MBEDTLS_SSL_CLI_C)
4578 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4579 {
4580 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4581#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4582 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4583#endif
4584 }
4585#endif
4586
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004587#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4588 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4589#endif
4590
4591#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4592 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4593#endif
4594
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004595#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004596 conf->f_cookie_write = ssl_cookie_write_dummy;
4597 conf->f_cookie_check = ssl_cookie_check_dummy;
4598#endif
4599
4600#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4601 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4602#endif
4603
Janos Follath088ce432017-04-10 12:42:31 +01004604#if defined(MBEDTLS_SSL_SRV_C)
4605 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004606 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004607#endif
4608
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004609#if defined(MBEDTLS_SSL_PROTO_DTLS)
4610 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4611 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4612#endif
4613
4614#if defined(MBEDTLS_SSL_RENEGOTIATION)
4615 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004616 memset( conf->renego_period, 0x00, 2 );
4617 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004618#endif
4619
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004620#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004621 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4622 {
4623 const unsigned char dhm_p[] =
4624 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4625 const unsigned char dhm_g[] =
4626 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004627
Hanno Beckere2defad2021-07-24 05:59:17 +01004628 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4629 dhm_p, sizeof( dhm_p ),
4630 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4631 {
4632 return( ret );
4633 }
4634 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004635#endif
4636
Ronald Cron6f135e12021-12-08 16:57:54 +01004637#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004638 /*
4639 * Allow all TLS 1.3 key exchange modes by default.
4640 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004641 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004642#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004643
XiaokangQian4d3a6042022-04-21 13:46:17 +00004644 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4645 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004647 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004648 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004649#else
XiaokangQian060d8672022-04-21 09:24:56 +00004650 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004651#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004652 }
4653 else
4654 {
4655#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4656 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4657 {
4658 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4659 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4660 }
4661 else
4662 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4663 {
4664 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4665 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4666 }
4667#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4668 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4669 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4670#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4671 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4672 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4673#else
4674 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4675#endif
4676 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004677
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004678 /*
4679 * Preset-specific defaults
4680 */
4681 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004682 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004683 /*
4684 * NSA Suite B
4685 */
4686 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004687
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004688 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004689
4690#if defined(MBEDTLS_X509_CRT_PARSE_C)
4691 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004692#endif
4693
Gilles Peskineeccd8882020-03-10 12:19:08 +01004694#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004695#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4696 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4697 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4698 else
4699#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4700 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004701#endif
4702
Brett Warrene0edc842021-08-17 09:53:13 +01004703#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4704 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004705#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004706 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004707 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004708
4709 /*
4710 * Default
4711 */
4712 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004713
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004714 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004715
4716#if defined(MBEDTLS_X509_CRT_PARSE_C)
4717 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4718#endif
4719
Gilles Peskineeccd8882020-03-10 12:19:08 +01004720#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004721#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4722 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4723 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4724 else
4725#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4726 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004727#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004728
Brett Warrene0edc842021-08-17 09:53:13 +01004729#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4730 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004731#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004732 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004733
4734#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4735 conf->dhm_min_bitlen = 1024;
4736#endif
4737 }
4738
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004739 return( 0 );
4740}
4741
4742/*
4743 * Free mbedtls_ssl_config
4744 */
4745void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4746{
4747#if defined(MBEDTLS_DHM_C)
4748 mbedtls_mpi_free( &conf->dhm_P );
4749 mbedtls_mpi_free( &conf->dhm_G );
4750#endif
4751
Gilles Peskineeccd8882020-03-10 12:19:08 +01004752#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004753#if defined(MBEDTLS_USE_PSA_CRYPTO)
4754 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4755 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004756 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4757 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004758#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004759 if( conf->psk != NULL )
4760 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004761 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004762 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004763 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004764 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004765 }
4766
4767 if( conf->psk_identity != NULL )
4768 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004769 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004770 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004771 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004772 conf->psk_identity_len = 0;
4773 }
4774#endif
4775
4776#if defined(MBEDTLS_X509_CRT_PARSE_C)
4777 ssl_key_cert_free( conf->key_cert );
4778#endif
4779
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004780 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004781}
4782
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004783#if defined(MBEDTLS_PK_C) && \
4784 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004785/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004788unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004789{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790#if defined(MBEDTLS_RSA_C)
4791 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4792 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004793#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794#if defined(MBEDTLS_ECDSA_C)
4795 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4796 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004797#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004799}
4800
Hanno Becker7e5437a2017-04-28 17:15:26 +01004801unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4802{
4803 switch( type ) {
4804 case MBEDTLS_PK_RSA:
4805 return( MBEDTLS_SSL_SIG_RSA );
4806 case MBEDTLS_PK_ECDSA:
4807 case MBEDTLS_PK_ECKEY:
4808 return( MBEDTLS_SSL_SIG_ECDSA );
4809 default:
4810 return( MBEDTLS_SSL_SIG_ANON );
4811 }
4812}
4813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004815{
4816 switch( sig )
4817 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818#if defined(MBEDTLS_RSA_C)
4819 case MBEDTLS_SSL_SIG_RSA:
4820 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004821#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004822#if defined(MBEDTLS_ECDSA_C)
4823 case MBEDTLS_SSL_SIG_ECDSA:
4824 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004825#endif
4826 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004828 }
4829}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004830#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004831
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004832/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004833 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004836{
4837 switch( hash )
4838 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004839#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004840 case MBEDTLS_SSL_HASH_MD5:
4841 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004842#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004843#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844 case MBEDTLS_SSL_HASH_SHA1:
4845 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004846#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004847#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004848 case MBEDTLS_SSL_HASH_SHA224:
4849 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004850#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004851#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004852 case MBEDTLS_SSL_HASH_SHA256:
4853 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004854#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004855#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004856 case MBEDTLS_SSL_HASH_SHA384:
4857 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004858#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004859#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860 case MBEDTLS_SSL_HASH_SHA512:
4861 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004862#endif
4863 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004864 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004865 }
4866}
4867
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004868/*
4869 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4870 */
4871unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4872{
4873 switch( md )
4874 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004875#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004876 case MBEDTLS_MD_MD5:
4877 return( MBEDTLS_SSL_HASH_MD5 );
4878#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004879#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004880 case MBEDTLS_MD_SHA1:
4881 return( MBEDTLS_SSL_HASH_SHA1 );
4882#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004883#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004884 case MBEDTLS_MD_SHA224:
4885 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004886#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004887#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004888 case MBEDTLS_MD_SHA256:
4889 return( MBEDTLS_SSL_HASH_SHA256 );
4890#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004891#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004892 case MBEDTLS_MD_SHA384:
4893 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004894#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004895#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004896 case MBEDTLS_MD_SHA512:
4897 return( MBEDTLS_SSL_HASH_SHA512 );
4898#endif
4899 default:
4900 return( MBEDTLS_SSL_HASH_NONE );
4901 }
4902}
4903
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004904/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004905 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004906 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004907 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004908int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004909{
Brett Warrene0edc842021-08-17 09:53:13 +01004910 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004911
Brett Warrene0edc842021-08-17 09:53:13 +01004912 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004913 return( -1 );
4914
Brett Warrene0edc842021-08-17 09:53:13 +01004915 for( ; *group_list != 0; group_list++ )
4916 {
4917 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004918 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004919 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004920
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004921 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004922}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004923
4924#if defined(MBEDTLS_ECP_C)
4925/*
4926 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4927 */
4928int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4929{
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004930 const mbedtls_ecp_curve_info *grp_info =
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004931 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004932
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01004933 if ( grp_info == NULL )
Leonid Rozenboim19e59732022-08-08 16:52:38 -07004934 return -1;
4935
4936 uint16_t tls_id = grp_info->tls_id;
4937
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004938 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4939}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004940#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004942#if defined(MBEDTLS_X509_CRT_PARSE_C)
4943int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4944 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004945 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004946 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004947{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004948 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004949 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004950 const char *ext_oid;
4951 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004953 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004954 {
4955 /* Server part of the key exchange */
4956 switch( ciphersuite->key_exchange )
4957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004958 case MBEDTLS_KEY_EXCHANGE_RSA:
4959 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004960 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004961 break;
4962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004963 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4964 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4965 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4966 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004967 break;
4968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004969 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4970 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004971 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004972 break;
4973
4974 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004975 case MBEDTLS_KEY_EXCHANGE_NONE:
4976 case MBEDTLS_KEY_EXCHANGE_PSK:
4977 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4978 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004979 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004980 usage = 0;
4981 }
4982 }
4983 else
4984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004985 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4986 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004987 }
4988
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004989 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004990 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004991 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004992 ret = -1;
4993 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004995 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004996 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4998 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004999 }
5000 else
5001 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005002 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5003 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005004 }
5005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005006 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005007 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005008 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005009 ret = -1;
5010 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005011
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005012 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005013}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005015
Jerry Yu148165c2021-09-24 23:20:59 +08005016#if defined(MBEDTLS_USE_PSA_CRYPTO)
5017int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5018 const mbedtls_md_type_t md,
5019 unsigned char *dst,
5020 size_t dst_len,
5021 size_t *olen )
5022{
Ronald Cronf6893e12022-01-07 22:09:01 +01005023 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5024 psa_hash_operation_t *hash_operation_to_clone;
5025 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5026
Jerry Yu148165c2021-09-24 23:20:59 +08005027 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005028
5029 switch( md )
5030 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005031#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005032 case MBEDTLS_MD_SHA384:
5033 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5034 break;
5035#endif
5036
Andrzej Kurek25f27152022-08-17 16:09:31 -04005037#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005038 case MBEDTLS_MD_SHA256:
5039 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5040 break;
5041#endif
5042
5043 default:
5044 goto exit;
5045 }
5046
5047 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5048 if( status != PSA_SUCCESS )
5049 goto exit;
5050
5051 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5052 if( status != PSA_SUCCESS )
5053 goto exit;
5054
5055exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005056 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005057}
5058#else /* MBEDTLS_USE_PSA_CRYPTO */
5059
Andrzej Kurek25f27152022-08-17 16:09:31 -04005060#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005061MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005062static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5063 unsigned char *dst,
5064 size_t dst_len,
5065 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005066{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005067 int ret;
5068 mbedtls_sha512_context sha512;
5069
5070 if( dst_len < 48 )
5071 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5072
5073 mbedtls_sha512_init( &sha512 );
Andrzej Kureka242e832022-08-11 10:03:14 -04005074 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005075
5076 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5077 {
5078 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5079 goto exit;
5080 }
5081
5082 *olen = 48;
5083
5084exit:
5085
5086 mbedtls_sha512_free( &sha512 );
5087 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005088}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005089#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005090
Andrzej Kurek25f27152022-08-17 16:09:31 -04005091#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005092MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005093static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5094 unsigned char *dst,
5095 size_t dst_len,
5096 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005097{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005098 int ret;
5099 mbedtls_sha256_context sha256;
5100
5101 if( dst_len < 32 )
5102 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5103
5104 mbedtls_sha256_init( &sha256 );
5105 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005106
Jerry Yu24c0ec32021-09-09 14:21:07 +08005107 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5108 {
5109 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5110 goto exit;
5111 }
5112
5113 *olen = 32;
5114
5115exit:
5116
5117 mbedtls_sha256_free( &sha256 );
5118 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005119}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005120#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005121
Jerry Yu000f9762021-09-14 11:12:51 +08005122int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5123 const mbedtls_md_type_t md,
5124 unsigned char *dst,
5125 size_t dst_len,
5126 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005127{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005128 switch( md )
5129 {
5130
Andrzej Kurek25f27152022-08-17 16:09:31 -04005131#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005132 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005133 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005134#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005135
Andrzej Kurek25f27152022-08-17 16:09:31 -04005136#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005137 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005138 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005139#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005140
5141 default:
5142 break;
5143 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005145}
XiaokangQian647719a2021-12-07 09:16:29 +00005146
Jerry Yu148165c2021-09-24 23:20:59 +08005147#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005148
Gabor Mezei078e8032022-04-27 21:17:56 +02005149#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5150/* mbedtls_ssl_parse_sig_alg_ext()
5151 *
5152 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5153 * value (TLS 1.3 RFC8446):
5154 * enum {
5155 * ....
5156 * ecdsa_secp256r1_sha256( 0x0403 ),
5157 * ecdsa_secp384r1_sha384( 0x0503 ),
5158 * ecdsa_secp521r1_sha512( 0x0603 ),
5159 * ....
5160 * } SignatureScheme;
5161 *
5162 * struct {
5163 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5164 * } SignatureSchemeList;
5165 *
5166 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5167 * value (TLS 1.2 RFC5246):
5168 * enum {
5169 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5170 * sha512(6), (255)
5171 * } HashAlgorithm;
5172 *
5173 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5174 * SignatureAlgorithm;
5175 *
5176 * struct {
5177 * HashAlgorithm hash;
5178 * SignatureAlgorithm signature;
5179 * } SignatureAndHashAlgorithm;
5180 *
5181 * SignatureAndHashAlgorithm
5182 * supported_signature_algorithms<2..2^16-2>;
5183 *
5184 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5185 * generalization of the TLS 1.2 signature algorithm extension.
5186 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5187 * `SignatureScheme` field of TLS 1.3
5188 *
5189 */
5190int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5191 const unsigned char *buf,
5192 const unsigned char *end )
5193{
5194 const unsigned char *p = buf;
5195 size_t supported_sig_algs_len = 0;
5196 const unsigned char *supported_sig_algs_end;
5197 uint16_t sig_alg;
5198 uint32_t common_idx = 0;
5199
5200 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5201 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5202 p += 2;
5203
5204 memset( ssl->handshake->received_sig_algs, 0,
5205 sizeof(ssl->handshake->received_sig_algs) );
5206
5207 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5208 supported_sig_algs_end = p + supported_sig_algs_len;
5209 while( p < supported_sig_algs_end )
5210 {
5211 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5212 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5213 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005214 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5215 sig_alg,
5216 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005217#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005218 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005219 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5220 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5221 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005222 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005223 }
5224#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005225
Jerry Yuf3b46b52022-06-19 16:52:27 +08005226 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5227 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005228
5229 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5230 {
5231 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5232 common_idx += 1;
5233 }
5234 }
5235 /* Check that we consumed all the message. */
5236 if( p != end )
5237 {
5238 MBEDTLS_SSL_DEBUG_MSG( 1,
5239 ( "Signature algorithms extension length misaligned" ) );
5240 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5241 MBEDTLS_ERR_SSL_DECODE_ERROR );
5242 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5243 }
5244
5245 if( common_idx == 0 )
5246 {
5247 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5248 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5249 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5250 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5251 }
5252
Gabor Mezei15b95a62022-05-09 16:37:58 +02005253 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005254 return( 0 );
5255}
5256
5257#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5258
Jerry Yudc7bd172022-02-17 13:44:15 +08005259#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5260
5261#if defined(MBEDTLS_USE_PSA_CRYPTO)
5262
5263static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5264 mbedtls_svc_key_id_t key,
5265 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005266 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005267 const unsigned char* seed, size_t seed_length,
5268 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005269 const unsigned char* other_secret,
5270 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005271 size_t capacity )
5272{
5273 psa_status_t status;
5274
5275 status = psa_key_derivation_setup( derivation, alg );
5276 if( status != PSA_SUCCESS )
5277 return( status );
5278
5279 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5280 {
5281 status = psa_key_derivation_input_bytes( derivation,
5282 PSA_KEY_DERIVATION_INPUT_SEED,
5283 seed, seed_length );
5284 if( status != PSA_SUCCESS )
5285 return( status );
5286
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005287 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005288 {
5289 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005290 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5291 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005292 if( status != PSA_SUCCESS )
5293 return( status );
5294 }
5295
Jerry Yudc7bd172022-02-17 13:44:15 +08005296 if( mbedtls_svc_key_id_is_null( key ) )
5297 {
5298 status = psa_key_derivation_input_bytes(
5299 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005300 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005301 }
5302 else
5303 {
5304 status = psa_key_derivation_input_key(
5305 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5306 }
5307 if( status != PSA_SUCCESS )
5308 return( status );
5309
5310 status = psa_key_derivation_input_bytes( derivation,
5311 PSA_KEY_DERIVATION_INPUT_LABEL,
5312 label, label_length );
5313 if( status != PSA_SUCCESS )
5314 return( status );
5315 }
5316 else
5317 {
5318 return( PSA_ERROR_NOT_SUPPORTED );
5319 }
5320
5321 status = psa_key_derivation_set_capacity( derivation, capacity );
5322 if( status != PSA_SUCCESS )
5323 return( status );
5324
5325 return( PSA_SUCCESS );
5326}
5327
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005328MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005329static int tls_prf_generic( mbedtls_md_type_t md_type,
5330 const unsigned char *secret, size_t slen,
5331 const char *label,
5332 const unsigned char *random, size_t rlen,
5333 unsigned char *dstbuf, size_t dlen )
5334{
5335 psa_status_t status;
5336 psa_algorithm_t alg;
5337 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5338 psa_key_derivation_operation_t derivation =
5339 PSA_KEY_DERIVATION_OPERATION_INIT;
5340
5341 if( md_type == MBEDTLS_MD_SHA384 )
5342 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5343 else
5344 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5345
5346 /* Normally a "secret" should be long enough to be impossible to
5347 * find by brute force, and in particular should not be empty. But
5348 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5349 * and for this use case it makes sense to have a 0-length "secret".
5350 * Since the key API doesn't allow importing a key of length 0,
5351 * keep master_key=0, which setup_psa_key_derivation() understands
5352 * to mean a 0-length "secret" input. */
5353 if( slen != 0 )
5354 {
5355 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5356 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5357 psa_set_key_algorithm( &key_attributes, alg );
5358 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5359
5360 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5361 if( status != PSA_SUCCESS )
5362 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5363 }
5364
5365 status = setup_psa_key_derivation( &derivation,
5366 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005367 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005368 random, rlen,
5369 (unsigned char const *) label,
5370 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005371 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005372 dlen );
5373 if( status != PSA_SUCCESS )
5374 {
5375 psa_key_derivation_abort( &derivation );
5376 psa_destroy_key( master_key );
5377 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5378 }
5379
5380 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5381 if( status != PSA_SUCCESS )
5382 {
5383 psa_key_derivation_abort( &derivation );
5384 psa_destroy_key( master_key );
5385 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5386 }
5387
5388 status = psa_key_derivation_abort( &derivation );
5389 if( status != PSA_SUCCESS )
5390 {
5391 psa_destroy_key( master_key );
5392 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5393 }
5394
5395 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5396 status = psa_destroy_key( master_key );
5397 if( status != PSA_SUCCESS )
5398 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5399
5400 return( 0 );
5401}
5402
5403#else /* MBEDTLS_USE_PSA_CRYPTO */
5404
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005405MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005406static int tls_prf_generic( mbedtls_md_type_t md_type,
5407 const unsigned char *secret, size_t slen,
5408 const char *label,
5409 const unsigned char *random, size_t rlen,
5410 unsigned char *dstbuf, size_t dlen )
5411{
5412 size_t nb;
5413 size_t i, j, k, md_len;
5414 unsigned char *tmp;
5415 size_t tmp_len = 0;
5416 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5417 const mbedtls_md_info_t *md_info;
5418 mbedtls_md_context_t md_ctx;
5419 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5420
5421 mbedtls_md_init( &md_ctx );
5422
5423 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5424 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5425
5426 md_len = mbedtls_md_get_size( md_info );
5427
5428 tmp_len = md_len + strlen( label ) + rlen;
5429 tmp = mbedtls_calloc( 1, tmp_len );
5430 if( tmp == NULL )
5431 {
5432 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5433 goto exit;
5434 }
5435
5436 nb = strlen( label );
5437 memcpy( tmp + md_len, label, nb );
5438 memcpy( tmp + md_len + nb, random, rlen );
5439 nb += rlen;
5440
5441 /*
5442 * Compute P_<hash>(secret, label + random)[0..dlen]
5443 */
5444 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5445 goto exit;
5446
5447 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5448 if( ret != 0 )
5449 goto exit;
5450 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5451 if( ret != 0 )
5452 goto exit;
5453 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5454 if( ret != 0 )
5455 goto exit;
5456
5457 for( i = 0; i < dlen; i += md_len )
5458 {
5459 ret = mbedtls_md_hmac_reset ( &md_ctx );
5460 if( ret != 0 )
5461 goto exit;
5462 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5463 if( ret != 0 )
5464 goto exit;
5465 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5466 if( ret != 0 )
5467 goto exit;
5468
5469 ret = mbedtls_md_hmac_reset ( &md_ctx );
5470 if( ret != 0 )
5471 goto exit;
5472 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5473 if( ret != 0 )
5474 goto exit;
5475 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5476 if( ret != 0 )
5477 goto exit;
5478
5479 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5480
5481 for( j = 0; j < k; j++ )
5482 dstbuf[i + j] = h_i[j];
5483 }
5484
5485exit:
5486 mbedtls_md_free( &md_ctx );
5487
5488 mbedtls_platform_zeroize( tmp, tmp_len );
5489 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5490
5491 mbedtls_free( tmp );
5492
5493 return( ret );
5494}
5495#endif /* MBEDTLS_USE_PSA_CRYPTO */
5496
Andrzej Kurek25f27152022-08-17 16:09:31 -04005497#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005498MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005499static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5500 const char *label,
5501 const unsigned char *random, size_t rlen,
5502 unsigned char *dstbuf, size_t dlen )
5503{
5504 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5505 label, random, rlen, dstbuf, dlen ) );
5506}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005507#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08005508
Andrzej Kurek25f27152022-08-17 16:09:31 -04005509#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005510MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005511static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5512 const char *label,
5513 const unsigned char *random, size_t rlen,
5514 unsigned char *dstbuf, size_t dlen )
5515{
5516 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5517 label, random, rlen, dstbuf, dlen ) );
5518}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005519#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08005520
Jerry Yuf009d862022-02-17 14:01:37 +08005521/*
5522 * Set appropriate PRF function and other SSL / TLS1.2 functions
5523 *
5524 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005525 * - hash associated with the ciphersuite (only used by TLS 1.2)
5526 *
5527 * Outputs:
5528 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5529 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005530MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005531static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005532 mbedtls_md_type_t hash )
5533{
Andrzej Kurek25f27152022-08-17 16:09:31 -04005534#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron81591aa2022-03-07 09:05:51 +01005535 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005536 {
5537 handshake->tls_prf = tls_prf_sha384;
5538 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5539 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5540 }
5541 else
5542#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005543#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08005544 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005545 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005546 handshake->tls_prf = tls_prf_sha256;
5547 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5548 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5549 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005550#else
Jerry Yuf009d862022-02-17 14:01:37 +08005551 {
Jerry Yuf009d862022-02-17 14:01:37 +08005552 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005553 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005554 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5555 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005556#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005557
5558 return( 0 );
5559}
Jerry Yud6ab2352022-02-17 14:03:43 +08005560
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005561/*
5562 * Compute master secret if needed
5563 *
5564 * Parameters:
5565 * [in/out] handshake
5566 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5567 * (PSA-PSK) ciphersuite_info, psk_opaque
5568 * [out] premaster (cleared)
5569 * [out] master
5570 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5571 * debug: conf->f_dbg, conf->p_dbg
5572 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005573 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005574 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005575MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005576static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5577 unsigned char *master,
5578 const mbedtls_ssl_context *ssl )
5579{
5580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5581
5582 /* cf. RFC 5246, Section 8.1:
5583 * "The master secret is always exactly 48 bytes in length." */
5584 size_t const master_secret_len = 48;
5585
5586#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5587 unsigned char session_hash[48];
5588#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5589
5590 /* The label for the KDF used for key expansion.
5591 * This is either "master secret" or "extended master secret"
5592 * depending on whether the Extended Master Secret extension
5593 * is used. */
5594 char const *lbl = "master secret";
5595
Przemek Stekielae4ed302022-04-05 17:15:55 +02005596 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005597 * - If the Extended Master Secret extension is not used,
5598 * this is ClientHello.Random + ServerHello.Random
5599 * (see Sect. 8.1 in RFC 5246).
5600 * - If the Extended Master Secret extension is used,
5601 * this is the transcript of the handshake so far.
5602 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005603 unsigned char const *seed = handshake->randbytes;
5604 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005605
5606#if !defined(MBEDTLS_DEBUG_C) && \
5607 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5608 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5609 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5610 ssl = NULL; /* make sure we don't use it except for those cases */
5611 (void) ssl;
5612#endif
5613
5614 if( handshake->resume != 0 )
5615 {
5616 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5617 return( 0 );
5618 }
5619
5620#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5621 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5622 {
5623 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005624 seed = session_hash;
5625 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005626
5627 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005628 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005629 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005630#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005631
Przemek Stekiel99114f32022-04-22 11:20:09 +02005632#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005633 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005634 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005635 {
5636 /* Perform PSK-to-MS expansion in a single step. */
5637 psa_status_t status;
5638 psa_algorithm_t alg;
5639 mbedtls_svc_key_id_t psk;
5640 psa_key_derivation_operation_t derivation =
5641 PSA_KEY_DERIVATION_OPERATION_INIT;
5642 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5643
5644 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5645
5646 psk = mbedtls_ssl_get_opaque_psk( ssl );
5647
5648 if( hash_alg == MBEDTLS_MD_SHA384 )
5649 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5650 else
5651 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5652
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005653 size_t other_secret_len = 0;
5654 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005655
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005656 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005657 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005658 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005659 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005660 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005661 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005662 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005663 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005664 other_secret_len = 48;
5665 other_secret = handshake->premaster + 2;
5666 break;
5667 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005668 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005669 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5670 other_secret = handshake->premaster + 2;
5671 break;
5672 default:
5673 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005674 }
5675
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005676 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005677 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005678 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005679 (unsigned char const *) lbl,
5680 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005681 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005682 master_secret_len );
5683 if( status != PSA_SUCCESS )
5684 {
5685 psa_key_derivation_abort( &derivation );
5686 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5687 }
5688
5689 status = psa_key_derivation_output_bytes( &derivation,
5690 master,
5691 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_abort( &derivation );
5699 if( status != PSA_SUCCESS )
5700 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5701 }
5702 else
5703#endif
5704 {
5705 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005706 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005707 master,
5708 master_secret_len );
5709 if( ret != 0 )
5710 {
5711 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5712 return( ret );
5713 }
5714
5715 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5716 handshake->premaster,
5717 handshake->pmslen );
5718
5719 mbedtls_platform_zeroize( handshake->premaster,
5720 sizeof(handshake->premaster) );
5721 }
5722
5723 return( 0 );
5724}
5725
Jerry Yud62f87e2022-02-17 14:09:02 +08005726int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5727{
5728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5729 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5730 ssl->handshake->ciphersuite_info;
5731
5732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5733
5734 /* Set PRF, calc_verify and calc_finished function pointers */
5735 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005736 ciphersuite_info->mac );
5737 if( ret != 0 )
5738 {
5739 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5740 return( ret );
5741 }
5742
5743 /* Compute master secret if needed */
5744 ret = ssl_compute_master( ssl->handshake,
5745 ssl->session_negotiate->master,
5746 ssl );
5747 if( ret != 0 )
5748 {
5749 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5750 return( ret );
5751 }
5752
5753 /* Swap the client and server random values:
5754 * - MS derivation wanted client+server (RFC 5246 8.1)
5755 * - key derivation wants server+client (RFC 5246 6.3) */
5756 {
5757 unsigned char tmp[64];
5758 memcpy( tmp, ssl->handshake->randbytes, 64 );
5759 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5760 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5761 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5762 }
5763
5764 /* Populate transform structure */
5765 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5766 ssl->session_negotiate->ciphersuite,
5767 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005768#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005769 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005770#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005771 ssl->handshake->tls_prf,
5772 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005773 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005774 ssl->conf->endpoint,
5775 ssl );
5776 if( ret != 0 )
5777 {
5778 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5779 return( ret );
5780 }
5781
5782 /* We no longer need Server/ClientHello.random values */
5783 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5784 sizeof( ssl->handshake->randbytes ) );
5785
5786 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5787
5788 return( 0 );
5789}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005790
Ronald Cron4dcbca92022-03-07 10:21:40 +01005791int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5792{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005793 switch( md )
5794 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005795#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01005796 case MBEDTLS_SSL_HASH_SHA384:
5797 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5798 break;
5799#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005800#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01005801 case MBEDTLS_SSL_HASH_SHA256:
5802 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5803 break;
5804#endif
5805 default:
5806 return( -1 );
5807 }
5808
Ronald Cronc2f13a02022-03-07 10:25:24 +01005809 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005810}
5811
Andrzej Kurek25f27152022-08-17 16:09:31 -04005812#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu8392e0d2022-02-17 14:10:24 +08005813void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5814 unsigned char *hash,
5815 size_t *hlen )
5816{
5817#if defined(MBEDTLS_USE_PSA_CRYPTO)
5818 size_t hash_size;
5819 psa_status_t status;
5820 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5821
5822 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5823 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5824 if( status != PSA_SUCCESS )
5825 {
5826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5827 return;
5828 }
5829
5830 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5831 if( status != PSA_SUCCESS )
5832 {
5833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5834 return;
5835 }
5836
5837 *hlen = 32;
5838 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5840#else
5841 mbedtls_sha256_context sha256;
5842
5843 mbedtls_sha256_init( &sha256 );
5844
5845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5846
5847 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5848 mbedtls_sha256_finish( &sha256, hash );
5849
5850 *hlen = 32;
5851
5852 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5854
5855 mbedtls_sha256_free( &sha256 );
5856#endif /* MBEDTLS_USE_PSA_CRYPTO */
5857 return;
5858}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005859#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08005860
Andrzej Kurek25f27152022-08-17 16:09:31 -04005861#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1cb3842022-02-17 14:13:48 +08005862void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5863 unsigned char *hash,
5864 size_t *hlen )
5865{
5866#if defined(MBEDTLS_USE_PSA_CRYPTO)
5867 size_t hash_size;
5868 psa_status_t status;
5869 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5870
5871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5872 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5873 if( status != PSA_SUCCESS )
5874 {
5875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5876 return;
5877 }
5878
5879 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5880 if( status != PSA_SUCCESS )
5881 {
5882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5883 return;
5884 }
5885
5886 *hlen = 48;
5887 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5889#else
5890 mbedtls_sha512_context sha512;
5891
5892 mbedtls_sha512_init( &sha512 );
5893
5894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5895
Andrzej Kureka242e832022-08-11 10:03:14 -04005896 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yuc1cb3842022-02-17 14:13:48 +08005897 mbedtls_sha512_finish( &sha512, hash );
5898
5899 *hlen = 48;
5900
5901 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5903
5904 mbedtls_sha512_free( &sha512 );
5905#endif /* MBEDTLS_USE_PSA_CRYPTO */
5906 return;
5907}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005908#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08005909
Neil Armstrong80f6f322022-05-03 17:56:38 +02005910#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5911 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005912int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5913{
5914 unsigned char *p = ssl->handshake->premaster;
5915 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5916 const unsigned char *psk = NULL;
5917 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005918 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005919
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005920 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005921 {
5922 /*
5923 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005924 * checked before calling this function.
5925 *
5926 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005927 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005928 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005929 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5930 {
5931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5932 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5933 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005934 }
5935
5936 /*
5937 * PMS = struct {
5938 * opaque other_secret<0..2^16-1>;
5939 * opaque psk<0..2^16-1>;
5940 * };
5941 * with "other_secret" depending on the particular key exchange
5942 */
5943#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5944 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5945 {
5946 if( end - p < 2 )
5947 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5948
5949 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5950 p += 2;
5951
5952 if( end < p || (size_t)( end - p ) < psk_len )
5953 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5954
5955 memset( p, 0, psk_len );
5956 p += psk_len;
5957 }
5958 else
5959#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5960#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5961 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5962 {
5963 /*
5964 * other_secret already set by the ClientKeyExchange message,
5965 * and is 48 bytes long
5966 */
5967 if( end - p < 2 )
5968 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5969
5970 *p++ = 0;
5971 *p++ = 48;
5972 p += 48;
5973 }
5974 else
5975#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5976#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5977 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5978 {
5979 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5980 size_t len;
5981
5982 /* Write length only when we know the actual value */
5983 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5984 p + 2, end - ( p + 2 ), &len,
5985 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5986 {
5987 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5988 return( ret );
5989 }
5990 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5991 p += 2 + len;
5992
5993 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5994 }
5995 else
5996#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005997#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005998 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5999 {
6000 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6001 size_t zlen;
6002
6003 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
6004 p + 2, end - ( p + 2 ),
6005 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6006 {
6007 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
6008 return( ret );
6009 }
6010
6011 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6012 p += 2 + zlen;
6013
6014 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6015 MBEDTLS_DEBUG_ECDH_Z );
6016 }
6017 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006018#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006019 {
6020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6021 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6022 }
6023
6024 /* opaque psk<0..2^16-1>; */
6025 if( end - p < 2 )
6026 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6027
6028 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6029 p += 2;
6030
6031 if( end < p || (size_t)( end - p ) < psk_len )
6032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6033
6034 memcpy( p, psk, psk_len );
6035 p += psk_len;
6036
6037 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6038
6039 return( 0 );
6040}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006041#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006042
6043#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006044MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006045static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6046
6047#if defined(MBEDTLS_SSL_PROTO_DTLS)
6048int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6049{
6050 /* If renegotiation is not enforced, retransmit until we would reach max
6051 * timeout if we were using the usual handshake doubling scheme */
6052 if( ssl->conf->renego_max_records < 0 )
6053 {
6054 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6055 unsigned char doublings = 1;
6056
6057 while( ratio != 0 )
6058 {
6059 ++doublings;
6060 ratio >>= 1;
6061 }
6062
6063 if( ++ssl->renego_records_seen > doublings )
6064 {
6065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6066 return( 0 );
6067 }
6068 }
6069
6070 return( ssl_write_hello_request( ssl ) );
6071}
6072#endif
6073#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006074
Jerry Yud9526692022-02-17 14:23:47 +08006075/*
6076 * Handshake functions
6077 */
6078#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6079/* No certificate support -> dummy functions */
6080int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6081{
6082 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6083 ssl->handshake->ciphersuite_info;
6084
6085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6086
6087 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6088 {
6089 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6090 ssl->state++;
6091 return( 0 );
6092 }
6093
6094 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6095 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6096}
6097
6098int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6099{
6100 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6101 ssl->handshake->ciphersuite_info;
6102
6103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6104
6105 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6106 {
6107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6108 ssl->state++;
6109 return( 0 );
6110 }
6111
6112 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6113 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6114}
6115
6116#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6117/* Some certificate support -> implement write and parse */
6118
6119int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6120{
6121 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6122 size_t i, n;
6123 const mbedtls_x509_crt *crt;
6124 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6125 ssl->handshake->ciphersuite_info;
6126
6127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6128
6129 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6130 {
6131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6132 ssl->state++;
6133 return( 0 );
6134 }
6135
6136#if defined(MBEDTLS_SSL_CLI_C)
6137 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6138 {
6139 if( ssl->handshake->client_auth == 0 )
6140 {
6141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6142 ssl->state++;
6143 return( 0 );
6144 }
6145 }
6146#endif /* MBEDTLS_SSL_CLI_C */
6147#if defined(MBEDTLS_SSL_SRV_C)
6148 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6149 {
6150 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6151 {
6152 /* Should never happen because we shouldn't have picked the
6153 * ciphersuite if we don't have a certificate. */
6154 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6155 }
6156 }
6157#endif
6158
6159 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6160
6161 /*
6162 * 0 . 0 handshake type
6163 * 1 . 3 handshake length
6164 * 4 . 6 length of all certs
6165 * 7 . 9 length of cert. 1
6166 * 10 . n-1 peer certificate
6167 * n . n+2 length of cert. 2
6168 * n+3 . ... upper level cert, etc.
6169 */
6170 i = 7;
6171 crt = mbedtls_ssl_own_cert( ssl );
6172
6173 while( crt != NULL )
6174 {
6175 n = crt->raw.len;
6176 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6177 {
6178 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6179 " > %" MBEDTLS_PRINTF_SIZET,
6180 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6181 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6182 }
6183
6184 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6185 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6186 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6187
6188 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6189 i += n; crt = crt->next;
6190 }
6191
6192 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6193 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6194 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6195
6196 ssl->out_msglen = i;
6197 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6198 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6199
6200 ssl->state++;
6201
6202 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6203 {
6204 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6205 return( ret );
6206 }
6207
6208 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6209
6210 return( ret );
6211}
6212
6213#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6214
6215#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006216MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006217static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6218 unsigned char *crt_buf,
6219 size_t crt_buf_len )
6220{
6221 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6222
6223 if( peer_crt == NULL )
6224 return( -1 );
6225
6226 if( peer_crt->raw.len != crt_buf_len )
6227 return( -1 );
6228
6229 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6230}
6231#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006232MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006233static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6234 unsigned char *crt_buf,
6235 size_t crt_buf_len )
6236{
6237 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6238 unsigned char const * const peer_cert_digest =
6239 ssl->session->peer_cert_digest;
6240 mbedtls_md_type_t const peer_cert_digest_type =
6241 ssl->session->peer_cert_digest_type;
6242 mbedtls_md_info_t const * const digest_info =
6243 mbedtls_md_info_from_type( peer_cert_digest_type );
6244 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6245 size_t digest_len;
6246
6247 if( peer_cert_digest == NULL || digest_info == NULL )
6248 return( -1 );
6249
6250 digest_len = mbedtls_md_get_size( digest_info );
6251 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6252 return( -1 );
6253
6254 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6255 if( ret != 0 )
6256 return( -1 );
6257
6258 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6259}
6260#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6261#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6262
6263/*
6264 * Once the certificate message is read, parse it into a cert chain and
6265 * perform basic checks, but leave actual verification to the caller
6266 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006267MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006268static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6269 mbedtls_x509_crt *chain )
6270{
6271 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6272#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6273 int crt_cnt=0;
6274#endif
6275 size_t i, n;
6276 uint8_t alert;
6277
6278 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6279 {
6280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6281 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6282 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6283 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6284 }
6285
6286 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6287 {
6288 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6289 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6290 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6291 }
6292
6293 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6294 {
6295 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6296 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6297 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6298 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6299 }
6300
6301 i = mbedtls_ssl_hs_hdr_len( ssl );
6302
6303 /*
6304 * Same message structure as in mbedtls_ssl_write_certificate()
6305 */
6306 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6307
6308 if( ssl->in_msg[i] != 0 ||
6309 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6310 {
6311 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6312 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6313 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6314 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6315 }
6316
6317 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6318 i += 3;
6319
6320 /* Iterate through and parse the CRTs in the provided chain. */
6321 while( i < ssl->in_hslen )
6322 {
6323 /* Check that there's room for the next CRT's length fields. */
6324 if ( i + 3 > ssl->in_hslen ) {
6325 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6326 mbedtls_ssl_send_alert_message( ssl,
6327 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6328 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6329 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6330 }
6331 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6332 * anything beyond 2**16 ~ 64K. */
6333 if( ssl->in_msg[i] != 0 )
6334 {
6335 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6336 mbedtls_ssl_send_alert_message( ssl,
6337 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6338 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6339 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6340 }
6341
6342 /* Read length of the next CRT in the chain. */
6343 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6344 | (unsigned int) ssl->in_msg[i + 2];
6345 i += 3;
6346
6347 if( n < 128 || i + n > ssl->in_hslen )
6348 {
6349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6350 mbedtls_ssl_send_alert_message( ssl,
6351 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6352 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6353 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6354 }
6355
6356 /* Check if we're handling the first CRT in the chain. */
6357#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6358 if( crt_cnt++ == 0 &&
6359 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6360 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6361 {
6362 /* During client-side renegotiation, check that the server's
6363 * end-CRTs hasn't changed compared to the initial handshake,
6364 * mitigating the triple handshake attack. On success, reuse
6365 * the original end-CRT instead of parsing it again. */
6366 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6367 if( ssl_check_peer_crt_unchanged( ssl,
6368 &ssl->in_msg[i],
6369 n ) != 0 )
6370 {
6371 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6372 mbedtls_ssl_send_alert_message( ssl,
6373 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6374 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6375 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6376 }
6377
6378 /* Now we can safely free the original chain. */
6379 ssl_clear_peer_cert( ssl->session );
6380 }
6381#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6382
6383 /* Parse the next certificate in the chain. */
6384#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6385 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6386#else
6387 /* If we don't need to store the CRT chain permanently, parse
6388 * it in-place from the input buffer instead of making a copy. */
6389 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6390#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6391 switch( ret )
6392 {
6393 case 0: /*ok*/
6394 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6395 /* Ignore certificate with an unknown algorithm: maybe a
6396 prior certificate was already trusted. */
6397 break;
6398
6399 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6400 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6401 goto crt_parse_der_failed;
6402
6403 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6404 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6405 goto crt_parse_der_failed;
6406
6407 default:
6408 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6409 crt_parse_der_failed:
6410 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6411 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6412 return( ret );
6413 }
6414
6415 i += n;
6416 }
6417
6418 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6419 return( 0 );
6420}
6421
6422#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006423MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006424static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6425{
6426 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6427 return( -1 );
6428
6429 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6430 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6431 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6432 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6433 {
Ronald Cron19385882022-06-15 16:26:13 +02006434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006435 return( 0 );
6436 }
6437 return( -1 );
6438}
6439#endif /* MBEDTLS_SSL_SRV_C */
6440
6441/* Check if a certificate message is expected.
6442 * Return either
6443 * - SSL_CERTIFICATE_EXPECTED, or
6444 * - SSL_CERTIFICATE_SKIP
6445 * indicating whether a Certificate message is expected or not.
6446 */
6447#define SSL_CERTIFICATE_EXPECTED 0
6448#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006449MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006450static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6451 int authmode )
6452{
6453 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6454 ssl->handshake->ciphersuite_info;
6455
6456 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6457 return( SSL_CERTIFICATE_SKIP );
6458
6459#if defined(MBEDTLS_SSL_SRV_C)
6460 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6461 {
6462 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6463 return( SSL_CERTIFICATE_SKIP );
6464
6465 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6466 {
6467 ssl->session_negotiate->verify_result =
6468 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6469 return( SSL_CERTIFICATE_SKIP );
6470 }
6471 }
6472#else
6473 ((void) authmode);
6474#endif /* MBEDTLS_SSL_SRV_C */
6475
6476 return( SSL_CERTIFICATE_EXPECTED );
6477}
6478
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006479MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006480static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6481 int authmode,
6482 mbedtls_x509_crt *chain,
6483 void *rs_ctx )
6484{
6485 int ret = 0;
6486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6487 ssl->handshake->ciphersuite_info;
6488 int have_ca_chain = 0;
6489
6490 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6491 void *p_vrfy;
6492
6493 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6494 return( 0 );
6495
6496 if( ssl->f_vrfy != NULL )
6497 {
6498 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6499 f_vrfy = ssl->f_vrfy;
6500 p_vrfy = ssl->p_vrfy;
6501 }
6502 else
6503 {
6504 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6505 f_vrfy = ssl->conf->f_vrfy;
6506 p_vrfy = ssl->conf->p_vrfy;
6507 }
6508
6509 /*
6510 * Main check: verify certificate
6511 */
6512#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6513 if( ssl->conf->f_ca_cb != NULL )
6514 {
6515 ((void) rs_ctx);
6516 have_ca_chain = 1;
6517
6518 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6519 ret = mbedtls_x509_crt_verify_with_ca_cb(
6520 chain,
6521 ssl->conf->f_ca_cb,
6522 ssl->conf->p_ca_cb,
6523 ssl->conf->cert_profile,
6524 ssl->hostname,
6525 &ssl->session_negotiate->verify_result,
6526 f_vrfy, p_vrfy );
6527 }
6528 else
6529#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6530 {
6531 mbedtls_x509_crt *ca_chain;
6532 mbedtls_x509_crl *ca_crl;
6533
6534#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6535 if( ssl->handshake->sni_ca_chain != NULL )
6536 {
6537 ca_chain = ssl->handshake->sni_ca_chain;
6538 ca_crl = ssl->handshake->sni_ca_crl;
6539 }
6540 else
6541#endif
6542 {
6543 ca_chain = ssl->conf->ca_chain;
6544 ca_crl = ssl->conf->ca_crl;
6545 }
6546
6547 if( ca_chain != NULL )
6548 have_ca_chain = 1;
6549
6550 ret = mbedtls_x509_crt_verify_restartable(
6551 chain,
6552 ca_chain, ca_crl,
6553 ssl->conf->cert_profile,
6554 ssl->hostname,
6555 &ssl->session_negotiate->verify_result,
6556 f_vrfy, p_vrfy, rs_ctx );
6557 }
6558
6559 if( ret != 0 )
6560 {
6561 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6562 }
6563
6564#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6565 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6566 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6567#endif
6568
6569 /*
6570 * Secondary checks: always done, but change 'ret' only if it was 0
6571 */
6572
6573#if defined(MBEDTLS_ECP_C)
6574 {
6575 const mbedtls_pk_context *pk = &chain->pk;
6576
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006577 /* If certificate uses an EC key, make sure the curve is OK.
6578 * This is a public key, so it can't be opaque, so can_do() is a good
6579 * enough check to ensure pk_ec() is safe to use here. */
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006580 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) )
Jerry Yud9526692022-02-17 14:23:47 +08006581 {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006582 /* and in the unlikely case the above assumption no longer holds
6583 * we are making sure that pk_ec() here does not return a NULL
6584 */
6585 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *pk );
6586 if( ec == NULL )
6587 {
Tom Cosgrove20c11372022-08-24 15:06:13 +01006588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_pk_ec() returned NULL" ) );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006589 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6590 }
Jerry Yud9526692022-02-17 14:23:47 +08006591
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006592 if( mbedtls_ssl_check_curve( ssl, ec->grp.id ) != 0 )
6593 {
6594 ssl->session_negotiate->verify_result |=
6595 MBEDTLS_X509_BADCERT_BAD_KEY;
6596
6597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6598 if( ret == 0 )
6599 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6600 }
Jerry Yud9526692022-02-17 14:23:47 +08006601 }
6602 }
6603#endif /* MBEDTLS_ECP_C */
6604
6605 if( mbedtls_ssl_check_cert_usage( chain,
6606 ciphersuite_info,
6607 ! ssl->conf->endpoint,
6608 &ssl->session_negotiate->verify_result ) != 0 )
6609 {
6610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6611 if( ret == 0 )
6612 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6613 }
6614
6615 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6616 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6617 * with details encoded in the verification flags. All other kinds
6618 * of error codes, including those from the user provided f_vrfy
6619 * functions, are treated as fatal and lead to a failure of
6620 * ssl_parse_certificate even if verification was optional. */
6621 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6622 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6623 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6624 {
6625 ret = 0;
6626 }
6627
6628 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6629 {
6630 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6631 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6632 }
6633
6634 if( ret != 0 )
6635 {
6636 uint8_t alert;
6637
6638 /* The certificate may have been rejected for several reasons.
6639 Pick one and send the corresponding alert. Which alert to send
6640 may be a subject of debate in some cases. */
6641 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6642 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6643 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6644 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6645 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6646 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6647 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6648 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6649 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6650 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6651 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6652 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6653 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6654 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6655 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6656 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6657 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6658 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6659 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6660 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6661 else
6662 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6663 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6664 alert );
6665 }
6666
6667#if defined(MBEDTLS_DEBUG_C)
6668 if( ssl->session_negotiate->verify_result != 0 )
6669 {
6670 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6671 (unsigned int) ssl->session_negotiate->verify_result ) );
6672 }
6673 else
6674 {
6675 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6676 }
6677#endif /* MBEDTLS_DEBUG_C */
6678
6679 return( ret );
6680}
6681
6682#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006683MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006684static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6685 unsigned char *start, size_t len )
6686{
6687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6688 /* Remember digest of the peer's end-CRT. */
6689 ssl->session_negotiate->peer_cert_digest =
6690 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6691 if( ssl->session_negotiate->peer_cert_digest == NULL )
6692 {
6693 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6694 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6695 mbedtls_ssl_send_alert_message( ssl,
6696 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6697 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6698
6699 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6700 }
6701
6702 ret = mbedtls_md( mbedtls_md_info_from_type(
6703 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6704 start, len,
6705 ssl->session_negotiate->peer_cert_digest );
6706
6707 ssl->session_negotiate->peer_cert_digest_type =
6708 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6709 ssl->session_negotiate->peer_cert_digest_len =
6710 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6711
6712 return( ret );
6713}
6714
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006715MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006716static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6717 unsigned char *start, size_t len )
6718{
6719 unsigned char *end = start + len;
6720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6721
6722 /* Make a copy of the peer's raw public key. */
6723 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6724 ret = mbedtls_pk_parse_subpubkey( &start, end,
6725 &ssl->handshake->peer_pubkey );
6726 if( ret != 0 )
6727 {
6728 /* We should have parsed the public key before. */
6729 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6730 }
6731
6732 return( 0 );
6733}
6734#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6735
6736int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6737{
6738 int ret = 0;
6739 int crt_expected;
6740#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6741 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6742 ? ssl->handshake->sni_authmode
6743 : ssl->conf->authmode;
6744#else
6745 const int authmode = ssl->conf->authmode;
6746#endif
6747 void *rs_ctx = NULL;
6748 mbedtls_x509_crt *chain = NULL;
6749
6750 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6751
6752 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6753 if( crt_expected == SSL_CERTIFICATE_SKIP )
6754 {
6755 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6756 goto exit;
6757 }
6758
6759#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6760 if( ssl->handshake->ecrs_enabled &&
6761 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6762 {
6763 chain = ssl->handshake->ecrs_peer_cert;
6764 ssl->handshake->ecrs_peer_cert = NULL;
6765 goto crt_verify;
6766 }
6767#endif
6768
6769 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6770 {
6771 /* mbedtls_ssl_read_record may have sent an alert already. We
6772 let it decide whether to alert. */
6773 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6774 goto exit;
6775 }
6776
6777#if defined(MBEDTLS_SSL_SRV_C)
6778 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6779 {
6780 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6781
6782 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6783 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6784
6785 goto exit;
6786 }
6787#endif /* MBEDTLS_SSL_SRV_C */
6788
6789 /* Clear existing peer CRT structure in case we tried to
6790 * reuse a session but it failed, and allocate a new one. */
6791 ssl_clear_peer_cert( ssl->session_negotiate );
6792
6793 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6794 if( chain == NULL )
6795 {
6796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6797 sizeof( mbedtls_x509_crt ) ) );
6798 mbedtls_ssl_send_alert_message( ssl,
6799 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6800 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6801
6802 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6803 goto exit;
6804 }
6805 mbedtls_x509_crt_init( chain );
6806
6807 ret = ssl_parse_certificate_chain( ssl, chain );
6808 if( ret != 0 )
6809 goto exit;
6810
6811#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6812 if( ssl->handshake->ecrs_enabled)
6813 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6814
6815crt_verify:
6816 if( ssl->handshake->ecrs_enabled)
6817 rs_ctx = &ssl->handshake->ecrs_ctx;
6818#endif
6819
6820 ret = ssl_parse_certificate_verify( ssl, authmode,
6821 chain, rs_ctx );
6822 if( ret != 0 )
6823 goto exit;
6824
6825#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6826 {
6827 unsigned char *crt_start, *pk_start;
6828 size_t crt_len, pk_len;
6829
6830 /* We parse the CRT chain without copying, so
6831 * these pointers point into the input buffer,
6832 * and are hence still valid after freeing the
6833 * CRT chain. */
6834
6835 crt_start = chain->raw.p;
6836 crt_len = chain->raw.len;
6837
6838 pk_start = chain->pk_raw.p;
6839 pk_len = chain->pk_raw.len;
6840
6841 /* Free the CRT structures before computing
6842 * digest and copying the peer's public key. */
6843 mbedtls_x509_crt_free( chain );
6844 mbedtls_free( chain );
6845 chain = NULL;
6846
6847 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6848 if( ret != 0 )
6849 goto exit;
6850
6851 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6852 if( ret != 0 )
6853 goto exit;
6854 }
6855#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6856 /* Pass ownership to session structure. */
6857 ssl->session_negotiate->peer_cert = chain;
6858 chain = NULL;
6859#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6860
6861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6862
6863exit:
6864
6865 if( ret == 0 )
6866 ssl->state++;
6867
6868#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6869 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6870 {
6871 ssl->handshake->ecrs_peer_cert = chain;
6872 chain = NULL;
6873 }
6874#endif
6875
6876 if( chain != NULL )
6877 {
6878 mbedtls_x509_crt_free( chain );
6879 mbedtls_free( chain );
6880 }
6881
6882 return( ret );
6883}
6884#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6885
Andrzej Kurek25f27152022-08-17 16:09:31 -04006886#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu615bd6f2022-02-17 14:25:15 +08006887static void ssl_calc_finished_tls_sha256(
6888 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6889{
6890 int len = 12;
6891 const char *sender;
6892 unsigned char padbuf[32];
6893#if defined(MBEDTLS_USE_PSA_CRYPTO)
6894 size_t hash_size;
6895 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6896 psa_status_t status;
6897#else
6898 mbedtls_sha256_context sha256;
6899#endif
6900
6901 mbedtls_ssl_session *session = ssl->session_negotiate;
6902 if( !session )
6903 session = ssl->session;
6904
6905 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6906 ? "client finished"
6907 : "server finished";
6908
6909#if defined(MBEDTLS_USE_PSA_CRYPTO)
6910 sha256_psa = psa_hash_operation_init();
6911
6912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6913
6914 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6915 if( status != PSA_SUCCESS )
6916 {
6917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6918 return;
6919 }
6920
6921 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6922 if( status != PSA_SUCCESS )
6923 {
6924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6925 return;
6926 }
6927 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6928#else
6929
6930 mbedtls_sha256_init( &sha256 );
6931
6932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6933
6934 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6935
6936 /*
6937 * TLSv1.2:
6938 * hash = PRF( master, finished_label,
6939 * Hash( handshake ) )[0.11]
6940 */
6941
6942#if !defined(MBEDTLS_SHA256_ALT)
6943 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6944 sha256.state, sizeof( sha256.state ) );
6945#endif
6946
6947 mbedtls_sha256_finish( &sha256, padbuf );
6948 mbedtls_sha256_free( &sha256 );
6949#endif /* MBEDTLS_USE_PSA_CRYPTO */
6950
6951 ssl->handshake->tls_prf( session->master, 48, sender,
6952 padbuf, 32, buf, len );
6953
6954 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6955
6956 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6957
6958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6959}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006960#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08006961
Jerry Yub7ba49e2022-02-17 14:25:53 +08006962
Andrzej Kurek25f27152022-08-17 16:09:31 -04006963#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yub7ba49e2022-02-17 14:25:53 +08006964static void ssl_calc_finished_tls_sha384(
6965 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6966{
6967 int len = 12;
6968 const char *sender;
6969 unsigned char padbuf[48];
6970#if defined(MBEDTLS_USE_PSA_CRYPTO)
6971 size_t hash_size;
6972 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6973 psa_status_t status;
6974#else
6975 mbedtls_sha512_context sha512;
6976#endif
6977
6978 mbedtls_ssl_session *session = ssl->session_negotiate;
6979 if( !session )
6980 session = ssl->session;
6981
6982 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6983 ? "client finished"
6984 : "server finished";
6985
6986#if defined(MBEDTLS_USE_PSA_CRYPTO)
6987 sha384_psa = psa_hash_operation_init();
6988
6989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6990
6991 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6992 if( status != PSA_SUCCESS )
6993 {
6994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6995 return;
6996 }
6997
6998 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6999 if( status != PSA_SUCCESS )
7000 {
7001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7002 return;
7003 }
7004 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
7005#else
7006 mbedtls_sha512_init( &sha512 );
7007
7008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
7009
Andrzej Kureka242e832022-08-11 10:03:14 -04007010 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yub7ba49e2022-02-17 14:25:53 +08007011
7012 /*
7013 * TLSv1.2:
7014 * hash = PRF( master, finished_label,
7015 * Hash( handshake ) )[0.11]
7016 */
7017
7018#if !defined(MBEDTLS_SHA512_ALT)
7019 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
7020 sha512.state, sizeof( sha512.state ) );
7021#endif
7022 mbedtls_sha512_finish( &sha512, padbuf );
7023
7024 mbedtls_sha512_free( &sha512 );
7025#endif
7026
7027 ssl->handshake->tls_prf( session->master, 48, sender,
7028 padbuf, 48, buf, len );
7029
7030 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7031
7032 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7033
7034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7035}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007036#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007037
Jerry Yuaef00152022-02-17 14:27:31 +08007038void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7039{
7040 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7041
7042 /*
7043 * Free our handshake params
7044 */
7045 mbedtls_ssl_handshake_free( ssl );
7046 mbedtls_free( ssl->handshake );
7047 ssl->handshake = NULL;
7048
7049 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007050 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007051 */
7052 if( ssl->transform )
7053 {
7054 mbedtls_ssl_transform_free( ssl->transform );
7055 mbedtls_free( ssl->transform );
7056 }
7057 ssl->transform = ssl->transform_negotiate;
7058 ssl->transform_negotiate = NULL;
7059
7060 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7061}
7062
Jerry Yu2a9fff52022-02-17 14:28:51 +08007063void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7064{
7065 int resume = ssl->handshake->resume;
7066
7067 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7068
7069#if defined(MBEDTLS_SSL_RENEGOTIATION)
7070 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7071 {
7072 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7073 ssl->renego_records_seen = 0;
7074 }
7075#endif
7076
7077 /*
7078 * Free the previous session and switch in the current one
7079 */
7080 if( ssl->session )
7081 {
7082#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7083 /* RFC 7366 3.1: keep the EtM state */
7084 ssl->session_negotiate->encrypt_then_mac =
7085 ssl->session->encrypt_then_mac;
7086#endif
7087
7088 mbedtls_ssl_session_free( ssl->session );
7089 mbedtls_free( ssl->session );
7090 }
7091 ssl->session = ssl->session_negotiate;
7092 ssl->session_negotiate = NULL;
7093
7094 /*
7095 * Add cache entry
7096 */
7097 if( ssl->conf->f_set_cache != NULL &&
7098 ssl->session->id_len != 0 &&
7099 resume == 0 )
7100 {
7101 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7102 ssl->session->id,
7103 ssl->session->id_len,
7104 ssl->session ) != 0 )
7105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7106 }
7107
7108#if defined(MBEDTLS_SSL_PROTO_DTLS)
7109 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7110 ssl->handshake->flight != NULL )
7111 {
7112 /* Cancel handshake timer */
7113 mbedtls_ssl_set_timer( ssl, 0 );
7114
7115 /* Keep last flight around in case we need to resend it:
7116 * we need the handshake and transform structures for that */
7117 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7118 }
7119 else
7120#endif
7121 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7122
7123 ssl->state++;
7124
7125 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7126}
7127
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007128int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7129{
7130 int ret, hash_len;
7131
7132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7133
7134 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7135
7136 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7137
7138 /*
7139 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7140 * may define some other value. Currently (early 2016), no defined
7141 * ciphersuite does this (and this is unlikely to change as activity has
7142 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7143 */
7144 hash_len = 12;
7145
7146#if defined(MBEDTLS_SSL_RENEGOTIATION)
7147 ssl->verify_data_len = hash_len;
7148 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7149#endif
7150
7151 ssl->out_msglen = 4 + hash_len;
7152 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7153 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7154
7155 /*
7156 * In case of session resuming, invert the client and server
7157 * ChangeCipherSpec messages order.
7158 */
7159 if( ssl->handshake->resume != 0 )
7160 {
7161#if defined(MBEDTLS_SSL_CLI_C)
7162 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7163 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7164#endif
7165#if defined(MBEDTLS_SSL_SRV_C)
7166 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7167 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7168#endif
7169 }
7170 else
7171 ssl->state++;
7172
7173 /*
7174 * Switch to our negotiated transform and session parameters for outbound
7175 * data.
7176 */
7177 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7178
7179#if defined(MBEDTLS_SSL_PROTO_DTLS)
7180 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7181 {
7182 unsigned char i;
7183
7184 /* Remember current epoch settings for resending */
7185 ssl->handshake->alt_transform_out = ssl->transform_out;
7186 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7187 sizeof( ssl->handshake->alt_out_ctr ) );
7188
7189 /* Set sequence_number to zero */
7190 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7191
7192
7193 /* Increment epoch */
7194 for( i = 2; i > 0; i-- )
7195 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7196 break;
7197
7198 /* The loop goes to its end iff the counter is wrapping */
7199 if( i == 0 )
7200 {
7201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7202 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7203 }
7204 }
7205 else
7206#endif /* MBEDTLS_SSL_PROTO_DTLS */
7207 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7208
7209 ssl->transform_out = ssl->transform_negotiate;
7210 ssl->session_out = ssl->session_negotiate;
7211
7212#if defined(MBEDTLS_SSL_PROTO_DTLS)
7213 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7214 mbedtls_ssl_send_flight_completed( ssl );
7215#endif
7216
7217 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7218 {
7219 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7220 return( ret );
7221 }
7222
7223#if defined(MBEDTLS_SSL_PROTO_DTLS)
7224 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7225 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7226 {
7227 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7228 return( ret );
7229 }
7230#endif
7231
7232 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7233
7234 return( 0 );
7235}
7236
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007237#define SSL_MAX_HASH_LEN 12
7238
7239int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7240{
7241 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7242 unsigned int hash_len = 12;
7243 unsigned char buf[SSL_MAX_HASH_LEN];
7244
7245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7246
7247 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7248
7249 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7250 {
7251 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7252 goto exit;
7253 }
7254
7255 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7256 {
7257 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7258 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7259 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7260 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7261 goto exit;
7262 }
7263
7264 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7265 {
7266 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7267 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7268 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7269 goto exit;
7270 }
7271
7272 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7273 {
7274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7275 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7276 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7277 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7278 goto exit;
7279 }
7280
7281 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7282 buf, hash_len ) != 0 )
7283 {
7284 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7285 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7286 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7287 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7288 goto exit;
7289 }
7290
7291#if defined(MBEDTLS_SSL_RENEGOTIATION)
7292 ssl->verify_data_len = hash_len;
7293 memcpy( ssl->peer_verify_data, buf, hash_len );
7294#endif
7295
7296 if( ssl->handshake->resume != 0 )
7297 {
7298#if defined(MBEDTLS_SSL_CLI_C)
7299 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7300 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7301#endif
7302#if defined(MBEDTLS_SSL_SRV_C)
7303 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7304 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7305#endif
7306 }
7307 else
7308 ssl->state++;
7309
7310#if defined(MBEDTLS_SSL_PROTO_DTLS)
7311 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7312 mbedtls_ssl_recv_flight_completed( ssl );
7313#endif
7314
7315 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7316
7317exit:
7318 mbedtls_platform_zeroize( buf, hash_len );
7319 return( ret );
7320}
7321
Jerry Yu392112c2022-02-17 14:34:10 +08007322#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7323/*
7324 * Helper to get TLS 1.2 PRF from ciphersuite
7325 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7326 */
7327static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7328{
Andrzej Kurek25f27152022-08-17 16:09:31 -04007329#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu392112c2022-02-17 14:34:10 +08007330 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7331 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7332
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007333 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007334 return( tls_prf_sha384 );
7335#else
7336 (void) ciphersuite_id;
7337#endif
7338 return( tls_prf_sha256 );
7339}
7340#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007341
7342static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7343{
7344 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04007345#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007346 if( tls_prf == tls_prf_sha384 )
7347 {
7348 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7349 }
7350 else
7351#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04007352#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007353 if( tls_prf == tls_prf_sha256 )
7354 {
7355 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7356 }
7357 else
7358#endif
7359 return( MBEDTLS_SSL_TLS_PRF_NONE );
7360}
7361
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007362/*
7363 * Populate a transform structure with session keys and all the other
7364 * necessary information.
7365 *
7366 * Parameters:
7367 * - [in/out]: transform: structure to populate
7368 * [in] must be just initialised with mbedtls_ssl_transform_init()
7369 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7370 * - [in] ciphersuite
7371 * - [in] master
7372 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007373 * - [in] tls_prf: pointer to PRF to use for key derivation
7374 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007375 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007376 * - [in] endpoint: client or server
7377 * - [in] ssl: used for:
7378 * - ssl->conf->{f,p}_export_keys
7379 * [in] optionally used for:
7380 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7381 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007382MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7384 int ciphersuite,
7385 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007387 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007388#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007389 ssl_tls_prf_t tls_prf,
7390 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007391 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007392 unsigned endpoint,
7393 const mbedtls_ssl_context *ssl )
7394{
7395 int ret = 0;
7396 unsigned char keyblk[256];
7397 unsigned char *key1;
7398 unsigned char *key2;
7399 unsigned char *mac_enc;
7400 unsigned char *mac_dec;
7401 size_t mac_key_len = 0;
7402 size_t iv_copy_len;
7403 size_t keylen;
7404 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007405 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007406#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007407 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007408 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007409#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007410
7411#if defined(MBEDTLS_USE_PSA_CRYPTO)
7412 psa_key_type_t key_type;
7413 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7414 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007415 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007416 size_t key_bits;
7417 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7418#endif
7419
7420#if !defined(MBEDTLS_DEBUG_C) && \
7421 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7422 if( ssl->f_export_keys == NULL )
7423 {
7424 ssl = NULL; /* make sure we don't use it except for these cases */
7425 (void) ssl;
7426 }
7427#endif
7428
7429 /*
7430 * Some data just needs copying into the structure
7431 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007432#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007433 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007434#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007435 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007436
7437#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7438 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7439#endif
7440
7441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007442 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007443 {
7444 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7445 * generation separate. This should never happen. */
7446 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7447 }
7448#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7449
7450 /*
7451 * Get various info structures
7452 */
7453 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7454 if( ciphersuite_info == NULL )
7455 {
7456 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7457 ciphersuite ) );
7458 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7459 }
7460
Neil Armstrongab555e02022-04-04 11:07:59 +02007461 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007462#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007463 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007464#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007465 ciphersuite_info );
7466
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007467 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7468 transform->taglen =
7469 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7470
7471#if defined(MBEDTLS_USE_PSA_CRYPTO)
7472 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7473 transform->taglen,
7474 &alg,
7475 &key_type,
7476 &key_bits ) ) != PSA_SUCCESS )
7477 {
7478 ret = psa_ssl_status_to_mbedtls( status );
7479 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7480 goto end;
7481 }
7482#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007483 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7484 if( cipher_info == NULL )
7485 {
7486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7487 ciphersuite_info->cipher ) );
7488 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7489 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007490#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007491
Neil Armstronge4512952022-03-08 09:08:22 +01007492#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007493 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007494 if( mac_alg == 0 )
7495 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007497 (unsigned) ciphersuite_info->mac ) );
7498 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7499 }
7500#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007501 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7502 if( md_info == NULL )
7503 {
7504 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7505 (unsigned) ciphersuite_info->mac ) );
7506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7507 }
Neil Armstronge4512952022-03-08 09:08:22 +01007508#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007509
7510#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7511 /* Copy own and peer's CID if the use of the CID
7512 * extension has been negotiated. */
7513 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7514 {
7515 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7516
7517 transform->in_cid_len = ssl->own_cid_len;
7518 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7519 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7520 transform->in_cid_len );
7521
7522 transform->out_cid_len = ssl->handshake->peer_cid_len;
7523 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7524 ssl->handshake->peer_cid_len );
7525 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7526 transform->out_cid_len );
7527 }
7528#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7529
7530 /*
7531 * Compute key block using the PRF
7532 */
7533 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7534 if( ret != 0 )
7535 {
7536 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7537 return( ret );
7538 }
7539
7540 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7541 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7542 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7543 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7544 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7545
7546 /*
7547 * Determine the appropriate key, IV and MAC length.
7548 */
7549
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007550#if defined(MBEDTLS_USE_PSA_CRYPTO)
7551 keylen = PSA_BITS_TO_BYTES(key_bits);
7552#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007553 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007554#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007555
7556#if defined(MBEDTLS_GCM_C) || \
7557 defined(MBEDTLS_CCM_C) || \
7558 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007559 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007560 {
7561 size_t explicit_ivlen;
7562
7563 transform->maclen = 0;
7564 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007565
7566 /* All modes haves 96-bit IVs, but the length of the static parts vary
7567 * with mode and version:
7568 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7569 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7570 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7571 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7572 * sequence number).
7573 */
7574 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007575#if defined(MBEDTLS_USE_PSA_CRYPTO)
7576 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7577#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007578 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007579#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007580 transform->fixed_ivlen = 12;
7581 else
7582 transform->fixed_ivlen = 4;
7583
7584 /* Minimum length of encrypted record */
7585 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7586 transform->minlen = explicit_ivlen + transform->taglen;
7587 }
7588 else
7589#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7590#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007591 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7592 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7593 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007594 {
Neil Armstronge4512952022-03-08 09:08:22 +01007595#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007596 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007597#else
7598 size_t block_size = cipher_info->block_size;
7599#endif /* MBEDTLS_USE_PSA_CRYPTO */
7600
7601#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007602 /* Get MAC length */
7603 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7604#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007605 /* Initialize HMAC contexts */
7606 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7607 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7608 {
7609 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7610 goto end;
7611 }
7612
7613 /* Get MAC length */
7614 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007615#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007616 transform->maclen = mac_key_len;
7617
7618 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007619#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007620 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007621#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007622 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007623#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007624
7625 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007626 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007627 transform->minlen = transform->maclen;
7628 else
7629 {
7630 /*
7631 * GenericBlockCipher:
7632 * 1. if EtM is in use: one block plus MAC
7633 * otherwise: * first multiple of blocklen greater than maclen
7634 * 2. IV
7635 */
7636#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007637 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007638 {
7639 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007640 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007641 }
7642 else
7643#endif
7644 {
7645 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007646 + block_size
7647 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007648 }
7649
Glenn Strauss07c64162022-03-14 12:34:51 -04007650 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007651 {
7652 transform->minlen += transform->ivlen;
7653 }
7654 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007655 {
7656 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7657 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7658 goto end;
7659 }
7660 }
7661 }
7662 else
7663#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7664 {
7665 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7666 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7667 }
7668
7669 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7670 (unsigned) keylen,
7671 (unsigned) transform->minlen,
7672 (unsigned) transform->ivlen,
7673 (unsigned) transform->maclen ) );
7674
7675 /*
7676 * Finally setup the cipher contexts, IVs and MAC secrets.
7677 */
7678#if defined(MBEDTLS_SSL_CLI_C)
7679 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7680 {
7681 key1 = keyblk + mac_key_len * 2;
7682 key2 = keyblk + mac_key_len * 2 + keylen;
7683
7684 mac_enc = keyblk;
7685 mac_dec = keyblk + mac_key_len;
7686
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007687 iv_copy_len = ( transform->fixed_ivlen ) ?
7688 transform->fixed_ivlen : transform->ivlen;
7689 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7690 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7691 iv_copy_len );
7692 }
7693 else
7694#endif /* MBEDTLS_SSL_CLI_C */
7695#if defined(MBEDTLS_SSL_SRV_C)
7696 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7697 {
7698 key1 = keyblk + mac_key_len * 2 + keylen;
7699 key2 = keyblk + mac_key_len * 2;
7700
7701 mac_enc = keyblk + mac_key_len;
7702 mac_dec = keyblk;
7703
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007704 iv_copy_len = ( transform->fixed_ivlen ) ?
7705 transform->fixed_ivlen : transform->ivlen;
7706 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7707 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7708 iv_copy_len );
7709 }
7710 else
7711#endif /* MBEDTLS_SSL_SRV_C */
7712 {
7713 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7714 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7715 goto end;
7716 }
7717
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007718 if( ssl != NULL && ssl->f_export_keys != NULL )
7719 {
7720 ssl->f_export_keys( ssl->p_export_keys,
7721 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7722 master, 48,
7723 randbytes + 32,
7724 randbytes,
7725 tls_prf_get_type( tls_prf ) );
7726 }
7727
7728#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007729 transform->psa_alg = alg;
7730
7731 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7732 {
7733 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7734 psa_set_key_algorithm( &attributes, alg );
7735 psa_set_key_type( &attributes, key_type );
7736
7737 if( ( status = psa_import_key( &attributes,
7738 key1,
7739 PSA_BITS_TO_BYTES( key_bits ),
7740 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7741 {
7742 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7743 ret = psa_ssl_status_to_mbedtls( status );
7744 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7745 goto end;
7746 }
7747
7748 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7749
7750 if( ( status = psa_import_key( &attributes,
7751 key2,
7752 PSA_BITS_TO_BYTES( key_bits ),
7753 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7754 {
7755 ret = psa_ssl_status_to_mbedtls( status );
7756 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7757 goto end;
7758 }
7759 }
7760#else
7761 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7762 cipher_info ) ) != 0 )
7763 {
7764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7765 goto end;
7766 }
7767
7768 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7769 cipher_info ) ) != 0 )
7770 {
7771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7772 goto end;
7773 }
7774
7775 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7776 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7777 MBEDTLS_ENCRYPT ) ) != 0 )
7778 {
7779 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7780 goto end;
7781 }
7782
7783 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7784 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7785 MBEDTLS_DECRYPT ) ) != 0 )
7786 {
7787 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7788 goto end;
7789 }
7790
7791#if defined(MBEDTLS_CIPHER_MODE_CBC)
7792 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7793 {
7794 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7795 MBEDTLS_PADDING_NONE ) ) != 0 )
7796 {
7797 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7798 goto end;
7799 }
7800
7801 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7802 MBEDTLS_PADDING_NONE ) ) != 0 )
7803 {
7804 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7805 goto end;
7806 }
7807 }
7808#endif /* MBEDTLS_CIPHER_MODE_CBC */
7809#endif /* MBEDTLS_USE_PSA_CRYPTO */
7810
Neil Armstrong29c0c042022-03-17 17:47:28 +01007811#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7812 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7813 For AEAD-based ciphersuites, there is nothing to do here. */
7814 if( mac_key_len != 0 )
7815 {
7816#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007817 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007818
7819 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007820 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007821 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7822
7823 if( ( status = psa_import_key( &attributes,
7824 mac_enc, mac_key_len,
7825 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7826 {
7827 ret = psa_ssl_status_to_mbedtls( status );
7828 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7829 goto end;
7830 }
7831
Ronald Cronfb39f152022-03-25 14:36:28 +01007832 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007833 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
7834#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
7835 && ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED )
7836#endif
7837 ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007838 /* mbedtls_ct_hmac() requires the key to be exportable */
7839 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7840 PSA_KEY_USAGE_VERIFY_HASH );
7841 else
7842 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7843
7844 if( ( status = psa_import_key( &attributes,
7845 mac_dec, mac_key_len,
7846 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7847 {
7848 ret = psa_ssl_status_to_mbedtls( status );
7849 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7850 goto end;
7851 }
7852#else
7853 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7854 if( ret != 0 )
7855 goto end;
7856 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7857 if( ret != 0 )
7858 goto end;
7859#endif /* MBEDTLS_USE_PSA_CRYPTO */
7860 }
7861#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7862
7863 ((void) mac_dec);
7864 ((void) mac_enc);
7865
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007866end:
7867 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7868 return( ret );
7869}
7870
Jerry Yuee40f9d2022-02-17 14:55:16 +08007871#if defined(MBEDTLS_USE_PSA_CRYPTO)
7872int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7873 unsigned char *hash, size_t *hashlen,
7874 unsigned char *data, size_t data_len,
7875 mbedtls_md_type_t md_alg )
7876{
7877 psa_status_t status;
7878 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007879 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007880
7881 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7882
7883 if( ( status = psa_hash_setup( &hash_operation,
7884 hash_alg ) ) != PSA_SUCCESS )
7885 {
7886 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7887 goto exit;
7888 }
7889
7890 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7891 64 ) ) != PSA_SUCCESS )
7892 {
7893 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7894 goto exit;
7895 }
7896
7897 if( ( status = psa_hash_update( &hash_operation,
7898 data, data_len ) ) != PSA_SUCCESS )
7899 {
7900 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7901 goto exit;
7902 }
7903
7904 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7905 hashlen ) ) != PSA_SUCCESS )
7906 {
7907 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7908 goto exit;
7909 }
7910
7911exit:
7912 if( status != PSA_SUCCESS )
7913 {
7914 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7915 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7916 switch( status )
7917 {
7918 case PSA_ERROR_NOT_SUPPORTED:
7919 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7920 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7921 case PSA_ERROR_BUFFER_TOO_SMALL:
7922 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7923 case PSA_ERROR_INSUFFICIENT_MEMORY:
7924 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7925 default:
7926 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7927 }
7928 }
7929 return( 0 );
7930}
7931
7932#else
7933
7934int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7935 unsigned char *hash, size_t *hashlen,
7936 unsigned char *data, size_t data_len,
7937 mbedtls_md_type_t md_alg )
7938{
7939 int ret = 0;
7940 mbedtls_md_context_t ctx;
7941 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7942 *hashlen = mbedtls_md_get_size( md_info );
7943
7944 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7945
7946 mbedtls_md_init( &ctx );
7947
7948 /*
7949 * digitally-signed struct {
7950 * opaque client_random[32];
7951 * opaque server_random[32];
7952 * ServerDHParams params;
7953 * };
7954 */
7955 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7956 {
7957 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7958 goto exit;
7959 }
7960 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7961 {
7962 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7963 goto exit;
7964 }
7965 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7966 {
7967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7968 goto exit;
7969 }
7970 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7971 {
7972 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7973 goto exit;
7974 }
7975 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7976 {
7977 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7978 goto exit;
7979 }
7980
7981exit:
7982 mbedtls_md_free( &ctx );
7983
7984 if( ret != 0 )
7985 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7986 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7987
7988 return( ret );
7989}
7990#endif /* MBEDTLS_USE_PSA_CRYPTO */
7991
Jerry Yud9d91da2022-02-17 14:57:06 +08007992#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7993
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007994/* Find the preferred hash for a given signature algorithm. */
7995unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7996 mbedtls_ssl_context *ssl,
7997 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007998{
Gabor Mezei078e8032022-04-27 21:17:56 +02007999 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008000 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008001
8002 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008003 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02008004
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008005 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08008006 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008007 unsigned int hash_alg_received =
8008 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8009 received_sig_algs[i] );
8010 unsigned int sig_alg_received =
8011 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8012 received_sig_algs[i] );
8013
8014 if( sig_alg == sig_alg_received )
8015 {
8016#if defined(MBEDTLS_USE_PSA_CRYPTO)
8017 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
8018 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008019 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008020 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008021
Neil Armstrong96eceb82022-06-30 18:05:05 +02008022 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8023 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8024 PSA_ALG_ECDSA( psa_hash_alg ),
8025 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008026 continue;
8027
Neil Armstrong96eceb82022-06-30 18:05:05 +02008028 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008029 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8030 PSA_ALG_RSA_PKCS1V15_SIGN(
8031 psa_hash_alg ),
8032 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008033 continue;
8034 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008035#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008036
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008037 return( hash_alg_received );
8038 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008039 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008040
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008041 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008042}
8043
8044#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8045
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008046/* Serialization of TLS 1.2 sessions:
8047 *
8048 * struct {
8049 * uint64 start_time;
8050 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008051 * uint8 session_id_len; // at most 32
8052 * opaque session_id[32];
8053 * opaque master[48]; // fixed length in the standard
8054 * uint32 verify_result;
8055 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8056 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8057 * uint32 ticket_lifetime;
8058 * uint8 mfl_code; // up to 255 according to standard
8059 * uint8 encrypt_then_mac; // 0 or 1
8060 * } serialized_session_tls12;
8061 *
8062 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008063static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008064 unsigned char *buf,
8065 size_t buf_len )
8066{
8067 unsigned char *p = buf;
8068 size_t used = 0;
8069
8070#if defined(MBEDTLS_HAVE_TIME)
8071 uint64_t start;
8072#endif
8073#if defined(MBEDTLS_X509_CRT_PARSE_C)
8074#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8075 size_t cert_len;
8076#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8077#endif /* MBEDTLS_X509_CRT_PARSE_C */
8078
8079 /*
8080 * Time
8081 */
8082#if defined(MBEDTLS_HAVE_TIME)
8083 used += 8;
8084
8085 if( used <= buf_len )
8086 {
8087 start = (uint64_t) session->start;
8088
8089 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8090 p += 8;
8091 }
8092#endif /* MBEDTLS_HAVE_TIME */
8093
8094 /*
8095 * Basic mandatory fields
8096 */
8097 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008098 + 1 /* id_len */
8099 + sizeof( session->id )
8100 + sizeof( session->master )
8101 + 4; /* verify_result */
8102
8103 if( used <= buf_len )
8104 {
8105 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8106 p += 2;
8107
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008108 *p++ = MBEDTLS_BYTE_0( session->id_len );
8109 memcpy( p, session->id, 32 );
8110 p += 32;
8111
8112 memcpy( p, session->master, 48 );
8113 p += 48;
8114
8115 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8116 p += 4;
8117 }
8118
8119 /*
8120 * Peer's end-entity certificate
8121 */
8122#if defined(MBEDTLS_X509_CRT_PARSE_C)
8123#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8124 if( session->peer_cert == NULL )
8125 cert_len = 0;
8126 else
8127 cert_len = session->peer_cert->raw.len;
8128
8129 used += 3 + cert_len;
8130
8131 if( used <= buf_len )
8132 {
8133 *p++ = MBEDTLS_BYTE_2( cert_len );
8134 *p++ = MBEDTLS_BYTE_1( cert_len );
8135 *p++ = MBEDTLS_BYTE_0( cert_len );
8136
8137 if( session->peer_cert != NULL )
8138 {
8139 memcpy( p, session->peer_cert->raw.p, cert_len );
8140 p += cert_len;
8141 }
8142 }
8143#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8144 if( session->peer_cert_digest != NULL )
8145 {
8146 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8147 if( used <= buf_len )
8148 {
8149 *p++ = (unsigned char) session->peer_cert_digest_type;
8150 *p++ = (unsigned char) session->peer_cert_digest_len;
8151 memcpy( p, session->peer_cert_digest,
8152 session->peer_cert_digest_len );
8153 p += session->peer_cert_digest_len;
8154 }
8155 }
8156 else
8157 {
8158 used += 2;
8159 if( used <= buf_len )
8160 {
8161 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8162 *p++ = 0;
8163 }
8164 }
8165#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8166#endif /* MBEDTLS_X509_CRT_PARSE_C */
8167
8168 /*
8169 * Session ticket if any, plus associated data
8170 */
8171#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8172 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8173
8174 if( used <= buf_len )
8175 {
8176 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8177 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8178 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8179
8180 if( session->ticket != NULL )
8181 {
8182 memcpy( p, session->ticket, session->ticket_len );
8183 p += session->ticket_len;
8184 }
8185
8186 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8187 p += 4;
8188 }
8189#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8190
8191 /*
8192 * Misc extension-related info
8193 */
8194#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8195 used += 1;
8196
8197 if( used <= buf_len )
8198 *p++ = session->mfl_code;
8199#endif
8200
8201#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8202 used += 1;
8203
8204 if( used <= buf_len )
8205 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8206#endif
8207
8208 return( used );
8209}
8210
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008211MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008212static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008213 const unsigned char *buf,
8214 size_t len )
8215{
8216#if defined(MBEDTLS_HAVE_TIME)
8217 uint64_t start;
8218#endif
8219#if defined(MBEDTLS_X509_CRT_PARSE_C)
8220#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8221 size_t cert_len;
8222#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8223#endif /* MBEDTLS_X509_CRT_PARSE_C */
8224
8225 const unsigned char *p = buf;
8226 const unsigned char * const end = buf + len;
8227
8228 /*
8229 * Time
8230 */
8231#if defined(MBEDTLS_HAVE_TIME)
8232 if( 8 > (size_t)( end - p ) )
8233 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8234
8235 start = ( (uint64_t) p[0] << 56 ) |
8236 ( (uint64_t) p[1] << 48 ) |
8237 ( (uint64_t) p[2] << 40 ) |
8238 ( (uint64_t) p[3] << 32 ) |
8239 ( (uint64_t) p[4] << 24 ) |
8240 ( (uint64_t) p[5] << 16 ) |
8241 ( (uint64_t) p[6] << 8 ) |
8242 ( (uint64_t) p[7] );
8243 p += 8;
8244
8245 session->start = (time_t) start;
8246#endif /* MBEDTLS_HAVE_TIME */
8247
8248 /*
8249 * Basic mandatory fields
8250 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008251 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008252 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8253
8254 session->ciphersuite = ( p[0] << 8 ) | p[1];
8255 p += 2;
8256
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008257 session->id_len = *p++;
8258 memcpy( session->id, p, 32 );
8259 p += 32;
8260
8261 memcpy( session->master, p, 48 );
8262 p += 48;
8263
8264 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8265 ( (uint32_t) p[1] << 16 ) |
8266 ( (uint32_t) p[2] << 8 ) |
8267 ( (uint32_t) p[3] );
8268 p += 4;
8269
8270 /* Immediately clear invalid pointer values that have been read, in case
8271 * we exit early before we replaced them with valid ones. */
8272#if defined(MBEDTLS_X509_CRT_PARSE_C)
8273#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8274 session->peer_cert = NULL;
8275#else
8276 session->peer_cert_digest = NULL;
8277#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8278#endif /* MBEDTLS_X509_CRT_PARSE_C */
8279#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8280 session->ticket = NULL;
8281#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8282
8283 /*
8284 * Peer certificate
8285 */
8286#if defined(MBEDTLS_X509_CRT_PARSE_C)
8287#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8288 /* Deserialize CRT from the end of the ticket. */
8289 if( 3 > (size_t)( end - p ) )
8290 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8291
8292 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8293 p += 3;
8294
8295 if( cert_len != 0 )
8296 {
8297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8298
8299 if( cert_len > (size_t)( end - p ) )
8300 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8301
8302 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8303
8304 if( session->peer_cert == NULL )
8305 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8306
8307 mbedtls_x509_crt_init( session->peer_cert );
8308
8309 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8310 p, cert_len ) ) != 0 )
8311 {
8312 mbedtls_x509_crt_free( session->peer_cert );
8313 mbedtls_free( session->peer_cert );
8314 session->peer_cert = NULL;
8315 return( ret );
8316 }
8317
8318 p += cert_len;
8319 }
8320#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8321 /* Deserialize CRT digest from the end of the ticket. */
8322 if( 2 > (size_t)( end - p ) )
8323 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8324
8325 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8326 session->peer_cert_digest_len = (size_t) *p++;
8327
8328 if( session->peer_cert_digest_len != 0 )
8329 {
8330 const mbedtls_md_info_t *md_info =
8331 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8332 if( md_info == NULL )
8333 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8334 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8335 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8336
8337 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8338 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8339
8340 session->peer_cert_digest =
8341 mbedtls_calloc( 1, session->peer_cert_digest_len );
8342 if( session->peer_cert_digest == NULL )
8343 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8344
8345 memcpy( session->peer_cert_digest, p,
8346 session->peer_cert_digest_len );
8347 p += session->peer_cert_digest_len;
8348 }
8349#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8350#endif /* MBEDTLS_X509_CRT_PARSE_C */
8351
8352 /*
8353 * Session ticket and associated data
8354 */
8355#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8356 if( 3 > (size_t)( end - p ) )
8357 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8358
8359 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8360 p += 3;
8361
8362 if( session->ticket_len != 0 )
8363 {
8364 if( session->ticket_len > (size_t)( end - p ) )
8365 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8366
8367 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8368 if( session->ticket == NULL )
8369 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8370
8371 memcpy( session->ticket, p, session->ticket_len );
8372 p += session->ticket_len;
8373 }
8374
8375 if( 4 > (size_t)( end - p ) )
8376 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8377
8378 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8379 ( (uint32_t) p[1] << 16 ) |
8380 ( (uint32_t) p[2] << 8 ) |
8381 ( (uint32_t) p[3] );
8382 p += 4;
8383#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8384
8385 /*
8386 * Misc extension-related info
8387 */
8388#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8389 if( 1 > (size_t)( end - p ) )
8390 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8391
8392 session->mfl_code = *p++;
8393#endif
8394
8395#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8396 if( 1 > (size_t)( end - p ) )
8397 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8398
8399 session->encrypt_then_mac = *p++;
8400#endif
8401
8402 /* Done, should have consumed entire buffer */
8403 if( p != end )
8404 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8405
8406 return( 0 );
8407}
Jerry Yudc7bd172022-02-17 13:44:15 +08008408#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8409
XiaokangQian75d40ef2022-04-20 11:05:24 +00008410int mbedtls_ssl_validate_ciphersuite(
8411 const mbedtls_ssl_context *ssl,
8412 const mbedtls_ssl_ciphersuite_t *suite_info,
8413 mbedtls_ssl_protocol_version min_tls_version,
8414 mbedtls_ssl_protocol_version max_tls_version )
8415{
8416 (void) ssl;
8417
8418 if( suite_info == NULL )
8419 return( -1 );
8420
8421 if( ( suite_info->min_tls_version > max_tls_version ) ||
8422 ( suite_info->max_tls_version < min_tls_version ) )
8423 {
8424 return( -1 );
8425 }
8426
XiaokangQian060d8672022-04-21 09:24:56 +00008427#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008428#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8429 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8430 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8431 {
8432 return( -1 );
8433 }
8434#endif
8435
8436 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8437#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8438 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8439 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8440 {
8441 return( -1 );
8442 }
8443#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8444#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8445
8446 return( 0 );
8447}
8448
XiaokangQianeaf36512022-04-24 09:07:44 +00008449#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8450/*
8451 * Function for writing a signature algorithm extension.
8452 *
8453 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8454 * value (TLS 1.3 RFC8446):
8455 * enum {
8456 * ....
8457 * ecdsa_secp256r1_sha256( 0x0403 ),
8458 * ecdsa_secp384r1_sha384( 0x0503 ),
8459 * ecdsa_secp521r1_sha512( 0x0603 ),
8460 * ....
8461 * } SignatureScheme;
8462 *
8463 * struct {
8464 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8465 * } SignatureSchemeList;
8466 *
8467 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8468 * value (TLS 1.2 RFC5246):
8469 * enum {
8470 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8471 * sha512(6), (255)
8472 * } HashAlgorithm;
8473 *
8474 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8475 * SignatureAlgorithm;
8476 *
8477 * struct {
8478 * HashAlgorithm hash;
8479 * SignatureAlgorithm signature;
8480 * } SignatureAndHashAlgorithm;
8481 *
8482 * SignatureAndHashAlgorithm
8483 * supported_signature_algorithms<2..2^16-2>;
8484 *
8485 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8486 * generalization of the TLS 1.2 signature algorithm extension.
8487 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8488 * `SignatureScheme` field of TLS 1.3
8489 *
8490 */
8491int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8492 const unsigned char *end, size_t *out_len )
8493{
8494 unsigned char *p = buf;
8495 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8496 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8497
8498 *out_len = 0;
8499
8500 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8501
8502 /* Check if we have space for header and length field:
8503 * - extension_type (2 bytes)
8504 * - extension_data_length (2 bytes)
8505 * - supported_signature_algorithms_length (2 bytes)
8506 */
8507 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8508 p += 6;
8509
8510 /*
8511 * Write supported_signature_algorithms
8512 */
8513 supported_sig_alg = p;
8514 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8515 if( sig_alg == NULL )
8516 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8517
8518 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8519 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008520 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8521 *sig_alg,
8522 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008523 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8524 continue;
8525 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8526 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8527 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008528 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008529 *sig_alg,
8530 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008531 }
8532
8533 /* Length of supported_signature_algorithms */
8534 supported_sig_alg_len = p - supported_sig_alg;
8535 if( supported_sig_alg_len == 0 )
8536 {
8537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8538 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8539 }
8540
XiaokangQianeaf36512022-04-24 09:07:44 +00008541 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008542 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008543 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8544
XiaokangQianeaf36512022-04-24 09:07:44 +00008545 *out_len = p - buf;
8546
8547#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8548 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8549#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8550 return( 0 );
8551}
8552#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8553
XiaokangQian40a35232022-05-07 09:02:40 +00008554#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008555/*
8556 * mbedtls_ssl_parse_server_name_ext
8557 *
8558 * Structure of server_name extension:
8559 *
8560 * enum {
8561 * host_name(0), (255)
8562 * } NameType;
8563 * opaque HostName<1..2^16-1>;
8564 *
8565 * struct {
8566 * NameType name_type;
8567 * select (name_type) {
8568 * case host_name: HostName;
8569 * } name;
8570 * } ServerName;
8571 * struct {
8572 * ServerName server_name_list<1..2^16-1>
8573 * } ServerNameList;
8574 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008575MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008576int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8577 const unsigned char *buf,
8578 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008579{
8580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8581 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008582 size_t server_name_list_len, hostname_len;
8583 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008584
XiaokangQianf2a94202022-05-20 06:44:24 +00008585 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008586
8587 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008588 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008589 p += 2;
8590
XiaokangQian9b2b7712022-05-17 02:57:00 +00008591 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8592 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008593 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008594 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008595 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008596 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008597 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8598 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008599
8600 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8601 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008602 /* sni_name is intended to be used only during the parsing of the
8603 * ClientHello message (it is reset to NULL before the end of
8604 * the message parsing). Thus it is ok to just point to the
8605 * reception buffer and not make a copy of it.
8606 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008607 ssl->handshake->sni_name = p + 3;
8608 ssl->handshake->sni_name_len = hostname_len;
8609 if( ssl->conf->f_sni == NULL )
8610 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008611 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008612 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008613 if( ret != 0 )
8614 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008615 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008616 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8617 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008618 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8619 }
8620 return( 0 );
8621 }
8622
8623 p += hostname_len + 3;
8624 }
8625
8626 return( 0 );
8627}
8628#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8629
XiaokangQianacb39922022-06-17 10:18:48 +00008630#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008631MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008632int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8633 const unsigned char *buf,
8634 const unsigned char *end )
8635{
8636 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008637 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008638 const unsigned char *protocol_name_list;
8639 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008640 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008641
8642 /* If ALPN not configured, just ignore the extension */
8643 if( ssl->conf->alpn_list == NULL )
8644 return( 0 );
8645
8646 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008647 * RFC7301, section 3.1
8648 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008649 *
XiaokangQianc7403452022-06-23 03:24:12 +00008650 * struct {
8651 * ProtocolName protocol_name_list<2..2^16-1>
8652 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008653 */
8654
XiaokangQianc7403452022-06-23 03:24:12 +00008655 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008656 * protocol_name_list_len 2 bytes
8657 * protocol_name_len 1 bytes
8658 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008659 */
XiaokangQianacb39922022-06-17 10:18:48 +00008660 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8661
XiaokangQianc7403452022-06-23 03:24:12 +00008662 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008663 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008664 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008665 protocol_name_list = p;
8666 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008667
8668 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008669 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008670 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008671 protocol_name_len = *p++;
8672 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8673 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008674 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008675 {
8676 MBEDTLS_SSL_PEND_FATAL_ALERT(
8677 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8678 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008679 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008680 }
8681
8682 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008683 }
8684
8685 /* Use our order of preference */
8686 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8687 {
8688 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008689 p = protocol_name_list;
8690 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008691 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008692 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008693 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008694 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008695 {
8696 ssl->alpn_chosen = *alpn;
8697 return( 0 );
8698 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008699
8700 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008701 }
8702 }
8703
XiaokangQian95d5f542022-06-24 02:29:26 +00008704 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008705 MBEDTLS_SSL_PEND_FATAL_ALERT(
8706 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8707 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8708 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8709}
8710
8711int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8712 unsigned char *buf,
8713 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008714 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008715{
8716 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008717 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008718 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008719
8720 if( ssl->alpn_chosen == NULL )
8721 {
8722 return( 0 );
8723 }
8724
XiaokangQian95d5f542022-06-24 02:29:26 +00008725 protocol_name_len = strlen( ssl->alpn_chosen );
8726 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008727
8728 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8729 /*
8730 * 0 . 1 ext identifier
8731 * 2 . 3 ext length
8732 * 4 . 5 protocol list length
8733 * 6 . 6 protocol name length
8734 * 7 . 7+n protocol name
8735 */
8736 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8737
XiaokangQian95d5f542022-06-24 02:29:26 +00008738 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008739
XiaokangQian95d5f542022-06-24 02:29:26 +00008740 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8741 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008742 /* Note: the length of the chosen protocol has been checked to be less
8743 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8744 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008745 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008746
XiaokangQian95d5f542022-06-24 02:29:26 +00008747 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008748 return ( 0 );
8749}
8750#endif /* MBEDTLS_SSL_ALPN */
8751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008752#endif /* MBEDTLS_SSL_TLS_C */