blob: 04f9af05df855cd85e8f6545bed16288a33a198b [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
387 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
388 int encrypt_then_mac,
389#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
390 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
391 ssl_tls_prf_t tls_prf,
392 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400393 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800394 unsigned endpoint,
395 const mbedtls_ssl_context *ssl );
396
397#if defined(MBEDTLS_SHA256_C)
398static int tls_prf_sha256( const unsigned char *secret, size_t slen,
399 const char *label,
400 const unsigned char *random, size_t rlen,
401 unsigned char *dstbuf, size_t dlen );
402static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
403static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
404
405#endif /* MBEDTLS_SHA256_C */
406
407#if defined(MBEDTLS_SHA384_C)
408static int tls_prf_sha384( const unsigned char *secret, size_t slen,
409 const char *label,
410 const unsigned char *random, size_t rlen,
411 unsigned char *dstbuf, size_t dlen );
412
413static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
414static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
415#endif /* MBEDTLS_SHA384_C */
416
417static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
418 unsigned char *buf,
419 size_t buf_len );
420static int ssl_session_load_tls12( mbedtls_ssl_session *session,
421 const unsigned char *buf,
422 size_t len );
423#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
424
Jerry Yu53d23e22022-02-09 16:25:09 +0800425static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
426
Jerry Yudb8c48a2022-01-27 14:54:54 +0800427#if defined(MBEDTLS_SHA256_C)
428static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800429#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800430
431#if defined(MBEDTLS_SHA384_C)
432static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800433#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000434
Ron Eldor51d3ab52019-05-12 14:54:30 +0300435int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
436 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{
441 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
442
443 switch( prf )
444 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200446#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300447 case MBEDTLS_SSL_TLS_PRF_SHA384:
448 tls_prf = tls_prf_sha384;
449 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200450#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300451#if defined(MBEDTLS_SHA256_C)
452 case MBEDTLS_SSL_TLS_PRF_SHA256:
453 tls_prf = tls_prf_sha256;
454 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300455#endif /* MBEDTLS_SHA256_C */
456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300457 default:
458 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
459 }
460
461 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
462}
463
Jerry Yuc73c6182022-02-08 20:29:25 +0800464#if defined(MBEDTLS_X509_CRT_PARSE_C)
465static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
466{
467#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
468 if( session->peer_cert != NULL )
469 {
470 mbedtls_x509_crt_free( session->peer_cert );
471 mbedtls_free( session->peer_cert );
472 session->peer_cert = NULL;
473 }
474#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
475 if( session->peer_cert_digest != NULL )
476 {
477 /* Zeroization is not necessary. */
478 mbedtls_free( session->peer_cert_digest );
479 session->peer_cert_digest = NULL;
480 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
481 session->peer_cert_digest_len = 0;
482 }
483#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
484}
485#endif /* MBEDTLS_X509_CRT_PARSE_C */
486
487void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
488 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
489{
490 ((void) ciphersuite_info);
491
492#if defined(MBEDTLS_SHA384_C)
493 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
494 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
495 else
496#endif
497#if defined(MBEDTLS_SHA256_C)
498 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
499 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
500 else
501#endif
502 {
503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
504 return;
505 }
506}
507
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100508static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
509 unsigned hs_type,
510 size_t total_hs_len )
511{
512 unsigned char hs_hdr[4];
513
514 /* Build HS header for checksum update. */
515 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
516 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
517 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
518 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
519
520 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
521}
522
523void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
524 unsigned hs_type,
525 unsigned char const *msg,
526 size_t msg_len )
527{
528 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
529 ssl->handshake->update_checksum( ssl, msg, msg_len );
530}
531
Jerry Yuc73c6182022-02-08 20:29:25 +0800532void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
533{
534 ((void) ssl);
535#if defined(MBEDTLS_SHA256_C)
536#if defined(MBEDTLS_USE_PSA_CRYPTO)
537 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
538 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
539#else
540 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
541#endif
542#endif
543#if defined(MBEDTLS_SHA384_C)
544#if defined(MBEDTLS_USE_PSA_CRYPTO)
545 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
546 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
547#else
548 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
549#endif
550#endif
551}
552
553static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
554 const unsigned char *buf, size_t len )
555{
556#if defined(MBEDTLS_SHA256_C)
557#if defined(MBEDTLS_USE_PSA_CRYPTO)
558 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
559#else
560 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
561#endif
562#endif
563#if defined(MBEDTLS_SHA384_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
566#else
567 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
568#endif
569#endif
570}
571
572#if defined(MBEDTLS_SHA256_C)
573static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
574 const unsigned char *buf, size_t len )
575{
576#if defined(MBEDTLS_USE_PSA_CRYPTO)
577 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
578#else
579 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
580#endif
581}
582#endif
583
584#if defined(MBEDTLS_SHA384_C)
585static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
586 const unsigned char *buf, size_t len )
587{
588#if defined(MBEDTLS_USE_PSA_CRYPTO)
589 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
590#else
591 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
592#endif
593}
594#endif
595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500601#if defined(MBEDTLS_USE_PSA_CRYPTO)
602 handshake->fin_sha256_psa = psa_hash_operation_init();
603 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
604#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200606 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200607#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200609#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500610#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500611 handshake->fin_sha384_psa = psa_hash_operation_init();
612 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500613#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200615 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500617#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200618
619 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100620
621#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100622 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100623 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
624#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626#if defined(MBEDTLS_DHM_C)
627 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200628#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629#if defined(MBEDTLS_ECDH_C)
630 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200631#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200632#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200633 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200634#if defined(MBEDTLS_SSL_CLI_C)
635 handshake->ecjpake_cache = NULL;
636 handshake->ecjpake_cache_len = 0;
637#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200638#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200639
Gilles Peskineeccd8882020-03-10 12:19:08 +0100640#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200641 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200642#endif
643
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200644#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
645 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
646#endif
Hanno Becker75173122019-02-06 16:18:31 +0000647
648#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
649 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
650 mbedtls_pk_init( &handshake->peer_pubkey );
651#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200652}
653
Hanno Beckera18d1322018-01-03 14:27:32 +0000654void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200655{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200657
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100658#if defined(MBEDTLS_USE_PSA_CRYPTO)
659 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
660 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100661#else
662 mbedtls_cipher_init( &transform->cipher_ctx_enc );
663 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100664#endif
665
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000666#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100667#if defined(MBEDTLS_USE_PSA_CRYPTO)
668 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
669 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100670#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 mbedtls_md_init( &transform->md_ctx_enc );
672 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000673#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680}
681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000683{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000685 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200690 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200691
692 /*
693 * Either the pointers are now NULL or cleared properly and can be freed.
694 * Now allocate missing structures.
695 */
696 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200698 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200699 }
Paul Bakker48916f92012-09-16 19:57:18 +0000700
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200703 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200704 }
Paul Bakker48916f92012-09-16 19:57:18 +0000705
Paul Bakker82788fb2014-10-20 13:59:19 +0200706 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200708 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200709 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500710#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
711 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400712
Andrzej Kurek4a063792020-10-21 15:08:44 +0200713 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
714 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500715#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000716
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200717 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000718 if( ssl->handshake == NULL ||
719 ssl->transform_negotiate == NULL ||
720 ssl->session_negotiate == NULL )
721 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 mbedtls_free( ssl->handshake );
725 mbedtls_free( ssl->transform_negotiate );
726 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200727
728 ssl->handshake = NULL;
729 ssl->transform_negotiate = NULL;
730 ssl->session_negotiate = NULL;
731
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000733 }
734
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200735 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000737 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200738 ssl_handshake_params_init( ssl->handshake );
739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200741 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
742 {
743 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200744
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200745 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
747 else
748 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200749
Hanno Becker0f57a652020-02-05 10:37:26 +0000750 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200751 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200752#endif
753
Brett Warrene0edc842021-08-17 09:53:13 +0100754/*
755 * curve_list is translated to IANA TLS group identifiers here because
756 * mbedtls_ssl_conf_curves returns void and so can't return
757 * any error codes.
758 */
759#if defined(MBEDTLS_ECP_C)
760#if !defined(MBEDTLS_DEPRECATED_REMOVED)
761 /* Heap allocate and translate curve_list from internal to IANA group ids */
762 if ( ssl->conf->curve_list != NULL )
763 {
764 size_t length;
765 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
766
767 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
768 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
769
770 /* Leave room for zero termination */
771 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
772 if ( group_list == NULL )
773 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
774
775 for( size_t i = 0; i < length; i++ )
776 {
777 const mbedtls_ecp_curve_info *info =
778 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
779 if ( info == NULL )
780 {
781 mbedtls_free( group_list );
782 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
783 }
784 group_list[i] = info->tls_id;
785 }
786
787 group_list[length] = 0;
788
789 ssl->handshake->group_list = group_list;
790 ssl->handshake->group_list_heap_allocated = 1;
791 }
792 else
793 {
794 ssl->handshake->group_list = ssl->conf->group_list;
795 ssl->handshake->group_list_heap_allocated = 0;
796 }
797#endif /* MBEDTLS_DEPRECATED_REMOVED */
798#endif /* MBEDTLS_ECP_C */
799
Jerry Yuf017ee42022-01-12 15:49:48 +0800800#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
801#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800802#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800803 /* Heap allocate and translate sig_hashes from internal hash identifiers to
804 signature algorithms IANA identifiers. */
805 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800806 ssl->conf->sig_hashes != NULL )
807 {
808 const int *md;
809 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800810 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800811 uint16_t *p;
812
Jerry Yub476a442022-01-21 18:14:45 +0800813#if defined(static_assert)
814 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
815 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
816 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800817#endif
818
Jerry Yuf017ee42022-01-12 15:49:48 +0800819 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
820 {
821 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
822 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800823#if defined(MBEDTLS_ECDSA_C)
824 sig_algs_len += sizeof( uint16_t );
825#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800826
Jerry Yub476a442022-01-21 18:14:45 +0800827#if defined(MBEDTLS_RSA_C)
828 sig_algs_len += sizeof( uint16_t );
829#endif
830 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
831 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 }
833
Jerry Yub476a442022-01-21 18:14:45 +0800834 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
836
Jerry Yub476a442022-01-21 18:14:45 +0800837 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
838 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800839 if( ssl->handshake->sig_algs == NULL )
840 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
841
842 p = (uint16_t *)ssl->handshake->sig_algs;
843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
846 if( hash == MBEDTLS_SSL_HASH_NONE )
847 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
850 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800851#endif
852#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800853 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
854 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800855#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857 *p = MBEDTLS_TLS1_3_SIG_NONE;
858 ssl->handshake->sig_algs_heap_allocated = 1;
859 }
860 else
Jerry Yua69269a2022-01-17 21:06:01 +0800861#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800862 {
863 ssl->handshake->sig_algs = ssl->conf->sig_algs;
864 ssl->handshake->sig_algs_heap_allocated = 0;
865 }
866#endif /* MBEDTLS_DEPRECATED_REMOVED */
867#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000868 return( 0 );
869}
870
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200871#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200872/* Dummy cookie callbacks for defaults */
873static int ssl_cookie_write_dummy( void *ctx,
874 unsigned char **p, unsigned char *end,
875 const unsigned char *cli_id, size_t cli_id_len )
876{
877 ((void) ctx);
878 ((void) p);
879 ((void) end);
880 ((void) cli_id);
881 ((void) cli_id_len);
882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200884}
885
886static int ssl_cookie_check_dummy( void *ctx,
887 const unsigned char *cookie, size_t cookie_len,
888 const unsigned char *cli_id, size_t cli_id_len )
889{
890 ((void) ctx);
891 ((void) cookie);
892 ((void) cookie_len);
893 ((void) cli_id);
894 ((void) cli_id_len);
895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200898#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200899
Paul Bakker5121ce52009-01-03 21:22:43 +0000900/*
901 * Initialize an SSL context
902 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200903void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
904{
905 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
906}
907
Jerry Yu60835a82021-08-04 10:13:52 +0800908static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
909{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100910 const mbedtls_ssl_config *conf = ssl->conf;
911
Ronald Cron6f135e12021-12-08 16:57:54 +0100912#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100913 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
914 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000915 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
916 {
917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
918 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
919 }
920
Jerry Yu60835a82021-08-04 10:13:52 +0800921 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
922 return( 0 );
923 }
924#endif
925
926#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100927 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800928 {
929 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
930 return( 0 );
931 }
932#endif
933
Ronald Cron6f135e12021-12-08 16:57:54 +0100934#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100935 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800936 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000937 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
938 {
939 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
940 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
941 }
942
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000943 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
946 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
947 }
948
949
Ronald Crone1d3f062022-02-10 14:50:54 +0100950 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
951 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800952 }
953#endif
954
955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
956 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
957}
958
959static int ssl_conf_check(const mbedtls_ssl_context *ssl)
960{
961 int ret;
962 ret = ssl_conf_version_check( ssl );
963 if( ret != 0 )
964 return( ret );
965
966 /* Space for further checks */
967
968 return( 0 );
969}
970
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200971/*
972 * Setup an SSL context
973 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100974
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200975int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200976 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000977{
Janos Follath865b3eb2019-12-16 11:46:15 +0000978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000979 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
980 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000981
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200982 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000983
Jerry Yu60835a82021-08-04 10:13:52 +0800984 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
985 return( ret );
986
Paul Bakker62f2dee2012-09-28 07:31:51 +0000987 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100988 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000989 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200990
991 /* Set to NULL in case of an error condition */
992 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200993
Darryl Greenb33cc762019-11-28 14:29:44 +0000994#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
995 ssl->in_buf_len = in_buf_len;
996#endif
997 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000998 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000999 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001000 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001001 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001002 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001003 }
1004
Darryl Greenb33cc762019-11-28 14:29:44 +00001005#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1006 ssl->out_buf_len = out_buf_len;
1007#endif
1008 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001009 if( ssl->out_buf == NULL )
1010 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001012 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001013 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001014 }
1015
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001016 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001017
Johan Pascalb62bb512015-12-03 21:56:45 +01001018#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001019 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001020#endif
1021
Paul Bakker48916f92012-09-16 19:57:18 +00001022 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001023 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001024
1025 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001026
1027error:
1028 mbedtls_free( ssl->in_buf );
1029 mbedtls_free( ssl->out_buf );
1030
1031 ssl->conf = NULL;
1032
Darryl Greenb33cc762019-11-28 14:29:44 +00001033#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1034 ssl->in_buf_len = 0;
1035 ssl->out_buf_len = 0;
1036#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001037 ssl->in_buf = NULL;
1038 ssl->out_buf = NULL;
1039
1040 ssl->in_hdr = NULL;
1041 ssl->in_ctr = NULL;
1042 ssl->in_len = NULL;
1043 ssl->in_iv = NULL;
1044 ssl->in_msg = NULL;
1045
1046 ssl->out_hdr = NULL;
1047 ssl->out_ctr = NULL;
1048 ssl->out_len = NULL;
1049 ssl->out_iv = NULL;
1050 ssl->out_msg = NULL;
1051
k-stachowiak9f7798e2018-07-31 16:52:32 +02001052 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001053}
1054
1055/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001056 * Reset an initialized and used SSL context for re-use while retaining
1057 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001058 *
1059 * If partial is non-zero, keep data in the input buffer and client ID.
1060 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001061 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001062void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1063 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001064{
Darryl Greenb33cc762019-11-28 14:29:44 +00001065#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1066 size_t in_buf_len = ssl->in_buf_len;
1067 size_t out_buf_len = ssl->out_buf_len;
1068#else
1069 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1070 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1071#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001072
Hanno Beckerb0302c42021-08-03 09:39:42 +01001073#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1074 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001075#endif
1076
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001077 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001078 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001079
Hanno Beckerb0302c42021-08-03 09:39:42 +01001080 mbedtls_ssl_reset_in_out_pointers( ssl );
1081
1082 /* Reset incoming message parsing */
1083 ssl->in_offt = NULL;
1084 ssl->nb_zero = 0;
1085 ssl->in_msgtype = 0;
1086 ssl->in_msglen = 0;
1087 ssl->in_hslen = 0;
1088 ssl->keep_current_message = 0;
1089 ssl->transform_in = NULL;
1090
1091#if defined(MBEDTLS_SSL_PROTO_DTLS)
1092 ssl->next_record_offset = 0;
1093 ssl->in_epoch = 0;
1094#endif
1095
1096 /* Keep current datagram if partial == 1 */
1097 if( partial == 0 )
1098 {
1099 ssl->in_left = 0;
1100 memset( ssl->in_buf, 0, in_buf_len );
1101 }
1102
1103 /* Reset outgoing message writing */
1104 ssl->out_msgtype = 0;
1105 ssl->out_msglen = 0;
1106 ssl->out_left = 0;
1107 memset( ssl->out_buf, 0, out_buf_len );
1108 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1109 ssl->transform_out = NULL;
1110
1111#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1112 mbedtls_ssl_dtls_replay_reset( ssl );
1113#endif
1114
XiaokangQian2b01dc32022-01-21 02:53:13 +00001115#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001116 if( ssl->transform )
1117 {
1118 mbedtls_ssl_transform_free( ssl->transform );
1119 mbedtls_free( ssl->transform );
1120 ssl->transform = NULL;
1121 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001122#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1123
XiaokangQian2b01dc32022-01-21 02:53:13 +00001124#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1125 mbedtls_ssl_transform_free( ssl->transform_application );
1126 mbedtls_free( ssl->transform_application );
1127 ssl->transform_application = NULL;
1128
1129 if( ssl->handshake != NULL )
1130 {
1131 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1132 mbedtls_free( ssl->handshake->transform_earlydata );
1133 ssl->handshake->transform_earlydata = NULL;
1134
1135 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1136 mbedtls_free( ssl->handshake->transform_handshake );
1137 ssl->handshake->transform_handshake = NULL;
1138 }
1139
XiaokangQian2b01dc32022-01-21 02:53:13 +00001140#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001141}
1142
1143int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1144{
1145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1146
1147 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1148
XiaokangQian78b1fa72022-01-19 06:56:30 +00001149 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001150
1151 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152#if defined(MBEDTLS_SSL_RENEGOTIATION)
1153 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001154 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001155
1156 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1158 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001159#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001161
Hanno Beckerb0302c42021-08-03 09:39:42 +01001162 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001163 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001164 if( ssl->session )
1165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 mbedtls_ssl_session_free( ssl->session );
1167 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001168 ssl->session = NULL;
1169 }
1170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001172 ssl->alpn_chosen = NULL;
1173#endif
1174
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001175#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001176#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001177 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001178#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001179 {
1180 mbedtls_free( ssl->cli_id );
1181 ssl->cli_id = NULL;
1182 ssl->cli_id_len = 0;
1183 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001184#endif
1185
Paul Bakker48916f92012-09-16 19:57:18 +00001186 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1187 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001188
1189 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001190}
1191
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001192/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001193 * Reset an initialized and used SSL context for re-use while retaining
1194 * all application-set variables, function pointers and data.
1195 */
1196int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1197{
Hanno Becker43aefe22020-02-05 10:44:56 +00001198 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001199}
1200
1201/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001202 * SSL set accessors
1203 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001204void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001205{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001206 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001207}
1208
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001209void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001211 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001212}
1213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001215void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001216{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001217 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001218}
1219#endif
1220
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001221void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001222{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001223 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001224}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001227
Hanno Becker1841b0a2018-08-24 11:13:57 +01001228void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1229 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001230{
1231 ssl->disable_datagram_packing = !allow_packing;
1232}
1233
1234void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1235 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001236{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001237 conf->hs_timeout_min = min;
1238 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001239}
1240#endif
1241
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001242void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001243{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001244 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001245}
1246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001248void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001249 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001250 void *p_vrfy )
1251{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001252 conf->f_vrfy = f_vrfy;
1253 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001254}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001256
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001257void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001258 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001259 void *p_rng )
1260{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001261 conf->f_rng = f_rng;
1262 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001263}
1264
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001265void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001266 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001267 void *p_dbg )
1268{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001269 conf->f_dbg = f_dbg;
1270 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001271}
1272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001274 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001275 mbedtls_ssl_send_t *f_send,
1276 mbedtls_ssl_recv_t *f_recv,
1277 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001278{
1279 ssl->p_bio = p_bio;
1280 ssl->f_send = f_send;
1281 ssl->f_recv = f_recv;
1282 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001283}
1284
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001285#if defined(MBEDTLS_SSL_PROTO_DTLS)
1286void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1287{
1288 ssl->mtu = mtu;
1289}
1290#endif
1291
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001292void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001293{
1294 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001295}
1296
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001297void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1298 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001299 mbedtls_ssl_set_timer_t *f_set_timer,
1300 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001301{
1302 ssl->p_timer = p_timer;
1303 ssl->f_set_timer = f_set_timer;
1304 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001305
1306 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001307 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001308}
1309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001311void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001312 void *p_cache,
1313 mbedtls_ssl_cache_get_t *f_get_cache,
1314 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001315{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001316 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001317 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001318 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001319}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322#if defined(MBEDTLS_SSL_CLI_C)
1323int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001324{
Janos Follath865b3eb2019-12-16 11:46:15 +00001325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001326
1327 if( ssl == NULL ||
1328 session == NULL ||
1329 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001330 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001331 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001332 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001333 }
1334
Hanno Beckere810bbc2021-05-14 16:01:05 +01001335 if( ssl->handshake->resume == 1 )
1336 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1337
Hanno Becker52055ae2019-02-06 14:30:46 +00001338 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1339 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001340 return( ret );
1341
Paul Bakker0a597072012-09-25 21:55:46 +00001342 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001343
1344 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001345}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001347
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001348void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1349 const int *ciphersuites )
1350{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001351 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001352}
1353
Ronald Cron6f135e12021-12-08 16:57:54 +01001354#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001355void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001356 const int kex_modes )
1357{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001358 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001359}
Ronald Cron6f135e12021-12-08 16:57:54 +01001360#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001362#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001363void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001364 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001365{
1366 conf->cert_profile = profile;
1367}
1368
Glenn Strauss36872db2022-01-22 05:06:31 -05001369static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1370{
1371 mbedtls_ssl_key_cert *cur = key_cert, *next;
1372
1373 while( cur != NULL )
1374 {
1375 next = cur->next;
1376 mbedtls_free( cur );
1377 cur = next;
1378 }
1379}
1380
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001381/* Append a new keycert entry to a (possibly empty) list */
1382static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1383 mbedtls_x509_crt *cert,
1384 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001385{
niisato8ee24222018-06-25 19:05:48 +09001386 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001387
Glenn Strauss36872db2022-01-22 05:06:31 -05001388 if( cert == NULL )
1389 {
1390 /* Free list if cert is null */
1391 ssl_key_cert_free( *head );
1392 *head = NULL;
1393 return( 0 );
1394 }
1395
niisato8ee24222018-06-25 19:05:48 +09001396 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1397 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001398 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001399
niisato8ee24222018-06-25 19:05:48 +09001400 new_cert->cert = cert;
1401 new_cert->key = key;
1402 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001403
Glenn Strauss36872db2022-01-22 05:06:31 -05001404 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001405 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001406 {
niisato8ee24222018-06-25 19:05:48 +09001407 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001408 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001409 else
1410 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001411 mbedtls_ssl_key_cert *cur = *head;
1412 while( cur->next != NULL )
1413 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001414 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415 }
1416
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001417 return( 0 );
1418}
1419
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001420int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001421 mbedtls_x509_crt *own_cert,
1422 mbedtls_pk_context *pk_key )
1423{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001424 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001425}
1426
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001427void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001428 mbedtls_x509_crt *ca_chain,
1429 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001430{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001431 conf->ca_chain = ca_chain;
1432 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001433
1434#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1435 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1436 * cannot be used together. */
1437 conf->f_ca_cb = NULL;
1438 conf->p_ca_cb = NULL;
1439#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001440}
Hanno Becker5adaad92019-03-27 16:54:37 +00001441
1442#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1443void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001444 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001445 void *p_ca_cb )
1446{
1447 conf->f_ca_cb = f_ca_cb;
1448 conf->p_ca_cb = p_ca_cb;
1449
1450 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1451 * cannot be used together. */
1452 conf->ca_chain = NULL;
1453 conf->ca_crl = NULL;
1454}
1455#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001457
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001458#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001459const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1460 size_t *name_len )
1461{
1462 *name_len = ssl->handshake->sni_name_len;
1463 return( ssl->handshake->sni_name );
1464}
1465
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001466int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1467 mbedtls_x509_crt *own_cert,
1468 mbedtls_pk_context *pk_key )
1469{
1470 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1471 own_cert, pk_key ) );
1472}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001473
1474void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1475 mbedtls_x509_crt *ca_chain,
1476 mbedtls_x509_crl *ca_crl )
1477{
1478 ssl->handshake->sni_ca_chain = ca_chain;
1479 ssl->handshake->sni_ca_crl = ca_crl;
1480}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001481
1482void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1483 int authmode )
1484{
1485 ssl->handshake->sni_authmode = authmode;
1486}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001487#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1488
Hanno Becker8927c832019-04-03 12:52:50 +01001489#if defined(MBEDTLS_X509_CRT_PARSE_C)
1490void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1491 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1492 void *p_vrfy )
1493{
1494 ssl->f_vrfy = f_vrfy;
1495 ssl->p_vrfy = p_vrfy;
1496}
1497#endif
1498
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001499#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001500/*
1501 * Set EC J-PAKE password for current handshake
1502 */
1503int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1504 const unsigned char *pw,
1505 size_t pw_len )
1506{
1507 mbedtls_ecjpake_role role;
1508
Janos Follath8eb64132016-06-03 15:40:57 +01001509 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001510 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1511
1512 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1513 role = MBEDTLS_ECJPAKE_SERVER;
1514 else
1515 role = MBEDTLS_ECJPAKE_CLIENT;
1516
1517 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1518 role,
1519 MBEDTLS_MD_SHA256,
1520 MBEDTLS_ECP_DP_SECP256R1,
1521 pw, pw_len ) );
1522}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001523#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001524
Gilles Peskineeccd8882020-03-10 12:19:08 +01001525#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001526
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001527static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1528{
1529#if defined(MBEDTLS_USE_PSA_CRYPTO)
1530 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1531 return( 1 );
1532#endif /* MBEDTLS_USE_PSA_CRYPTO */
1533
1534 if( conf->psk != NULL )
1535 return( 1 );
1536
1537 return( 0 );
1538}
1539
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001540static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1541{
1542 /* Remove reference to existing PSK, if any. */
1543#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001544 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545 {
1546 /* The maintenance of the PSK key slot is the
1547 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001548 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001549 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001550 /* This and the following branch should never
1551 * be taken simultaenously as we maintain the
1552 * invariant that raw and opaque PSKs are never
1553 * configured simultaneously. As a safeguard,
1554 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001555#endif /* MBEDTLS_USE_PSA_CRYPTO */
1556 if( conf->psk != NULL )
1557 {
1558 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1559
1560 mbedtls_free( conf->psk );
1561 conf->psk = NULL;
1562 conf->psk_len = 0;
1563 }
1564
1565 /* Remove reference to PSK identity, if any. */
1566 if( conf->psk_identity != NULL )
1567 {
1568 mbedtls_free( conf->psk_identity );
1569 conf->psk_identity = NULL;
1570 conf->psk_identity_len = 0;
1571 }
1572}
1573
Hanno Becker7390c712018-11-15 13:33:04 +00001574/* This function assumes that PSK identity in the SSL config is unset.
1575 * It checks that the provided identity is well-formed and attempts
1576 * to make a copy of it in the SSL config.
1577 * On failure, the PSK identity in the config remains unset. */
1578static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1579 unsigned char const *psk_identity,
1580 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001581{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001582 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001583 if( psk_identity == NULL ||
1584 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001585 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001586 {
1587 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1588 }
1589
Hanno Becker7390c712018-11-15 13:33:04 +00001590 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1591 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001592 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001593
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001594 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001595 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001596
1597 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001598}
1599
Hanno Becker7390c712018-11-15 13:33:04 +00001600int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1601 const unsigned char *psk, size_t psk_len,
1602 const unsigned char *psk_identity, size_t psk_identity_len )
1603{
Janos Follath865b3eb2019-12-16 11:46:15 +00001604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001605
1606 /* We currently only support one PSK, raw or opaque. */
1607 if( ssl_conf_psk_is_configured( conf ) )
1608 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001609
1610 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001611 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001612 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001613 if( psk_len == 0 )
1614 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1615 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1616 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1617
Hanno Becker7390c712018-11-15 13:33:04 +00001618 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1619 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1620 conf->psk_len = psk_len;
1621 memcpy( conf->psk, psk, conf->psk_len );
1622
1623 /* Check and set PSK Identity */
1624 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1625 if( ret != 0 )
1626 ssl_conf_remove_psk( conf );
1627
1628 return( ret );
1629}
1630
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001631static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1632{
1633#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001634 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001635 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001636 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001637 }
1638 else
1639#endif /* MBEDTLS_USE_PSA_CRYPTO */
1640 if( ssl->handshake->psk != NULL )
1641 {
1642 mbedtls_platform_zeroize( ssl->handshake->psk,
1643 ssl->handshake->psk_len );
1644 mbedtls_free( ssl->handshake->psk );
1645 ssl->handshake->psk_len = 0;
1646 }
1647}
1648
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001649int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1650 const unsigned char *psk, size_t psk_len )
1651{
1652 if( psk == NULL || ssl->handshake == NULL )
1653 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1654
1655 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1656 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1657
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001658 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001659
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001660 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001661 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001662
1663 ssl->handshake->psk_len = psk_len;
1664 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1665
1666 return( 0 );
1667}
1668
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001669#if defined(MBEDTLS_USE_PSA_CRYPTO)
1670int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001671 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001672 const unsigned char *psk_identity,
1673 size_t psk_identity_len )
1674{
Janos Follath865b3eb2019-12-16 11:46:15 +00001675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001676
1677 /* We currently only support one PSK, raw or opaque. */
1678 if( ssl_conf_psk_is_configured( conf ) )
1679 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680
Hanno Becker7390c712018-11-15 13:33:04 +00001681 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001682 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001683 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001684 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001685
1686 /* Check and set PSK Identity */
1687 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1688 psk_identity_len );
1689 if( ret != 0 )
1690 ssl_conf_remove_psk( conf );
1691
1692 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001693}
1694
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001695int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1696 mbedtls_svc_key_id_t psk )
1697{
1698 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1699 ( ssl->handshake == NULL ) )
1700 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1701
1702 ssl_remove_psk( ssl );
1703 ssl->handshake->psk_opaque = psk;
1704 return( 0 );
1705}
1706#endif /* MBEDTLS_USE_PSA_CRYPTO */
1707
1708void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1709 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1710 size_t),
1711 void *p_psk )
1712{
1713 conf->f_psk = f_psk;
1714 conf->p_psk = p_psk;
1715}
1716#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1717
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001718
1719mbedtls_ssl_mode_t mbedtls_get_mode_from_transform(
1720 const mbedtls_ssl_transform *transform )
1721{
1722#if !defined(MBEDTLS_USE_PSA_CRYPTO)
1723 mbedtls_cipher_mode_t mode =
1724 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
1725#endif /* !MBEDTLS_USE_PSA_CRYPTO */
1726
1727#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1728#if defined(MBEDTLS_USE_PSA_CRYPTO)
1729 if( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1730 {
1731#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1732 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
1733 return( MBEDTLS_SSL_MODE_CBC_ETM );
1734#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1735
1736 return( MBEDTLS_SSL_MODE_CBC );
1737 }
1738#else
1739 if( mode == MBEDTLS_MODE_CBC )
1740 {
1741#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1742 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
1743 return( MBEDTLS_SSL_MODE_CBC_ETM );
1744#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1745
1746 return( MBEDTLS_SSL_MODE_CBC );
1747 }
1748#endif /* MBEDTLS_USE_PSA_CRYPTO */
1749#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1750
1751#if defined(MBEDTLS_USE_PSA_CRYPTO)
1752 if( PSA_ALG_IS_AEAD( transform->psa_alg ) )
1753 return( MBEDTLS_SSL_MODE_AEAD );
1754#else
1755#if defined(MBEDTLS_GCM_C) || \
1756 defined(MBEDTLS_CCM_C) || \
1757 defined(MBEDTLS_CHACHAPOLY_C)
1758 if( mode == MBEDTLS_MODE_GCM ||
1759 mode == MBEDTLS_MODE_CCM ||
1760 mode == MBEDTLS_MODE_CHACHAPOLY )
1761 return( MBEDTLS_SSL_MODE_AEAD );
1762#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
1763#endif /* MBEDTLS_USE_PSA_CRYPTO */
1764
1765 return( MBEDTLS_SSL_MODE_STREAM );
1766}
1767
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001768#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001769psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001770 size_t taglen,
1771 psa_algorithm_t *alg,
1772 psa_key_type_t *key_type,
1773 size_t *key_size )
1774{
1775 switch ( mbedtls_cipher_type )
1776 {
1777 case MBEDTLS_CIPHER_AES_128_CBC:
1778 *alg = PSA_ALG_CBC_NO_PADDING;
1779 *key_type = PSA_KEY_TYPE_AES;
1780 *key_size = 128;
1781 break;
1782 case MBEDTLS_CIPHER_AES_128_CCM:
1783 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1784 *key_type = PSA_KEY_TYPE_AES;
1785 *key_size = 128;
1786 break;
1787 case MBEDTLS_CIPHER_AES_128_GCM:
1788 *alg = PSA_ALG_GCM;
1789 *key_type = PSA_KEY_TYPE_AES;
1790 *key_size = 128;
1791 break;
1792 case MBEDTLS_CIPHER_AES_192_CCM:
1793 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1794 *key_type = PSA_KEY_TYPE_AES;
1795 *key_size = 192;
1796 break;
1797 case MBEDTLS_CIPHER_AES_192_GCM:
1798 *alg = PSA_ALG_GCM;
1799 *key_type = PSA_KEY_TYPE_AES;
1800 *key_size = 192;
1801 break;
1802 case MBEDTLS_CIPHER_AES_256_CBC:
1803 *alg = PSA_ALG_CBC_NO_PADDING;
1804 *key_type = PSA_KEY_TYPE_AES;
1805 *key_size = 256;
1806 break;
1807 case MBEDTLS_CIPHER_AES_256_CCM:
1808 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1809 *key_type = PSA_KEY_TYPE_AES;
1810 *key_size = 256;
1811 break;
1812 case MBEDTLS_CIPHER_AES_256_GCM:
1813 *alg = PSA_ALG_GCM;
1814 *key_type = PSA_KEY_TYPE_AES;
1815 *key_size = 256;
1816 break;
1817 case MBEDTLS_CIPHER_ARIA_128_CBC:
1818 *alg = PSA_ALG_CBC_NO_PADDING;
1819 *key_type = PSA_KEY_TYPE_ARIA;
1820 *key_size = 128;
1821 break;
1822 case MBEDTLS_CIPHER_ARIA_128_CCM:
1823 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1824 *key_type = PSA_KEY_TYPE_ARIA;
1825 *key_size = 128;
1826 break;
1827 case MBEDTLS_CIPHER_ARIA_128_GCM:
1828 *alg = PSA_ALG_GCM;
1829 *key_type = PSA_KEY_TYPE_ARIA;
1830 *key_size = 128;
1831 break;
1832 case MBEDTLS_CIPHER_ARIA_192_CCM:
1833 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1834 *key_type = PSA_KEY_TYPE_ARIA;
1835 *key_size = 192;
1836 break;
1837 case MBEDTLS_CIPHER_ARIA_192_GCM:
1838 *alg = PSA_ALG_GCM;
1839 *key_type = PSA_KEY_TYPE_ARIA;
1840 *key_size = 192;
1841 break;
1842 case MBEDTLS_CIPHER_ARIA_256_CBC:
1843 *alg = PSA_ALG_CBC_NO_PADDING;
1844 *key_type = PSA_KEY_TYPE_ARIA;
1845 *key_size = 256;
1846 break;
1847 case MBEDTLS_CIPHER_ARIA_256_CCM:
1848 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1849 *key_type = PSA_KEY_TYPE_ARIA;
1850 *key_size = 256;
1851 break;
1852 case MBEDTLS_CIPHER_ARIA_256_GCM:
1853 *alg = PSA_ALG_GCM;
1854 *key_type = PSA_KEY_TYPE_ARIA;
1855 *key_size = 256;
1856 break;
1857 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1858 *alg = PSA_ALG_CBC_NO_PADDING;
1859 *key_type = PSA_KEY_TYPE_CAMELLIA;
1860 *key_size = 128;
1861 break;
1862 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1863 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1864 *key_type = PSA_KEY_TYPE_CAMELLIA;
1865 *key_size = 128;
1866 break;
1867 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1868 *alg = PSA_ALG_GCM;
1869 *key_type = PSA_KEY_TYPE_CAMELLIA;
1870 *key_size = 128;
1871 break;
1872 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1873 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1874 *key_type = PSA_KEY_TYPE_CAMELLIA;
1875 *key_size = 192;
1876 break;
1877 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1878 *alg = PSA_ALG_GCM;
1879 *key_type = PSA_KEY_TYPE_CAMELLIA;
1880 *key_size = 192;
1881 break;
1882 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1883 *alg = PSA_ALG_CBC_NO_PADDING;
1884 *key_type = PSA_KEY_TYPE_CAMELLIA;
1885 *key_size = 256;
1886 break;
1887 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1888 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1889 *key_type = PSA_KEY_TYPE_CAMELLIA;
1890 *key_size = 256;
1891 break;
1892 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1893 *alg = PSA_ALG_GCM;
1894 *key_type = PSA_KEY_TYPE_CAMELLIA;
1895 *key_size = 256;
1896 break;
1897 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1898 *alg = PSA_ALG_CHACHA20_POLY1305;
1899 *key_type = PSA_KEY_TYPE_CHACHA20;
1900 *key_size = 256;
1901 break;
1902 case MBEDTLS_CIPHER_NULL:
1903 *alg = MBEDTLS_SSL_NULL_CIPHER;
1904 *key_type = 0;
1905 *key_size = 0;
1906 break;
1907 default:
1908 return PSA_ERROR_NOT_SUPPORTED;
1909 }
1910
1911 return PSA_SUCCESS;
1912}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001913#endif /* MBEDTLS_USE_PSA_CRYPTO */
1914
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001915#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001916int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1917 const unsigned char *dhm_P, size_t P_len,
1918 const unsigned char *dhm_G, size_t G_len )
1919{
Janos Follath865b3eb2019-12-16 11:46:15 +00001920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001921
Glenn Strausscee11292021-12-20 01:43:17 -05001922 mbedtls_mpi_free( &conf->dhm_P );
1923 mbedtls_mpi_free( &conf->dhm_G );
1924
Hanno Beckera90658f2017-10-04 15:29:08 +01001925 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1926 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1927 {
1928 mbedtls_mpi_free( &conf->dhm_P );
1929 mbedtls_mpi_free( &conf->dhm_G );
1930 return( ret );
1931 }
1932
1933 return( 0 );
1934}
Paul Bakker5121ce52009-01-03 21:22:43 +00001935
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001936int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001937{
Janos Follath865b3eb2019-12-16 11:46:15 +00001938 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001939
Glenn Strausscee11292021-12-20 01:43:17 -05001940 mbedtls_mpi_free( &conf->dhm_P );
1941 mbedtls_mpi_free( &conf->dhm_G );
1942
Gilles Peskinee5702482021-06-11 21:59:08 +02001943 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1944 &conf->dhm_P ) ) != 0 ||
1945 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1946 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001947 {
1948 mbedtls_mpi_free( &conf->dhm_P );
1949 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001950 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001951 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001952
1953 return( 0 );
1954}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001955#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001956
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001957#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1958/*
1959 * Set the minimum length for Diffie-Hellman parameters
1960 */
1961void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1962 unsigned int bitlen )
1963{
1964 conf->dhm_min_bitlen = bitlen;
1965}
1966#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1967
Gilles Peskineeccd8882020-03-10 12:19:08 +01001968#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001969#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001970/*
1971 * Set allowed/preferred hashes for handshake signatures
1972 */
1973void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1974 const int *hashes )
1975{
1976 conf->sig_hashes = hashes;
1977}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001978#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001979
Jerry Yuf017ee42022-01-12 15:49:48 +08001980/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001981void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1982 const uint16_t* sig_algs )
1983{
Jerry Yuf017ee42022-01-12 15:49:48 +08001984#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1985 conf->sig_hashes = NULL;
1986#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1987 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001988}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001989#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001990
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001991#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001992#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001993/*
1994 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001995 *
1996 * mbedtls_ssl_setup() takes the provided list
1997 * and translates it to a list of IANA TLS group identifiers,
1998 * stored in ssl->handshake->group_list.
1999 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002000 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002001void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002002 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002003{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002004 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002005 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002006}
Brett Warrene0edc842021-08-17 09:53:13 +01002007#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002008#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002009
Brett Warrene0edc842021-08-17 09:53:13 +01002010/*
2011 * Set the allowed groups
2012 */
2013void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2014 const uint16_t *group_list )
2015{
2016#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2017 conf->curve_list = NULL;
2018#endif
2019 conf->group_list = group_list;
2020}
2021
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002022#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002024{
Hanno Becker947194e2017-04-07 13:25:49 +01002025 /* Initialize to suppress unnecessary compiler warning */
2026 size_t hostname_len = 0;
2027
2028 /* Check if new hostname is valid before
2029 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002030 if( hostname != NULL )
2031 {
2032 hostname_len = strlen( hostname );
2033
2034 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2035 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2036 }
2037
2038 /* Now it's clear that we will overwrite the old hostname,
2039 * so we can free it safely */
2040
2041 if( ssl->hostname != NULL )
2042 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002043 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002044 mbedtls_free( ssl->hostname );
2045 }
2046
2047 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002048
Paul Bakker5121ce52009-01-03 21:22:43 +00002049 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002050 {
2051 ssl->hostname = NULL;
2052 }
2053 else
2054 {
2055 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002056 if( ssl->hostname == NULL )
2057 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002058
Hanno Becker947194e2017-04-07 13:25:49 +01002059 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002060
Hanno Becker947194e2017-04-07 13:25:49 +01002061 ssl->hostname[hostname_len] = '\0';
2062 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002063
2064 return( 0 );
2065}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002066#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002068#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002069void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002071 const unsigned char *, size_t),
2072 void *p_sni )
2073{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002074 conf->f_sni = f_sni;
2075 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002076}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002080int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002081{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002082 size_t cur_len, tot_len;
2083 const char **p;
2084
2085 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002086 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2087 * MUST NOT be truncated."
2088 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002089 */
2090 tot_len = 0;
2091 for( p = protos; *p != NULL; p++ )
2092 {
2093 cur_len = strlen( *p );
2094 tot_len += cur_len;
2095
Ronald Cron8216dd32020-04-23 16:41:44 +02002096 if( ( cur_len == 0 ) ||
2097 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2098 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002100 }
2101
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002102 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002103
2104 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002105}
2106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002108{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002109 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002110}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002112
Johan Pascalb62bb512015-12-03 21:56:45 +01002113#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002114void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2115 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002116{
2117 conf->dtls_srtp_mki_support = support_mki_value;
2118}
2119
Ron Eldoref72faf2018-07-12 11:54:20 +03002120int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2121 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002122 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002123{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002124 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002125 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002126 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002127 }
Ron Eldor591f1622018-01-22 12:30:04 +02002128
2129 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002130 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002131 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002132 }
Ron Eldor591f1622018-01-22 12:30:04 +02002133
2134 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2135 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002136 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002137}
2138
Ron Eldoref72faf2018-07-12 11:54:20 +03002139int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002140 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002141{
Johan Pascal253d0262020-09-22 13:04:45 +02002142 const mbedtls_ssl_srtp_profile *p;
2143 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002144
Johan Pascal253d0262020-09-22 13:04:45 +02002145 /* check the profiles list: all entry must be valid,
2146 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002147 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2148 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2149 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002150 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002151 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002152 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002153 list_size++;
2154 }
2155 else
2156 {
2157 /* unsupported value, stop parsing and set the size to an error value */
2158 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002159 }
2160 }
2161
Johan Pascal5ef72d22020-10-28 17:05:47 +01002162 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002163 {
Johan Pascal253d0262020-09-22 13:04:45 +02002164 conf->dtls_srtp_profile_list = NULL;
2165 conf->dtls_srtp_profile_list_len = 0;
2166 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2167 }
2168
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002169 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002170 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002171
2172 return( 0 );
2173}
2174
Johan Pascal5ef72d22020-10-28 17:05:47 +01002175void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2176 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002177{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002178 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2179 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002180 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002181 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002182 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002183 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002184 else
2185 {
2186 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002187 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2188 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002189 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002190}
Johan Pascalb62bb512015-12-03 21:56:45 +01002191#endif /* MBEDTLS_SSL_DTLS_SRTP */
2192
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002193void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002194{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002195 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002196}
2197
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002198void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002199{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002200 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002201}
2202
Janos Follath088ce432017-04-10 12:42:31 +01002203#if defined(MBEDTLS_SSL_SRV_C)
2204void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2205 char cert_req_ca_list )
2206{
2207 conf->cert_req_ca_list = cert_req_ca_list;
2208}
2209#endif
2210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002212void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002213{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002214 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002215}
2216#endif
2217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002219void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002220{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002221 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002222}
2223#endif
2224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002226int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002227{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002228 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002229 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002232 }
2233
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002234 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002235
2236 return( 0 );
2237}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002239
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002240void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002242 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002243}
2244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002246void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002247{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002248 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002249}
2250
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002251void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002252{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002253 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002254}
2255
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002256void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002257 const unsigned char period[8] )
2258{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002259 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002260}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002264#if defined(MBEDTLS_SSL_CLI_C)
2265void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002266{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002267 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002268}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002269#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002270
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002271#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002272void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2273 mbedtls_ssl_ticket_write_t *f_ticket_write,
2274 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2275 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002276{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002277 conf->f_ticket_write = f_ticket_write;
2278 conf->f_ticket_parse = f_ticket_parse;
2279 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002280}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002281#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002283
Hanno Becker7e6c1782021-06-08 09:24:55 +01002284void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2285 mbedtls_ssl_export_keys_t *f_export_keys,
2286 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002287{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002288 ssl->f_export_keys = f_export_keys;
2289 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002290}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002291
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002292#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002293void mbedtls_ssl_conf_async_private_cb(
2294 mbedtls_ssl_config *conf,
2295 mbedtls_ssl_async_sign_t *f_async_sign,
2296 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2297 mbedtls_ssl_async_resume_t *f_async_resume,
2298 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002299 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002300{
2301 conf->f_async_sign_start = f_async_sign;
2302 conf->f_async_decrypt_start = f_async_decrypt;
2303 conf->f_async_resume = f_async_resume;
2304 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002305 conf->p_async_config_data = async_config_data;
2306}
2307
Gilles Peskine8f97af72018-04-26 11:46:10 +02002308void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2309{
2310 return( conf->p_async_config_data );
2311}
2312
Gilles Peskine1febfef2018-04-30 11:54:39 +02002313void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002314{
2315 if( ssl->handshake == NULL )
2316 return( NULL );
2317 else
2318 return( ssl->handshake->user_async_ctx );
2319}
2320
Gilles Peskine1febfef2018-04-30 11:54:39 +02002321void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002322 void *ctx )
2323{
2324 if( ssl->handshake != NULL )
2325 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002326}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002327#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002328
Paul Bakker5121ce52009-01-03 21:22:43 +00002329/*
2330 * SSL get accessors
2331 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002332uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002333{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002334 if( ssl->session != NULL )
2335 return( ssl->session->verify_result );
2336
2337 if( ssl->session_negotiate != NULL )
2338 return( ssl->session_negotiate->verify_result );
2339
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002340 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002341}
2342
Glenn Strauss8f526902022-01-13 00:04:49 -05002343int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2344{
2345 if( ssl == NULL || ssl->session == NULL )
2346 return( 0 );
2347
2348 return( ssl->session->ciphersuite );
2349}
2350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002352{
Paul Bakker926c8e42013-03-06 10:23:34 +01002353 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002354 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002357}
2358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002360{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002362 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002363 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002364 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002365 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002366 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002367 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002368 default:
2369 return( "unknown (DTLS)" );
2370 }
2371 }
2372#endif
2373
Glenn Strauss60bfe602022-03-14 19:04:24 -04002374 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002375 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002376 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002377 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002378 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002379 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002380 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002381 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002382 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002383}
2384
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002385#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002386size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2387{
David Horstmann95d516f2021-05-04 18:36:56 +01002388 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002389 size_t read_mfl;
2390
2391 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2392 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2393 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2394 {
2395 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2396 }
2397
2398 /* Check if a smaller max length was negotiated */
2399 if( ssl->session_out != NULL )
2400 {
2401 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2402 if( read_mfl < max_len )
2403 {
2404 max_len = read_mfl;
2405 }
2406 }
2407
2408 // During a handshake, use the value being negotiated
2409 if( ssl->session_negotiate != NULL )
2410 {
2411 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2412 if( read_mfl < max_len )
2413 {
2414 max_len = read_mfl;
2415 }
2416 }
2417
2418 return( max_len );
2419}
2420
2421size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002422{
2423 size_t max_len;
2424
2425 /*
2426 * Assume mfl_code is correct since it was checked when set
2427 */
Angus Grattond8213d02016-05-25 20:56:48 +10002428 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002429
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002430 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002431 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002432 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002433 {
Angus Grattond8213d02016-05-25 20:56:48 +10002434 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002435 }
2436
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002437 /* During a handshake, use the value being negotiated */
2438 if( ssl->session_negotiate != NULL &&
2439 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2440 {
2441 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2442 }
2443
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002444 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002445}
2446#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2447
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002448#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002449size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002450{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002451 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2452 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2453 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2454 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2455 return ( 0 );
2456
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002457 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2458 return( ssl->mtu );
2459
2460 if( ssl->mtu == 0 )
2461 return( ssl->handshake->mtu );
2462
2463 return( ssl->mtu < ssl->handshake->mtu ?
2464 ssl->mtu : ssl->handshake->mtu );
2465}
2466#endif /* MBEDTLS_SSL_PROTO_DTLS */
2467
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002468int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2469{
2470 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2471
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002472#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2473 !defined(MBEDTLS_SSL_PROTO_DTLS)
2474 (void) ssl;
2475#endif
2476
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002477#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002478 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002479
2480 if( max_len > mfl )
2481 max_len = mfl;
2482#endif
2483
2484#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002485 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002486 {
Hanno Becker89490712020-02-05 10:50:12 +00002487 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002488 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2489 const size_t overhead = (size_t) ret;
2490
2491 if( ret < 0 )
2492 return( ret );
2493
2494 if( mtu <= overhead )
2495 {
2496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2497 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2498 }
2499
2500 if( max_len > mtu - overhead )
2501 max_len = mtu - overhead;
2502 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002503#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002504
Hanno Becker0defedb2018-08-10 12:35:02 +01002505#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2506 !defined(MBEDTLS_SSL_PROTO_DTLS)
2507 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002508#endif
2509
2510 return( (int) max_len );
2511}
2512
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002513int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2514{
2515 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2516
2517#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2518 (void) ssl;
2519#endif
2520
2521#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2522 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2523
2524 if( max_len > mfl )
2525 max_len = mfl;
2526#endif
2527
2528 return( (int) max_len );
2529}
2530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#if defined(MBEDTLS_X509_CRT_PARSE_C)
2532const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002533{
2534 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002535 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002536
Hanno Beckere6824572019-02-07 13:18:46 +00002537#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002538 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002539#else
2540 return( NULL );
2541#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002542}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002546int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2547 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002548{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002549 int ret;
2550
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002551 if( ssl == NULL ||
2552 dst == NULL ||
2553 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002554 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002555 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002557 }
2558
Hanno Beckere810bbc2021-05-14 16:01:05 +01002559 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2560 * idempotent: Each session can only be exported once.
2561 *
2562 * (This is in preparation for TLS 1.3 support where we will
2563 * need the ability to export multiple sessions (aka tickets),
2564 * which will be achieved by calling mbedtls_ssl_get_session()
2565 * multiple times until it fails.)
2566 *
2567 * Check whether we have already exported the current session,
2568 * and fail if so.
2569 */
2570 if( ssl->session->exported == 1 )
2571 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2572
2573 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2574 if( ret != 0 )
2575 return( ret );
2576
2577 /* Remember that we've exported the session. */
2578 ssl->session->exported = 1;
2579 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002580}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002582
Paul Bakker5121ce52009-01-03 21:22:43 +00002583/*
Hanno Beckera835da52019-05-16 12:39:07 +01002584 * Define ticket header determining Mbed TLS version
2585 * and structure of the ticket.
2586 */
2587
Hanno Becker94ef3b32019-05-16 12:50:45 +01002588/*
Hanno Becker50b59662019-05-28 14:30:45 +01002589 * Define bitflag determining compile-time settings influencing
2590 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002591 */
2592
Hanno Becker50b59662019-05-28 14:30:45 +01002593#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002594#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002595#else
Hanno Becker3e088662019-05-29 11:10:18 +01002596#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002597#endif /* MBEDTLS_HAVE_TIME */
2598
2599#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002600#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002601#else
Hanno Becker3e088662019-05-29 11:10:18 +01002602#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002603#endif /* MBEDTLS_X509_CRT_PARSE_C */
2604
2605#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002606#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002607#else
Hanno Becker3e088662019-05-29 11:10:18 +01002608#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002609#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2610
2611#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002612#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002613#else
Hanno Becker3e088662019-05-29 11:10:18 +01002614#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002615#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2616
Hanno Becker94ef3b32019-05-16 12:50:45 +01002617#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002618#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002619#else
Hanno Becker3e088662019-05-29 11:10:18 +01002620#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002621#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2622
Hanno Becker94ef3b32019-05-16 12:50:45 +01002623#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2624#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2625#else
2626#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2627#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2628
Hanno Becker3e088662019-05-29 11:10:18 +01002629#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2630#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2631#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2632#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002633#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2634#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002635
Hanno Becker50b59662019-05-28 14:30:45 +01002636#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002637 ( (uint16_t) ( \
2638 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2639 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2640 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2641 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002642 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002643 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002644
Hanno Beckerf8787072019-05-16 12:41:07 +01002645static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002646 MBEDTLS_VERSION_MAJOR,
2647 MBEDTLS_VERSION_MINOR,
2648 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002649 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2650 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002651};
Hanno Beckera835da52019-05-16 12:39:07 +01002652
2653/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002654 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002655 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002656 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002657 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002658 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002659 * opaque mbedtls_version[3]; // library version: major, minor, patch
2660 * opaque session_format[2]; // library-version specific 16-bit field
2661 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002662 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002663 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002664 * Note: When updating the format, remember to keep
2665 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002666 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002667 * // In this version, `session_format` determines
2668 * // the setting of those compile-time
2669 * // configuration options which influence
2670 * // the structure of mbedtls_ssl_session.
2671 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002672 * uint8_t minor_ver; // Protocol minor version. Possible values:
2673 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002674 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002675 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002676 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002677 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002678 * serialized_session_tls12 data;
2679 *
2680 * };
2681 *
2682 * } serialized_session;
2683 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002684 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002685
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002686static int ssl_session_save( const mbedtls_ssl_session *session,
2687 unsigned char omit_header,
2688 unsigned char *buf,
2689 size_t buf_len,
2690 size_t *olen )
2691{
2692 unsigned char *p = buf;
2693 size_t used = 0;
2694
2695 if( !omit_header )
2696 {
2697 /*
2698 * Add Mbed TLS version identifier
2699 */
2700
2701 used += sizeof( ssl_serialized_session_header );
2702
2703 if( used <= buf_len )
2704 {
2705 memcpy( p, ssl_serialized_session_header,
2706 sizeof( ssl_serialized_session_header ) );
2707 p += sizeof( ssl_serialized_session_header );
2708 }
2709 }
2710
2711 /*
2712 * TLS version identifier
2713 */
2714 used += 1;
2715 if( used <= buf_len )
2716 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002717 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002718 }
2719
2720 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002721 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002722 {
2723#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002724 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002725 {
2726 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2727 used += ssl_session_save_tls12( session, p, remaining_len );
2728 break;
2729 }
2730#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2731
2732 default:
2733 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2734 }
2735
2736 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002737 if( used > buf_len )
2738 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002739
2740 return( 0 );
2741}
2742
2743/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002744 * Public wrapper for ssl_session_save()
2745 */
2746int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2747 unsigned char *buf,
2748 size_t buf_len,
2749 size_t *olen )
2750{
2751 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2752}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002753
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002754/*
2755 * Deserialize session, see mbedtls_ssl_session_save() for format.
2756 *
2757 * This internal version is wrapped by a public function that cleans up in
2758 * case of error, and has an extra option omit_header.
2759 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002760static int ssl_session_load( mbedtls_ssl_session *session,
2761 unsigned char omit_header,
2762 const unsigned char *buf,
2763 size_t len )
2764{
2765 const unsigned char *p = buf;
2766 const unsigned char * const end = buf + len;
2767
2768 if( !omit_header )
2769 {
2770 /*
2771 * Check Mbed TLS version identifier
2772 */
2773
2774 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2775 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2776
2777 if( memcmp( p, ssl_serialized_session_header,
2778 sizeof( ssl_serialized_session_header ) ) != 0 )
2779 {
2780 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2781 }
2782 p += sizeof( ssl_serialized_session_header );
2783 }
2784
2785 /*
2786 * TLS version identifier
2787 */
2788 if( 1 > (size_t)( end - p ) )
2789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002790 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002791
2792 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002793 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002794 {
2795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002796 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002797 {
2798 size_t remaining_len = ( end - p );
2799 return( ssl_session_load_tls12( session, p, remaining_len ) );
2800 }
2801#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2802
2803 default:
2804 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2805 }
2806}
2807
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002808/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002809 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002810 */
2811int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2812 const unsigned char *buf,
2813 size_t len )
2814{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002815 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002816
2817 if( ret != 0 )
2818 mbedtls_ssl_session_free( session );
2819
2820 return( ret );
2821}
2822
2823/*
Paul Bakker1961b702013-01-25 14:49:24 +01002824 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002825 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002826static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2827{
2828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2829
Ronald Cron66dbf912022-02-02 15:33:46 +01002830 /*
2831 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002832 * that were written into the output buffer by the previous handshake step,
2833 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002834 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2835 * We proceed to the next handshake step only when all data from the
2836 * previous one have been sent to the peer, thus we make sure that this is
2837 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2838 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2839 * we have to wait before to go ahead.
2840 * In the case of TLS 1.3, handshake step handlers do not send data to the
2841 * peer. Data are only sent here and through
2842 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2843 * alert occured.
2844 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002845 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2846 return( ret );
2847
2848#if defined(MBEDTLS_SSL_PROTO_DTLS)
2849 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2850 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2851 {
2852 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2853 return( ret );
2854 }
2855#endif /* MBEDTLS_SSL_PROTO_DTLS */
2856
2857 return( ret );
2858}
2859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002861{
Hanno Becker41934dd2021-08-07 19:13:43 +01002862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002863
Hanno Becker41934dd2021-08-07 19:13:43 +01002864 if( ssl == NULL ||
2865 ssl->conf == NULL ||
2866 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002867 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002868 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002869 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002870 }
2871
2872 ret = ssl_prepare_handshake_step( ssl );
2873 if( ret != 0 )
2874 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002875
Jerry Yue7047812021-09-13 19:26:39 +08002876 ret = mbedtls_ssl_handle_pending_alert( ssl );
2877 if( ret != 0 )
2878 goto cleanup;
2879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002881 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002882 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2884 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002885
Ronald Cron9f0fba32022-02-10 16:45:15 +01002886 switch( ssl->state )
2887 {
2888 case MBEDTLS_SSL_HELLO_REQUEST:
2889 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2890 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002891
Ronald Cron9f0fba32022-02-10 16:45:15 +01002892 case MBEDTLS_SSL_CLIENT_HELLO:
2893 ret = mbedtls_ssl_write_client_hello( ssl );
2894 break;
2895
2896 default:
2897#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002898 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002899 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2900 else
2901 ret = mbedtls_ssl_handshake_client_step( ssl );
2902#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2903 ret = mbedtls_ssl_handshake_client_step( ssl );
2904#else
2905 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2906#endif
2907 }
Jerry Yub9930e72021-08-06 17:11:51 +08002908 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002909#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002911 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002912 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002913#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002914 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002915 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002916#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002917
2918#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2919 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2920 ret = mbedtls_ssl_handshake_server_step( ssl );
2921#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2922 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002923#endif
2924
Jerry Yue7047812021-09-13 19:26:39 +08002925 if( ret != 0 )
2926 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002927 /* handshake_step return error. And it is same
2928 * with alert_reason.
2929 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002930 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002931 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002932 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002933 goto cleanup;
2934 }
2935 }
2936
2937cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002938 return( ret );
2939}
2940
2941/*
2942 * Perform the SSL handshake
2943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002945{
2946 int ret = 0;
2947
Hanno Beckera817ea42020-10-20 15:20:23 +01002948 /* Sanity checks */
2949
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002950 if( ssl == NULL || ssl->conf == NULL )
2951 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2952
Hanno Beckera817ea42020-10-20 15:20:23 +01002953#if defined(MBEDTLS_SSL_PROTO_DTLS)
2954 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2955 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2956 {
2957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2958 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2959 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2960 }
2961#endif /* MBEDTLS_SSL_PROTO_DTLS */
2962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002964
Hanno Beckera817ea42020-10-20 15:20:23 +01002965 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00002966 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01002967 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002969
2970 if( ret != 0 )
2971 break;
2972 }
2973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002975
2976 return( ret );
2977}
2978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979#if defined(MBEDTLS_SSL_RENEGOTIATION)
2980#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002981/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002982 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002985{
Janos Follath865b3eb2019-12-16 11:46:15 +00002986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002989
2990 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2992 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002993
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002994 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002995 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002996 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002997 return( ret );
2998 }
2999
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003001
3002 return( 0 );
3003}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003005
3006/*
3007 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008 * - any side: calling mbedtls_ssl_renegotiate(),
3009 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3010 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003011 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003012 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003014 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003015int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003016{
Janos Follath865b3eb2019-12-16 11:46:15 +00003017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003020
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003021 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3022 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003023
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003024 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3025 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003027 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003029 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003030 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003031 ssl->handshake->out_msg_seq = 1;
3032 else
3033 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003034 }
3035#endif
3036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3038 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003041 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003043 return( ret );
3044 }
3045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003047
3048 return( 0 );
3049}
3050
3051/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003052 * Renegotiate current connection on client,
3053 * or request renegotiation on server
3054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003056{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003058
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003059 if( ssl == NULL || ssl->conf == NULL )
3060 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003063 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003064 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003065 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003066 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003070
3071 /* Did we already try/start sending HelloRequest? */
3072 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003074
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003075 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003076 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003080 /*
3081 * On client, either start the renegotiation process or,
3082 * if already in progress, continue the handshake
3083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003085 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003086 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003088
Hanno Becker40cdaa12020-02-05 10:48:27 +00003089 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003090 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003091 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003092 return( ret );
3093 }
3094 }
3095 else
3096 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003098 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003100 return( ret );
3101 }
3102 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003104
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003105 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003106}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003108
Gilles Peskine9b562d52018-04-25 20:32:43 +02003109void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003110{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003111 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3112
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003113 if( handshake == NULL )
3114 return;
3115
Brett Warrene0edc842021-08-17 09:53:13 +01003116#if defined(MBEDTLS_ECP_C)
3117#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3118 if ( ssl->handshake->group_list_heap_allocated )
3119 mbedtls_free( (void*) handshake->group_list );
3120 handshake->group_list = NULL;
3121#endif /* MBEDTLS_DEPRECATED_REMOVED */
3122#endif /* MBEDTLS_ECP_C */
3123
Jerry Yuf017ee42022-01-12 15:49:48 +08003124#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3125#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3126 if ( ssl->handshake->sig_algs_heap_allocated )
3127 mbedtls_free( (void*) handshake->sig_algs );
3128 handshake->sig_algs = NULL;
3129#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003130#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3131 if( ssl->handshake->certificate_request_context )
3132 {
3133 mbedtls_free( (void*) handshake->certificate_request_context );
3134 }
3135#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003136#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3137
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003138#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3139 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3140 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003141 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003142 handshake->async_in_progress = 0;
3143 }
3144#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3145
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003146#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003147#if defined(MBEDTLS_USE_PSA_CRYPTO)
3148 psa_hash_abort( &handshake->fin_sha256_psa );
3149#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003150 mbedtls_sha256_free( &handshake->fin_sha256 );
3151#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003152#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003153#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003154#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003155 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003156#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003157 mbedtls_sha512_free( &handshake->fin_sha512 );
3158#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003159#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#if defined(MBEDTLS_DHM_C)
3162 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003163#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#if defined(MBEDTLS_ECDH_C)
3165 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003166#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003167#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003168 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003169#if defined(MBEDTLS_SSL_CLI_C)
3170 mbedtls_free( handshake->ecjpake_cache );
3171 handshake->ecjpake_cache = NULL;
3172 handshake->ecjpake_cache_len = 0;
3173#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003174#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003175
Janos Follath4ae5c292016-02-10 11:27:43 +00003176#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3177 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003178 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003180#endif
3181
Gilles Peskineeccd8882020-03-10 12:19:08 +01003182#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003183 if( handshake->psk != NULL )
3184 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003185 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003186 mbedtls_free( handshake->psk );
3187 }
3188#endif
3189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3191 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003192 /*
3193 * Free only the linked list wrapper, not the keys themselves
3194 * since the belong to the SNI callback
3195 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003196 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003198
Gilles Peskineeccd8882020-03-10 12:19:08 +01003199#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003200 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003201 if( handshake->ecrs_peer_cert != NULL )
3202 {
3203 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3204 mbedtls_free( handshake->ecrs_peer_cert );
3205 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003206#endif
3207
Hanno Becker75173122019-02-06 16:18:31 +00003208#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3209 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3210 mbedtls_pk_free( &handshake->peer_pubkey );
3211#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3212
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003213#if defined(MBEDTLS_SSL_CLI_C) && \
3214 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3215 mbedtls_free( handshake->cookie );
3216#endif /* MBEDTLS_SSL_CLI_C &&
3217 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003218
3219#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003220 mbedtls_ssl_flight_free( handshake->flight );
3221 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003222#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003223
Ronald Cronf12b81d2022-03-15 10:42:41 +01003224#if defined(MBEDTLS_ECDH_C) && \
3225 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003226 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003227 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003228#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3229
Ronald Cron6f135e12021-12-08 16:57:54 +01003230#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003231 mbedtls_ssl_transform_free( handshake->transform_handshake );
3232 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003233 mbedtls_free( handshake->transform_earlydata );
3234 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003235#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003236
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003237
3238#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3239 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3240 * processes datagrams and the fact that a datagram is allowed to have
3241 * several records in it, it is possible that the I/O buffers are not
3242 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003243 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3244 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003245#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003246
Jerry Yuba9c7272021-10-30 11:54:10 +08003247 /* mbedtls_platform_zeroize MUST be last one in this function */
3248 mbedtls_platform_zeroize( handshake,
3249 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003250}
3251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003253{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003254 if( session == NULL )
3255 return;
3256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003258 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003259#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003260
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003261#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003263#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003264
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003265 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003266}
3267
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003268#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003269
3270#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3271#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3272#else
3273#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3274#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3275
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003276#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003277
3278#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3280#else
3281#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3282#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3283
3284#if defined(MBEDTLS_SSL_ALPN)
3285#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3286#else
3287#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3288#endif /* MBEDTLS_SSL_ALPN */
3289
3290#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3291#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3292#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3293#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3294
3295#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3296 ( (uint32_t) ( \
3297 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3298 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3299 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3300 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3301 0u ) )
3302
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003303static unsigned char ssl_serialized_context_header[] = {
3304 MBEDTLS_VERSION_MAJOR,
3305 MBEDTLS_VERSION_MINOR,
3306 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003307 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3308 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3309 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3310 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3311 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003312};
3313
Paul Bakker5121ce52009-01-03 21:22:43 +00003314/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003315 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003316 *
3317 * The format of the serialized data is:
3318 * (in the presentation language of TLS, RFC 8446 section 3)
3319 *
3320 * // header
3321 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003322 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003323 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003324 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003325 * Note: When updating the format, remember to keep these
3326 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003327 *
3328 * // session sub-structure
3329 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3330 * // transform sub-structure
3331 * uint8 random[64]; // ServerHello.random+ClientHello.random
3332 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3333 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3334 * // fields from ssl_context
3335 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3336 * uint64 in_window_top; // DTLS: last validated record seq_num
3337 * uint64 in_window; // DTLS: bitmask for replay protection
3338 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3339 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3340 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3341 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3342 *
3343 * Note that many fields of the ssl_context or sub-structures are not
3344 * serialized, as they fall in one of the following categories:
3345 *
3346 * 1. forced value (eg in_left must be 0)
3347 * 2. pointer to dynamically-allocated memory (eg session, transform)
3348 * 3. value can be re-derived from other data (eg session keys from MS)
3349 * 4. value was temporary (eg content of input buffer)
3350 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003351 */
3352int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3353 unsigned char *buf,
3354 size_t buf_len,
3355 size_t *olen )
3356{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003357 unsigned char *p = buf;
3358 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003359 size_t session_len;
3360 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003361
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003362 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003363 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3364 * this function's documentation.
3365 *
3366 * These are due to assumptions/limitations in the implementation. Some of
3367 * them are likely to stay (no handshake in progress) some might go away
3368 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003369 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003370 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003371 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003372 {
3373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003374 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003375 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003376 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003377 {
3378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003379 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003380 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003381 /* Double-check that sub-structures are indeed ready */
3382 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003383 {
3384 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003385 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003386 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003387 /* There must be no pending incoming or outgoing data */
3388 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003389 {
3390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003391 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003392 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003393 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003394 {
3395 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003396 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003397 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003398 /* Protocol must be DLTS, not TLS */
3399 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003400 {
3401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003402 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003403 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003404 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003405 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003406 {
3407 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003408 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003409 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003410 /* We must be using an AEAD ciphersuite */
3411 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003412 {
3413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003414 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003415 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003416 /* Renegotiation must not be enabled */
3417#if defined(MBEDTLS_SSL_RENEGOTIATION)
3418 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003419 {
3420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003421 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003422 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003423#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003424
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003425 /*
3426 * Version and format identifier
3427 */
3428 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003429
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003430 if( used <= buf_len )
3431 {
3432 memcpy( p, ssl_serialized_context_header,
3433 sizeof( ssl_serialized_context_header ) );
3434 p += sizeof( ssl_serialized_context_header );
3435 }
3436
3437 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003438 * Session (length + data)
3439 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003440 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003441 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3442 return( ret );
3443
3444 used += 4 + session_len;
3445 if( used <= buf_len )
3446 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003447 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3448 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003449
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003450 ret = ssl_session_save( ssl->session, 1,
3451 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003452 if( ret != 0 )
3453 return( ret );
3454
3455 p += session_len;
3456 }
3457
3458 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003459 * Transform
3460 */
3461 used += sizeof( ssl->transform->randbytes );
3462 if( used <= buf_len )
3463 {
3464 memcpy( p, ssl->transform->randbytes,
3465 sizeof( ssl->transform->randbytes ) );
3466 p += sizeof( ssl->transform->randbytes );
3467 }
3468
3469#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3470 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3471 if( used <= buf_len )
3472 {
3473 *p++ = ssl->transform->in_cid_len;
3474 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3475 p += ssl->transform->in_cid_len;
3476
3477 *p++ = ssl->transform->out_cid_len;
3478 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3479 p += ssl->transform->out_cid_len;
3480 }
3481#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3482
3483 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003484 * Saved fields from top-level ssl_context structure
3485 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003486 used += 4;
3487 if( used <= buf_len )
3488 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003489 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3490 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003491 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003492
3493#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3494 used += 16;
3495 if( used <= buf_len )
3496 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003497 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3498 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003499
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003500 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3501 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003502 }
3503#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3504
3505#if defined(MBEDTLS_SSL_PROTO_DTLS)
3506 used += 1;
3507 if( used <= buf_len )
3508 {
3509 *p++ = ssl->disable_datagram_packing;
3510 }
3511#endif /* MBEDTLS_SSL_PROTO_DTLS */
3512
Jerry Yuae0b2e22021-10-08 15:21:19 +08003513 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003514 if( used <= buf_len )
3515 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003516 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3517 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003518 }
3519
3520#if defined(MBEDTLS_SSL_PROTO_DTLS)
3521 used += 2;
3522 if( used <= buf_len )
3523 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003524 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3525 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003526 }
3527#endif /* MBEDTLS_SSL_PROTO_DTLS */
3528
3529#if defined(MBEDTLS_SSL_ALPN)
3530 {
3531 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003532 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003533 : 0;
3534
3535 used += 1 + alpn_len;
3536 if( used <= buf_len )
3537 {
3538 *p++ = alpn_len;
3539
3540 if( ssl->alpn_chosen != NULL )
3541 {
3542 memcpy( p, ssl->alpn_chosen, alpn_len );
3543 p += alpn_len;
3544 }
3545 }
3546 }
3547#endif /* MBEDTLS_SSL_ALPN */
3548
3549 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003550 * Done
3551 */
3552 *olen = used;
3553
3554 if( used > buf_len )
3555 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003556
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003557 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3558
Hanno Becker43aefe22020-02-05 10:44:56 +00003559 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003560}
3561
3562/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003563 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003564 *
3565 * This internal version is wrapped by a public function that cleans up in
3566 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003567 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003568static int ssl_context_load( mbedtls_ssl_context *ssl,
3569 const unsigned char *buf,
3570 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003571{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003572 const unsigned char *p = buf;
3573 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003574 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003576
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003577 /*
3578 * The context should have been freshly setup or reset.
3579 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003580 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003581 * renegotiating, or if the user mistakenly loaded a session first.)
3582 */
3583 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3584 ssl->session != NULL )
3585 {
3586 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3587 }
3588
3589 /*
3590 * We can't check that the config matches the initial one, but we can at
3591 * least check it matches the requirements for serializing.
3592 */
3593 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003594 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3595 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003596#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003597 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003598#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003599 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003600 {
3601 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3602 }
3603
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003604 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3605
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003606 /*
3607 * Check version identifier
3608 */
3609 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3610 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3611
3612 if( memcmp( p, ssl_serialized_context_header,
3613 sizeof( ssl_serialized_context_header ) ) != 0 )
3614 {
3615 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3616 }
3617 p += sizeof( ssl_serialized_context_header );
3618
3619 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003620 * Session
3621 */
3622 if( (size_t)( end - p ) < 4 )
3623 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3624
3625 session_len = ( (size_t) p[0] << 24 ) |
3626 ( (size_t) p[1] << 16 ) |
3627 ( (size_t) p[2] << 8 ) |
3628 ( (size_t) p[3] );
3629 p += 4;
3630
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003631 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003632 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003633 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003634 ssl->session_in = ssl->session;
3635 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003636 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003637
3638 if( (size_t)( end - p ) < session_len )
3639 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3640
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003641 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003642 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003643 {
3644 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003645 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003646 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003647
3648 p += session_len;
3649
3650 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003651 * Transform
3652 */
3653
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003654 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003655 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003656 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003657 ssl->transform_in = ssl->transform;
3658 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003659 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003660
3661 /* Read random bytes and populate structure */
3662 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3663 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003664#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003665 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003666 ssl->session->ciphersuite,
3667 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003668#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3669 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003670 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003671#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3672 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003673 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3674 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003675 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003676 ssl->conf->endpoint,
3677 ssl );
3678 if( ret != 0 )
3679 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003680#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003681 p += sizeof( ssl->transform->randbytes );
3682
3683#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3684 /* Read connection IDs and store them */
3685 if( (size_t)( end - p ) < 1 )
3686 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3687
3688 ssl->transform->in_cid_len = *p++;
3689
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003690 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003691 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3692
3693 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3694 p += ssl->transform->in_cid_len;
3695
3696 ssl->transform->out_cid_len = *p++;
3697
3698 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3699 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3700
3701 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3702 p += ssl->transform->out_cid_len;
3703#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3704
3705 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003706 * Saved fields from top-level ssl_context structure
3707 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003708 if( (size_t)( end - p ) < 4 )
3709 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3710
3711 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3712 ( (uint32_t) p[1] << 16 ) |
3713 ( (uint32_t) p[2] << 8 ) |
3714 ( (uint32_t) p[3] );
3715 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003716
3717#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3718 if( (size_t)( end - p ) < 16 )
3719 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3720
3721 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3722 ( (uint64_t) p[1] << 48 ) |
3723 ( (uint64_t) p[2] << 40 ) |
3724 ( (uint64_t) p[3] << 32 ) |
3725 ( (uint64_t) p[4] << 24 ) |
3726 ( (uint64_t) p[5] << 16 ) |
3727 ( (uint64_t) p[6] << 8 ) |
3728 ( (uint64_t) p[7] );
3729 p += 8;
3730
3731 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3732 ( (uint64_t) p[1] << 48 ) |
3733 ( (uint64_t) p[2] << 40 ) |
3734 ( (uint64_t) p[3] << 32 ) |
3735 ( (uint64_t) p[4] << 24 ) |
3736 ( (uint64_t) p[5] << 16 ) |
3737 ( (uint64_t) p[6] << 8 ) |
3738 ( (uint64_t) p[7] );
3739 p += 8;
3740#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3741
3742#if defined(MBEDTLS_SSL_PROTO_DTLS)
3743 if( (size_t)( end - p ) < 1 )
3744 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3745
3746 ssl->disable_datagram_packing = *p++;
3747#endif /* MBEDTLS_SSL_PROTO_DTLS */
3748
Jerry Yud9a94fe2021-09-28 18:58:59 +08003749 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003750 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003751 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3752 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003753
3754#if defined(MBEDTLS_SSL_PROTO_DTLS)
3755 if( (size_t)( end - p ) < 2 )
3756 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3757
3758 ssl->mtu = ( p[0] << 8 ) | p[1];
3759 p += 2;
3760#endif /* MBEDTLS_SSL_PROTO_DTLS */
3761
3762#if defined(MBEDTLS_SSL_ALPN)
3763 {
3764 uint8_t alpn_len;
3765 const char **cur;
3766
3767 if( (size_t)( end - p ) < 1 )
3768 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3769
3770 alpn_len = *p++;
3771
3772 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3773 {
3774 /* alpn_chosen should point to an item in the configured list */
3775 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3776 {
3777 if( strlen( *cur ) == alpn_len &&
3778 memcmp( p, cur, alpn_len ) == 0 )
3779 {
3780 ssl->alpn_chosen = *cur;
3781 break;
3782 }
3783 }
3784 }
3785
3786 /* can only happen on conf mismatch */
3787 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3788 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3789
3790 p += alpn_len;
3791 }
3792#endif /* MBEDTLS_SSL_ALPN */
3793
3794 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003795 * Forced fields from top-level ssl_context structure
3796 *
3797 * Most of them already set to the correct value by mbedtls_ssl_init() and
3798 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3799 */
3800 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003801 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003802
Hanno Becker361b10d2019-08-30 10:42:49 +01003803 /* Adjust pointers for header fields of outgoing records to
3804 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003805 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003806
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003807#if defined(MBEDTLS_SSL_PROTO_DTLS)
3808 ssl->in_epoch = 1;
3809#endif
3810
3811 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3812 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003813 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3814 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003815 if( ssl->handshake != NULL )
3816 {
3817 mbedtls_ssl_handshake_free( ssl );
3818 mbedtls_free( ssl->handshake );
3819 ssl->handshake = NULL;
3820 }
3821
3822 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003823 * Done - should have consumed entire buffer
3824 */
3825 if( p != end )
3826 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003827
3828 return( 0 );
3829}
3830
3831/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003832 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003833 */
3834int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3835 const unsigned char *buf,
3836 size_t len )
3837{
3838 int ret = ssl_context_load( context, buf, len );
3839
3840 if( ret != 0 )
3841 mbedtls_ssl_free( context );
3842
3843 return( ret );
3844}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003845#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003846
3847/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003848 * Free an SSL context
3849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003850void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003851{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003852 if( ssl == NULL )
3853 return;
3854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003855 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003856
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003857 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003858 {
sander-visserb8aa2072020-05-06 22:05:13 +02003859#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3860 size_t out_buf_len = ssl->out_buf_len;
3861#else
3862 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3863#endif
3864
Darryl Greenb33cc762019-11-28 14:29:44 +00003865 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003867 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003868 }
3869
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003870 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003871 {
sander-visserb8aa2072020-05-06 22:05:13 +02003872#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3873 size_t in_buf_len = ssl->in_buf_len;
3874#else
3875 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3876#endif
3877
Darryl Greenb33cc762019-11-28 14:29:44 +00003878 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003879 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003880 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003881 }
3882
Paul Bakker48916f92012-09-16 19:57:18 +00003883 if( ssl->transform )
3884 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003885 mbedtls_ssl_transform_free( ssl->transform );
3886 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003887 }
3888
3889 if( ssl->handshake )
3890 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003891 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003892 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3893 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003895 mbedtls_free( ssl->handshake );
3896 mbedtls_free( ssl->transform_negotiate );
3897 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003898 }
3899
Ronald Cron6f135e12021-12-08 16:57:54 +01003900#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003901 mbedtls_ssl_transform_free( ssl->transform_application );
3902 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003903#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003904
Paul Bakkerc0463502013-02-14 11:19:38 +01003905 if( ssl->session )
3906 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003907 mbedtls_ssl_session_free( ssl->session );
3908 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003909 }
3910
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003911#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003912 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003913 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003914 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003915 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003916 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003917#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003918
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003919#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003920 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003921#endif
3922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003923 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003924
Paul Bakker86f04f42013-02-14 11:20:09 +01003925 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003926 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003927}
3928
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003929/*
3930 * Initialze mbedtls_ssl_config
3931 */
3932void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3933{
3934 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3935}
3936
Gilles Peskineeccd8882020-03-10 12:19:08 +01003937#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003938#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003939/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003940 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3941 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003942 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3943 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003944static int ssl_preset_default_hashes[] = {
3945#if defined(MBEDTLS_SHA512_C)
3946 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003947#endif
3948#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003949 MBEDTLS_MD_SHA384,
3950#endif
3951#if defined(MBEDTLS_SHA256_C)
3952 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003953#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003954 MBEDTLS_MD_NONE
3955};
Jerry Yuf017ee42022-01-12 15:49:48 +08003956#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3957#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003958
Gilles Peskineae270bf2021-06-02 00:05:29 +02003959/* The selection should be the same as mbedtls_x509_crt_profile_default in
3960 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003961 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003962 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003963 * about this list.
3964 */
Brett Warrene0edc842021-08-17 09:53:13 +01003965static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003966#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003967 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003968#endif
3969#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003970 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003971#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003972#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003973 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003974#endif
3975#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003976 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003977#endif
3978#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003979 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003980#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003981#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003982 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003983#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003984#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003985 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003986#endif
3987#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003988 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003989#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003990 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003991};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003992
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003993static int ssl_preset_suiteb_ciphersuites[] = {
3994 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3995 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3996 0
3997};
3998
Gilles Peskineeccd8882020-03-10 12:19:08 +01003999#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004000#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004001static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08004002#if defined(MBEDTLS_SHA256_C)
4003 MBEDTLS_MD_SHA256,
4004#endif
Jerry Yu713013f2022-01-17 18:16:35 +08004005#if defined(MBEDTLS_SHA384_C)
4006 MBEDTLS_MD_SHA384,
4007#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004008 MBEDTLS_MD_NONE
4009};
Jerry Yuf017ee42022-01-12 15:49:48 +08004010#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004011
Jerry Yu909df7b2022-01-22 11:56:27 +08004012/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004013 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004014 * rules SHOULD be upheld.
4015 * - No duplicate entries.
4016 * - But if there is a good reason, do not change the order of the algorithms.
4017 * - ssl_tls12_present* is for TLS 1.2 use only.
4018 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004019 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004020static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004021
Jerry Yued5e9f42022-01-26 11:21:34 +08004022#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4023 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4024 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4025#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4026 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004027
Jerry Yu909df7b2022-01-22 11:56:27 +08004028#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4029 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4030 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4031#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4032 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4033
Jerry Yued5e9f42022-01-26 11:21:34 +08004034#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4035 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4036 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4037#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4038 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004039
Jerry Yu909df7b2022-01-22 11:56:27 +08004040#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4041 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4042#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4043
Ronald Cron8540cf62022-03-16 08:01:09 +01004044#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4045 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4046#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4047
4048#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4049 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4050#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4051
Jerry Yu53037892022-01-25 11:02:06 +08004052#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4053 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4054#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4055
Jerry Yu909df7b2022-01-22 11:56:27 +08004056 MBEDTLS_TLS1_3_SIG_NONE
4057};
4058
4059/* NOTICE: see above */
4060#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4061static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004062#if defined(MBEDTLS_SHA512_C)
4063 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4064#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004065#if defined(MBEDTLS_SHA384_C)
4066 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4067#endif
4068#if defined(MBEDTLS_SHA256_C)
4069 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4070#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004071 MBEDTLS_TLS1_3_SIG_NONE
4072};
4073#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4074/* NOTICE: see above */
4075static uint16_t ssl_preset_suiteb_sig_algs[] = {
4076
Jerry Yu909df7b2022-01-22 11:56:27 +08004077#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4078 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4079 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4080#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4081 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4082
Jerry Yu53037892022-01-25 11:02:06 +08004083#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4084 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4085 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4086#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4087 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004088
4089#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4090 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4091#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004092
Jerry Yu53037892022-01-25 11:02:06 +08004093#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4094 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4095#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4096
Jerry Yu713013f2022-01-17 18:16:35 +08004097 MBEDTLS_TLS1_3_SIG_NONE
4098};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004099
Jerry Yu909df7b2022-01-22 11:56:27 +08004100/* NOTICE: see above */
4101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4102static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004103#if defined(MBEDTLS_SHA256_C)
4104 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4105#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004106#if defined(MBEDTLS_SHA384_C)
4107 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4108#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004109 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004110};
Jerry Yu909df7b2022-01-22 11:56:27 +08004111#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4112
Jerry Yu1a8b4812022-01-20 17:56:50 +08004113#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004114
Brett Warrene0edc842021-08-17 09:53:13 +01004115static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004116#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004117 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004118#endif
4119#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004120 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004121#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004122 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004123};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004124
Jerry Yu1a8b4812022-01-20 17:56:50 +08004125#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004126/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004127 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004128static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004129{
4130 size_t i, j;
4131 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004132
Jerry Yuf377d642022-01-25 10:43:59 +08004133 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004134 {
Jerry Yuf377d642022-01-25 10:43:59 +08004135 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004136 {
Jerry Yuf377d642022-01-25 10:43:59 +08004137 if( sig_algs[i] != sig_algs[j] )
4138 continue;
4139 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4140 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4141 sig_algs[i], j, i );
4142 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004143 }
4144 }
4145 return( ret );
4146}
4147
4148#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4149
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004150/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004151 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004152 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004153int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004154 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004155{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004156#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004158#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004159
Jerry Yu1a8b4812022-01-20 17:56:50 +08004160#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004161 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004162 {
4163 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4164 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4165 }
4166
Jerry Yuf377d642022-01-25 10:43:59 +08004167 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004168 {
4169 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4170 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4171 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004172
4173#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004174 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004175 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004176 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004177 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4178 }
4179
Jerry Yuf377d642022-01-25 10:43:59 +08004180 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004181 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004182 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004183 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4184 }
4185#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004186#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4187
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004188 /* Use the functions here so that they are covered in tests,
4189 * but otherwise access member directly for efficiency */
4190 mbedtls_ssl_conf_endpoint( conf, endpoint );
4191 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004192
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004193 /*
4194 * Things that are common to all presets
4195 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004196#if defined(MBEDTLS_SSL_CLI_C)
4197 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4198 {
4199 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4200#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4201 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4202#endif
4203 }
4204#endif
4205
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004206#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4207 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4208#endif
4209
4210#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4211 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4212#endif
4213
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004214#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004215 conf->f_cookie_write = ssl_cookie_write_dummy;
4216 conf->f_cookie_check = ssl_cookie_check_dummy;
4217#endif
4218
4219#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4220 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4221#endif
4222
Janos Follath088ce432017-04-10 12:42:31 +01004223#if defined(MBEDTLS_SSL_SRV_C)
4224 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004225 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004226#endif
4227
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004228#if defined(MBEDTLS_SSL_PROTO_DTLS)
4229 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4230 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4231#endif
4232
4233#if defined(MBEDTLS_SSL_RENEGOTIATION)
4234 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004235 memset( conf->renego_period, 0x00, 2 );
4236 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004237#endif
4238
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004239#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004240 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4241 {
4242 const unsigned char dhm_p[] =
4243 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4244 const unsigned char dhm_g[] =
4245 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004246
Hanno Beckere2defad2021-07-24 05:59:17 +01004247 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4248 dhm_p, sizeof( dhm_p ),
4249 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4250 {
4251 return( ret );
4252 }
4253 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004254#endif
4255
Ronald Cron6f135e12021-12-08 16:57:54 +01004256#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004257 /*
4258 * Allow all TLS 1.3 key exchange modes by default.
4259 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004260 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004261#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004262
XiaokangQian4d3a6042022-04-21 13:46:17 +00004263 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4264 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004265#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004266 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004267 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004268#else
XiaokangQian060d8672022-04-21 09:24:56 +00004269 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004270#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004271 }
4272 else
4273 {
4274#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4275 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4276 {
4277 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4278 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4279 }
4280 else
4281 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4282 {
4283 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4284 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4285 }
4286#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4287 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4288 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4289#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4290 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4291 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4292#else
4293 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4294#endif
4295 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004296
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004297 /*
4298 * Preset-specific defaults
4299 */
4300 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004301 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004302 /*
4303 * NSA Suite B
4304 */
4305 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004306
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004307 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004308
4309#if defined(MBEDTLS_X509_CRT_PARSE_C)
4310 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004311#endif
4312
Gilles Peskineeccd8882020-03-10 12:19:08 +01004313#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004314#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004315 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004316#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004317#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4318 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4319 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4320 else
4321#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4322 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004323#endif
4324
Brett Warrene0edc842021-08-17 09:53:13 +01004325#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4326 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004327#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004328 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004329 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004330
4331 /*
4332 * Default
4333 */
4334 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004335
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004336 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004337
4338#if defined(MBEDTLS_X509_CRT_PARSE_C)
4339 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4340#endif
4341
Gilles Peskineeccd8882020-03-10 12:19:08 +01004342#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004343#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004344 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004345#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004346#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4347 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4348 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4349 else
4350#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4351 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004352#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004353
Brett Warrene0edc842021-08-17 09:53:13 +01004354#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4355 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004356#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004357 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004358
4359#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4360 conf->dhm_min_bitlen = 1024;
4361#endif
4362 }
4363
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004364 return( 0 );
4365}
4366
4367/*
4368 * Free mbedtls_ssl_config
4369 */
4370void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4371{
4372#if defined(MBEDTLS_DHM_C)
4373 mbedtls_mpi_free( &conf->dhm_P );
4374 mbedtls_mpi_free( &conf->dhm_G );
4375#endif
4376
Gilles Peskineeccd8882020-03-10 12:19:08 +01004377#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004378 if( conf->psk != NULL )
4379 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004380 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004381 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004382 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004383 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004384 }
4385
4386 if( conf->psk_identity != NULL )
4387 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004388 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004389 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004390 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004391 conf->psk_identity_len = 0;
4392 }
4393#endif
4394
4395#if defined(MBEDTLS_X509_CRT_PARSE_C)
4396 ssl_key_cert_free( conf->key_cert );
4397#endif
4398
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004399 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004400}
4401
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004402#if defined(MBEDTLS_PK_C) && \
4403 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004404/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004405 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004407unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004408{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409#if defined(MBEDTLS_RSA_C)
4410 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4411 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004412#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004413#if defined(MBEDTLS_ECDSA_C)
4414 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4415 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004416#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004417 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004418}
4419
Hanno Becker7e5437a2017-04-28 17:15:26 +01004420unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4421{
4422 switch( type ) {
4423 case MBEDTLS_PK_RSA:
4424 return( MBEDTLS_SSL_SIG_RSA );
4425 case MBEDTLS_PK_ECDSA:
4426 case MBEDTLS_PK_ECKEY:
4427 return( MBEDTLS_SSL_SIG_ECDSA );
4428 default:
4429 return( MBEDTLS_SSL_SIG_ANON );
4430 }
4431}
4432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004433mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004434{
4435 switch( sig )
4436 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004437#if defined(MBEDTLS_RSA_C)
4438 case MBEDTLS_SSL_SIG_RSA:
4439 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004440#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004441#if defined(MBEDTLS_ECDSA_C)
4442 case MBEDTLS_SSL_SIG_ECDSA:
4443 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004444#endif
4445 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004446 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004447 }
4448}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004449#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004450
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004451/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004452 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004454mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004455{
4456 switch( hash )
4457 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458#if defined(MBEDTLS_MD5_C)
4459 case MBEDTLS_SSL_HASH_MD5:
4460 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004461#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004462#if defined(MBEDTLS_SHA1_C)
4463 case MBEDTLS_SSL_HASH_SHA1:
4464 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004465#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004466#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004467 case MBEDTLS_SSL_HASH_SHA224:
4468 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004469#endif
4470#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004471 case MBEDTLS_SSL_HASH_SHA256:
4472 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004473#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004474#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004475 case MBEDTLS_SSL_HASH_SHA384:
4476 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004477#endif
4478#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004479 case MBEDTLS_SSL_HASH_SHA512:
4480 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004481#endif
4482 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004483 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004484 }
4485}
4486
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004487/*
4488 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4489 */
4490unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4491{
4492 switch( md )
4493 {
4494#if defined(MBEDTLS_MD5_C)
4495 case MBEDTLS_MD_MD5:
4496 return( MBEDTLS_SSL_HASH_MD5 );
4497#endif
4498#if defined(MBEDTLS_SHA1_C)
4499 case MBEDTLS_MD_SHA1:
4500 return( MBEDTLS_SSL_HASH_SHA1 );
4501#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004502#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004503 case MBEDTLS_MD_SHA224:
4504 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004505#endif
4506#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004507 case MBEDTLS_MD_SHA256:
4508 return( MBEDTLS_SSL_HASH_SHA256 );
4509#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004510#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004511 case MBEDTLS_MD_SHA384:
4512 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004513#endif
4514#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004515 case MBEDTLS_MD_SHA512:
4516 return( MBEDTLS_SSL_HASH_SHA512 );
4517#endif
4518 default:
4519 return( MBEDTLS_SSL_HASH_NONE );
4520 }
4521}
4522
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004523/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004524 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004525 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004526 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004527int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004528{
Brett Warrene0edc842021-08-17 09:53:13 +01004529 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004530
Brett Warrene0edc842021-08-17 09:53:13 +01004531 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004532 return( -1 );
4533
Brett Warrene0edc842021-08-17 09:53:13 +01004534 for( ; *group_list != 0; group_list++ )
4535 {
4536 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004537 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004538 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004539
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004540 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004541}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004542
4543#if defined(MBEDTLS_ECP_C)
4544/*
4545 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4546 */
4547int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4548{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004549 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004550 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4551}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004552#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004554#if defined(MBEDTLS_X509_CRT_PARSE_C)
4555int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4556 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004557 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004558 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004559{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004560 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004561 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004562 const char *ext_oid;
4563 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004566 {
4567 /* Server part of the key exchange */
4568 switch( ciphersuite->key_exchange )
4569 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570 case MBEDTLS_KEY_EXCHANGE_RSA:
4571 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004572 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004573 break;
4574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4576 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4577 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4578 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004579 break;
4580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4582 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004583 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004584 break;
4585
4586 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004587 case MBEDTLS_KEY_EXCHANGE_NONE:
4588 case MBEDTLS_KEY_EXCHANGE_PSK:
4589 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4590 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004591 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004592 usage = 0;
4593 }
4594 }
4595 else
4596 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004597 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4598 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004599 }
4600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004601 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004602 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004603 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004604 ret = -1;
4605 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004608 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4610 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004611 }
4612 else
4613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004614 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4615 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004616 }
4617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004619 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004620 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004621 ret = -1;
4622 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004623
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004624 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004625}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004627
Jerry Yu148165c2021-09-24 23:20:59 +08004628#if defined(MBEDTLS_USE_PSA_CRYPTO)
4629int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4630 const mbedtls_md_type_t md,
4631 unsigned char *dst,
4632 size_t dst_len,
4633 size_t *olen )
4634{
Ronald Cronf6893e12022-01-07 22:09:01 +01004635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4636 psa_hash_operation_t *hash_operation_to_clone;
4637 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4638
Jerry Yu148165c2021-09-24 23:20:59 +08004639 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004640
4641 switch( md )
4642 {
4643#if defined(MBEDTLS_SHA384_C)
4644 case MBEDTLS_MD_SHA384:
4645 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4646 break;
4647#endif
4648
4649#if defined(MBEDTLS_SHA256_C)
4650 case MBEDTLS_MD_SHA256:
4651 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4652 break;
4653#endif
4654
4655 default:
4656 goto exit;
4657 }
4658
4659 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4660 if( status != PSA_SUCCESS )
4661 goto exit;
4662
4663 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4664 if( status != PSA_SUCCESS )
4665 goto exit;
4666
4667exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004668 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004669}
4670#else /* MBEDTLS_USE_PSA_CRYPTO */
4671
Jerry Yu24c0ec32021-09-09 14:21:07 +08004672#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004673static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4674 unsigned char *dst,
4675 size_t dst_len,
4676 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004677{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004678 int ret;
4679 mbedtls_sha512_context sha512;
4680
4681 if( dst_len < 48 )
4682 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4683
4684 mbedtls_sha512_init( &sha512 );
4685 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4686
4687 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4688 {
4689 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4690 goto exit;
4691 }
4692
4693 *olen = 48;
4694
4695exit:
4696
4697 mbedtls_sha512_free( &sha512 );
4698 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004699}
4700#endif /* MBEDTLS_SHA384_C */
4701
4702#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004703static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4704 unsigned char *dst,
4705 size_t dst_len,
4706 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004707{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004708 int ret;
4709 mbedtls_sha256_context sha256;
4710
4711 if( dst_len < 32 )
4712 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4713
4714 mbedtls_sha256_init( &sha256 );
4715 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004716
Jerry Yu24c0ec32021-09-09 14:21:07 +08004717 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4718 {
4719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4720 goto exit;
4721 }
4722
4723 *olen = 32;
4724
4725exit:
4726
4727 mbedtls_sha256_free( &sha256 );
4728 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004729}
4730#endif /* MBEDTLS_SHA256_C */
4731
Jerry Yu000f9762021-09-14 11:12:51 +08004732int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4733 const mbedtls_md_type_t md,
4734 unsigned char *dst,
4735 size_t dst_len,
4736 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004737{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004738 switch( md )
4739 {
4740
Jerry Yu24c0ec32021-09-09 14:21:07 +08004741#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004742 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004743 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004744#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004745
Jerry Yu24c0ec32021-09-09 14:21:07 +08004746#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004747 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004748 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004749#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004750
4751 default:
4752 break;
4753 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004754 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004755}
XiaokangQian647719a2021-12-07 09:16:29 +00004756
Jerry Yu148165c2021-09-24 23:20:59 +08004757#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004758
Jerry Yudc7bd172022-02-17 13:44:15 +08004759#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4760
4761#if defined(MBEDTLS_USE_PSA_CRYPTO)
4762
4763static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4764 mbedtls_svc_key_id_t key,
4765 psa_algorithm_t alg,
4766 const unsigned char* seed, size_t seed_length,
4767 const unsigned char* label, size_t label_length,
4768 size_t capacity )
4769{
4770 psa_status_t status;
4771
4772 status = psa_key_derivation_setup( derivation, alg );
4773 if( status != PSA_SUCCESS )
4774 return( status );
4775
4776 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4777 {
4778 status = psa_key_derivation_input_bytes( derivation,
4779 PSA_KEY_DERIVATION_INPUT_SEED,
4780 seed, seed_length );
4781 if( status != PSA_SUCCESS )
4782 return( status );
4783
4784 if( mbedtls_svc_key_id_is_null( key ) )
4785 {
4786 status = psa_key_derivation_input_bytes(
4787 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4788 NULL, 0 );
4789 }
4790 else
4791 {
4792 status = psa_key_derivation_input_key(
4793 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4794 }
4795 if( status != PSA_SUCCESS )
4796 return( status );
4797
4798 status = psa_key_derivation_input_bytes( derivation,
4799 PSA_KEY_DERIVATION_INPUT_LABEL,
4800 label, label_length );
4801 if( status != PSA_SUCCESS )
4802 return( status );
4803 }
4804 else
4805 {
4806 return( PSA_ERROR_NOT_SUPPORTED );
4807 }
4808
4809 status = psa_key_derivation_set_capacity( derivation, capacity );
4810 if( status != PSA_SUCCESS )
4811 return( status );
4812
4813 return( PSA_SUCCESS );
4814}
4815
4816static int tls_prf_generic( mbedtls_md_type_t md_type,
4817 const unsigned char *secret, size_t slen,
4818 const char *label,
4819 const unsigned char *random, size_t rlen,
4820 unsigned char *dstbuf, size_t dlen )
4821{
4822 psa_status_t status;
4823 psa_algorithm_t alg;
4824 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4825 psa_key_derivation_operation_t derivation =
4826 PSA_KEY_DERIVATION_OPERATION_INIT;
4827
4828 if( md_type == MBEDTLS_MD_SHA384 )
4829 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4830 else
4831 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4832
4833 /* Normally a "secret" should be long enough to be impossible to
4834 * find by brute force, and in particular should not be empty. But
4835 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4836 * and for this use case it makes sense to have a 0-length "secret".
4837 * Since the key API doesn't allow importing a key of length 0,
4838 * keep master_key=0, which setup_psa_key_derivation() understands
4839 * to mean a 0-length "secret" input. */
4840 if( slen != 0 )
4841 {
4842 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4843 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4844 psa_set_key_algorithm( &key_attributes, alg );
4845 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4846
4847 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4848 if( status != PSA_SUCCESS )
4849 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4850 }
4851
4852 status = setup_psa_key_derivation( &derivation,
4853 master_key, alg,
4854 random, rlen,
4855 (unsigned char const *) label,
4856 (size_t) strlen( label ),
4857 dlen );
4858 if( status != PSA_SUCCESS )
4859 {
4860 psa_key_derivation_abort( &derivation );
4861 psa_destroy_key( master_key );
4862 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4863 }
4864
4865 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4866 if( status != PSA_SUCCESS )
4867 {
4868 psa_key_derivation_abort( &derivation );
4869 psa_destroy_key( master_key );
4870 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4871 }
4872
4873 status = psa_key_derivation_abort( &derivation );
4874 if( status != PSA_SUCCESS )
4875 {
4876 psa_destroy_key( master_key );
4877 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4878 }
4879
4880 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4881 status = psa_destroy_key( master_key );
4882 if( status != PSA_SUCCESS )
4883 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4884
4885 return( 0 );
4886}
4887
4888#else /* MBEDTLS_USE_PSA_CRYPTO */
4889
4890static int tls_prf_generic( mbedtls_md_type_t md_type,
4891 const unsigned char *secret, size_t slen,
4892 const char *label,
4893 const unsigned char *random, size_t rlen,
4894 unsigned char *dstbuf, size_t dlen )
4895{
4896 size_t nb;
4897 size_t i, j, k, md_len;
4898 unsigned char *tmp;
4899 size_t tmp_len = 0;
4900 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
4901 const mbedtls_md_info_t *md_info;
4902 mbedtls_md_context_t md_ctx;
4903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4904
4905 mbedtls_md_init( &md_ctx );
4906
4907 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
4908 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4909
4910 md_len = mbedtls_md_get_size( md_info );
4911
4912 tmp_len = md_len + strlen( label ) + rlen;
4913 tmp = mbedtls_calloc( 1, tmp_len );
4914 if( tmp == NULL )
4915 {
4916 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4917 goto exit;
4918 }
4919
4920 nb = strlen( label );
4921 memcpy( tmp + md_len, label, nb );
4922 memcpy( tmp + md_len + nb, random, rlen );
4923 nb += rlen;
4924
4925 /*
4926 * Compute P_<hash>(secret, label + random)[0..dlen]
4927 */
4928 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
4929 goto exit;
4930
4931 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
4932 if( ret != 0 )
4933 goto exit;
4934 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
4935 if( ret != 0 )
4936 goto exit;
4937 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4938 if( ret != 0 )
4939 goto exit;
4940
4941 for( i = 0; i < dlen; i += md_len )
4942 {
4943 ret = mbedtls_md_hmac_reset ( &md_ctx );
4944 if( ret != 0 )
4945 goto exit;
4946 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
4947 if( ret != 0 )
4948 goto exit;
4949 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
4950 if( ret != 0 )
4951 goto exit;
4952
4953 ret = mbedtls_md_hmac_reset ( &md_ctx );
4954 if( ret != 0 )
4955 goto exit;
4956 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
4957 if( ret != 0 )
4958 goto exit;
4959 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4960 if( ret != 0 )
4961 goto exit;
4962
4963 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
4964
4965 for( j = 0; j < k; j++ )
4966 dstbuf[i + j] = h_i[j];
4967 }
4968
4969exit:
4970 mbedtls_md_free( &md_ctx );
4971
4972 mbedtls_platform_zeroize( tmp, tmp_len );
4973 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
4974
4975 mbedtls_free( tmp );
4976
4977 return( ret );
4978}
4979#endif /* MBEDTLS_USE_PSA_CRYPTO */
4980
4981#if defined(MBEDTLS_SHA256_C)
4982static int tls_prf_sha256( const unsigned char *secret, size_t slen,
4983 const char *label,
4984 const unsigned char *random, size_t rlen,
4985 unsigned char *dstbuf, size_t dlen )
4986{
4987 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
4988 label, random, rlen, dstbuf, dlen ) );
4989}
4990#endif /* MBEDTLS_SHA256_C */
4991
4992#if defined(MBEDTLS_SHA384_C)
4993static int tls_prf_sha384( const unsigned char *secret, size_t slen,
4994 const char *label,
4995 const unsigned char *random, size_t rlen,
4996 unsigned char *dstbuf, size_t dlen )
4997{
4998 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
4999 label, random, rlen, dstbuf, dlen ) );
5000}
5001#endif /* MBEDTLS_SHA384_C */
5002
Jerry Yuf009d862022-02-17 14:01:37 +08005003/*
5004 * Set appropriate PRF function and other SSL / TLS1.2 functions
5005 *
5006 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005007 * - hash associated with the ciphersuite (only used by TLS 1.2)
5008 *
5009 * Outputs:
5010 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5011 */
5012static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005013 mbedtls_md_type_t hash )
5014{
Jerry Yuf009d862022-02-17 14:01:37 +08005015#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005016 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005017 {
5018 handshake->tls_prf = tls_prf_sha384;
5019 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5020 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5021 }
5022 else
5023#endif
5024#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005025 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005026 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005027 handshake->tls_prf = tls_prf_sha256;
5028 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5029 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5030 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005031#else
Jerry Yuf009d862022-02-17 14:01:37 +08005032 {
Jerry Yuf009d862022-02-17 14:01:37 +08005033 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005034 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005035 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5036 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005037#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005038
5039 return( 0 );
5040}
Jerry Yud6ab2352022-02-17 14:03:43 +08005041
5042#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
5043 defined(MBEDTLS_USE_PSA_CRYPTO)
5044static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
5045{
5046 if( ssl->conf->f_psk != NULL )
5047 {
5048 /* If we've used a callback to select the PSK,
5049 * the static configuration is irrelevant. */
5050 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
5051 return( 1 );
5052
5053 return( 0 );
5054 }
5055
5056 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5057 return( 1 );
5058
5059 return( 0 );
5060}
5061#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5062 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5063
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005064/*
5065 * Compute master secret if needed
5066 *
5067 * Parameters:
5068 * [in/out] handshake
5069 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5070 * (PSA-PSK) ciphersuite_info, psk_opaque
5071 * [out] premaster (cleared)
5072 * [out] master
5073 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5074 * debug: conf->f_dbg, conf->p_dbg
5075 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005076 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005077 */
5078static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5079 unsigned char *master,
5080 const mbedtls_ssl_context *ssl )
5081{
5082 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5083
5084 /* cf. RFC 5246, Section 8.1:
5085 * "The master secret is always exactly 48 bytes in length." */
5086 size_t const master_secret_len = 48;
5087
5088#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5089 unsigned char session_hash[48];
5090#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5091
5092 /* The label for the KDF used for key expansion.
5093 * This is either "master secret" or "extended master secret"
5094 * depending on whether the Extended Master Secret extension
5095 * is used. */
5096 char const *lbl = "master secret";
5097
5098 /* The salt for the KDF used for key expansion.
5099 * - If the Extended Master Secret extension is not used,
5100 * this is ClientHello.Random + ServerHello.Random
5101 * (see Sect. 8.1 in RFC 5246).
5102 * - If the Extended Master Secret extension is used,
5103 * this is the transcript of the handshake so far.
5104 * (see Sect. 4 in RFC 7627). */
5105 unsigned char const *salt = handshake->randbytes;
5106 size_t salt_len = 64;
5107
5108#if !defined(MBEDTLS_DEBUG_C) && \
5109 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5110 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5111 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5112 ssl = NULL; /* make sure we don't use it except for those cases */
5113 (void) ssl;
5114#endif
5115
5116 if( handshake->resume != 0 )
5117 {
5118 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5119 return( 0 );
5120 }
5121
5122#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5123 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5124 {
5125 lbl = "extended master secret";
5126 salt = session_hash;
5127 handshake->calc_verify( ssl, session_hash, &salt_len );
5128
5129 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5130 session_hash, salt_len );
5131 }
5132#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5133
5134#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5135 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5136 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005137 ssl_use_opaque_psk( ssl ) == 1 )
5138 {
5139 /* Perform PSK-to-MS expansion in a single step. */
5140 psa_status_t status;
5141 psa_algorithm_t alg;
5142 mbedtls_svc_key_id_t psk;
5143 psa_key_derivation_operation_t derivation =
5144 PSA_KEY_DERIVATION_OPERATION_INIT;
5145 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5146
5147 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5148
5149 psk = mbedtls_ssl_get_opaque_psk( ssl );
5150
5151 if( hash_alg == MBEDTLS_MD_SHA384 )
5152 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5153 else
5154 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5155
5156 status = setup_psa_key_derivation( &derivation, psk, alg,
5157 salt, salt_len,
5158 (unsigned char const *) lbl,
5159 (size_t) strlen( lbl ),
5160 master_secret_len );
5161 if( status != PSA_SUCCESS )
5162 {
5163 psa_key_derivation_abort( &derivation );
5164 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5165 }
5166
5167 status = psa_key_derivation_output_bytes( &derivation,
5168 master,
5169 master_secret_len );
5170 if( status != PSA_SUCCESS )
5171 {
5172 psa_key_derivation_abort( &derivation );
5173 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5174 }
5175
5176 status = psa_key_derivation_abort( &derivation );
5177 if( status != PSA_SUCCESS )
5178 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5179 }
5180 else
5181#endif
5182 {
5183 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5184 lbl, salt, salt_len,
5185 master,
5186 master_secret_len );
5187 if( ret != 0 )
5188 {
5189 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5190 return( ret );
5191 }
5192
5193 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5194 handshake->premaster,
5195 handshake->pmslen );
5196
5197 mbedtls_platform_zeroize( handshake->premaster,
5198 sizeof(handshake->premaster) );
5199 }
5200
5201 return( 0 );
5202}
5203
Jerry Yud62f87e2022-02-17 14:09:02 +08005204int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5205{
5206 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5207 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5208 ssl->handshake->ciphersuite_info;
5209
5210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5211
5212 /* Set PRF, calc_verify and calc_finished function pointers */
5213 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005214 ciphersuite_info->mac );
5215 if( ret != 0 )
5216 {
5217 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5218 return( ret );
5219 }
5220
5221 /* Compute master secret if needed */
5222 ret = ssl_compute_master( ssl->handshake,
5223 ssl->session_negotiate->master,
5224 ssl );
5225 if( ret != 0 )
5226 {
5227 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5228 return( ret );
5229 }
5230
5231 /* Swap the client and server random values:
5232 * - MS derivation wanted client+server (RFC 5246 8.1)
5233 * - key derivation wants server+client (RFC 5246 6.3) */
5234 {
5235 unsigned char tmp[64];
5236 memcpy( tmp, ssl->handshake->randbytes, 64 );
5237 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5238 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5239 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5240 }
5241
5242 /* Populate transform structure */
5243 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5244 ssl->session_negotiate->ciphersuite,
5245 ssl->session_negotiate->master,
5246#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5247 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5248 ssl->session_negotiate->encrypt_then_mac,
5249#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5250 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5251 ssl->handshake->tls_prf,
5252 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005253 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005254 ssl->conf->endpoint,
5255 ssl );
5256 if( ret != 0 )
5257 {
5258 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5259 return( ret );
5260 }
5261
5262 /* We no longer need Server/ClientHello.random values */
5263 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5264 sizeof( ssl->handshake->randbytes ) );
5265
5266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5267
5268 return( 0 );
5269}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005270
Ronald Cron4dcbca92022-03-07 10:21:40 +01005271int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5272{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005273 switch( md )
5274 {
5275#if defined(MBEDTLS_SHA384_C)
5276 case MBEDTLS_SSL_HASH_SHA384:
5277 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5278 break;
5279#endif
5280#if defined(MBEDTLS_SHA256_C)
5281 case MBEDTLS_SSL_HASH_SHA256:
5282 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5283 break;
5284#endif
5285 default:
5286 return( -1 );
5287 }
5288
Ronald Cronc2f13a02022-03-07 10:25:24 +01005289 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005290}
5291
Jerry Yu8392e0d2022-02-17 14:10:24 +08005292#if defined(MBEDTLS_SHA256_C)
5293void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5294 unsigned char *hash,
5295 size_t *hlen )
5296{
5297#if defined(MBEDTLS_USE_PSA_CRYPTO)
5298 size_t hash_size;
5299 psa_status_t status;
5300 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5301
5302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5303 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5304 if( status != PSA_SUCCESS )
5305 {
5306 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5307 return;
5308 }
5309
5310 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5311 if( status != PSA_SUCCESS )
5312 {
5313 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5314 return;
5315 }
5316
5317 *hlen = 32;
5318 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5319 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5320#else
5321 mbedtls_sha256_context sha256;
5322
5323 mbedtls_sha256_init( &sha256 );
5324
5325 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5326
5327 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5328 mbedtls_sha256_finish( &sha256, hash );
5329
5330 *hlen = 32;
5331
5332 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5333 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5334
5335 mbedtls_sha256_free( &sha256 );
5336#endif /* MBEDTLS_USE_PSA_CRYPTO */
5337 return;
5338}
5339#endif /* MBEDTLS_SHA256_C */
5340
Jerry Yuc1cb3842022-02-17 14:13:48 +08005341#if defined(MBEDTLS_SHA384_C)
5342void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5343 unsigned char *hash,
5344 size_t *hlen )
5345{
5346#if defined(MBEDTLS_USE_PSA_CRYPTO)
5347 size_t hash_size;
5348 psa_status_t status;
5349 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5350
5351 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5352 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5353 if( status != PSA_SUCCESS )
5354 {
5355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5356 return;
5357 }
5358
5359 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5360 if( status != PSA_SUCCESS )
5361 {
5362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5363 return;
5364 }
5365
5366 *hlen = 48;
5367 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5369#else
5370 mbedtls_sha512_context sha512;
5371
5372 mbedtls_sha512_init( &sha512 );
5373
5374 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5375
5376 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5377 mbedtls_sha512_finish( &sha512, hash );
5378
5379 *hlen = 48;
5380
5381 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5382 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5383
5384 mbedtls_sha512_free( &sha512 );
5385#endif /* MBEDTLS_USE_PSA_CRYPTO */
5386 return;
5387}
5388#endif /* MBEDTLS_SHA384_C */
5389
Jerry Yuce3dca42022-02-17 14:16:37 +08005390#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5391int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5392{
5393 unsigned char *p = ssl->handshake->premaster;
5394 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5395 const unsigned char *psk = NULL;
5396 size_t psk_len = 0;
5397
5398 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5399 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5400 {
5401 /*
5402 * This should never happen because the existence of a PSK is always
5403 * checked before calling this function
5404 */
5405 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5406 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5407 }
5408
5409 /*
5410 * PMS = struct {
5411 * opaque other_secret<0..2^16-1>;
5412 * opaque psk<0..2^16-1>;
5413 * };
5414 * with "other_secret" depending on the particular key exchange
5415 */
5416#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5417 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5418 {
5419 if( end - p < 2 )
5420 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5421
5422 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5423 p += 2;
5424
5425 if( end < p || (size_t)( end - p ) < psk_len )
5426 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5427
5428 memset( p, 0, psk_len );
5429 p += psk_len;
5430 }
5431 else
5432#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5433#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5434 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5435 {
5436 /*
5437 * other_secret already set by the ClientKeyExchange message,
5438 * and is 48 bytes long
5439 */
5440 if( end - p < 2 )
5441 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5442
5443 *p++ = 0;
5444 *p++ = 48;
5445 p += 48;
5446 }
5447 else
5448#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5449#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5450 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5451 {
5452 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5453 size_t len;
5454
5455 /* Write length only when we know the actual value */
5456 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5457 p + 2, end - ( p + 2 ), &len,
5458 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5459 {
5460 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5461 return( ret );
5462 }
5463 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5464 p += 2 + len;
5465
5466 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5467 }
5468 else
5469#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5470#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5471 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5472 {
5473 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5474 size_t zlen;
5475
5476 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5477 p + 2, end - ( p + 2 ),
5478 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5479 {
5480 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5481 return( ret );
5482 }
5483
5484 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5485 p += 2 + zlen;
5486
5487 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5488 MBEDTLS_DEBUG_ECDH_Z );
5489 }
5490 else
5491#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5492 {
5493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5494 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5495 }
5496
5497 /* opaque psk<0..2^16-1>; */
5498 if( end - p < 2 )
5499 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5500
5501 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5502 p += 2;
5503
5504 if( end < p || (size_t)( end - p ) < psk_len )
5505 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5506
5507 memcpy( p, psk, psk_len );
5508 p += psk_len;
5509
5510 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5511
5512 return( 0 );
5513}
5514#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005515
5516#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5517static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5518
5519#if defined(MBEDTLS_SSL_PROTO_DTLS)
5520int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5521{
5522 /* If renegotiation is not enforced, retransmit until we would reach max
5523 * timeout if we were using the usual handshake doubling scheme */
5524 if( ssl->conf->renego_max_records < 0 )
5525 {
5526 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5527 unsigned char doublings = 1;
5528
5529 while( ratio != 0 )
5530 {
5531 ++doublings;
5532 ratio >>= 1;
5533 }
5534
5535 if( ++ssl->renego_records_seen > doublings )
5536 {
5537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5538 return( 0 );
5539 }
5540 }
5541
5542 return( ssl_write_hello_request( ssl ) );
5543}
5544#endif
5545#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005546
Jerry Yud9526692022-02-17 14:23:47 +08005547/*
5548 * Handshake functions
5549 */
5550#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5551/* No certificate support -> dummy functions */
5552int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5553{
5554 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5555 ssl->handshake->ciphersuite_info;
5556
5557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5558
5559 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5560 {
5561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5562 ssl->state++;
5563 return( 0 );
5564 }
5565
5566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5567 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5568}
5569
5570int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5571{
5572 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5573 ssl->handshake->ciphersuite_info;
5574
5575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5576
5577 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5578 {
5579 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5580 ssl->state++;
5581 return( 0 );
5582 }
5583
5584 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5585 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5586}
5587
5588#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5589/* Some certificate support -> implement write and parse */
5590
5591int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5592{
5593 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5594 size_t i, n;
5595 const mbedtls_x509_crt *crt;
5596 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5597 ssl->handshake->ciphersuite_info;
5598
5599 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5600
5601 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5602 {
5603 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5604 ssl->state++;
5605 return( 0 );
5606 }
5607
5608#if defined(MBEDTLS_SSL_CLI_C)
5609 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5610 {
5611 if( ssl->handshake->client_auth == 0 )
5612 {
5613 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5614 ssl->state++;
5615 return( 0 );
5616 }
5617 }
5618#endif /* MBEDTLS_SSL_CLI_C */
5619#if defined(MBEDTLS_SSL_SRV_C)
5620 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5621 {
5622 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5623 {
5624 /* Should never happen because we shouldn't have picked the
5625 * ciphersuite if we don't have a certificate. */
5626 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5627 }
5628 }
5629#endif
5630
5631 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5632
5633 /*
5634 * 0 . 0 handshake type
5635 * 1 . 3 handshake length
5636 * 4 . 6 length of all certs
5637 * 7 . 9 length of cert. 1
5638 * 10 . n-1 peer certificate
5639 * n . n+2 length of cert. 2
5640 * n+3 . ... upper level cert, etc.
5641 */
5642 i = 7;
5643 crt = mbedtls_ssl_own_cert( ssl );
5644
5645 while( crt != NULL )
5646 {
5647 n = crt->raw.len;
5648 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5649 {
5650 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5651 " > %" MBEDTLS_PRINTF_SIZET,
5652 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5653 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5654 }
5655
5656 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5657 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5658 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5659
5660 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5661 i += n; crt = crt->next;
5662 }
5663
5664 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5665 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5666 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5667
5668 ssl->out_msglen = i;
5669 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5670 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5671
5672 ssl->state++;
5673
5674 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5675 {
5676 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5677 return( ret );
5678 }
5679
5680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5681
5682 return( ret );
5683}
5684
5685#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5686
5687#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5688static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5689 unsigned char *crt_buf,
5690 size_t crt_buf_len )
5691{
5692 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5693
5694 if( peer_crt == NULL )
5695 return( -1 );
5696
5697 if( peer_crt->raw.len != crt_buf_len )
5698 return( -1 );
5699
5700 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5701}
5702#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5703static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5704 unsigned char *crt_buf,
5705 size_t crt_buf_len )
5706{
5707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5708 unsigned char const * const peer_cert_digest =
5709 ssl->session->peer_cert_digest;
5710 mbedtls_md_type_t const peer_cert_digest_type =
5711 ssl->session->peer_cert_digest_type;
5712 mbedtls_md_info_t const * const digest_info =
5713 mbedtls_md_info_from_type( peer_cert_digest_type );
5714 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5715 size_t digest_len;
5716
5717 if( peer_cert_digest == NULL || digest_info == NULL )
5718 return( -1 );
5719
5720 digest_len = mbedtls_md_get_size( digest_info );
5721 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5722 return( -1 );
5723
5724 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5725 if( ret != 0 )
5726 return( -1 );
5727
5728 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5729}
5730#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5731#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5732
5733/*
5734 * Once the certificate message is read, parse it into a cert chain and
5735 * perform basic checks, but leave actual verification to the caller
5736 */
5737static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5738 mbedtls_x509_crt *chain )
5739{
5740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5741#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5742 int crt_cnt=0;
5743#endif
5744 size_t i, n;
5745 uint8_t alert;
5746
5747 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5748 {
5749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5750 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5751 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5752 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5753 }
5754
5755 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5756 {
5757 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5758 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5759 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5760 }
5761
5762 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5763 {
5764 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5765 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5766 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5767 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5768 }
5769
5770 i = mbedtls_ssl_hs_hdr_len( ssl );
5771
5772 /*
5773 * Same message structure as in mbedtls_ssl_write_certificate()
5774 */
5775 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5776
5777 if( ssl->in_msg[i] != 0 ||
5778 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5779 {
5780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5781 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5782 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5783 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5784 }
5785
5786 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5787 i += 3;
5788
5789 /* Iterate through and parse the CRTs in the provided chain. */
5790 while( i < ssl->in_hslen )
5791 {
5792 /* Check that there's room for the next CRT's length fields. */
5793 if ( i + 3 > ssl->in_hslen ) {
5794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5795 mbedtls_ssl_send_alert_message( ssl,
5796 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5797 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5798 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5799 }
5800 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5801 * anything beyond 2**16 ~ 64K. */
5802 if( ssl->in_msg[i] != 0 )
5803 {
5804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5805 mbedtls_ssl_send_alert_message( ssl,
5806 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5807 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5808 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5809 }
5810
5811 /* Read length of the next CRT in the chain. */
5812 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5813 | (unsigned int) ssl->in_msg[i + 2];
5814 i += 3;
5815
5816 if( n < 128 || i + n > ssl->in_hslen )
5817 {
5818 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5819 mbedtls_ssl_send_alert_message( ssl,
5820 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5821 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5822 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5823 }
5824
5825 /* Check if we're handling the first CRT in the chain. */
5826#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5827 if( crt_cnt++ == 0 &&
5828 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5829 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5830 {
5831 /* During client-side renegotiation, check that the server's
5832 * end-CRTs hasn't changed compared to the initial handshake,
5833 * mitigating the triple handshake attack. On success, reuse
5834 * the original end-CRT instead of parsing it again. */
5835 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5836 if( ssl_check_peer_crt_unchanged( ssl,
5837 &ssl->in_msg[i],
5838 n ) != 0 )
5839 {
5840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5841 mbedtls_ssl_send_alert_message( ssl,
5842 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5843 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5844 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5845 }
5846
5847 /* Now we can safely free the original chain. */
5848 ssl_clear_peer_cert( ssl->session );
5849 }
5850#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5851
5852 /* Parse the next certificate in the chain. */
5853#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5854 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5855#else
5856 /* If we don't need to store the CRT chain permanently, parse
5857 * it in-place from the input buffer instead of making a copy. */
5858 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5859#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5860 switch( ret )
5861 {
5862 case 0: /*ok*/
5863 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5864 /* Ignore certificate with an unknown algorithm: maybe a
5865 prior certificate was already trusted. */
5866 break;
5867
5868 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5869 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5870 goto crt_parse_der_failed;
5871
5872 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5873 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5874 goto crt_parse_der_failed;
5875
5876 default:
5877 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5878 crt_parse_der_failed:
5879 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5880 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5881 return( ret );
5882 }
5883
5884 i += n;
5885 }
5886
5887 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
5888 return( 0 );
5889}
5890
5891#if defined(MBEDTLS_SSL_SRV_C)
5892static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
5893{
5894 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5895 return( -1 );
5896
5897 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
5898 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
5899 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
5900 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
5901 {
5902 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
5903 return( 0 );
5904 }
5905 return( -1 );
5906}
5907#endif /* MBEDTLS_SSL_SRV_C */
5908
5909/* Check if a certificate message is expected.
5910 * Return either
5911 * - SSL_CERTIFICATE_EXPECTED, or
5912 * - SSL_CERTIFICATE_SKIP
5913 * indicating whether a Certificate message is expected or not.
5914 */
5915#define SSL_CERTIFICATE_EXPECTED 0
5916#define SSL_CERTIFICATE_SKIP 1
5917static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
5918 int authmode )
5919{
5920 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5921 ssl->handshake->ciphersuite_info;
5922
5923 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5924 return( SSL_CERTIFICATE_SKIP );
5925
5926#if defined(MBEDTLS_SSL_SRV_C)
5927 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5928 {
5929 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5930 return( SSL_CERTIFICATE_SKIP );
5931
5932 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5933 {
5934 ssl->session_negotiate->verify_result =
5935 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
5936 return( SSL_CERTIFICATE_SKIP );
5937 }
5938 }
5939#else
5940 ((void) authmode);
5941#endif /* MBEDTLS_SSL_SRV_C */
5942
5943 return( SSL_CERTIFICATE_EXPECTED );
5944}
5945
5946static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
5947 int authmode,
5948 mbedtls_x509_crt *chain,
5949 void *rs_ctx )
5950{
5951 int ret = 0;
5952 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5953 ssl->handshake->ciphersuite_info;
5954 int have_ca_chain = 0;
5955
5956 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
5957 void *p_vrfy;
5958
5959 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5960 return( 0 );
5961
5962 if( ssl->f_vrfy != NULL )
5963 {
5964 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
5965 f_vrfy = ssl->f_vrfy;
5966 p_vrfy = ssl->p_vrfy;
5967 }
5968 else
5969 {
5970 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
5971 f_vrfy = ssl->conf->f_vrfy;
5972 p_vrfy = ssl->conf->p_vrfy;
5973 }
5974
5975 /*
5976 * Main check: verify certificate
5977 */
5978#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
5979 if( ssl->conf->f_ca_cb != NULL )
5980 {
5981 ((void) rs_ctx);
5982 have_ca_chain = 1;
5983
5984 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
5985 ret = mbedtls_x509_crt_verify_with_ca_cb(
5986 chain,
5987 ssl->conf->f_ca_cb,
5988 ssl->conf->p_ca_cb,
5989 ssl->conf->cert_profile,
5990 ssl->hostname,
5991 &ssl->session_negotiate->verify_result,
5992 f_vrfy, p_vrfy );
5993 }
5994 else
5995#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
5996 {
5997 mbedtls_x509_crt *ca_chain;
5998 mbedtls_x509_crl *ca_crl;
5999
6000#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6001 if( ssl->handshake->sni_ca_chain != NULL )
6002 {
6003 ca_chain = ssl->handshake->sni_ca_chain;
6004 ca_crl = ssl->handshake->sni_ca_crl;
6005 }
6006 else
6007#endif
6008 {
6009 ca_chain = ssl->conf->ca_chain;
6010 ca_crl = ssl->conf->ca_crl;
6011 }
6012
6013 if( ca_chain != NULL )
6014 have_ca_chain = 1;
6015
6016 ret = mbedtls_x509_crt_verify_restartable(
6017 chain,
6018 ca_chain, ca_crl,
6019 ssl->conf->cert_profile,
6020 ssl->hostname,
6021 &ssl->session_negotiate->verify_result,
6022 f_vrfy, p_vrfy, rs_ctx );
6023 }
6024
6025 if( ret != 0 )
6026 {
6027 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6028 }
6029
6030#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6031 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6032 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6033#endif
6034
6035 /*
6036 * Secondary checks: always done, but change 'ret' only if it was 0
6037 */
6038
6039#if defined(MBEDTLS_ECP_C)
6040 {
6041 const mbedtls_pk_context *pk = &chain->pk;
6042
6043 /* If certificate uses an EC key, make sure the curve is OK */
6044 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6045 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6046 {
6047 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6048
6049 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6050 if( ret == 0 )
6051 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6052 }
6053 }
6054#endif /* MBEDTLS_ECP_C */
6055
6056 if( mbedtls_ssl_check_cert_usage( chain,
6057 ciphersuite_info,
6058 ! ssl->conf->endpoint,
6059 &ssl->session_negotiate->verify_result ) != 0 )
6060 {
6061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6062 if( ret == 0 )
6063 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6064 }
6065
6066 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6067 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6068 * with details encoded in the verification flags. All other kinds
6069 * of error codes, including those from the user provided f_vrfy
6070 * functions, are treated as fatal and lead to a failure of
6071 * ssl_parse_certificate even if verification was optional. */
6072 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6073 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6074 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6075 {
6076 ret = 0;
6077 }
6078
6079 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6080 {
6081 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6082 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6083 }
6084
6085 if( ret != 0 )
6086 {
6087 uint8_t alert;
6088
6089 /* The certificate may have been rejected for several reasons.
6090 Pick one and send the corresponding alert. Which alert to send
6091 may be a subject of debate in some cases. */
6092 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6093 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6094 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6095 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6096 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6097 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6098 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6099 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6100 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6101 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6102 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6103 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6104 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6105 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6106 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6107 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6108 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6109 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6110 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6111 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6112 else
6113 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6114 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6115 alert );
6116 }
6117
6118#if defined(MBEDTLS_DEBUG_C)
6119 if( ssl->session_negotiate->verify_result != 0 )
6120 {
6121 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6122 (unsigned int) ssl->session_negotiate->verify_result ) );
6123 }
6124 else
6125 {
6126 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6127 }
6128#endif /* MBEDTLS_DEBUG_C */
6129
6130 return( ret );
6131}
6132
6133#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6134static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6135 unsigned char *start, size_t len )
6136{
6137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6138 /* Remember digest of the peer's end-CRT. */
6139 ssl->session_negotiate->peer_cert_digest =
6140 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6141 if( ssl->session_negotiate->peer_cert_digest == NULL )
6142 {
6143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6144 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6145 mbedtls_ssl_send_alert_message( ssl,
6146 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6147 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6148
6149 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6150 }
6151
6152 ret = mbedtls_md( mbedtls_md_info_from_type(
6153 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6154 start, len,
6155 ssl->session_negotiate->peer_cert_digest );
6156
6157 ssl->session_negotiate->peer_cert_digest_type =
6158 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6159 ssl->session_negotiate->peer_cert_digest_len =
6160 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6161
6162 return( ret );
6163}
6164
6165static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6166 unsigned char *start, size_t len )
6167{
6168 unsigned char *end = start + len;
6169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6170
6171 /* Make a copy of the peer's raw public key. */
6172 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6173 ret = mbedtls_pk_parse_subpubkey( &start, end,
6174 &ssl->handshake->peer_pubkey );
6175 if( ret != 0 )
6176 {
6177 /* We should have parsed the public key before. */
6178 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6179 }
6180
6181 return( 0 );
6182}
6183#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6184
6185int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6186{
6187 int ret = 0;
6188 int crt_expected;
6189#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6190 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6191 ? ssl->handshake->sni_authmode
6192 : ssl->conf->authmode;
6193#else
6194 const int authmode = ssl->conf->authmode;
6195#endif
6196 void *rs_ctx = NULL;
6197 mbedtls_x509_crt *chain = NULL;
6198
6199 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6200
6201 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6202 if( crt_expected == SSL_CERTIFICATE_SKIP )
6203 {
6204 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6205 goto exit;
6206 }
6207
6208#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6209 if( ssl->handshake->ecrs_enabled &&
6210 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6211 {
6212 chain = ssl->handshake->ecrs_peer_cert;
6213 ssl->handshake->ecrs_peer_cert = NULL;
6214 goto crt_verify;
6215 }
6216#endif
6217
6218 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6219 {
6220 /* mbedtls_ssl_read_record may have sent an alert already. We
6221 let it decide whether to alert. */
6222 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6223 goto exit;
6224 }
6225
6226#if defined(MBEDTLS_SSL_SRV_C)
6227 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6228 {
6229 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6230
6231 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6232 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6233
6234 goto exit;
6235 }
6236#endif /* MBEDTLS_SSL_SRV_C */
6237
6238 /* Clear existing peer CRT structure in case we tried to
6239 * reuse a session but it failed, and allocate a new one. */
6240 ssl_clear_peer_cert( ssl->session_negotiate );
6241
6242 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6243 if( chain == NULL )
6244 {
6245 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6246 sizeof( mbedtls_x509_crt ) ) );
6247 mbedtls_ssl_send_alert_message( ssl,
6248 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6249 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6250
6251 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6252 goto exit;
6253 }
6254 mbedtls_x509_crt_init( chain );
6255
6256 ret = ssl_parse_certificate_chain( ssl, chain );
6257 if( ret != 0 )
6258 goto exit;
6259
6260#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6261 if( ssl->handshake->ecrs_enabled)
6262 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6263
6264crt_verify:
6265 if( ssl->handshake->ecrs_enabled)
6266 rs_ctx = &ssl->handshake->ecrs_ctx;
6267#endif
6268
6269 ret = ssl_parse_certificate_verify( ssl, authmode,
6270 chain, rs_ctx );
6271 if( ret != 0 )
6272 goto exit;
6273
6274#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6275 {
6276 unsigned char *crt_start, *pk_start;
6277 size_t crt_len, pk_len;
6278
6279 /* We parse the CRT chain without copying, so
6280 * these pointers point into the input buffer,
6281 * and are hence still valid after freeing the
6282 * CRT chain. */
6283
6284 crt_start = chain->raw.p;
6285 crt_len = chain->raw.len;
6286
6287 pk_start = chain->pk_raw.p;
6288 pk_len = chain->pk_raw.len;
6289
6290 /* Free the CRT structures before computing
6291 * digest and copying the peer's public key. */
6292 mbedtls_x509_crt_free( chain );
6293 mbedtls_free( chain );
6294 chain = NULL;
6295
6296 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6297 if( ret != 0 )
6298 goto exit;
6299
6300 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6301 if( ret != 0 )
6302 goto exit;
6303 }
6304#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6305 /* Pass ownership to session structure. */
6306 ssl->session_negotiate->peer_cert = chain;
6307 chain = NULL;
6308#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6309
6310 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6311
6312exit:
6313
6314 if( ret == 0 )
6315 ssl->state++;
6316
6317#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6318 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6319 {
6320 ssl->handshake->ecrs_peer_cert = chain;
6321 chain = NULL;
6322 }
6323#endif
6324
6325 if( chain != NULL )
6326 {
6327 mbedtls_x509_crt_free( chain );
6328 mbedtls_free( chain );
6329 }
6330
6331 return( ret );
6332}
6333#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6334
Jerry Yu615bd6f2022-02-17 14:25:15 +08006335#if defined(MBEDTLS_SHA256_C)
6336static void ssl_calc_finished_tls_sha256(
6337 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6338{
6339 int len = 12;
6340 const char *sender;
6341 unsigned char padbuf[32];
6342#if defined(MBEDTLS_USE_PSA_CRYPTO)
6343 size_t hash_size;
6344 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6345 psa_status_t status;
6346#else
6347 mbedtls_sha256_context sha256;
6348#endif
6349
6350 mbedtls_ssl_session *session = ssl->session_negotiate;
6351 if( !session )
6352 session = ssl->session;
6353
6354 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6355 ? "client finished"
6356 : "server finished";
6357
6358#if defined(MBEDTLS_USE_PSA_CRYPTO)
6359 sha256_psa = psa_hash_operation_init();
6360
6361 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6362
6363 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6364 if( status != PSA_SUCCESS )
6365 {
6366 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6367 return;
6368 }
6369
6370 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6371 if( status != PSA_SUCCESS )
6372 {
6373 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6374 return;
6375 }
6376 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6377#else
6378
6379 mbedtls_sha256_init( &sha256 );
6380
6381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6382
6383 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6384
6385 /*
6386 * TLSv1.2:
6387 * hash = PRF( master, finished_label,
6388 * Hash( handshake ) )[0.11]
6389 */
6390
6391#if !defined(MBEDTLS_SHA256_ALT)
6392 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6393 sha256.state, sizeof( sha256.state ) );
6394#endif
6395
6396 mbedtls_sha256_finish( &sha256, padbuf );
6397 mbedtls_sha256_free( &sha256 );
6398#endif /* MBEDTLS_USE_PSA_CRYPTO */
6399
6400 ssl->handshake->tls_prf( session->master, 48, sender,
6401 padbuf, 32, buf, len );
6402
6403 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6404
6405 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6406
6407 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6408}
6409#endif /* MBEDTLS_SHA256_C */
6410
Jerry Yub7ba49e2022-02-17 14:25:53 +08006411
6412#if defined(MBEDTLS_SHA384_C)
6413
6414static void ssl_calc_finished_tls_sha384(
6415 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6416{
6417 int len = 12;
6418 const char *sender;
6419 unsigned char padbuf[48];
6420#if defined(MBEDTLS_USE_PSA_CRYPTO)
6421 size_t hash_size;
6422 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6423 psa_status_t status;
6424#else
6425 mbedtls_sha512_context sha512;
6426#endif
6427
6428 mbedtls_ssl_session *session = ssl->session_negotiate;
6429 if( !session )
6430 session = ssl->session;
6431
6432 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6433 ? "client finished"
6434 : "server finished";
6435
6436#if defined(MBEDTLS_USE_PSA_CRYPTO)
6437 sha384_psa = psa_hash_operation_init();
6438
6439 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6440
6441 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6442 if( status != PSA_SUCCESS )
6443 {
6444 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6445 return;
6446 }
6447
6448 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6449 if( status != PSA_SUCCESS )
6450 {
6451 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6452 return;
6453 }
6454 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6455#else
6456 mbedtls_sha512_init( &sha512 );
6457
6458 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6459
6460 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6461
6462 /*
6463 * TLSv1.2:
6464 * hash = PRF( master, finished_label,
6465 * Hash( handshake ) )[0.11]
6466 */
6467
6468#if !defined(MBEDTLS_SHA512_ALT)
6469 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6470 sha512.state, sizeof( sha512.state ) );
6471#endif
6472 mbedtls_sha512_finish( &sha512, padbuf );
6473
6474 mbedtls_sha512_free( &sha512 );
6475#endif
6476
6477 ssl->handshake->tls_prf( session->master, 48, sender,
6478 padbuf, 48, buf, len );
6479
6480 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6481
6482 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6483
6484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6485}
6486#endif /* MBEDTLS_SHA384_C */
6487
Jerry Yuaef00152022-02-17 14:27:31 +08006488void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6489{
6490 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6491
6492 /*
6493 * Free our handshake params
6494 */
6495 mbedtls_ssl_handshake_free( ssl );
6496 mbedtls_free( ssl->handshake );
6497 ssl->handshake = NULL;
6498
6499 /*
6500 * Free the previous transform and swith in the current one
6501 */
6502 if( ssl->transform )
6503 {
6504 mbedtls_ssl_transform_free( ssl->transform );
6505 mbedtls_free( ssl->transform );
6506 }
6507 ssl->transform = ssl->transform_negotiate;
6508 ssl->transform_negotiate = NULL;
6509
6510 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6511}
6512
Jerry Yu2a9fff52022-02-17 14:28:51 +08006513void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6514{
6515 int resume = ssl->handshake->resume;
6516
6517 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6518
6519#if defined(MBEDTLS_SSL_RENEGOTIATION)
6520 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6521 {
6522 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6523 ssl->renego_records_seen = 0;
6524 }
6525#endif
6526
6527 /*
6528 * Free the previous session and switch in the current one
6529 */
6530 if( ssl->session )
6531 {
6532#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6533 /* RFC 7366 3.1: keep the EtM state */
6534 ssl->session_negotiate->encrypt_then_mac =
6535 ssl->session->encrypt_then_mac;
6536#endif
6537
6538 mbedtls_ssl_session_free( ssl->session );
6539 mbedtls_free( ssl->session );
6540 }
6541 ssl->session = ssl->session_negotiate;
6542 ssl->session_negotiate = NULL;
6543
6544 /*
6545 * Add cache entry
6546 */
6547 if( ssl->conf->f_set_cache != NULL &&
6548 ssl->session->id_len != 0 &&
6549 resume == 0 )
6550 {
6551 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6552 ssl->session->id,
6553 ssl->session->id_len,
6554 ssl->session ) != 0 )
6555 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6556 }
6557
6558#if defined(MBEDTLS_SSL_PROTO_DTLS)
6559 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6560 ssl->handshake->flight != NULL )
6561 {
6562 /* Cancel handshake timer */
6563 mbedtls_ssl_set_timer( ssl, 0 );
6564
6565 /* Keep last flight around in case we need to resend it:
6566 * we need the handshake and transform structures for that */
6567 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6568 }
6569 else
6570#endif
6571 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6572
6573 ssl->state++;
6574
6575 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6576}
6577
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006578int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6579{
6580 int ret, hash_len;
6581
6582 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6583
6584 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6585
6586 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6587
6588 /*
6589 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6590 * may define some other value. Currently (early 2016), no defined
6591 * ciphersuite does this (and this is unlikely to change as activity has
6592 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6593 */
6594 hash_len = 12;
6595
6596#if defined(MBEDTLS_SSL_RENEGOTIATION)
6597 ssl->verify_data_len = hash_len;
6598 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6599#endif
6600
6601 ssl->out_msglen = 4 + hash_len;
6602 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6603 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6604
6605 /*
6606 * In case of session resuming, invert the client and server
6607 * ChangeCipherSpec messages order.
6608 */
6609 if( ssl->handshake->resume != 0 )
6610 {
6611#if defined(MBEDTLS_SSL_CLI_C)
6612 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6613 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6614#endif
6615#if defined(MBEDTLS_SSL_SRV_C)
6616 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6617 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6618#endif
6619 }
6620 else
6621 ssl->state++;
6622
6623 /*
6624 * Switch to our negotiated transform and session parameters for outbound
6625 * data.
6626 */
6627 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6628
6629#if defined(MBEDTLS_SSL_PROTO_DTLS)
6630 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6631 {
6632 unsigned char i;
6633
6634 /* Remember current epoch settings for resending */
6635 ssl->handshake->alt_transform_out = ssl->transform_out;
6636 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6637 sizeof( ssl->handshake->alt_out_ctr ) );
6638
6639 /* Set sequence_number to zero */
6640 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6641
6642
6643 /* Increment epoch */
6644 for( i = 2; i > 0; i-- )
6645 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6646 break;
6647
6648 /* The loop goes to its end iff the counter is wrapping */
6649 if( i == 0 )
6650 {
6651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6652 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6653 }
6654 }
6655 else
6656#endif /* MBEDTLS_SSL_PROTO_DTLS */
6657 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6658
6659 ssl->transform_out = ssl->transform_negotiate;
6660 ssl->session_out = ssl->session_negotiate;
6661
6662#if defined(MBEDTLS_SSL_PROTO_DTLS)
6663 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6664 mbedtls_ssl_send_flight_completed( ssl );
6665#endif
6666
6667 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6668 {
6669 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6670 return( ret );
6671 }
6672
6673#if defined(MBEDTLS_SSL_PROTO_DTLS)
6674 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6675 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6676 {
6677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6678 return( ret );
6679 }
6680#endif
6681
6682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6683
6684 return( 0 );
6685}
6686
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006687#define SSL_MAX_HASH_LEN 12
6688
6689int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6690{
6691 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6692 unsigned int hash_len = 12;
6693 unsigned char buf[SSL_MAX_HASH_LEN];
6694
6695 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6696
6697 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6698
6699 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6700 {
6701 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6702 goto exit;
6703 }
6704
6705 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6706 {
6707 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6708 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6709 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6710 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6711 goto exit;
6712 }
6713
6714 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6715 {
6716 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6717 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6718 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6719 goto exit;
6720 }
6721
6722 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6723 {
6724 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6725 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6726 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6727 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6728 goto exit;
6729 }
6730
6731 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6732 buf, hash_len ) != 0 )
6733 {
6734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6735 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6736 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6737 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6738 goto exit;
6739 }
6740
6741#if defined(MBEDTLS_SSL_RENEGOTIATION)
6742 ssl->verify_data_len = hash_len;
6743 memcpy( ssl->peer_verify_data, buf, hash_len );
6744#endif
6745
6746 if( ssl->handshake->resume != 0 )
6747 {
6748#if defined(MBEDTLS_SSL_CLI_C)
6749 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6750 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6751#endif
6752#if defined(MBEDTLS_SSL_SRV_C)
6753 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6754 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6755#endif
6756 }
6757 else
6758 ssl->state++;
6759
6760#if defined(MBEDTLS_SSL_PROTO_DTLS)
6761 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6762 mbedtls_ssl_recv_flight_completed( ssl );
6763#endif
6764
6765 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6766
6767exit:
6768 mbedtls_platform_zeroize( buf, hash_len );
6769 return( ret );
6770}
6771
Jerry Yu392112c2022-02-17 14:34:10 +08006772#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6773/*
6774 * Helper to get TLS 1.2 PRF from ciphersuite
6775 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6776 */
6777static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6778{
6779#if defined(MBEDTLS_SHA384_C)
6780 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6781 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6782
6783 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6784 return( tls_prf_sha384 );
6785#else
6786 (void) ciphersuite_id;
6787#endif
6788 return( tls_prf_sha256 );
6789}
6790#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006791
6792static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6793{
6794 ((void) tls_prf);
6795#if defined(MBEDTLS_SHA384_C)
6796 if( tls_prf == tls_prf_sha384 )
6797 {
6798 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6799 }
6800 else
6801#endif
6802#if defined(MBEDTLS_SHA256_C)
6803 if( tls_prf == tls_prf_sha256 )
6804 {
6805 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6806 }
6807 else
6808#endif
6809 return( MBEDTLS_SSL_TLS_PRF_NONE );
6810}
6811
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006812/*
6813 * Populate a transform structure with session keys and all the other
6814 * necessary information.
6815 *
6816 * Parameters:
6817 * - [in/out]: transform: structure to populate
6818 * [in] must be just initialised with mbedtls_ssl_transform_init()
6819 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6820 * - [in] ciphersuite
6821 * - [in] master
6822 * - [in] encrypt_then_mac
6823 * - [in] compression
6824 * - [in] tls_prf: pointer to PRF to use for key derivation
6825 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006826 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006827 * - [in] endpoint: client or server
6828 * - [in] ssl: used for:
6829 * - ssl->conf->{f,p}_export_keys
6830 * [in] optionally used for:
6831 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6832 */
6833static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6834 int ciphersuite,
6835 const unsigned char master[48],
6836#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6837 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6838 int encrypt_then_mac,
6839#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6840 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6841 ssl_tls_prf_t tls_prf,
6842 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006843 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006844 unsigned endpoint,
6845 const mbedtls_ssl_context *ssl )
6846{
6847 int ret = 0;
6848 unsigned char keyblk[256];
6849 unsigned char *key1;
6850 unsigned char *key2;
6851 unsigned char *mac_enc;
6852 unsigned char *mac_dec;
6853 size_t mac_key_len = 0;
6854 size_t iv_copy_len;
6855 size_t keylen;
6856 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
6857 const mbedtls_cipher_info_t *cipher_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006858#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006859 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006860#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006861
6862#if defined(MBEDTLS_USE_PSA_CRYPTO)
6863 psa_key_type_t key_type;
6864 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6865 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006866 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006867 size_t key_bits;
6868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6869#endif
6870
6871#if !defined(MBEDTLS_DEBUG_C) && \
6872 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6873 if( ssl->f_export_keys == NULL )
6874 {
6875 ssl = NULL; /* make sure we don't use it except for these cases */
6876 (void) ssl;
6877 }
6878#endif
6879
6880 /*
6881 * Some data just needs copying into the structure
6882 */
6883#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
6884 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6885 transform->encrypt_then_mac = encrypt_then_mac;
6886#endif
Glenn Strauss07c64162022-03-14 12:34:51 -04006887 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006888
6889#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6890 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
6891#endif
6892
6893#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04006894 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006895 {
6896 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
6897 * generation separate. This should never happen. */
6898 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6899 }
6900#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6901
6902 /*
6903 * Get various info structures
6904 */
6905 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
6906 if( ciphersuite_info == NULL )
6907 {
6908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
6909 ciphersuite ) );
6910 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6911 }
6912
6913 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
6914 if( cipher_info == NULL )
6915 {
6916 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
6917 ciphersuite_info->cipher ) );
6918 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6919 }
6920
Neil Armstronge4512952022-03-08 09:08:22 +01006921#if defined(MBEDTLS_USE_PSA_CRYPTO)
6922 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
6923 if( mac_alg == 0 )
6924 {
6925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
6926 (unsigned) ciphersuite_info->mac ) );
6927 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6928 }
6929#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006930 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
6931 if( md_info == NULL )
6932 {
6933 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
6934 (unsigned) ciphersuite_info->mac ) );
6935 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6936 }
Neil Armstronge4512952022-03-08 09:08:22 +01006937#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006938
6939#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6940 /* Copy own and peer's CID if the use of the CID
6941 * extension has been negotiated. */
6942 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
6943 {
6944 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
6945
6946 transform->in_cid_len = ssl->own_cid_len;
6947 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
6948 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
6949 transform->in_cid_len );
6950
6951 transform->out_cid_len = ssl->handshake->peer_cid_len;
6952 memcpy( transform->out_cid, ssl->handshake->peer_cid,
6953 ssl->handshake->peer_cid_len );
6954 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
6955 transform->out_cid_len );
6956 }
6957#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
6958
6959 /*
6960 * Compute key block using the PRF
6961 */
6962 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
6963 if( ret != 0 )
6964 {
6965 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6966 return( ret );
6967 }
6968
6969 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
6970 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
6971 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
6972 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
6973 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
6974
6975 /*
6976 * Determine the appropriate key, IV and MAC length.
6977 */
6978
6979 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
6980
6981#if defined(MBEDTLS_GCM_C) || \
6982 defined(MBEDTLS_CCM_C) || \
6983 defined(MBEDTLS_CHACHAPOLY_C)
6984 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
6985 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
6986 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6987 {
6988 size_t explicit_ivlen;
6989
6990 transform->maclen = 0;
6991 mac_key_len = 0;
6992 transform->taglen =
6993 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
6994
6995 /* All modes haves 96-bit IVs, but the length of the static parts vary
6996 * with mode and version:
6997 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
6998 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
6999 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7000 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7001 * sequence number).
7002 */
7003 transform->ivlen = 12;
7004 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
7005 transform->fixed_ivlen = 12;
7006 else
7007 transform->fixed_ivlen = 4;
7008
7009 /* Minimum length of encrypted record */
7010 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7011 transform->minlen = explicit_ivlen + transform->taglen;
7012 }
7013 else
7014#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7015#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7016 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
7017 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7018 {
Neil Armstronge4512952022-03-08 09:08:22 +01007019#if defined(MBEDTLS_USE_PSA_CRYPTO)
7020 /* Get MAC length */
7021 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7022#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007023 /* Initialize HMAC contexts */
7024 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7025 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7026 {
7027 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7028 goto end;
7029 }
7030
7031 /* Get MAC length */
7032 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007033#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007034 transform->maclen = mac_key_len;
7035
7036 /* IV length */
7037 transform->ivlen = cipher_info->iv_size;
7038
7039 /* Minimum length */
7040 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
7041 transform->minlen = transform->maclen;
7042 else
7043 {
7044 /*
7045 * GenericBlockCipher:
7046 * 1. if EtM is in use: one block plus MAC
7047 * otherwise: * first multiple of blocklen greater than maclen
7048 * 2. IV
7049 */
7050#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7051 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
7052 {
7053 transform->minlen = transform->maclen
7054 + cipher_info->block_size;
7055 }
7056 else
7057#endif
7058 {
7059 transform->minlen = transform->maclen
7060 + cipher_info->block_size
7061 - transform->maclen % cipher_info->block_size;
7062 }
7063
Glenn Strauss07c64162022-03-14 12:34:51 -04007064 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007065 {
7066 transform->minlen += transform->ivlen;
7067 }
7068 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007069 {
7070 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7071 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7072 goto end;
7073 }
7074 }
7075 }
7076 else
7077#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7078 {
7079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7080 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7081 }
7082
7083 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7084 (unsigned) keylen,
7085 (unsigned) transform->minlen,
7086 (unsigned) transform->ivlen,
7087 (unsigned) transform->maclen ) );
7088
7089 /*
7090 * Finally setup the cipher contexts, IVs and MAC secrets.
7091 */
7092#if defined(MBEDTLS_SSL_CLI_C)
7093 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7094 {
7095 key1 = keyblk + mac_key_len * 2;
7096 key2 = keyblk + mac_key_len * 2 + keylen;
7097
7098 mac_enc = keyblk;
7099 mac_dec = keyblk + mac_key_len;
7100
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007101 iv_copy_len = ( transform->fixed_ivlen ) ?
7102 transform->fixed_ivlen : transform->ivlen;
7103 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7104 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7105 iv_copy_len );
7106 }
7107 else
7108#endif /* MBEDTLS_SSL_CLI_C */
7109#if defined(MBEDTLS_SSL_SRV_C)
7110 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7111 {
7112 key1 = keyblk + mac_key_len * 2 + keylen;
7113 key2 = keyblk + mac_key_len * 2;
7114
7115 mac_enc = keyblk + mac_key_len;
7116 mac_dec = keyblk;
7117
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007118 iv_copy_len = ( transform->fixed_ivlen ) ?
7119 transform->fixed_ivlen : transform->ivlen;
7120 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7121 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7122 iv_copy_len );
7123 }
7124 else
7125#endif /* MBEDTLS_SSL_SRV_C */
7126 {
7127 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7128 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7129 goto end;
7130 }
7131
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007132 if( ssl != NULL && ssl->f_export_keys != NULL )
7133 {
7134 ssl->f_export_keys( ssl->p_export_keys,
7135 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7136 master, 48,
7137 randbytes + 32,
7138 randbytes,
7139 tls_prf_get_type( tls_prf ) );
7140 }
7141
7142#if defined(MBEDTLS_USE_PSA_CRYPTO)
7143 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7144 transform->taglen,
7145 &alg,
7146 &key_type,
7147 &key_bits ) ) != PSA_SUCCESS )
7148 {
7149 ret = psa_ssl_status_to_mbedtls( status );
7150 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7151 goto end;
7152 }
7153
7154 transform->psa_alg = alg;
7155
7156 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7157 {
7158 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7159 psa_set_key_algorithm( &attributes, alg );
7160 psa_set_key_type( &attributes, key_type );
7161
7162 if( ( status = psa_import_key( &attributes,
7163 key1,
7164 PSA_BITS_TO_BYTES( key_bits ),
7165 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7166 {
7167 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7168 ret = psa_ssl_status_to_mbedtls( status );
7169 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7170 goto end;
7171 }
7172
7173 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7174
7175 if( ( status = psa_import_key( &attributes,
7176 key2,
7177 PSA_BITS_TO_BYTES( key_bits ),
7178 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7179 {
7180 ret = psa_ssl_status_to_mbedtls( status );
7181 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7182 goto end;
7183 }
7184 }
7185#else
7186 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7187 cipher_info ) ) != 0 )
7188 {
7189 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7190 goto end;
7191 }
7192
7193 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7194 cipher_info ) ) != 0 )
7195 {
7196 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7197 goto end;
7198 }
7199
7200 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7201 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7202 MBEDTLS_ENCRYPT ) ) != 0 )
7203 {
7204 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7205 goto end;
7206 }
7207
7208 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7209 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7210 MBEDTLS_DECRYPT ) ) != 0 )
7211 {
7212 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7213 goto end;
7214 }
7215
7216#if defined(MBEDTLS_CIPHER_MODE_CBC)
7217 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7218 {
7219 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7220 MBEDTLS_PADDING_NONE ) ) != 0 )
7221 {
7222 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7223 goto end;
7224 }
7225
7226 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7227 MBEDTLS_PADDING_NONE ) ) != 0 )
7228 {
7229 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7230 goto end;
7231 }
7232 }
7233#endif /* MBEDTLS_CIPHER_MODE_CBC */
7234#endif /* MBEDTLS_USE_PSA_CRYPTO */
7235
Neil Armstrong29c0c042022-03-17 17:47:28 +01007236#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7237 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7238 For AEAD-based ciphersuites, there is nothing to do here. */
7239 if( mac_key_len != 0 )
7240 {
7241#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007242 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007243
7244 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007245 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007246 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7247
7248 if( ( status = psa_import_key( &attributes,
7249 mac_enc, mac_key_len,
7250 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7251 {
7252 ret = psa_ssl_status_to_mbedtls( status );
7253 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7254 goto end;
7255 }
7256
Ronald Cronfb39f152022-03-25 14:36:28 +01007257 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7258 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7259 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007260 /* mbedtls_ct_hmac() requires the key to be exportable */
7261 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7262 PSA_KEY_USAGE_VERIFY_HASH );
7263 else
7264 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7265
7266 if( ( status = psa_import_key( &attributes,
7267 mac_dec, mac_key_len,
7268 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7269 {
7270 ret = psa_ssl_status_to_mbedtls( status );
7271 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7272 goto end;
7273 }
7274#else
7275 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7276 if( ret != 0 )
7277 goto end;
7278 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7279 if( ret != 0 )
7280 goto end;
7281#endif /* MBEDTLS_USE_PSA_CRYPTO */
7282 }
7283#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7284
7285 ((void) mac_dec);
7286 ((void) mac_enc);
7287
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007288end:
7289 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7290 return( ret );
7291}
7292
Jerry Yuee40f9d2022-02-17 14:55:16 +08007293#if defined(MBEDTLS_USE_PSA_CRYPTO)
7294int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7295 unsigned char *hash, size_t *hashlen,
7296 unsigned char *data, size_t data_len,
7297 mbedtls_md_type_t md_alg )
7298{
7299 psa_status_t status;
7300 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7301 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7302
7303 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7304
7305 if( ( status = psa_hash_setup( &hash_operation,
7306 hash_alg ) ) != PSA_SUCCESS )
7307 {
7308 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7309 goto exit;
7310 }
7311
7312 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7313 64 ) ) != PSA_SUCCESS )
7314 {
7315 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7316 goto exit;
7317 }
7318
7319 if( ( status = psa_hash_update( &hash_operation,
7320 data, data_len ) ) != PSA_SUCCESS )
7321 {
7322 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7323 goto exit;
7324 }
7325
7326 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7327 hashlen ) ) != PSA_SUCCESS )
7328 {
7329 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7330 goto exit;
7331 }
7332
7333exit:
7334 if( status != PSA_SUCCESS )
7335 {
7336 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7337 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7338 switch( status )
7339 {
7340 case PSA_ERROR_NOT_SUPPORTED:
7341 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7342 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7343 case PSA_ERROR_BUFFER_TOO_SMALL:
7344 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7345 case PSA_ERROR_INSUFFICIENT_MEMORY:
7346 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7347 default:
7348 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7349 }
7350 }
7351 return( 0 );
7352}
7353
7354#else
7355
7356int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7357 unsigned char *hash, size_t *hashlen,
7358 unsigned char *data, size_t data_len,
7359 mbedtls_md_type_t md_alg )
7360{
7361 int ret = 0;
7362 mbedtls_md_context_t ctx;
7363 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7364 *hashlen = mbedtls_md_get_size( md_info );
7365
7366 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7367
7368 mbedtls_md_init( &ctx );
7369
7370 /*
7371 * digitally-signed struct {
7372 * opaque client_random[32];
7373 * opaque server_random[32];
7374 * ServerDHParams params;
7375 * };
7376 */
7377 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7378 {
7379 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7380 goto exit;
7381 }
7382 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7383 {
7384 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7385 goto exit;
7386 }
7387 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7388 {
7389 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7390 goto exit;
7391 }
7392 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7393 {
7394 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7395 goto exit;
7396 }
7397 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7398 {
7399 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7400 goto exit;
7401 }
7402
7403exit:
7404 mbedtls_md_free( &ctx );
7405
7406 if( ret != 0 )
7407 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7408 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7409
7410 return( ret );
7411}
7412#endif /* MBEDTLS_USE_PSA_CRYPTO */
7413
Jerry Yud9d91da2022-02-17 14:57:06 +08007414#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7415
7416/* Find an entry in a signature-hash set matching a given hash algorithm. */
7417mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7418 mbedtls_pk_type_t sig_alg )
7419{
7420 switch( sig_alg )
7421 {
7422 case MBEDTLS_PK_RSA:
7423 return( set->rsa );
7424 case MBEDTLS_PK_ECDSA:
7425 return( set->ecdsa );
7426 default:
7427 return( MBEDTLS_MD_NONE );
7428 }
7429}
7430
7431/* Add a signature-hash-pair to a signature-hash set */
7432void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7433 mbedtls_pk_type_t sig_alg,
7434 mbedtls_md_type_t md_alg )
7435{
7436 switch( sig_alg )
7437 {
7438 case MBEDTLS_PK_RSA:
7439 if( set->rsa == MBEDTLS_MD_NONE )
7440 set->rsa = md_alg;
7441 break;
7442
7443 case MBEDTLS_PK_ECDSA:
7444 if( set->ecdsa == MBEDTLS_MD_NONE )
7445 set->ecdsa = md_alg;
7446 break;
7447
7448 default:
7449 break;
7450 }
7451}
7452
7453/* Allow exactly one hash algorithm for each signature. */
7454void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7455 mbedtls_md_type_t md_alg )
7456{
7457 set->rsa = md_alg;
7458 set->ecdsa = md_alg;
7459}
7460
7461#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7462
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007463/* Serialization of TLS 1.2 sessions:
7464 *
7465 * struct {
7466 * uint64 start_time;
7467 * uint8 ciphersuite[2]; // defined by the standard
7468 * uint8 compression; // 0 or 1
7469 * uint8 session_id_len; // at most 32
7470 * opaque session_id[32];
7471 * opaque master[48]; // fixed length in the standard
7472 * uint32 verify_result;
7473 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7474 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7475 * uint32 ticket_lifetime;
7476 * uint8 mfl_code; // up to 255 according to standard
7477 * uint8 encrypt_then_mac; // 0 or 1
7478 * } serialized_session_tls12;
7479 *
7480 */
7481static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7482 unsigned char *buf,
7483 size_t buf_len )
7484{
7485 unsigned char *p = buf;
7486 size_t used = 0;
7487
7488#if defined(MBEDTLS_HAVE_TIME)
7489 uint64_t start;
7490#endif
7491#if defined(MBEDTLS_X509_CRT_PARSE_C)
7492#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7493 size_t cert_len;
7494#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7495#endif /* MBEDTLS_X509_CRT_PARSE_C */
7496
7497 /*
7498 * Time
7499 */
7500#if defined(MBEDTLS_HAVE_TIME)
7501 used += 8;
7502
7503 if( used <= buf_len )
7504 {
7505 start = (uint64_t) session->start;
7506
7507 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7508 p += 8;
7509 }
7510#endif /* MBEDTLS_HAVE_TIME */
7511
7512 /*
7513 * Basic mandatory fields
7514 */
7515 used += 2 /* ciphersuite */
7516 + 1 /* compression */
7517 + 1 /* id_len */
7518 + sizeof( session->id )
7519 + sizeof( session->master )
7520 + 4; /* verify_result */
7521
7522 if( used <= buf_len )
7523 {
7524 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7525 p += 2;
7526
7527 *p++ = MBEDTLS_BYTE_0( session->compression );
7528
7529 *p++ = MBEDTLS_BYTE_0( session->id_len );
7530 memcpy( p, session->id, 32 );
7531 p += 32;
7532
7533 memcpy( p, session->master, 48 );
7534 p += 48;
7535
7536 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7537 p += 4;
7538 }
7539
7540 /*
7541 * Peer's end-entity certificate
7542 */
7543#if defined(MBEDTLS_X509_CRT_PARSE_C)
7544#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7545 if( session->peer_cert == NULL )
7546 cert_len = 0;
7547 else
7548 cert_len = session->peer_cert->raw.len;
7549
7550 used += 3 + cert_len;
7551
7552 if( used <= buf_len )
7553 {
7554 *p++ = MBEDTLS_BYTE_2( cert_len );
7555 *p++ = MBEDTLS_BYTE_1( cert_len );
7556 *p++ = MBEDTLS_BYTE_0( cert_len );
7557
7558 if( session->peer_cert != NULL )
7559 {
7560 memcpy( p, session->peer_cert->raw.p, cert_len );
7561 p += cert_len;
7562 }
7563 }
7564#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7565 if( session->peer_cert_digest != NULL )
7566 {
7567 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7568 if( used <= buf_len )
7569 {
7570 *p++ = (unsigned char) session->peer_cert_digest_type;
7571 *p++ = (unsigned char) session->peer_cert_digest_len;
7572 memcpy( p, session->peer_cert_digest,
7573 session->peer_cert_digest_len );
7574 p += session->peer_cert_digest_len;
7575 }
7576 }
7577 else
7578 {
7579 used += 2;
7580 if( used <= buf_len )
7581 {
7582 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7583 *p++ = 0;
7584 }
7585 }
7586#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7587#endif /* MBEDTLS_X509_CRT_PARSE_C */
7588
7589 /*
7590 * Session ticket if any, plus associated data
7591 */
7592#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7593 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7594
7595 if( used <= buf_len )
7596 {
7597 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7598 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7599 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7600
7601 if( session->ticket != NULL )
7602 {
7603 memcpy( p, session->ticket, session->ticket_len );
7604 p += session->ticket_len;
7605 }
7606
7607 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7608 p += 4;
7609 }
7610#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7611
7612 /*
7613 * Misc extension-related info
7614 */
7615#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7616 used += 1;
7617
7618 if( used <= buf_len )
7619 *p++ = session->mfl_code;
7620#endif
7621
7622#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7623 used += 1;
7624
7625 if( used <= buf_len )
7626 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7627#endif
7628
7629 return( used );
7630}
7631
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007632static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7633 const unsigned char *buf,
7634 size_t len )
7635{
7636#if defined(MBEDTLS_HAVE_TIME)
7637 uint64_t start;
7638#endif
7639#if defined(MBEDTLS_X509_CRT_PARSE_C)
7640#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7641 size_t cert_len;
7642#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7643#endif /* MBEDTLS_X509_CRT_PARSE_C */
7644
7645 const unsigned char *p = buf;
7646 const unsigned char * const end = buf + len;
7647
7648 /*
7649 * Time
7650 */
7651#if defined(MBEDTLS_HAVE_TIME)
7652 if( 8 > (size_t)( end - p ) )
7653 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7654
7655 start = ( (uint64_t) p[0] << 56 ) |
7656 ( (uint64_t) p[1] << 48 ) |
7657 ( (uint64_t) p[2] << 40 ) |
7658 ( (uint64_t) p[3] << 32 ) |
7659 ( (uint64_t) p[4] << 24 ) |
7660 ( (uint64_t) p[5] << 16 ) |
7661 ( (uint64_t) p[6] << 8 ) |
7662 ( (uint64_t) p[7] );
7663 p += 8;
7664
7665 session->start = (time_t) start;
7666#endif /* MBEDTLS_HAVE_TIME */
7667
7668 /*
7669 * Basic mandatory fields
7670 */
7671 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7672 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7673
7674 session->ciphersuite = ( p[0] << 8 ) | p[1];
7675 p += 2;
7676
7677 session->compression = *p++;
7678
7679 session->id_len = *p++;
7680 memcpy( session->id, p, 32 );
7681 p += 32;
7682
7683 memcpy( session->master, p, 48 );
7684 p += 48;
7685
7686 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7687 ( (uint32_t) p[1] << 16 ) |
7688 ( (uint32_t) p[2] << 8 ) |
7689 ( (uint32_t) p[3] );
7690 p += 4;
7691
7692 /* Immediately clear invalid pointer values that have been read, in case
7693 * we exit early before we replaced them with valid ones. */
7694#if defined(MBEDTLS_X509_CRT_PARSE_C)
7695#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7696 session->peer_cert = NULL;
7697#else
7698 session->peer_cert_digest = NULL;
7699#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7700#endif /* MBEDTLS_X509_CRT_PARSE_C */
7701#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7702 session->ticket = NULL;
7703#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7704
7705 /*
7706 * Peer certificate
7707 */
7708#if defined(MBEDTLS_X509_CRT_PARSE_C)
7709#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7710 /* Deserialize CRT from the end of the ticket. */
7711 if( 3 > (size_t)( end - p ) )
7712 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7713
7714 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7715 p += 3;
7716
7717 if( cert_len != 0 )
7718 {
7719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7720
7721 if( cert_len > (size_t)( end - p ) )
7722 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7723
7724 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7725
7726 if( session->peer_cert == NULL )
7727 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7728
7729 mbedtls_x509_crt_init( session->peer_cert );
7730
7731 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7732 p, cert_len ) ) != 0 )
7733 {
7734 mbedtls_x509_crt_free( session->peer_cert );
7735 mbedtls_free( session->peer_cert );
7736 session->peer_cert = NULL;
7737 return( ret );
7738 }
7739
7740 p += cert_len;
7741 }
7742#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7743 /* Deserialize CRT digest from the end of the ticket. */
7744 if( 2 > (size_t)( end - p ) )
7745 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7746
7747 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7748 session->peer_cert_digest_len = (size_t) *p++;
7749
7750 if( session->peer_cert_digest_len != 0 )
7751 {
7752 const mbedtls_md_info_t *md_info =
7753 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7754 if( md_info == NULL )
7755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7756 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7758
7759 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7760 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7761
7762 session->peer_cert_digest =
7763 mbedtls_calloc( 1, session->peer_cert_digest_len );
7764 if( session->peer_cert_digest == NULL )
7765 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7766
7767 memcpy( session->peer_cert_digest, p,
7768 session->peer_cert_digest_len );
7769 p += session->peer_cert_digest_len;
7770 }
7771#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7772#endif /* MBEDTLS_X509_CRT_PARSE_C */
7773
7774 /*
7775 * Session ticket and associated data
7776 */
7777#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7778 if( 3 > (size_t)( end - p ) )
7779 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7780
7781 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7782 p += 3;
7783
7784 if( session->ticket_len != 0 )
7785 {
7786 if( session->ticket_len > (size_t)( end - p ) )
7787 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7788
7789 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7790 if( session->ticket == NULL )
7791 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7792
7793 memcpy( session->ticket, p, session->ticket_len );
7794 p += session->ticket_len;
7795 }
7796
7797 if( 4 > (size_t)( end - p ) )
7798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7799
7800 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7801 ( (uint32_t) p[1] << 16 ) |
7802 ( (uint32_t) p[2] << 8 ) |
7803 ( (uint32_t) p[3] );
7804 p += 4;
7805#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7806
7807 /*
7808 * Misc extension-related info
7809 */
7810#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7811 if( 1 > (size_t)( end - p ) )
7812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7813
7814 session->mfl_code = *p++;
7815#endif
7816
7817#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7818 if( 1 > (size_t)( end - p ) )
7819 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7820
7821 session->encrypt_then_mac = *p++;
7822#endif
7823
7824 /* Done, should have consumed entire buffer */
7825 if( p != end )
7826 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7827
7828 return( 0 );
7829}
Jerry Yudc7bd172022-02-17 13:44:15 +08007830#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7831
XiaokangQian75d40ef2022-04-20 11:05:24 +00007832int mbedtls_ssl_validate_ciphersuite(
7833 const mbedtls_ssl_context *ssl,
7834 const mbedtls_ssl_ciphersuite_t *suite_info,
7835 mbedtls_ssl_protocol_version min_tls_version,
7836 mbedtls_ssl_protocol_version max_tls_version )
7837{
7838 (void) ssl;
7839
7840 if( suite_info == NULL )
7841 return( -1 );
7842
7843 if( ( suite_info->min_tls_version > max_tls_version ) ||
7844 ( suite_info->max_tls_version < min_tls_version ) )
7845 {
7846 return( -1 );
7847 }
7848
XiaokangQian060d8672022-04-21 09:24:56 +00007849#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00007850#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7851 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
7852 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
7853 {
7854 return( -1 );
7855 }
7856#endif
7857
7858 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
7859#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
7860 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
7861 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
7862 {
7863 return( -1 );
7864 }
7865#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
7866#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7867
7868 return( 0 );
7869}
7870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007871#endif /* MBEDTLS_SSL_TLS_C */