blob: 277904ddd04684031b75b57faadac44cbdc49c51 [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 {
915 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jerry Yu60835a82021-08-04 10:13:52 +0800916 {
Ronald Cron086ee0b2022-03-15 15:18:51 +0100917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
Jerry Yu60835a82021-08-04 10:13:52 +0800918 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
919 }
Ronald Cron37bdaab2022-03-30 16:45:51 +0200920
921 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
922 {
923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
924 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
925 }
926
Jerry Yu60835a82021-08-04 10:13:52 +0800927 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
928 return( 0 );
929 }
930#endif
931
932#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100933 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800934 {
935 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
936 return( 0 );
937 }
938#endif
939
Ronald Cron6f135e12021-12-08 16:57:54 +0100940#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100941 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800942 {
Ronald Crone1d3f062022-02-10 14:50:54 +0100943 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
946 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
947 }
Ronald Cron37bdaab2022-03-30 16:45:51 +0200948
949 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
950 {
951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
952 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
953 }
954
Ronald Crone1d3f062022-02-10 14:50:54 +0100955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
956 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800957 }
958#endif
959
960 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
961 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
962}
963
964static int ssl_conf_check(const mbedtls_ssl_context *ssl)
965{
966 int ret;
967 ret = ssl_conf_version_check( ssl );
968 if( ret != 0 )
969 return( ret );
970
971 /* Space for further checks */
972
973 return( 0 );
974}
975
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200976/*
977 * Setup an SSL context
978 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100979
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200980int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200981 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000982{
Janos Follath865b3eb2019-12-16 11:46:15 +0000983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000984 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
985 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000986
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200987 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000988
Jerry Yu60835a82021-08-04 10:13:52 +0800989 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
990 return( ret );
991
Paul Bakker62f2dee2012-09-28 07:31:51 +0000992 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100993 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000994 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200995
996 /* Set to NULL in case of an error condition */
997 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200998
Darryl Greenb33cc762019-11-28 14:29:44 +0000999#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1000 ssl->in_buf_len = in_buf_len;
1001#endif
1002 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001003 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001006 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001007 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001008 }
1009
Darryl Greenb33cc762019-11-28 14:29:44 +00001010#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1011 ssl->out_buf_len = out_buf_len;
1012#endif
1013 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001014 if( ssl->out_buf == NULL )
1015 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001017 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001018 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001019 }
1020
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001021 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001022
Johan Pascalb62bb512015-12-03 21:56:45 +01001023#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001024 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001025#endif
1026
Paul Bakker48916f92012-09-16 19:57:18 +00001027 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001028 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001029
1030 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001031
1032error:
1033 mbedtls_free( ssl->in_buf );
1034 mbedtls_free( ssl->out_buf );
1035
1036 ssl->conf = NULL;
1037
Darryl Greenb33cc762019-11-28 14:29:44 +00001038#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1039 ssl->in_buf_len = 0;
1040 ssl->out_buf_len = 0;
1041#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001042 ssl->in_buf = NULL;
1043 ssl->out_buf = NULL;
1044
1045 ssl->in_hdr = NULL;
1046 ssl->in_ctr = NULL;
1047 ssl->in_len = NULL;
1048 ssl->in_iv = NULL;
1049 ssl->in_msg = NULL;
1050
1051 ssl->out_hdr = NULL;
1052 ssl->out_ctr = NULL;
1053 ssl->out_len = NULL;
1054 ssl->out_iv = NULL;
1055 ssl->out_msg = NULL;
1056
k-stachowiak9f7798e2018-07-31 16:52:32 +02001057 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001058}
1059
1060/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001061 * Reset an initialized and used SSL context for re-use while retaining
1062 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001063 *
1064 * If partial is non-zero, keep data in the input buffer and client ID.
1065 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001066 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001067void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1068 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001069{
Darryl Greenb33cc762019-11-28 14:29:44 +00001070#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1071 size_t in_buf_len = ssl->in_buf_len;
1072 size_t out_buf_len = ssl->out_buf_len;
1073#else
1074 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1075 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Hanno Beckerb0302c42021-08-03 09:39:42 +01001078#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1079 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001080#endif
1081
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001082 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001083 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001084
Hanno Beckerb0302c42021-08-03 09:39:42 +01001085 mbedtls_ssl_reset_in_out_pointers( ssl );
1086
1087 /* Reset incoming message parsing */
1088 ssl->in_offt = NULL;
1089 ssl->nb_zero = 0;
1090 ssl->in_msgtype = 0;
1091 ssl->in_msglen = 0;
1092 ssl->in_hslen = 0;
1093 ssl->keep_current_message = 0;
1094 ssl->transform_in = NULL;
1095
1096#if defined(MBEDTLS_SSL_PROTO_DTLS)
1097 ssl->next_record_offset = 0;
1098 ssl->in_epoch = 0;
1099#endif
1100
1101 /* Keep current datagram if partial == 1 */
1102 if( partial == 0 )
1103 {
1104 ssl->in_left = 0;
1105 memset( ssl->in_buf, 0, in_buf_len );
1106 }
1107
1108 /* Reset outgoing message writing */
1109 ssl->out_msgtype = 0;
1110 ssl->out_msglen = 0;
1111 ssl->out_left = 0;
1112 memset( ssl->out_buf, 0, out_buf_len );
1113 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1114 ssl->transform_out = NULL;
1115
1116#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1117 mbedtls_ssl_dtls_replay_reset( ssl );
1118#endif
1119
XiaokangQian2b01dc32022-01-21 02:53:13 +00001120#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001121 if( ssl->transform )
1122 {
1123 mbedtls_ssl_transform_free( ssl->transform );
1124 mbedtls_free( ssl->transform );
1125 ssl->transform = NULL;
1126 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001127#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1128
XiaokangQian2b01dc32022-01-21 02:53:13 +00001129#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1130 mbedtls_ssl_transform_free( ssl->transform_application );
1131 mbedtls_free( ssl->transform_application );
1132 ssl->transform_application = NULL;
1133
1134 if( ssl->handshake != NULL )
1135 {
1136 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1137 mbedtls_free( ssl->handshake->transform_earlydata );
1138 ssl->handshake->transform_earlydata = NULL;
1139
1140 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1141 mbedtls_free( ssl->handshake->transform_handshake );
1142 ssl->handshake->transform_handshake = NULL;
1143 }
1144
XiaokangQian2b01dc32022-01-21 02:53:13 +00001145#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001146}
1147
1148int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1149{
1150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1151
1152 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1153
XiaokangQian78b1fa72022-01-19 06:56:30 +00001154 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001155
1156 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157#if defined(MBEDTLS_SSL_RENEGOTIATION)
1158 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001159 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001160
1161 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1163 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001164#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001166
Hanno Beckerb0302c42021-08-03 09:39:42 +01001167 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001168 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001169 if( ssl->session )
1170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 mbedtls_ssl_session_free( ssl->session );
1172 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001173 ssl->session = NULL;
1174 }
1175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001177 ssl->alpn_chosen = NULL;
1178#endif
1179
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001180#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001181#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001182 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001183#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001184 {
1185 mbedtls_free( ssl->cli_id );
1186 ssl->cli_id = NULL;
1187 ssl->cli_id_len = 0;
1188 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001189#endif
1190
Paul Bakker48916f92012-09-16 19:57:18 +00001191 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1192 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001193
1194 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001195}
1196
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001197/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001198 * Reset an initialized and used SSL context for re-use while retaining
1199 * all application-set variables, function pointers and data.
1200 */
1201int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1202{
Hanno Becker43aefe22020-02-05 10:44:56 +00001203 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001204}
1205
1206/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001207 * SSL set accessors
1208 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001209void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001211 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001212}
1213
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001214void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001216 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001217}
1218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001220void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001221{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001222 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001223}
1224#endif
1225
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001226void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001227{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001228 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001229}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001232
Hanno Becker1841b0a2018-08-24 11:13:57 +01001233void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1234 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001235{
1236 ssl->disable_datagram_packing = !allow_packing;
1237}
1238
1239void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1240 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->hs_timeout_min = min;
1243 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001244}
1245#endif
1246
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001247void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001248{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001249 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001250}
1251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001253void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001254 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001255 void *p_vrfy )
1256{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001257 conf->f_vrfy = f_vrfy;
1258 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001259}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001261
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001262void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001263 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001264 void *p_rng )
1265{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001266 conf->f_rng = f_rng;
1267 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001268}
1269
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001270void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001271 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001272 void *p_dbg )
1273{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001274 conf->f_dbg = f_dbg;
1275 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001276}
1277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001279 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001280 mbedtls_ssl_send_t *f_send,
1281 mbedtls_ssl_recv_t *f_recv,
1282 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001283{
1284 ssl->p_bio = p_bio;
1285 ssl->f_send = f_send;
1286 ssl->f_recv = f_recv;
1287 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001288}
1289
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001290#if defined(MBEDTLS_SSL_PROTO_DTLS)
1291void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1292{
1293 ssl->mtu = mtu;
1294}
1295#endif
1296
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001297void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001298{
1299 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001300}
1301
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001302void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1303 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_set_timer_t *f_set_timer,
1305 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001306{
1307 ssl->p_timer = p_timer;
1308 ssl->f_set_timer = f_set_timer;
1309 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001310
1311 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001312 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001313}
1314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss2ed95272022-01-21 18:02:17 -05001316void mbedtls_ssl_conf_cert_cb( mbedtls_ssl_config *conf,
1317 int (*f_cert_cb)(mbedtls_ssl_context *) )
1318{
1319 conf->f_cert_cb = f_cert_cb;
1320}
1321#endif /* MBEDTLS_SSL_SRV_C */
1322
1323#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001324void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001325 void *p_cache,
1326 mbedtls_ssl_cache_get_t *f_get_cache,
1327 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001328{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001329 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001330 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001331 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001332}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#if defined(MBEDTLS_SSL_CLI_C)
1336int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001337{
Janos Follath865b3eb2019-12-16 11:46:15 +00001338 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001339
1340 if( ssl == NULL ||
1341 session == NULL ||
1342 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001343 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001346 }
1347
Hanno Beckere810bbc2021-05-14 16:01:05 +01001348 if( ssl->handshake->resume == 1 )
1349 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1350
Hanno Becker52055ae2019-02-06 14:30:46 +00001351 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1352 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001353 return( ret );
1354
Paul Bakker0a597072012-09-25 21:55:46 +00001355 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001356
1357 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001358}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001360
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001361void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1362 const int *ciphersuites )
1363{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001364 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001365}
1366
Ronald Cron6f135e12021-12-08 16:57:54 +01001367#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001368void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001369 const int kex_modes )
1370{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001371 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001372}
Ronald Cron6f135e12021-12-08 16:57:54 +01001373#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001376void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001377 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001378{
1379 conf->cert_profile = profile;
1380}
1381
Glenn Strauss36872db2022-01-22 05:06:31 -05001382static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1383{
1384 mbedtls_ssl_key_cert *cur = key_cert, *next;
1385
1386 while( cur != NULL )
1387 {
1388 next = cur->next;
1389 mbedtls_free( cur );
1390 cur = next;
1391 }
1392}
1393
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001394/* Append a new keycert entry to a (possibly empty) list */
1395static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1396 mbedtls_x509_crt *cert,
1397 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001398{
niisato8ee24222018-06-25 19:05:48 +09001399 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001400
Glenn Strauss36872db2022-01-22 05:06:31 -05001401 if( cert == NULL )
1402 {
1403 /* Free list if cert is null */
1404 ssl_key_cert_free( *head );
1405 *head = NULL;
1406 return( 0 );
1407 }
1408
niisato8ee24222018-06-25 19:05:48 +09001409 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1410 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001411 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001412
niisato8ee24222018-06-25 19:05:48 +09001413 new_cert->cert = cert;
1414 new_cert->key = key;
1415 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001416
Glenn Strauss36872db2022-01-22 05:06:31 -05001417 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001418 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001419 {
niisato8ee24222018-06-25 19:05:48 +09001420 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001421 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001422 else
1423 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001424 mbedtls_ssl_key_cert *cur = *head;
1425 while( cur->next != NULL )
1426 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001427 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001428 }
1429
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001430 return( 0 );
1431}
1432
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001433int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001434 mbedtls_x509_crt *own_cert,
1435 mbedtls_pk_context *pk_key )
1436{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001437 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001438}
1439
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001440void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001441 mbedtls_x509_crt *ca_chain,
1442 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001443{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001444 conf->ca_chain = ca_chain;
1445 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001446
1447#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1448 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1449 * cannot be used together. */
1450 conf->f_ca_cb = NULL;
1451 conf->p_ca_cb = NULL;
1452#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001453}
Hanno Becker5adaad92019-03-27 16:54:37 +00001454
1455#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1456void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001457 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001458 void *p_ca_cb )
1459{
1460 conf->f_ca_cb = f_ca_cb;
1461 conf->p_ca_cb = p_ca_cb;
1462
1463 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1464 * cannot be used together. */
1465 conf->ca_chain = NULL;
1466 conf->ca_crl = NULL;
1467}
1468#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001470
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001471#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001472const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1473 size_t *name_len )
1474{
1475 *name_len = ssl->handshake->sni_name_len;
1476 return( ssl->handshake->sni_name );
1477}
1478
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001479int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1480 mbedtls_x509_crt *own_cert,
1481 mbedtls_pk_context *pk_key )
1482{
1483 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1484 own_cert, pk_key ) );
1485}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001486
1487void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1488 mbedtls_x509_crt *ca_chain,
1489 mbedtls_x509_crl *ca_crl )
1490{
1491 ssl->handshake->sni_ca_chain = ca_chain;
1492 ssl->handshake->sni_ca_crl = ca_crl;
1493}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001494
1495void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1496 int authmode )
1497{
1498 ssl->handshake->sni_authmode = authmode;
1499}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001500#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1501
Hanno Becker8927c832019-04-03 12:52:50 +01001502#if defined(MBEDTLS_X509_CRT_PARSE_C)
1503void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1504 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1505 void *p_vrfy )
1506{
1507 ssl->f_vrfy = f_vrfy;
1508 ssl->p_vrfy = p_vrfy;
1509}
1510#endif
1511
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001512#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001513/*
1514 * Set EC J-PAKE password for current handshake
1515 */
1516int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1517 const unsigned char *pw,
1518 size_t pw_len )
1519{
1520 mbedtls_ecjpake_role role;
1521
Janos Follath8eb64132016-06-03 15:40:57 +01001522 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001523 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1524
1525 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1526 role = MBEDTLS_ECJPAKE_SERVER;
1527 else
1528 role = MBEDTLS_ECJPAKE_CLIENT;
1529
1530 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1531 role,
1532 MBEDTLS_MD_SHA256,
1533 MBEDTLS_ECP_DP_SECP256R1,
1534 pw, pw_len ) );
1535}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001536#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001537
Gilles Peskineeccd8882020-03-10 12:19:08 +01001538#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001539
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001540static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1541{
1542#if defined(MBEDTLS_USE_PSA_CRYPTO)
1543 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1544 return( 1 );
1545#endif /* MBEDTLS_USE_PSA_CRYPTO */
1546
1547 if( conf->psk != NULL )
1548 return( 1 );
1549
1550 return( 0 );
1551}
1552
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001553static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1554{
1555 /* Remove reference to existing PSK, if any. */
1556#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001557 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001558 {
1559 /* The maintenance of the PSK key slot is the
1560 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001561 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001562 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001563 /* This and the following branch should never
1564 * be taken simultaenously as we maintain the
1565 * invariant that raw and opaque PSKs are never
1566 * configured simultaneously. As a safeguard,
1567 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001568#endif /* MBEDTLS_USE_PSA_CRYPTO */
1569 if( conf->psk != NULL )
1570 {
1571 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1572
1573 mbedtls_free( conf->psk );
1574 conf->psk = NULL;
1575 conf->psk_len = 0;
1576 }
1577
1578 /* Remove reference to PSK identity, if any. */
1579 if( conf->psk_identity != NULL )
1580 {
1581 mbedtls_free( conf->psk_identity );
1582 conf->psk_identity = NULL;
1583 conf->psk_identity_len = 0;
1584 }
1585}
1586
Hanno Becker7390c712018-11-15 13:33:04 +00001587/* This function assumes that PSK identity in the SSL config is unset.
1588 * It checks that the provided identity is well-formed and attempts
1589 * to make a copy of it in the SSL config.
1590 * On failure, the PSK identity in the config remains unset. */
1591static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1592 unsigned char const *psk_identity,
1593 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001594{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001595 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001596 if( psk_identity == NULL ||
1597 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001598 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001599 {
1600 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1601 }
1602
Hanno Becker7390c712018-11-15 13:33:04 +00001603 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1604 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001605 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001606
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001607 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001608 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001609
1610 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001611}
1612
Hanno Becker7390c712018-11-15 13:33:04 +00001613int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1614 const unsigned char *psk, size_t psk_len,
1615 const unsigned char *psk_identity, size_t psk_identity_len )
1616{
Janos Follath865b3eb2019-12-16 11:46:15 +00001617 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001618
1619 /* We currently only support one PSK, raw or opaque. */
1620 if( ssl_conf_psk_is_configured( conf ) )
1621 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001622
1623 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001624 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001625 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001626 if( psk_len == 0 )
1627 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1628 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1630
Hanno Becker7390c712018-11-15 13:33:04 +00001631 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1632 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1633 conf->psk_len = psk_len;
1634 memcpy( conf->psk, psk, conf->psk_len );
1635
1636 /* Check and set PSK Identity */
1637 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1638 if( ret != 0 )
1639 ssl_conf_remove_psk( conf );
1640
1641 return( ret );
1642}
1643
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001644static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1645{
1646#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001647 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001648 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001649 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001650 }
1651 else
1652#endif /* MBEDTLS_USE_PSA_CRYPTO */
1653 if( ssl->handshake->psk != NULL )
1654 {
1655 mbedtls_platform_zeroize( ssl->handshake->psk,
1656 ssl->handshake->psk_len );
1657 mbedtls_free( ssl->handshake->psk );
1658 ssl->handshake->psk_len = 0;
1659 }
1660}
1661
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001662int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1663 const unsigned char *psk, size_t psk_len )
1664{
1665 if( psk == NULL || ssl->handshake == NULL )
1666 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1667
1668 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1669 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1670
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001671 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001672
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001673 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001674 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001675
1676 ssl->handshake->psk_len = psk_len;
1677 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1678
1679 return( 0 );
1680}
1681
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001682#if defined(MBEDTLS_USE_PSA_CRYPTO)
1683int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001684 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001685 const unsigned char *psk_identity,
1686 size_t psk_identity_len )
1687{
Janos Follath865b3eb2019-12-16 11:46:15 +00001688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001689
1690 /* We currently only support one PSK, raw or opaque. */
1691 if( ssl_conf_psk_is_configured( conf ) )
1692 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001693
Hanno Becker7390c712018-11-15 13:33:04 +00001694 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001695 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001697 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001698
1699 /* Check and set PSK Identity */
1700 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1701 psk_identity_len );
1702 if( ret != 0 )
1703 ssl_conf_remove_psk( conf );
1704
1705 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706}
1707
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001708int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1709 mbedtls_svc_key_id_t psk )
1710{
1711 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1712 ( ssl->handshake == NULL ) )
1713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1714
1715 ssl_remove_psk( ssl );
1716 ssl->handshake->psk_opaque = psk;
1717 return( 0 );
1718}
1719#endif /* MBEDTLS_USE_PSA_CRYPTO */
1720
1721void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1722 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1723 size_t),
1724 void *p_psk )
1725{
1726 conf->f_psk = f_psk;
1727 conf->p_psk = p_psk;
1728}
1729#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1730
1731#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001732psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001733 size_t taglen,
1734 psa_algorithm_t *alg,
1735 psa_key_type_t *key_type,
1736 size_t *key_size )
1737{
1738 switch ( mbedtls_cipher_type )
1739 {
1740 case MBEDTLS_CIPHER_AES_128_CBC:
1741 *alg = PSA_ALG_CBC_NO_PADDING;
1742 *key_type = PSA_KEY_TYPE_AES;
1743 *key_size = 128;
1744 break;
1745 case MBEDTLS_CIPHER_AES_128_CCM:
1746 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1747 *key_type = PSA_KEY_TYPE_AES;
1748 *key_size = 128;
1749 break;
1750 case MBEDTLS_CIPHER_AES_128_GCM:
1751 *alg = PSA_ALG_GCM;
1752 *key_type = PSA_KEY_TYPE_AES;
1753 *key_size = 128;
1754 break;
1755 case MBEDTLS_CIPHER_AES_192_CCM:
1756 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1757 *key_type = PSA_KEY_TYPE_AES;
1758 *key_size = 192;
1759 break;
1760 case MBEDTLS_CIPHER_AES_192_GCM:
1761 *alg = PSA_ALG_GCM;
1762 *key_type = PSA_KEY_TYPE_AES;
1763 *key_size = 192;
1764 break;
1765 case MBEDTLS_CIPHER_AES_256_CBC:
1766 *alg = PSA_ALG_CBC_NO_PADDING;
1767 *key_type = PSA_KEY_TYPE_AES;
1768 *key_size = 256;
1769 break;
1770 case MBEDTLS_CIPHER_AES_256_CCM:
1771 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1772 *key_type = PSA_KEY_TYPE_AES;
1773 *key_size = 256;
1774 break;
1775 case MBEDTLS_CIPHER_AES_256_GCM:
1776 *alg = PSA_ALG_GCM;
1777 *key_type = PSA_KEY_TYPE_AES;
1778 *key_size = 256;
1779 break;
1780 case MBEDTLS_CIPHER_ARIA_128_CBC:
1781 *alg = PSA_ALG_CBC_NO_PADDING;
1782 *key_type = PSA_KEY_TYPE_ARIA;
1783 *key_size = 128;
1784 break;
1785 case MBEDTLS_CIPHER_ARIA_128_CCM:
1786 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1787 *key_type = PSA_KEY_TYPE_ARIA;
1788 *key_size = 128;
1789 break;
1790 case MBEDTLS_CIPHER_ARIA_128_GCM:
1791 *alg = PSA_ALG_GCM;
1792 *key_type = PSA_KEY_TYPE_ARIA;
1793 *key_size = 128;
1794 break;
1795 case MBEDTLS_CIPHER_ARIA_192_CCM:
1796 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1797 *key_type = PSA_KEY_TYPE_ARIA;
1798 *key_size = 192;
1799 break;
1800 case MBEDTLS_CIPHER_ARIA_192_GCM:
1801 *alg = PSA_ALG_GCM;
1802 *key_type = PSA_KEY_TYPE_ARIA;
1803 *key_size = 192;
1804 break;
1805 case MBEDTLS_CIPHER_ARIA_256_CBC:
1806 *alg = PSA_ALG_CBC_NO_PADDING;
1807 *key_type = PSA_KEY_TYPE_ARIA;
1808 *key_size = 256;
1809 break;
1810 case MBEDTLS_CIPHER_ARIA_256_CCM:
1811 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1812 *key_type = PSA_KEY_TYPE_ARIA;
1813 *key_size = 256;
1814 break;
1815 case MBEDTLS_CIPHER_ARIA_256_GCM:
1816 *alg = PSA_ALG_GCM;
1817 *key_type = PSA_KEY_TYPE_ARIA;
1818 *key_size = 256;
1819 break;
1820 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1821 *alg = PSA_ALG_CBC_NO_PADDING;
1822 *key_type = PSA_KEY_TYPE_CAMELLIA;
1823 *key_size = 128;
1824 break;
1825 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1826 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1827 *key_type = PSA_KEY_TYPE_CAMELLIA;
1828 *key_size = 128;
1829 break;
1830 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1831 *alg = PSA_ALG_GCM;
1832 *key_type = PSA_KEY_TYPE_CAMELLIA;
1833 *key_size = 128;
1834 break;
1835 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1836 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1837 *key_type = PSA_KEY_TYPE_CAMELLIA;
1838 *key_size = 192;
1839 break;
1840 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1841 *alg = PSA_ALG_GCM;
1842 *key_type = PSA_KEY_TYPE_CAMELLIA;
1843 *key_size = 192;
1844 break;
1845 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1846 *alg = PSA_ALG_CBC_NO_PADDING;
1847 *key_type = PSA_KEY_TYPE_CAMELLIA;
1848 *key_size = 256;
1849 break;
1850 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1851 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1852 *key_type = PSA_KEY_TYPE_CAMELLIA;
1853 *key_size = 256;
1854 break;
1855 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1856 *alg = PSA_ALG_GCM;
1857 *key_type = PSA_KEY_TYPE_CAMELLIA;
1858 *key_size = 256;
1859 break;
1860 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1861 *alg = PSA_ALG_CHACHA20_POLY1305;
1862 *key_type = PSA_KEY_TYPE_CHACHA20;
1863 *key_size = 256;
1864 break;
1865 case MBEDTLS_CIPHER_NULL:
1866 *alg = MBEDTLS_SSL_NULL_CIPHER;
1867 *key_type = 0;
1868 *key_size = 0;
1869 break;
1870 default:
1871 return PSA_ERROR_NOT_SUPPORTED;
1872 }
1873
1874 return PSA_SUCCESS;
1875}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001876#endif /* MBEDTLS_USE_PSA_CRYPTO */
1877
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001878#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001879int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1880 const unsigned char *dhm_P, size_t P_len,
1881 const unsigned char *dhm_G, size_t G_len )
1882{
Janos Follath865b3eb2019-12-16 11:46:15 +00001883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001884
Glenn Strausscee11292021-12-20 01:43:17 -05001885 mbedtls_mpi_free( &conf->dhm_P );
1886 mbedtls_mpi_free( &conf->dhm_G );
1887
Hanno Beckera90658f2017-10-04 15:29:08 +01001888 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1889 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1890 {
1891 mbedtls_mpi_free( &conf->dhm_P );
1892 mbedtls_mpi_free( &conf->dhm_G );
1893 return( ret );
1894 }
1895
1896 return( 0 );
1897}
Paul Bakker5121ce52009-01-03 21:22:43 +00001898
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001899int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001900{
Janos Follath865b3eb2019-12-16 11:46:15 +00001901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001902
Glenn Strausscee11292021-12-20 01:43:17 -05001903 mbedtls_mpi_free( &conf->dhm_P );
1904 mbedtls_mpi_free( &conf->dhm_G );
1905
Gilles Peskinee5702482021-06-11 21:59:08 +02001906 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1907 &conf->dhm_P ) ) != 0 ||
1908 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1909 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001910 {
1911 mbedtls_mpi_free( &conf->dhm_P );
1912 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001913 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001914 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001915
1916 return( 0 );
1917}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001918#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001919
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001920#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1921/*
1922 * Set the minimum length for Diffie-Hellman parameters
1923 */
1924void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1925 unsigned int bitlen )
1926{
1927 conf->dhm_min_bitlen = bitlen;
1928}
1929#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1930
Gilles Peskineeccd8882020-03-10 12:19:08 +01001931#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001932#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001933/*
1934 * Set allowed/preferred hashes for handshake signatures
1935 */
1936void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1937 const int *hashes )
1938{
1939 conf->sig_hashes = hashes;
1940}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001941#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001942
Jerry Yuf017ee42022-01-12 15:49:48 +08001943/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001944void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1945 const uint16_t* sig_algs )
1946{
Jerry Yuf017ee42022-01-12 15:49:48 +08001947#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1948 conf->sig_hashes = NULL;
1949#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1950 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001951}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001952#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001953
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001954#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001955#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001956/*
1957 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001958 *
1959 * mbedtls_ssl_setup() takes the provided list
1960 * and translates it to a list of IANA TLS group identifiers,
1961 * stored in ssl->handshake->group_list.
1962 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001963 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001964void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001965 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001966{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001967 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01001968 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001969}
Brett Warrene0edc842021-08-17 09:53:13 +01001970#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01001971#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001972
Brett Warrene0edc842021-08-17 09:53:13 +01001973/*
1974 * Set the allowed groups
1975 */
1976void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
1977 const uint16_t *group_list )
1978{
1979#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1980 conf->curve_list = NULL;
1981#endif
1982 conf->group_list = group_list;
1983}
1984
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001985#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00001987{
Hanno Becker947194e2017-04-07 13:25:49 +01001988 /* Initialize to suppress unnecessary compiler warning */
1989 size_t hostname_len = 0;
1990
1991 /* Check if new hostname is valid before
1992 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01001993 if( hostname != NULL )
1994 {
1995 hostname_len = strlen( hostname );
1996
1997 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
1998 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1999 }
2000
2001 /* Now it's clear that we will overwrite the old hostname,
2002 * so we can free it safely */
2003
2004 if( ssl->hostname != NULL )
2005 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002006 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002007 mbedtls_free( ssl->hostname );
2008 }
2009
2010 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002011
Paul Bakker5121ce52009-01-03 21:22:43 +00002012 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002013 {
2014 ssl->hostname = NULL;
2015 }
2016 else
2017 {
2018 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002019 if( ssl->hostname == NULL )
2020 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002021
Hanno Becker947194e2017-04-07 13:25:49 +01002022 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002023
Hanno Becker947194e2017-04-07 13:25:49 +01002024 ssl->hostname[hostname_len] = '\0';
2025 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002026
2027 return( 0 );
2028}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002029#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002030
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002031#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002032void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002034 const unsigned char *, size_t),
2035 void *p_sni )
2036{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002037 conf->f_sni = f_sni;
2038 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002039}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002043int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002044{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002045 size_t cur_len, tot_len;
2046 const char **p;
2047
2048 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002049 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2050 * MUST NOT be truncated."
2051 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002052 */
2053 tot_len = 0;
2054 for( p = protos; *p != NULL; p++ )
2055 {
2056 cur_len = strlen( *p );
2057 tot_len += cur_len;
2058
Ronald Cron8216dd32020-04-23 16:41:44 +02002059 if( ( cur_len == 0 ) ||
2060 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2061 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002063 }
2064
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002065 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002066
2067 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002068}
2069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002071{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002072 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002073}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002075
Johan Pascalb62bb512015-12-03 21:56:45 +01002076#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002077void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2078 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002079{
2080 conf->dtls_srtp_mki_support = support_mki_value;
2081}
2082
Ron Eldoref72faf2018-07-12 11:54:20 +03002083int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2084 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002085 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002086{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002087 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002088 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002089 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002090 }
Ron Eldor591f1622018-01-22 12:30:04 +02002091
2092 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002093 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002094 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002095 }
Ron Eldor591f1622018-01-22 12:30:04 +02002096
2097 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2098 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002099 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002100}
2101
Ron Eldoref72faf2018-07-12 11:54:20 +03002102int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002103 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002104{
Johan Pascal253d0262020-09-22 13:04:45 +02002105 const mbedtls_ssl_srtp_profile *p;
2106 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002107
Johan Pascal253d0262020-09-22 13:04:45 +02002108 /* check the profiles list: all entry must be valid,
2109 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002110 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2111 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2112 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002113 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002114 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002115 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002116 list_size++;
2117 }
2118 else
2119 {
2120 /* unsupported value, stop parsing and set the size to an error value */
2121 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002122 }
2123 }
2124
Johan Pascal5ef72d22020-10-28 17:05:47 +01002125 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002126 {
Johan Pascal253d0262020-09-22 13:04:45 +02002127 conf->dtls_srtp_profile_list = NULL;
2128 conf->dtls_srtp_profile_list_len = 0;
2129 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2130 }
2131
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002132 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002133 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002134
2135 return( 0 );
2136}
2137
Johan Pascal5ef72d22020-10-28 17:05:47 +01002138void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2139 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002140{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002141 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2142 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002143 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002144 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002145 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002146 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002147 else
2148 {
2149 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002150 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2151 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002152 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002153}
Johan Pascalb62bb512015-12-03 21:56:45 +01002154#endif /* MBEDTLS_SSL_DTLS_SRTP */
2155
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002156void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002157{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002158 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002159}
2160
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002161void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002162{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002163 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002164}
2165
Janos Follath088ce432017-04-10 12:42:31 +01002166#if defined(MBEDTLS_SSL_SRV_C)
2167void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2168 char cert_req_ca_list )
2169{
2170 conf->cert_req_ca_list = cert_req_ca_list;
2171}
2172#endif
2173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002175void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002176{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002177 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002178}
2179#endif
2180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002182void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002183{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002184 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002185}
2186#endif
2187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002189int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002190{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002192 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002193 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002195 }
2196
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002197 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002198
2199 return( 0 );
2200}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002202
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002203void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002204{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002205 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002206}
2207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002209void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002211 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002212}
2213
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002214void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002216 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002217}
2218
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002219void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002220 const unsigned char period[8] )
2221{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002222 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002223}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002227#if defined(MBEDTLS_SSL_CLI_C)
2228void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002229{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002230 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002231}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002232#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002233
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002234#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002235void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2236 mbedtls_ssl_ticket_write_t *f_ticket_write,
2237 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2238 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002239{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002240 conf->f_ticket_write = f_ticket_write;
2241 conf->f_ticket_parse = f_ticket_parse;
2242 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002243}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002244#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002246
Hanno Becker7e6c1782021-06-08 09:24:55 +01002247void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2248 mbedtls_ssl_export_keys_t *f_export_keys,
2249 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002250{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002251 ssl->f_export_keys = f_export_keys;
2252 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002253}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002254
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002255#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002256void mbedtls_ssl_conf_async_private_cb(
2257 mbedtls_ssl_config *conf,
2258 mbedtls_ssl_async_sign_t *f_async_sign,
2259 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2260 mbedtls_ssl_async_resume_t *f_async_resume,
2261 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002262 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002263{
2264 conf->f_async_sign_start = f_async_sign;
2265 conf->f_async_decrypt_start = f_async_decrypt;
2266 conf->f_async_resume = f_async_resume;
2267 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002268 conf->p_async_config_data = async_config_data;
2269}
2270
Gilles Peskine8f97af72018-04-26 11:46:10 +02002271void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2272{
2273 return( conf->p_async_config_data );
2274}
2275
Gilles Peskine1febfef2018-04-30 11:54:39 +02002276void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002277{
2278 if( ssl->handshake == NULL )
2279 return( NULL );
2280 else
2281 return( ssl->handshake->user_async_ctx );
2282}
2283
Gilles Peskine1febfef2018-04-30 11:54:39 +02002284void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002285 void *ctx )
2286{
2287 if( ssl->handshake != NULL )
2288 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002289}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002290#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002291
Paul Bakker5121ce52009-01-03 21:22:43 +00002292/*
2293 * SSL get accessors
2294 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002295uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002296{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002297 if( ssl->session != NULL )
2298 return( ssl->session->verify_result );
2299
2300 if( ssl->session_negotiate != NULL )
2301 return( ssl->session_negotiate->verify_result );
2302
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002303 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002304}
2305
Glenn Strauss8f526902022-01-13 00:04:49 -05002306int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2307{
2308 if( ssl == NULL || ssl->session == NULL )
2309 return( 0 );
2310
2311 return( ssl->session->ciphersuite );
2312}
2313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002315{
Paul Bakker926c8e42013-03-06 10:23:34 +01002316 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002317 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002320}
2321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002323{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002325 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002326 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002327 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002328 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002329 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002330 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002331 default:
2332 return( "unknown (DTLS)" );
2333 }
2334 }
2335#endif
2336
Glenn Strauss60bfe602022-03-14 19:04:24 -04002337 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002338 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002339 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002340 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002341 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002342 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002343 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002344 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002345 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002346}
2347
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002348#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002349size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2350{
David Horstmann95d516f2021-05-04 18:36:56 +01002351 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002352 size_t read_mfl;
2353
2354 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2355 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2356 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2357 {
2358 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2359 }
2360
2361 /* Check if a smaller max length was negotiated */
2362 if( ssl->session_out != NULL )
2363 {
2364 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2365 if( read_mfl < max_len )
2366 {
2367 max_len = read_mfl;
2368 }
2369 }
2370
2371 // During a handshake, use the value being negotiated
2372 if( ssl->session_negotiate != NULL )
2373 {
2374 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2375 if( read_mfl < max_len )
2376 {
2377 max_len = read_mfl;
2378 }
2379 }
2380
2381 return( max_len );
2382}
2383
2384size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002385{
2386 size_t max_len;
2387
2388 /*
2389 * Assume mfl_code is correct since it was checked when set
2390 */
Angus Grattond8213d02016-05-25 20:56:48 +10002391 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002392
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002393 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002394 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002395 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002396 {
Angus Grattond8213d02016-05-25 20:56:48 +10002397 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002398 }
2399
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002400 /* During a handshake, use the value being negotiated */
2401 if( ssl->session_negotiate != NULL &&
2402 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2403 {
2404 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2405 }
2406
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002407 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002408}
2409#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2410
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002411#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002412size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002413{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002414 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2415 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2416 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2417 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2418 return ( 0 );
2419
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002420 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2421 return( ssl->mtu );
2422
2423 if( ssl->mtu == 0 )
2424 return( ssl->handshake->mtu );
2425
2426 return( ssl->mtu < ssl->handshake->mtu ?
2427 ssl->mtu : ssl->handshake->mtu );
2428}
2429#endif /* MBEDTLS_SSL_PROTO_DTLS */
2430
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002431int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2432{
2433 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2434
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002435#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2436 !defined(MBEDTLS_SSL_PROTO_DTLS)
2437 (void) ssl;
2438#endif
2439
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002440#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002441 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002442
2443 if( max_len > mfl )
2444 max_len = mfl;
2445#endif
2446
2447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002448 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002449 {
Hanno Becker89490712020-02-05 10:50:12 +00002450 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002451 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2452 const size_t overhead = (size_t) ret;
2453
2454 if( ret < 0 )
2455 return( ret );
2456
2457 if( mtu <= overhead )
2458 {
2459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2460 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2461 }
2462
2463 if( max_len > mtu - overhead )
2464 max_len = mtu - overhead;
2465 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002466#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002467
Hanno Becker0defedb2018-08-10 12:35:02 +01002468#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2469 !defined(MBEDTLS_SSL_PROTO_DTLS)
2470 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002471#endif
2472
2473 return( (int) max_len );
2474}
2475
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002476int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2477{
2478 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2479
2480#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2481 (void) ssl;
2482#endif
2483
2484#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2485 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2486
2487 if( max_len > mfl )
2488 max_len = mfl;
2489#endif
2490
2491 return( (int) max_len );
2492}
2493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#if defined(MBEDTLS_X509_CRT_PARSE_C)
2495const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002496{
2497 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002498 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002499
Hanno Beckere6824572019-02-07 13:18:46 +00002500#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002501 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002502#else
2503 return( NULL );
2504#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002505}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002507
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002509int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2510 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002511{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002512 int ret;
2513
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002514 if( ssl == NULL ||
2515 dst == NULL ||
2516 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002517 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002518 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002520 }
2521
Hanno Beckere810bbc2021-05-14 16:01:05 +01002522 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2523 * idempotent: Each session can only be exported once.
2524 *
2525 * (This is in preparation for TLS 1.3 support where we will
2526 * need the ability to export multiple sessions (aka tickets),
2527 * which will be achieved by calling mbedtls_ssl_get_session()
2528 * multiple times until it fails.)
2529 *
2530 * Check whether we have already exported the current session,
2531 * and fail if so.
2532 */
2533 if( ssl->session->exported == 1 )
2534 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2535
2536 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2537 if( ret != 0 )
2538 return( ret );
2539
2540 /* Remember that we've exported the session. */
2541 ssl->session->exported = 1;
2542 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002543}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002545
Paul Bakker5121ce52009-01-03 21:22:43 +00002546/*
Hanno Beckera835da52019-05-16 12:39:07 +01002547 * Define ticket header determining Mbed TLS version
2548 * and structure of the ticket.
2549 */
2550
Hanno Becker94ef3b32019-05-16 12:50:45 +01002551/*
Hanno Becker50b59662019-05-28 14:30:45 +01002552 * Define bitflag determining compile-time settings influencing
2553 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002554 */
2555
Hanno Becker50b59662019-05-28 14:30:45 +01002556#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002557#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002558#else
Hanno Becker3e088662019-05-29 11:10:18 +01002559#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002560#endif /* MBEDTLS_HAVE_TIME */
2561
2562#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002563#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002564#else
Hanno Becker3e088662019-05-29 11:10:18 +01002565#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002566#endif /* MBEDTLS_X509_CRT_PARSE_C */
2567
2568#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002569#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002570#else
Hanno Becker3e088662019-05-29 11:10:18 +01002571#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002572#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2573
2574#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002575#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002576#else
Hanno Becker3e088662019-05-29 11:10:18 +01002577#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002578#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2579
Hanno Becker94ef3b32019-05-16 12:50:45 +01002580#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002581#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002582#else
Hanno Becker3e088662019-05-29 11:10:18 +01002583#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002584#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2585
Hanno Becker94ef3b32019-05-16 12:50:45 +01002586#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2587#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2588#else
2589#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2590#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2591
Hanno Becker3e088662019-05-29 11:10:18 +01002592#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2593#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2594#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2595#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002596#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2597#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002598
Hanno Becker50b59662019-05-28 14:30:45 +01002599#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002600 ( (uint16_t) ( \
2601 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2602 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2603 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2604 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002605 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002606 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002607
Hanno Beckerf8787072019-05-16 12:41:07 +01002608static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002609 MBEDTLS_VERSION_MAJOR,
2610 MBEDTLS_VERSION_MINOR,
2611 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002612 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2613 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002614};
Hanno Beckera835da52019-05-16 12:39:07 +01002615
2616/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002617 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002618 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002619 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002620 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002621 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002622 * opaque mbedtls_version[3]; // library version: major, minor, patch
2623 * opaque session_format[2]; // library-version specific 16-bit field
2624 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002625 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002626 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002627 * Note: When updating the format, remember to keep
2628 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002629 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002630 * // In this version, `session_format` determines
2631 * // the setting of those compile-time
2632 * // configuration options which influence
2633 * // the structure of mbedtls_ssl_session.
2634 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002635 * uint8_t minor_ver; // Protocol minor version. Possible values:
2636 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002637 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002638 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002639 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002640 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002641 * serialized_session_tls12 data;
2642 *
2643 * };
2644 *
2645 * } serialized_session;
2646 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002647 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002648
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002649static int ssl_session_save( const mbedtls_ssl_session *session,
2650 unsigned char omit_header,
2651 unsigned char *buf,
2652 size_t buf_len,
2653 size_t *olen )
2654{
2655 unsigned char *p = buf;
2656 size_t used = 0;
2657
2658 if( !omit_header )
2659 {
2660 /*
2661 * Add Mbed TLS version identifier
2662 */
2663
2664 used += sizeof( ssl_serialized_session_header );
2665
2666 if( used <= buf_len )
2667 {
2668 memcpy( p, ssl_serialized_session_header,
2669 sizeof( ssl_serialized_session_header ) );
2670 p += sizeof( ssl_serialized_session_header );
2671 }
2672 }
2673
2674 /*
2675 * TLS version identifier
2676 */
2677 used += 1;
2678 if( used <= buf_len )
2679 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002680 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002681 }
2682
2683 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002684 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002685 {
2686#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002687 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002688 {
2689 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2690 used += ssl_session_save_tls12( session, p, remaining_len );
2691 break;
2692 }
2693#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2694
2695 default:
2696 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2697 }
2698
2699 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002700 if( used > buf_len )
2701 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002702
2703 return( 0 );
2704}
2705
2706/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002707 * Public wrapper for ssl_session_save()
2708 */
2709int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2710 unsigned char *buf,
2711 size_t buf_len,
2712 size_t *olen )
2713{
2714 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2715}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002716
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002717/*
2718 * Deserialize session, see mbedtls_ssl_session_save() for format.
2719 *
2720 * This internal version is wrapped by a public function that cleans up in
2721 * case of error, and has an extra option omit_header.
2722 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002723static int ssl_session_load( mbedtls_ssl_session *session,
2724 unsigned char omit_header,
2725 const unsigned char *buf,
2726 size_t len )
2727{
2728 const unsigned char *p = buf;
2729 const unsigned char * const end = buf + len;
2730
2731 if( !omit_header )
2732 {
2733 /*
2734 * Check Mbed TLS version identifier
2735 */
2736
2737 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2738 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2739
2740 if( memcmp( p, ssl_serialized_session_header,
2741 sizeof( ssl_serialized_session_header ) ) != 0 )
2742 {
2743 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2744 }
2745 p += sizeof( ssl_serialized_session_header );
2746 }
2747
2748 /*
2749 * TLS version identifier
2750 */
2751 if( 1 > (size_t)( end - p ) )
2752 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002753 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002754
2755 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002756 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002757 {
2758#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002759 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002760 {
2761 size_t remaining_len = ( end - p );
2762 return( ssl_session_load_tls12( session, p, remaining_len ) );
2763 }
2764#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2765
2766 default:
2767 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2768 }
2769}
2770
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002771/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002772 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002773 */
2774int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2775 const unsigned char *buf,
2776 size_t len )
2777{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002778 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002779
2780 if( ret != 0 )
2781 mbedtls_ssl_session_free( session );
2782
2783 return( ret );
2784}
2785
2786/*
Paul Bakker1961b702013-01-25 14:49:24 +01002787 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002788 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002789static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2790{
2791 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2792
Ronald Cron66dbf912022-02-02 15:33:46 +01002793 /*
2794 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002795 * that were written into the output buffer by the previous handshake step,
2796 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002797 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2798 * We proceed to the next handshake step only when all data from the
2799 * previous one have been sent to the peer, thus we make sure that this is
2800 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2801 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2802 * we have to wait before to go ahead.
2803 * In the case of TLS 1.3, handshake step handlers do not send data to the
2804 * peer. Data are only sent here and through
2805 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2806 * alert occured.
2807 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002808 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2809 return( ret );
2810
2811#if defined(MBEDTLS_SSL_PROTO_DTLS)
2812 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2813 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2814 {
2815 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2816 return( ret );
2817 }
2818#endif /* MBEDTLS_SSL_PROTO_DTLS */
2819
2820 return( ret );
2821}
2822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002824{
Hanno Becker41934dd2021-08-07 19:13:43 +01002825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002826
Hanno Becker41934dd2021-08-07 19:13:43 +01002827 if( ssl == NULL ||
2828 ssl->conf == NULL ||
2829 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002830 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002831 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002832 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002833 }
2834
2835 ret = ssl_prepare_handshake_step( ssl );
2836 if( ret != 0 )
2837 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002838
Jerry Yue7047812021-09-13 19:26:39 +08002839 ret = mbedtls_ssl_handle_pending_alert( ssl );
2840 if( ret != 0 )
2841 goto cleanup;
2842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002844 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002845 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2847 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002848
Ronald Cron9f0fba32022-02-10 16:45:15 +01002849 switch( ssl->state )
2850 {
2851 case MBEDTLS_SSL_HELLO_REQUEST:
2852 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2853 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002854
Ronald Cron9f0fba32022-02-10 16:45:15 +01002855 case MBEDTLS_SSL_CLIENT_HELLO:
2856 ret = mbedtls_ssl_write_client_hello( ssl );
2857 break;
2858
2859 default:
2860#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002861 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002862 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2863 else
2864 ret = mbedtls_ssl_handshake_client_step( ssl );
2865#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2866 ret = mbedtls_ssl_handshake_client_step( ssl );
2867#else
2868 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2869#endif
2870 }
Jerry Yub9930e72021-08-06 17:11:51 +08002871 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002872#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002874 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002875 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002876#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002877 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002878 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002879#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002880
2881#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2882 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2883 ret = mbedtls_ssl_handshake_server_step( ssl );
2884#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2885 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002886#endif
2887
Jerry Yue7047812021-09-13 19:26:39 +08002888 if( ret != 0 )
2889 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002890 /* handshake_step return error. And it is same
2891 * with alert_reason.
2892 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002893 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002894 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002895 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002896 goto cleanup;
2897 }
2898 }
2899
2900cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002901 return( ret );
2902}
2903
2904/*
2905 * Perform the SSL handshake
2906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002908{
2909 int ret = 0;
2910
Hanno Beckera817ea42020-10-20 15:20:23 +01002911 /* Sanity checks */
2912
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002913 if( ssl == NULL || ssl->conf == NULL )
2914 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2915
Hanno Beckera817ea42020-10-20 15:20:23 +01002916#if defined(MBEDTLS_SSL_PROTO_DTLS)
2917 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2918 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2919 {
2920 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2921 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2922 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2923 }
2924#endif /* MBEDTLS_SSL_PROTO_DTLS */
2925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002927
Hanno Beckera817ea42020-10-20 15:20:23 +01002928 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00002929 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01002930 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002932
2933 if( ret != 0 )
2934 break;
2935 }
2936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002938
2939 return( ret );
2940}
2941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942#if defined(MBEDTLS_SSL_RENEGOTIATION)
2943#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002944/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002945 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002948{
Janos Follath865b3eb2019-12-16 11:46:15 +00002949 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002952
2953 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2955 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002956
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002957 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002958 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002960 return( ret );
2961 }
2962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002964
2965 return( 0 );
2966}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002968
2969/*
2970 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * - any side: calling mbedtls_ssl_renegotiate(),
2972 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2973 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002974 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002975 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002977 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002978int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002979{
Janos Follath865b3eb2019-12-16 11:46:15 +00002980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002983
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002984 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2985 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002986
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002987 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
2988 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002990 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002992 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002993 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002994 ssl->handshake->out_msg_seq = 1;
2995 else
2996 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002997 }
2998#endif
2999
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3001 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003004 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003006 return( ret );
3007 }
3008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003010
3011 return( 0 );
3012}
3013
3014/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003015 * Renegotiate current connection on client,
3016 * or request renegotiation on server
3017 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003019{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003021
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003022 if( ssl == NULL || ssl->conf == NULL )
3023 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003026 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003027 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003028 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003029 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003033
3034 /* Did we already try/start sending HelloRequest? */
3035 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003037
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003038 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003039 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003043 /*
3044 * On client, either start the renegotiation process or,
3045 * if already in progress, continue the handshake
3046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003048 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003049 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003051
Hanno Becker40cdaa12020-02-05 10:48:27 +00003052 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003053 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003054 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003055 return( ret );
3056 }
3057 }
3058 else
3059 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003061 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003063 return( ret );
3064 }
3065 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003067
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003068 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003069}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003071
Gilles Peskine9b562d52018-04-25 20:32:43 +02003072void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003073{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003074 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3075
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003076 if( handshake == NULL )
3077 return;
3078
Brett Warrene0edc842021-08-17 09:53:13 +01003079#if defined(MBEDTLS_ECP_C)
3080#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3081 if ( ssl->handshake->group_list_heap_allocated )
3082 mbedtls_free( (void*) handshake->group_list );
3083 handshake->group_list = NULL;
3084#endif /* MBEDTLS_DEPRECATED_REMOVED */
3085#endif /* MBEDTLS_ECP_C */
3086
Jerry Yuf017ee42022-01-12 15:49:48 +08003087#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3088#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3089 if ( ssl->handshake->sig_algs_heap_allocated )
3090 mbedtls_free( (void*) handshake->sig_algs );
3091 handshake->sig_algs = NULL;
3092#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003093#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3094 if( ssl->handshake->certificate_request_context )
3095 {
3096 mbedtls_free( (void*) handshake->certificate_request_context );
3097 }
3098#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003099#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3100
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003101#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3102 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3103 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003104 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003105 handshake->async_in_progress = 0;
3106 }
3107#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3108
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003109#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003110#if defined(MBEDTLS_USE_PSA_CRYPTO)
3111 psa_hash_abort( &handshake->fin_sha256_psa );
3112#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003113 mbedtls_sha256_free( &handshake->fin_sha256 );
3114#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003115#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003116#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003118 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003119#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003120 mbedtls_sha512_free( &handshake->fin_sha512 );
3121#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003122#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124#if defined(MBEDTLS_DHM_C)
3125 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003126#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127#if defined(MBEDTLS_ECDH_C)
3128 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003129#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003130#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003131 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003132#if defined(MBEDTLS_SSL_CLI_C)
3133 mbedtls_free( handshake->ecjpake_cache );
3134 handshake->ecjpake_cache = NULL;
3135 handshake->ecjpake_cache_len = 0;
3136#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003137#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003138
Janos Follath4ae5c292016-02-10 11:27:43 +00003139#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3140 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003141 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003143#endif
3144
Gilles Peskineeccd8882020-03-10 12:19:08 +01003145#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003146 if( handshake->psk != NULL )
3147 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003148 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003149 mbedtls_free( handshake->psk );
3150 }
3151#endif
3152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3154 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003155 /*
3156 * Free only the linked list wrapper, not the keys themselves
3157 * since the belong to the SNI callback
3158 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003159 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003161
Gilles Peskineeccd8882020-03-10 12:19:08 +01003162#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003163 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003164 if( handshake->ecrs_peer_cert != NULL )
3165 {
3166 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3167 mbedtls_free( handshake->ecrs_peer_cert );
3168 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003169#endif
3170
Hanno Becker75173122019-02-06 16:18:31 +00003171#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3172 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3173 mbedtls_pk_free( &handshake->peer_pubkey );
3174#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3175
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003176#if defined(MBEDTLS_SSL_CLI_C) && \
3177 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3178 mbedtls_free( handshake->cookie );
3179#endif /* MBEDTLS_SSL_CLI_C &&
3180 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003181
3182#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003183 mbedtls_ssl_flight_free( handshake->flight );
3184 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003185#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003186
Ronald Cronf12b81d2022-03-15 10:42:41 +01003187#if defined(MBEDTLS_ECDH_C) && \
3188 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003189 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003190 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003191#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3192
Ronald Cron6f135e12021-12-08 16:57:54 +01003193#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003194 mbedtls_ssl_transform_free( handshake->transform_handshake );
3195 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003196 mbedtls_free( handshake->transform_earlydata );
3197 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003198#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003199
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003200
3201#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3202 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3203 * processes datagrams and the fact that a datagram is allowed to have
3204 * several records in it, it is possible that the I/O buffers are not
3205 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003206 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3207 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003208#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003209
Jerry Yuba9c7272021-10-30 11:54:10 +08003210 /* mbedtls_platform_zeroize MUST be last one in this function */
3211 mbedtls_platform_zeroize( handshake,
3212 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003213}
3214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003216{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003217 if( session == NULL )
3218 return;
3219
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003221 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003222#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003223
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003224#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003226#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003227
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003228 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003229}
3230
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003231#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003232
3233#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3234#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3235#else
3236#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3237#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3238
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003239#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003240
3241#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3242#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3243#else
3244#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3245#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3246
3247#if defined(MBEDTLS_SSL_ALPN)
3248#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3249#else
3250#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3251#endif /* MBEDTLS_SSL_ALPN */
3252
3253#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3254#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3255#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3256#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3257
3258#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3259 ( (uint32_t) ( \
3260 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3261 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3262 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3263 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3264 0u ) )
3265
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003266static unsigned char ssl_serialized_context_header[] = {
3267 MBEDTLS_VERSION_MAJOR,
3268 MBEDTLS_VERSION_MINOR,
3269 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003270 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3271 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3272 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3273 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3274 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003275};
3276
Paul Bakker5121ce52009-01-03 21:22:43 +00003277/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003278 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003279 *
3280 * The format of the serialized data is:
3281 * (in the presentation language of TLS, RFC 8446 section 3)
3282 *
3283 * // header
3284 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003285 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003286 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003287 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003288 * Note: When updating the format, remember to keep these
3289 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003290 *
3291 * // session sub-structure
3292 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3293 * // transform sub-structure
3294 * uint8 random[64]; // ServerHello.random+ClientHello.random
3295 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3296 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3297 * // fields from ssl_context
3298 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3299 * uint64 in_window_top; // DTLS: last validated record seq_num
3300 * uint64 in_window; // DTLS: bitmask for replay protection
3301 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3302 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3303 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3304 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3305 *
3306 * Note that many fields of the ssl_context or sub-structures are not
3307 * serialized, as they fall in one of the following categories:
3308 *
3309 * 1. forced value (eg in_left must be 0)
3310 * 2. pointer to dynamically-allocated memory (eg session, transform)
3311 * 3. value can be re-derived from other data (eg session keys from MS)
3312 * 4. value was temporary (eg content of input buffer)
3313 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003314 */
3315int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3316 unsigned char *buf,
3317 size_t buf_len,
3318 size_t *olen )
3319{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003320 unsigned char *p = buf;
3321 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003322 size_t session_len;
3323 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003324
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003325 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003326 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3327 * this function's documentation.
3328 *
3329 * These are due to assumptions/limitations in the implementation. Some of
3330 * them are likely to stay (no handshake in progress) some might go away
3331 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003332 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003333 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003334 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003335 {
3336 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003337 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003338 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003339 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003340 {
3341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003342 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003343 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003344 /* Double-check that sub-structures are indeed ready */
3345 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003346 {
3347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003348 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003349 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003350 /* There must be no pending incoming or outgoing data */
3351 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003352 {
3353 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003354 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003355 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003356 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003357 {
3358 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003359 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003360 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003361 /* Protocol must be DLTS, not TLS */
3362 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003363 {
3364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003365 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003366 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003367 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003368 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003369 {
3370 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003371 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003372 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003373 /* We must be using an AEAD ciphersuite */
3374 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003375 {
3376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003377 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003378 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003379 /* Renegotiation must not be enabled */
3380#if defined(MBEDTLS_SSL_RENEGOTIATION)
3381 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003382 {
3383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003384 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003385 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003386#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003387
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003388 /*
3389 * Version and format identifier
3390 */
3391 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003392
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003393 if( used <= buf_len )
3394 {
3395 memcpy( p, ssl_serialized_context_header,
3396 sizeof( ssl_serialized_context_header ) );
3397 p += sizeof( ssl_serialized_context_header );
3398 }
3399
3400 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003401 * Session (length + data)
3402 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003403 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003404 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3405 return( ret );
3406
3407 used += 4 + session_len;
3408 if( used <= buf_len )
3409 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003410 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3411 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003412
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003413 ret = ssl_session_save( ssl->session, 1,
3414 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003415 if( ret != 0 )
3416 return( ret );
3417
3418 p += session_len;
3419 }
3420
3421 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003422 * Transform
3423 */
3424 used += sizeof( ssl->transform->randbytes );
3425 if( used <= buf_len )
3426 {
3427 memcpy( p, ssl->transform->randbytes,
3428 sizeof( ssl->transform->randbytes ) );
3429 p += sizeof( ssl->transform->randbytes );
3430 }
3431
3432#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3433 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3434 if( used <= buf_len )
3435 {
3436 *p++ = ssl->transform->in_cid_len;
3437 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3438 p += ssl->transform->in_cid_len;
3439
3440 *p++ = ssl->transform->out_cid_len;
3441 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3442 p += ssl->transform->out_cid_len;
3443 }
3444#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3445
3446 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003447 * Saved fields from top-level ssl_context structure
3448 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003449 used += 4;
3450 if( used <= buf_len )
3451 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003452 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3453 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003454 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003455
3456#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3457 used += 16;
3458 if( used <= buf_len )
3459 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003460 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3461 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003462
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003463 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3464 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003465 }
3466#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3467
3468#if defined(MBEDTLS_SSL_PROTO_DTLS)
3469 used += 1;
3470 if( used <= buf_len )
3471 {
3472 *p++ = ssl->disable_datagram_packing;
3473 }
3474#endif /* MBEDTLS_SSL_PROTO_DTLS */
3475
Jerry Yuae0b2e22021-10-08 15:21:19 +08003476 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003477 if( used <= buf_len )
3478 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003479 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3480 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003481 }
3482
3483#if defined(MBEDTLS_SSL_PROTO_DTLS)
3484 used += 2;
3485 if( used <= buf_len )
3486 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003487 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3488 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003489 }
3490#endif /* MBEDTLS_SSL_PROTO_DTLS */
3491
3492#if defined(MBEDTLS_SSL_ALPN)
3493 {
3494 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003495 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003496 : 0;
3497
3498 used += 1 + alpn_len;
3499 if( used <= buf_len )
3500 {
3501 *p++ = alpn_len;
3502
3503 if( ssl->alpn_chosen != NULL )
3504 {
3505 memcpy( p, ssl->alpn_chosen, alpn_len );
3506 p += alpn_len;
3507 }
3508 }
3509 }
3510#endif /* MBEDTLS_SSL_ALPN */
3511
3512 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003513 * Done
3514 */
3515 *olen = used;
3516
3517 if( used > buf_len )
3518 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003519
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003520 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3521
Hanno Becker43aefe22020-02-05 10:44:56 +00003522 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003523}
3524
3525/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003526 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003527 *
3528 * This internal version is wrapped by a public function that cleans up in
3529 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003530 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003531static int ssl_context_load( mbedtls_ssl_context *ssl,
3532 const unsigned char *buf,
3533 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003534{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003535 const unsigned char *p = buf;
3536 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003537 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003538 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003539
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003540 /*
3541 * The context should have been freshly setup or reset.
3542 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003543 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003544 * renegotiating, or if the user mistakenly loaded a session first.)
3545 */
3546 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3547 ssl->session != NULL )
3548 {
3549 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3550 }
3551
3552 /*
3553 * We can't check that the config matches the initial one, but we can at
3554 * least check it matches the requirements for serializing.
3555 */
3556 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003557 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3558 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003559#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003560 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003561#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003562 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003563 {
3564 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3565 }
3566
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003567 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3568
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003569 /*
3570 * Check version identifier
3571 */
3572 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3573 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3574
3575 if( memcmp( p, ssl_serialized_context_header,
3576 sizeof( ssl_serialized_context_header ) ) != 0 )
3577 {
3578 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3579 }
3580 p += sizeof( ssl_serialized_context_header );
3581
3582 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003583 * Session
3584 */
3585 if( (size_t)( end - p ) < 4 )
3586 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3587
3588 session_len = ( (size_t) p[0] << 24 ) |
3589 ( (size_t) p[1] << 16 ) |
3590 ( (size_t) p[2] << 8 ) |
3591 ( (size_t) p[3] );
3592 p += 4;
3593
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003594 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003595 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003596 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003597 ssl->session_in = ssl->session;
3598 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003599 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003600
3601 if( (size_t)( end - p ) < session_len )
3602 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3603
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003604 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003605 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003606 {
3607 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003608 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003609 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003610
3611 p += session_len;
3612
3613 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003614 * Transform
3615 */
3616
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003617 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003618 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003619 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003620 ssl->transform_in = ssl->transform;
3621 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003622 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003623
3624 /* Read random bytes and populate structure */
3625 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3626 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003627#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003628 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003629 ssl->session->ciphersuite,
3630 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003631#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3632 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003633 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003634#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3635 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003636 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3637 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003638 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003639 ssl->conf->endpoint,
3640 ssl );
3641 if( ret != 0 )
3642 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003643#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003644 p += sizeof( ssl->transform->randbytes );
3645
3646#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3647 /* Read connection IDs and store them */
3648 if( (size_t)( end - p ) < 1 )
3649 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3650
3651 ssl->transform->in_cid_len = *p++;
3652
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003653 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003654 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3655
3656 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3657 p += ssl->transform->in_cid_len;
3658
3659 ssl->transform->out_cid_len = *p++;
3660
3661 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3662 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3663
3664 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3665 p += ssl->transform->out_cid_len;
3666#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3667
3668 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003669 * Saved fields from top-level ssl_context structure
3670 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003671 if( (size_t)( end - p ) < 4 )
3672 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3673
3674 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3675 ( (uint32_t) p[1] << 16 ) |
3676 ( (uint32_t) p[2] << 8 ) |
3677 ( (uint32_t) p[3] );
3678 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003679
3680#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3681 if( (size_t)( end - p ) < 16 )
3682 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3683
3684 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3685 ( (uint64_t) p[1] << 48 ) |
3686 ( (uint64_t) p[2] << 40 ) |
3687 ( (uint64_t) p[3] << 32 ) |
3688 ( (uint64_t) p[4] << 24 ) |
3689 ( (uint64_t) p[5] << 16 ) |
3690 ( (uint64_t) p[6] << 8 ) |
3691 ( (uint64_t) p[7] );
3692 p += 8;
3693
3694 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3695 ( (uint64_t) p[1] << 48 ) |
3696 ( (uint64_t) p[2] << 40 ) |
3697 ( (uint64_t) p[3] << 32 ) |
3698 ( (uint64_t) p[4] << 24 ) |
3699 ( (uint64_t) p[5] << 16 ) |
3700 ( (uint64_t) p[6] << 8 ) |
3701 ( (uint64_t) p[7] );
3702 p += 8;
3703#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3704
3705#if defined(MBEDTLS_SSL_PROTO_DTLS)
3706 if( (size_t)( end - p ) < 1 )
3707 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3708
3709 ssl->disable_datagram_packing = *p++;
3710#endif /* MBEDTLS_SSL_PROTO_DTLS */
3711
Jerry Yud9a94fe2021-09-28 18:58:59 +08003712 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003714 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3715 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003716
3717#if defined(MBEDTLS_SSL_PROTO_DTLS)
3718 if( (size_t)( end - p ) < 2 )
3719 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3720
3721 ssl->mtu = ( p[0] << 8 ) | p[1];
3722 p += 2;
3723#endif /* MBEDTLS_SSL_PROTO_DTLS */
3724
3725#if defined(MBEDTLS_SSL_ALPN)
3726 {
3727 uint8_t alpn_len;
3728 const char **cur;
3729
3730 if( (size_t)( end - p ) < 1 )
3731 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3732
3733 alpn_len = *p++;
3734
3735 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3736 {
3737 /* alpn_chosen should point to an item in the configured list */
3738 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3739 {
3740 if( strlen( *cur ) == alpn_len &&
3741 memcmp( p, cur, alpn_len ) == 0 )
3742 {
3743 ssl->alpn_chosen = *cur;
3744 break;
3745 }
3746 }
3747 }
3748
3749 /* can only happen on conf mismatch */
3750 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3751 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3752
3753 p += alpn_len;
3754 }
3755#endif /* MBEDTLS_SSL_ALPN */
3756
3757 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003758 * Forced fields from top-level ssl_context structure
3759 *
3760 * Most of them already set to the correct value by mbedtls_ssl_init() and
3761 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3762 */
3763 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003764 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003765
Hanno Becker361b10d2019-08-30 10:42:49 +01003766 /* Adjust pointers for header fields of outgoing records to
3767 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003768 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003769
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003770#if defined(MBEDTLS_SSL_PROTO_DTLS)
3771 ssl->in_epoch = 1;
3772#endif
3773
3774 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3775 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003776 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3777 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003778 if( ssl->handshake != NULL )
3779 {
3780 mbedtls_ssl_handshake_free( ssl );
3781 mbedtls_free( ssl->handshake );
3782 ssl->handshake = NULL;
3783 }
3784
3785 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003786 * Done - should have consumed entire buffer
3787 */
3788 if( p != end )
3789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003790
3791 return( 0 );
3792}
3793
3794/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003795 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003796 */
3797int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3798 const unsigned char *buf,
3799 size_t len )
3800{
3801 int ret = ssl_context_load( context, buf, len );
3802
3803 if( ret != 0 )
3804 mbedtls_ssl_free( context );
3805
3806 return( ret );
3807}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003808#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003809
3810/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003811 * Free an SSL context
3812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003814{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003815 if( ssl == NULL )
3816 return;
3817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003819
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003820 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003821 {
sander-visserb8aa2072020-05-06 22:05:13 +02003822#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3823 size_t out_buf_len = ssl->out_buf_len;
3824#else
3825 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3826#endif
3827
Darryl Greenb33cc762019-11-28 14:29:44 +00003828 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003830 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003831 }
3832
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003833 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003834 {
sander-visserb8aa2072020-05-06 22:05:13 +02003835#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3836 size_t in_buf_len = ssl->in_buf_len;
3837#else
3838 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3839#endif
3840
Darryl Greenb33cc762019-11-28 14:29:44 +00003841 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003842 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003843 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003844 }
3845
Paul Bakker48916f92012-09-16 19:57:18 +00003846 if( ssl->transform )
3847 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848 mbedtls_ssl_transform_free( ssl->transform );
3849 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003850 }
3851
3852 if( ssl->handshake )
3853 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003854 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003855 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3856 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003858 mbedtls_free( ssl->handshake );
3859 mbedtls_free( ssl->transform_negotiate );
3860 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003861 }
3862
Ronald Cron6f135e12021-12-08 16:57:54 +01003863#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003864 mbedtls_ssl_transform_free( ssl->transform_application );
3865 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003866#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003867
Paul Bakkerc0463502013-02-14 11:19:38 +01003868 if( ssl->session )
3869 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003870 mbedtls_ssl_session_free( ssl->session );
3871 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003872 }
3873
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003874#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003875 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003876 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003877 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003879 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003880#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003881
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003882#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003883 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003884#endif
3885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003887
Paul Bakker86f04f42013-02-14 11:20:09 +01003888 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003889 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003890}
3891
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003892/*
3893 * Initialze mbedtls_ssl_config
3894 */
3895void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3896{
3897 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3898}
3899
Gilles Peskineeccd8882020-03-10 12:19:08 +01003900#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003901#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003902/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003903 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3904 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003905 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3906 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003907static int ssl_preset_default_hashes[] = {
3908#if defined(MBEDTLS_SHA512_C)
3909 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003910#endif
3911#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003912 MBEDTLS_MD_SHA384,
3913#endif
3914#if defined(MBEDTLS_SHA256_C)
3915 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003916#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003917 MBEDTLS_MD_NONE
3918};
Jerry Yuf017ee42022-01-12 15:49:48 +08003919#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3920#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003921
Gilles Peskineae270bf2021-06-02 00:05:29 +02003922/* The selection should be the same as mbedtls_x509_crt_profile_default in
3923 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003924 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003925 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003926 * about this list.
3927 */
Brett Warrene0edc842021-08-17 09:53:13 +01003928static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003929#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003930 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003931#endif
3932#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003933 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003934#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003935#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003936 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003937#endif
3938#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003939 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003940#endif
3941#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003942 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003943#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003944#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003945 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003946#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003947#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003948 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003949#endif
3950#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003951 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003952#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003953 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003954};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003955
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003956static int ssl_preset_suiteb_ciphersuites[] = {
3957 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3958 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3959 0
3960};
3961
Gilles Peskineeccd8882020-03-10 12:19:08 +01003962#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003963#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003964static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003965#if defined(MBEDTLS_SHA256_C)
3966 MBEDTLS_MD_SHA256,
3967#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003968#if defined(MBEDTLS_SHA384_C)
3969 MBEDTLS_MD_SHA384,
3970#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003971 MBEDTLS_MD_NONE
3972};
Jerry Yuf017ee42022-01-12 15:49:48 +08003973#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003974
Jerry Yu909df7b2022-01-22 11:56:27 +08003975/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003976 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08003977 * rules SHOULD be upheld.
3978 * - No duplicate entries.
3979 * - But if there is a good reason, do not change the order of the algorithms.
3980 * - ssl_tls12_present* is for TLS 1.2 use only.
3981 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08003982 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003983static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08003984
Jerry Yued5e9f42022-01-26 11:21:34 +08003985#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3986 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3987 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3988#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3989 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003990
Jerry Yu909df7b2022-01-22 11:56:27 +08003991#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3992 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3993 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3994#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3995 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
3996
Jerry Yued5e9f42022-01-26 11:21:34 +08003997#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
3998 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
3999 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4000#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4001 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004002
Jerry Yu909df7b2022-01-22 11:56:27 +08004003#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4004 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4005#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4006
Ronald Cron8540cf62022-03-16 08:01:09 +01004007#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4008 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4009#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4010
4011#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4012 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4013#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4014
Jerry Yu53037892022-01-25 11:02:06 +08004015#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4016 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4017#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4018
Jerry Yu909df7b2022-01-22 11:56:27 +08004019 MBEDTLS_TLS1_3_SIG_NONE
4020};
4021
4022/* NOTICE: see above */
4023#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4024static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004025#if defined(MBEDTLS_SHA512_C)
4026 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4027#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004028#if defined(MBEDTLS_SHA384_C)
4029 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4030#endif
4031#if defined(MBEDTLS_SHA256_C)
4032 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4033#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004034 MBEDTLS_TLS1_3_SIG_NONE
4035};
4036#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4037/* NOTICE: see above */
4038static uint16_t ssl_preset_suiteb_sig_algs[] = {
4039
Jerry Yu909df7b2022-01-22 11:56:27 +08004040#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4041 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4042 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4043#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4044 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4045
Jerry Yu53037892022-01-25 11:02:06 +08004046#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4047 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4048 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4049#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4050 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004051
4052#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4053 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4054#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004055
Jerry Yu53037892022-01-25 11:02:06 +08004056#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4057 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4058#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4059
Jerry Yu713013f2022-01-17 18:16:35 +08004060 MBEDTLS_TLS1_3_SIG_NONE
4061};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004062
Jerry Yu909df7b2022-01-22 11:56:27 +08004063/* NOTICE: see above */
4064#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4065static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004066#if defined(MBEDTLS_SHA256_C)
4067 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4068#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004069#if defined(MBEDTLS_SHA384_C)
4070 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4071#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004072 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004073};
Jerry Yu909df7b2022-01-22 11:56:27 +08004074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4075
Jerry Yu1a8b4812022-01-20 17:56:50 +08004076#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004077
Brett Warrene0edc842021-08-17 09:53:13 +01004078static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004079#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004080 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004081#endif
4082#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004083 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004084#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004085 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004086};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004087
Jerry Yu1a8b4812022-01-20 17:56:50 +08004088#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004089/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004090 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004091static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004092{
4093 size_t i, j;
4094 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004095
Jerry Yuf377d642022-01-25 10:43:59 +08004096 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004097 {
Jerry Yuf377d642022-01-25 10:43:59 +08004098 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004099 {
Jerry Yuf377d642022-01-25 10:43:59 +08004100 if( sig_algs[i] != sig_algs[j] )
4101 continue;
4102 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4103 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4104 sig_algs[i], j, i );
4105 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004106 }
4107 }
4108 return( ret );
4109}
4110
4111#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4112
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004113/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004114 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004115 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004116int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004117 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004118{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004119#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004121#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004122
Jerry Yu1a8b4812022-01-20 17:56:50 +08004123#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004124 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004125 {
4126 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4127 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4128 }
4129
Jerry Yuf377d642022-01-25 10:43:59 +08004130 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004131 {
4132 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4133 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4134 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004135
4136#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004137 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004138 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004139 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004140 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4141 }
4142
Jerry Yuf377d642022-01-25 10:43:59 +08004143 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004144 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004145 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004146 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4147 }
4148#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004149#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4150
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004151 /* Use the functions here so that they are covered in tests,
4152 * but otherwise access member directly for efficiency */
4153 mbedtls_ssl_conf_endpoint( conf, endpoint );
4154 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004155
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004156 /*
4157 * Things that are common to all presets
4158 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004159#if defined(MBEDTLS_SSL_CLI_C)
4160 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4161 {
4162 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4163#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4164 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4165#endif
4166 }
4167#endif
4168
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004169#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4170 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4171#endif
4172
4173#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4174 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4175#endif
4176
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004177#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004178 conf->f_cookie_write = ssl_cookie_write_dummy;
4179 conf->f_cookie_check = ssl_cookie_check_dummy;
4180#endif
4181
4182#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4183 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4184#endif
4185
Janos Follath088ce432017-04-10 12:42:31 +01004186#if defined(MBEDTLS_SSL_SRV_C)
4187 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004188 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004189#endif
4190
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004191#if defined(MBEDTLS_SSL_PROTO_DTLS)
4192 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4193 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4194#endif
4195
4196#if defined(MBEDTLS_SSL_RENEGOTIATION)
4197 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004198 memset( conf->renego_period, 0x00, 2 );
4199 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004200#endif
4201
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004202#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004203 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4204 {
4205 const unsigned char dhm_p[] =
4206 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4207 const unsigned char dhm_g[] =
4208 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004209
Hanno Beckere2defad2021-07-24 05:59:17 +01004210 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4211 dhm_p, sizeof( dhm_p ),
4212 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4213 {
4214 return( ret );
4215 }
4216 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004217#endif
4218
Ronald Cron6f135e12021-12-08 16:57:54 +01004219#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004220 /*
4221 * Allow all TLS 1.3 key exchange modes by default.
4222 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004223 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004224#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004225
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004226 if( ( endpoint == MBEDTLS_SSL_IS_SERVER ) ||
4227 ( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) )
4228 {
4229#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4230 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4231 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4232#else
4233 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4234#endif
4235 }
4236 else
4237 {
4238#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4239 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4240 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4241#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4242 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4243 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4244#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4245 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4246 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4247#else
4248 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4249#endif
4250 }
4251
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004252 /*
4253 * Preset-specific defaults
4254 */
4255 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004256 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004257 /*
4258 * NSA Suite B
4259 */
4260 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004261
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004262 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004263
4264#if defined(MBEDTLS_X509_CRT_PARSE_C)
4265 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004266#endif
4267
Gilles Peskineeccd8882020-03-10 12:19:08 +01004268#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004269#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004270 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004271#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004272#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4273 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4274 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4275 else
4276#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4277 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004278#endif
4279
Brett Warrene0edc842021-08-17 09:53:13 +01004280#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4281 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004282#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004283 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004284 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004285
4286 /*
4287 * Default
4288 */
4289 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004290
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004291 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004292
4293#if defined(MBEDTLS_X509_CRT_PARSE_C)
4294 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4295#endif
4296
Gilles Peskineeccd8882020-03-10 12:19:08 +01004297#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004298#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004299 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004300#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004301#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4302 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4303 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4304 else
4305#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4306 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004307#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004308
Brett Warrene0edc842021-08-17 09:53:13 +01004309#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4310 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004311#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004312 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004313
4314#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4315 conf->dhm_min_bitlen = 1024;
4316#endif
4317 }
4318
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004319 return( 0 );
4320}
4321
4322/*
4323 * Free mbedtls_ssl_config
4324 */
4325void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4326{
4327#if defined(MBEDTLS_DHM_C)
4328 mbedtls_mpi_free( &conf->dhm_P );
4329 mbedtls_mpi_free( &conf->dhm_G );
4330#endif
4331
Gilles Peskineeccd8882020-03-10 12:19:08 +01004332#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004333 if( conf->psk != NULL )
4334 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004335 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004336 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004337 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004338 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004339 }
4340
4341 if( conf->psk_identity != NULL )
4342 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004343 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004344 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004345 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004346 conf->psk_identity_len = 0;
4347 }
4348#endif
4349
4350#if defined(MBEDTLS_X509_CRT_PARSE_C)
4351 ssl_key_cert_free( conf->key_cert );
4352#endif
4353
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004354 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004355}
4356
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004357#if defined(MBEDTLS_PK_C) && \
4358 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004359/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004360 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004362unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004363{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004364#if defined(MBEDTLS_RSA_C)
4365 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4366 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004367#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004368#if defined(MBEDTLS_ECDSA_C)
4369 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4370 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004371#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004372 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004373}
4374
Hanno Becker7e5437a2017-04-28 17:15:26 +01004375unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4376{
4377 switch( type ) {
4378 case MBEDTLS_PK_RSA:
4379 return( MBEDTLS_SSL_SIG_RSA );
4380 case MBEDTLS_PK_ECDSA:
4381 case MBEDTLS_PK_ECKEY:
4382 return( MBEDTLS_SSL_SIG_ECDSA );
4383 default:
4384 return( MBEDTLS_SSL_SIG_ANON );
4385 }
4386}
4387
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004388mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004389{
4390 switch( sig )
4391 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004392#if defined(MBEDTLS_RSA_C)
4393 case MBEDTLS_SSL_SIG_RSA:
4394 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004395#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396#if defined(MBEDTLS_ECDSA_C)
4397 case MBEDTLS_SSL_SIG_ECDSA:
4398 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004399#endif
4400 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004401 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004402 }
4403}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004404#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004405
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004406/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004407 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004410{
4411 switch( hash )
4412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004413#if defined(MBEDTLS_MD5_C)
4414 case MBEDTLS_SSL_HASH_MD5:
4415 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004416#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004417#if defined(MBEDTLS_SHA1_C)
4418 case MBEDTLS_SSL_HASH_SHA1:
4419 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004420#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004421#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004422 case MBEDTLS_SSL_HASH_SHA224:
4423 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004424#endif
4425#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004426 case MBEDTLS_SSL_HASH_SHA256:
4427 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004428#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004429#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004430 case MBEDTLS_SSL_HASH_SHA384:
4431 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004432#endif
4433#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004434 case MBEDTLS_SSL_HASH_SHA512:
4435 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004436#endif
4437 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004438 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004439 }
4440}
4441
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004442/*
4443 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4444 */
4445unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4446{
4447 switch( md )
4448 {
4449#if defined(MBEDTLS_MD5_C)
4450 case MBEDTLS_MD_MD5:
4451 return( MBEDTLS_SSL_HASH_MD5 );
4452#endif
4453#if defined(MBEDTLS_SHA1_C)
4454 case MBEDTLS_MD_SHA1:
4455 return( MBEDTLS_SSL_HASH_SHA1 );
4456#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004457#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004458 case MBEDTLS_MD_SHA224:
4459 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004460#endif
4461#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004462 case MBEDTLS_MD_SHA256:
4463 return( MBEDTLS_SSL_HASH_SHA256 );
4464#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004465#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004466 case MBEDTLS_MD_SHA384:
4467 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004468#endif
4469#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004470 case MBEDTLS_MD_SHA512:
4471 return( MBEDTLS_SSL_HASH_SHA512 );
4472#endif
4473 default:
4474 return( MBEDTLS_SSL_HASH_NONE );
4475 }
4476}
4477
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004478/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004479 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004480 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004481 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004482int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004483{
Brett Warrene0edc842021-08-17 09:53:13 +01004484 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004485
Brett Warrene0edc842021-08-17 09:53:13 +01004486 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004487 return( -1 );
4488
Brett Warrene0edc842021-08-17 09:53:13 +01004489 for( ; *group_list != 0; group_list++ )
4490 {
4491 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004492 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004493 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004494
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004495 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004496}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004497
4498#if defined(MBEDTLS_ECP_C)
4499/*
4500 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4501 */
4502int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4503{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004504 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004505 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4506}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004507#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509#if defined(MBEDTLS_X509_CRT_PARSE_C)
4510int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4511 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004512 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004513 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004514{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004515 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004516 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004517 const char *ext_oid;
4518 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004521 {
4522 /* Server part of the key exchange */
4523 switch( ciphersuite->key_exchange )
4524 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004525 case MBEDTLS_KEY_EXCHANGE_RSA:
4526 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004527 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004528 break;
4529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4531 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4532 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4533 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004534 break;
4535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004536 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4537 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004538 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004539 break;
4540
4541 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004542 case MBEDTLS_KEY_EXCHANGE_NONE:
4543 case MBEDTLS_KEY_EXCHANGE_PSK:
4544 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4545 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004546 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004547 usage = 0;
4548 }
4549 }
4550 else
4551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004552 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4553 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004554 }
4555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004556 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004557 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004558 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004559 ret = -1;
4560 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004562 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4565 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004566 }
4567 else
4568 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004569 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4570 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004571 }
4572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004573 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004574 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004575 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004576 ret = -1;
4577 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004578
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004579 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004580}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004582
Jerry Yu148165c2021-09-24 23:20:59 +08004583#if defined(MBEDTLS_USE_PSA_CRYPTO)
4584int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4585 const mbedtls_md_type_t md,
4586 unsigned char *dst,
4587 size_t dst_len,
4588 size_t *olen )
4589{
Ronald Cronf6893e12022-01-07 22:09:01 +01004590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4591 psa_hash_operation_t *hash_operation_to_clone;
4592 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4593
Jerry Yu148165c2021-09-24 23:20:59 +08004594 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004595
4596 switch( md )
4597 {
4598#if defined(MBEDTLS_SHA384_C)
4599 case MBEDTLS_MD_SHA384:
4600 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4601 break;
4602#endif
4603
4604#if defined(MBEDTLS_SHA256_C)
4605 case MBEDTLS_MD_SHA256:
4606 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4607 break;
4608#endif
4609
4610 default:
4611 goto exit;
4612 }
4613
4614 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4615 if( status != PSA_SUCCESS )
4616 goto exit;
4617
4618 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4619 if( status != PSA_SUCCESS )
4620 goto exit;
4621
4622exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004623 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004624}
4625#else /* MBEDTLS_USE_PSA_CRYPTO */
4626
Jerry Yu24c0ec32021-09-09 14:21:07 +08004627#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004628static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4629 unsigned char *dst,
4630 size_t dst_len,
4631 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004632{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004633 int ret;
4634 mbedtls_sha512_context sha512;
4635
4636 if( dst_len < 48 )
4637 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4638
4639 mbedtls_sha512_init( &sha512 );
4640 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4641
4642 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4643 {
4644 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4645 goto exit;
4646 }
4647
4648 *olen = 48;
4649
4650exit:
4651
4652 mbedtls_sha512_free( &sha512 );
4653 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004654}
4655#endif /* MBEDTLS_SHA384_C */
4656
4657#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004658static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4659 unsigned char *dst,
4660 size_t dst_len,
4661 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004662{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004663 int ret;
4664 mbedtls_sha256_context sha256;
4665
4666 if( dst_len < 32 )
4667 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4668
4669 mbedtls_sha256_init( &sha256 );
4670 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004671
Jerry Yu24c0ec32021-09-09 14:21:07 +08004672 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4673 {
4674 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4675 goto exit;
4676 }
4677
4678 *olen = 32;
4679
4680exit:
4681
4682 mbedtls_sha256_free( &sha256 );
4683 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004684}
4685#endif /* MBEDTLS_SHA256_C */
4686
Jerry Yu000f9762021-09-14 11:12:51 +08004687int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4688 const mbedtls_md_type_t md,
4689 unsigned char *dst,
4690 size_t dst_len,
4691 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004692{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004693 switch( md )
4694 {
4695
Jerry Yu24c0ec32021-09-09 14:21:07 +08004696#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004697 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004698 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004699#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004700
Jerry Yu24c0ec32021-09-09 14:21:07 +08004701#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004702 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004703 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004704#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004705
4706 default:
4707 break;
4708 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004709 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004710}
XiaokangQian647719a2021-12-07 09:16:29 +00004711
Jerry Yu148165c2021-09-24 23:20:59 +08004712#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004713
Jerry Yudc7bd172022-02-17 13:44:15 +08004714#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4715
4716#if defined(MBEDTLS_USE_PSA_CRYPTO)
4717
4718static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4719 mbedtls_svc_key_id_t key,
4720 psa_algorithm_t alg,
4721 const unsigned char* seed, size_t seed_length,
4722 const unsigned char* label, size_t label_length,
4723 size_t capacity )
4724{
4725 psa_status_t status;
4726
4727 status = psa_key_derivation_setup( derivation, alg );
4728 if( status != PSA_SUCCESS )
4729 return( status );
4730
4731 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4732 {
4733 status = psa_key_derivation_input_bytes( derivation,
4734 PSA_KEY_DERIVATION_INPUT_SEED,
4735 seed, seed_length );
4736 if( status != PSA_SUCCESS )
4737 return( status );
4738
4739 if( mbedtls_svc_key_id_is_null( key ) )
4740 {
4741 status = psa_key_derivation_input_bytes(
4742 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4743 NULL, 0 );
4744 }
4745 else
4746 {
4747 status = psa_key_derivation_input_key(
4748 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4749 }
4750 if( status != PSA_SUCCESS )
4751 return( status );
4752
4753 status = psa_key_derivation_input_bytes( derivation,
4754 PSA_KEY_DERIVATION_INPUT_LABEL,
4755 label, label_length );
4756 if( status != PSA_SUCCESS )
4757 return( status );
4758 }
4759 else
4760 {
4761 return( PSA_ERROR_NOT_SUPPORTED );
4762 }
4763
4764 status = psa_key_derivation_set_capacity( derivation, capacity );
4765 if( status != PSA_SUCCESS )
4766 return( status );
4767
4768 return( PSA_SUCCESS );
4769}
4770
4771static int tls_prf_generic( mbedtls_md_type_t md_type,
4772 const unsigned char *secret, size_t slen,
4773 const char *label,
4774 const unsigned char *random, size_t rlen,
4775 unsigned char *dstbuf, size_t dlen )
4776{
4777 psa_status_t status;
4778 psa_algorithm_t alg;
4779 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4780 psa_key_derivation_operation_t derivation =
4781 PSA_KEY_DERIVATION_OPERATION_INIT;
4782
4783 if( md_type == MBEDTLS_MD_SHA384 )
4784 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4785 else
4786 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4787
4788 /* Normally a "secret" should be long enough to be impossible to
4789 * find by brute force, and in particular should not be empty. But
4790 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4791 * and for this use case it makes sense to have a 0-length "secret".
4792 * Since the key API doesn't allow importing a key of length 0,
4793 * keep master_key=0, which setup_psa_key_derivation() understands
4794 * to mean a 0-length "secret" input. */
4795 if( slen != 0 )
4796 {
4797 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4798 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4799 psa_set_key_algorithm( &key_attributes, alg );
4800 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4801
4802 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4803 if( status != PSA_SUCCESS )
4804 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4805 }
4806
4807 status = setup_psa_key_derivation( &derivation,
4808 master_key, alg,
4809 random, rlen,
4810 (unsigned char const *) label,
4811 (size_t) strlen( label ),
4812 dlen );
4813 if( status != PSA_SUCCESS )
4814 {
4815 psa_key_derivation_abort( &derivation );
4816 psa_destroy_key( master_key );
4817 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4818 }
4819
4820 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4821 if( status != PSA_SUCCESS )
4822 {
4823 psa_key_derivation_abort( &derivation );
4824 psa_destroy_key( master_key );
4825 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4826 }
4827
4828 status = psa_key_derivation_abort( &derivation );
4829 if( status != PSA_SUCCESS )
4830 {
4831 psa_destroy_key( master_key );
4832 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4833 }
4834
4835 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4836 status = psa_destroy_key( master_key );
4837 if( status != PSA_SUCCESS )
4838 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4839
4840 return( 0 );
4841}
4842
4843#else /* MBEDTLS_USE_PSA_CRYPTO */
4844
4845static int tls_prf_generic( mbedtls_md_type_t md_type,
4846 const unsigned char *secret, size_t slen,
4847 const char *label,
4848 const unsigned char *random, size_t rlen,
4849 unsigned char *dstbuf, size_t dlen )
4850{
4851 size_t nb;
4852 size_t i, j, k, md_len;
4853 unsigned char *tmp;
4854 size_t tmp_len = 0;
4855 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
4856 const mbedtls_md_info_t *md_info;
4857 mbedtls_md_context_t md_ctx;
4858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4859
4860 mbedtls_md_init( &md_ctx );
4861
4862 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
4863 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4864
4865 md_len = mbedtls_md_get_size( md_info );
4866
4867 tmp_len = md_len + strlen( label ) + rlen;
4868 tmp = mbedtls_calloc( 1, tmp_len );
4869 if( tmp == NULL )
4870 {
4871 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4872 goto exit;
4873 }
4874
4875 nb = strlen( label );
4876 memcpy( tmp + md_len, label, nb );
4877 memcpy( tmp + md_len + nb, random, rlen );
4878 nb += rlen;
4879
4880 /*
4881 * Compute P_<hash>(secret, label + random)[0..dlen]
4882 */
4883 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
4884 goto exit;
4885
4886 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
4887 if( ret != 0 )
4888 goto exit;
4889 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
4890 if( ret != 0 )
4891 goto exit;
4892 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4893 if( ret != 0 )
4894 goto exit;
4895
4896 for( i = 0; i < dlen; i += md_len )
4897 {
4898 ret = mbedtls_md_hmac_reset ( &md_ctx );
4899 if( ret != 0 )
4900 goto exit;
4901 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
4902 if( ret != 0 )
4903 goto exit;
4904 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
4905 if( ret != 0 )
4906 goto exit;
4907
4908 ret = mbedtls_md_hmac_reset ( &md_ctx );
4909 if( ret != 0 )
4910 goto exit;
4911 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
4912 if( ret != 0 )
4913 goto exit;
4914 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4915 if( ret != 0 )
4916 goto exit;
4917
4918 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
4919
4920 for( j = 0; j < k; j++ )
4921 dstbuf[i + j] = h_i[j];
4922 }
4923
4924exit:
4925 mbedtls_md_free( &md_ctx );
4926
4927 mbedtls_platform_zeroize( tmp, tmp_len );
4928 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
4929
4930 mbedtls_free( tmp );
4931
4932 return( ret );
4933}
4934#endif /* MBEDTLS_USE_PSA_CRYPTO */
4935
4936#if defined(MBEDTLS_SHA256_C)
4937static int tls_prf_sha256( const unsigned char *secret, size_t slen,
4938 const char *label,
4939 const unsigned char *random, size_t rlen,
4940 unsigned char *dstbuf, size_t dlen )
4941{
4942 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
4943 label, random, rlen, dstbuf, dlen ) );
4944}
4945#endif /* MBEDTLS_SHA256_C */
4946
4947#if defined(MBEDTLS_SHA384_C)
4948static int tls_prf_sha384( const unsigned char *secret, size_t slen,
4949 const char *label,
4950 const unsigned char *random, size_t rlen,
4951 unsigned char *dstbuf, size_t dlen )
4952{
4953 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
4954 label, random, rlen, dstbuf, dlen ) );
4955}
4956#endif /* MBEDTLS_SHA384_C */
4957
Jerry Yuf009d862022-02-17 14:01:37 +08004958/*
4959 * Set appropriate PRF function and other SSL / TLS1.2 functions
4960 *
4961 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08004962 * - hash associated with the ciphersuite (only used by TLS 1.2)
4963 *
4964 * Outputs:
4965 * - the tls_prf, calc_verify and calc_finished members of handshake structure
4966 */
4967static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08004968 mbedtls_md_type_t hash )
4969{
Jerry Yuf009d862022-02-17 14:01:37 +08004970#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01004971 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08004972 {
4973 handshake->tls_prf = tls_prf_sha384;
4974 handshake->calc_verify = ssl_calc_verify_tls_sha384;
4975 handshake->calc_finished = ssl_calc_finished_tls_sha384;
4976 }
4977 else
4978#endif
4979#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08004980 {
Ronald Cron81591aa2022-03-07 09:05:51 +01004981 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004982 handshake->tls_prf = tls_prf_sha256;
4983 handshake->calc_verify = ssl_calc_verify_tls_sha256;
4984 handshake->calc_finished = ssl_calc_finished_tls_sha256;
4985 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004986#else
Jerry Yuf009d862022-02-17 14:01:37 +08004987 {
Jerry Yuf009d862022-02-17 14:01:37 +08004988 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01004989 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004990 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4991 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004992#endif
Jerry Yuf009d862022-02-17 14:01:37 +08004993
4994 return( 0 );
4995}
Jerry Yud6ab2352022-02-17 14:03:43 +08004996
4997#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
4998 defined(MBEDTLS_USE_PSA_CRYPTO)
4999static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
5000{
5001 if( ssl->conf->f_psk != NULL )
5002 {
5003 /* If we've used a callback to select the PSK,
5004 * the static configuration is irrelevant. */
5005 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
5006 return( 1 );
5007
5008 return( 0 );
5009 }
5010
5011 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5012 return( 1 );
5013
5014 return( 0 );
5015}
5016#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5017 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5018
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005019/*
5020 * Compute master secret if needed
5021 *
5022 * Parameters:
5023 * [in/out] handshake
5024 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5025 * (PSA-PSK) ciphersuite_info, psk_opaque
5026 * [out] premaster (cleared)
5027 * [out] master
5028 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5029 * debug: conf->f_dbg, conf->p_dbg
5030 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005031 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005032 */
5033static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5034 unsigned char *master,
5035 const mbedtls_ssl_context *ssl )
5036{
5037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5038
5039 /* cf. RFC 5246, Section 8.1:
5040 * "The master secret is always exactly 48 bytes in length." */
5041 size_t const master_secret_len = 48;
5042
5043#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5044 unsigned char session_hash[48];
5045#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5046
5047 /* The label for the KDF used for key expansion.
5048 * This is either "master secret" or "extended master secret"
5049 * depending on whether the Extended Master Secret extension
5050 * is used. */
5051 char const *lbl = "master secret";
5052
5053 /* The salt for the KDF used for key expansion.
5054 * - If the Extended Master Secret extension is not used,
5055 * this is ClientHello.Random + ServerHello.Random
5056 * (see Sect. 8.1 in RFC 5246).
5057 * - If the Extended Master Secret extension is used,
5058 * this is the transcript of the handshake so far.
5059 * (see Sect. 4 in RFC 7627). */
5060 unsigned char const *salt = handshake->randbytes;
5061 size_t salt_len = 64;
5062
5063#if !defined(MBEDTLS_DEBUG_C) && \
5064 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5065 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5066 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5067 ssl = NULL; /* make sure we don't use it except for those cases */
5068 (void) ssl;
5069#endif
5070
5071 if( handshake->resume != 0 )
5072 {
5073 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5074 return( 0 );
5075 }
5076
5077#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5078 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5079 {
5080 lbl = "extended master secret";
5081 salt = session_hash;
5082 handshake->calc_verify( ssl, session_hash, &salt_len );
5083
5084 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5085 session_hash, salt_len );
5086 }
5087#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5088
5089#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5090 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5091 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005092 ssl_use_opaque_psk( ssl ) == 1 )
5093 {
5094 /* Perform PSK-to-MS expansion in a single step. */
5095 psa_status_t status;
5096 psa_algorithm_t alg;
5097 mbedtls_svc_key_id_t psk;
5098 psa_key_derivation_operation_t derivation =
5099 PSA_KEY_DERIVATION_OPERATION_INIT;
5100 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5101
5102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5103
5104 psk = mbedtls_ssl_get_opaque_psk( ssl );
5105
5106 if( hash_alg == MBEDTLS_MD_SHA384 )
5107 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5108 else
5109 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5110
5111 status = setup_psa_key_derivation( &derivation, psk, alg,
5112 salt, salt_len,
5113 (unsigned char const *) lbl,
5114 (size_t) strlen( lbl ),
5115 master_secret_len );
5116 if( status != PSA_SUCCESS )
5117 {
5118 psa_key_derivation_abort( &derivation );
5119 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5120 }
5121
5122 status = psa_key_derivation_output_bytes( &derivation,
5123 master,
5124 master_secret_len );
5125 if( status != PSA_SUCCESS )
5126 {
5127 psa_key_derivation_abort( &derivation );
5128 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5129 }
5130
5131 status = psa_key_derivation_abort( &derivation );
5132 if( status != PSA_SUCCESS )
5133 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5134 }
5135 else
5136#endif
5137 {
5138 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5139 lbl, salt, salt_len,
5140 master,
5141 master_secret_len );
5142 if( ret != 0 )
5143 {
5144 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5145 return( ret );
5146 }
5147
5148 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5149 handshake->premaster,
5150 handshake->pmslen );
5151
5152 mbedtls_platform_zeroize( handshake->premaster,
5153 sizeof(handshake->premaster) );
5154 }
5155
5156 return( 0 );
5157}
5158
Jerry Yud62f87e2022-02-17 14:09:02 +08005159int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5160{
5161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5162 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5163 ssl->handshake->ciphersuite_info;
5164
5165 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5166
5167 /* Set PRF, calc_verify and calc_finished function pointers */
5168 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005169 ciphersuite_info->mac );
5170 if( ret != 0 )
5171 {
5172 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5173 return( ret );
5174 }
5175
5176 /* Compute master secret if needed */
5177 ret = ssl_compute_master( ssl->handshake,
5178 ssl->session_negotiate->master,
5179 ssl );
5180 if( ret != 0 )
5181 {
5182 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5183 return( ret );
5184 }
5185
5186 /* Swap the client and server random values:
5187 * - MS derivation wanted client+server (RFC 5246 8.1)
5188 * - key derivation wants server+client (RFC 5246 6.3) */
5189 {
5190 unsigned char tmp[64];
5191 memcpy( tmp, ssl->handshake->randbytes, 64 );
5192 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5193 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5194 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5195 }
5196
5197 /* Populate transform structure */
5198 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5199 ssl->session_negotiate->ciphersuite,
5200 ssl->session_negotiate->master,
5201#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5202 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5203 ssl->session_negotiate->encrypt_then_mac,
5204#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5205 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5206 ssl->handshake->tls_prf,
5207 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005208 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005209 ssl->conf->endpoint,
5210 ssl );
5211 if( ret != 0 )
5212 {
5213 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5214 return( ret );
5215 }
5216
5217 /* We no longer need Server/ClientHello.random values */
5218 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5219 sizeof( ssl->handshake->randbytes ) );
5220
5221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5222
5223 return( 0 );
5224}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005225
Ronald Cron4dcbca92022-03-07 10:21:40 +01005226int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5227{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005228 switch( md )
5229 {
5230#if defined(MBEDTLS_SHA384_C)
5231 case MBEDTLS_SSL_HASH_SHA384:
5232 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5233 break;
5234#endif
5235#if defined(MBEDTLS_SHA256_C)
5236 case MBEDTLS_SSL_HASH_SHA256:
5237 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5238 break;
5239#endif
5240 default:
5241 return( -1 );
5242 }
5243
Ronald Cronc2f13a02022-03-07 10:25:24 +01005244 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005245}
5246
Jerry Yu8392e0d2022-02-17 14:10:24 +08005247#if defined(MBEDTLS_SHA256_C)
5248void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5249 unsigned char *hash,
5250 size_t *hlen )
5251{
5252#if defined(MBEDTLS_USE_PSA_CRYPTO)
5253 size_t hash_size;
5254 psa_status_t status;
5255 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5256
5257 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5258 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5259 if( status != PSA_SUCCESS )
5260 {
5261 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5262 return;
5263 }
5264
5265 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5266 if( status != PSA_SUCCESS )
5267 {
5268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5269 return;
5270 }
5271
5272 *hlen = 32;
5273 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5275#else
5276 mbedtls_sha256_context sha256;
5277
5278 mbedtls_sha256_init( &sha256 );
5279
5280 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5281
5282 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5283 mbedtls_sha256_finish( &sha256, hash );
5284
5285 *hlen = 32;
5286
5287 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5288 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5289
5290 mbedtls_sha256_free( &sha256 );
5291#endif /* MBEDTLS_USE_PSA_CRYPTO */
5292 return;
5293}
5294#endif /* MBEDTLS_SHA256_C */
5295
Jerry Yuc1cb3842022-02-17 14:13:48 +08005296#if defined(MBEDTLS_SHA384_C)
5297void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5298 unsigned char *hash,
5299 size_t *hlen )
5300{
5301#if defined(MBEDTLS_USE_PSA_CRYPTO)
5302 size_t hash_size;
5303 psa_status_t status;
5304 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5305
5306 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5307 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5308 if( status != PSA_SUCCESS )
5309 {
5310 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5311 return;
5312 }
5313
5314 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5315 if( status != PSA_SUCCESS )
5316 {
5317 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5318 return;
5319 }
5320
5321 *hlen = 48;
5322 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5323 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5324#else
5325 mbedtls_sha512_context sha512;
5326
5327 mbedtls_sha512_init( &sha512 );
5328
5329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5330
5331 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5332 mbedtls_sha512_finish( &sha512, hash );
5333
5334 *hlen = 48;
5335
5336 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5338
5339 mbedtls_sha512_free( &sha512 );
5340#endif /* MBEDTLS_USE_PSA_CRYPTO */
5341 return;
5342}
5343#endif /* MBEDTLS_SHA384_C */
5344
Jerry Yuce3dca42022-02-17 14:16:37 +08005345#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5346int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5347{
5348 unsigned char *p = ssl->handshake->premaster;
5349 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5350 const unsigned char *psk = NULL;
5351 size_t psk_len = 0;
5352
5353 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5354 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5355 {
5356 /*
5357 * This should never happen because the existence of a PSK is always
5358 * checked before calling this function
5359 */
5360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5361 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5362 }
5363
5364 /*
5365 * PMS = struct {
5366 * opaque other_secret<0..2^16-1>;
5367 * opaque psk<0..2^16-1>;
5368 * };
5369 * with "other_secret" depending on the particular key exchange
5370 */
5371#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5372 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5373 {
5374 if( end - p < 2 )
5375 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5376
5377 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5378 p += 2;
5379
5380 if( end < p || (size_t)( end - p ) < psk_len )
5381 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5382
5383 memset( p, 0, psk_len );
5384 p += psk_len;
5385 }
5386 else
5387#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5388#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5389 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5390 {
5391 /*
5392 * other_secret already set by the ClientKeyExchange message,
5393 * and is 48 bytes long
5394 */
5395 if( end - p < 2 )
5396 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5397
5398 *p++ = 0;
5399 *p++ = 48;
5400 p += 48;
5401 }
5402 else
5403#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5404#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5405 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5406 {
5407 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5408 size_t len;
5409
5410 /* Write length only when we know the actual value */
5411 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5412 p + 2, end - ( p + 2 ), &len,
5413 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5414 {
5415 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5416 return( ret );
5417 }
5418 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5419 p += 2 + len;
5420
5421 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5422 }
5423 else
5424#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5425#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5426 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5427 {
5428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5429 size_t zlen;
5430
5431 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5432 p + 2, end - ( p + 2 ),
5433 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5434 {
5435 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5436 return( ret );
5437 }
5438
5439 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5440 p += 2 + zlen;
5441
5442 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5443 MBEDTLS_DEBUG_ECDH_Z );
5444 }
5445 else
5446#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5447 {
5448 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5449 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5450 }
5451
5452 /* opaque psk<0..2^16-1>; */
5453 if( end - p < 2 )
5454 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5455
5456 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5457 p += 2;
5458
5459 if( end < p || (size_t)( end - p ) < psk_len )
5460 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5461
5462 memcpy( p, psk, psk_len );
5463 p += psk_len;
5464
5465 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5466
5467 return( 0 );
5468}
5469#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005470
5471#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5472static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5473
5474#if defined(MBEDTLS_SSL_PROTO_DTLS)
5475int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5476{
5477 /* If renegotiation is not enforced, retransmit until we would reach max
5478 * timeout if we were using the usual handshake doubling scheme */
5479 if( ssl->conf->renego_max_records < 0 )
5480 {
5481 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5482 unsigned char doublings = 1;
5483
5484 while( ratio != 0 )
5485 {
5486 ++doublings;
5487 ratio >>= 1;
5488 }
5489
5490 if( ++ssl->renego_records_seen > doublings )
5491 {
5492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5493 return( 0 );
5494 }
5495 }
5496
5497 return( ssl_write_hello_request( ssl ) );
5498}
5499#endif
5500#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005501
Jerry Yud9526692022-02-17 14:23:47 +08005502/*
5503 * Handshake functions
5504 */
5505#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5506/* No certificate support -> dummy functions */
5507int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5508{
5509 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5510 ssl->handshake->ciphersuite_info;
5511
5512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5513
5514 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5515 {
5516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5517 ssl->state++;
5518 return( 0 );
5519 }
5520
5521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5522 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5523}
5524
5525int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5526{
5527 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5528 ssl->handshake->ciphersuite_info;
5529
5530 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5531
5532 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5533 {
5534 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5535 ssl->state++;
5536 return( 0 );
5537 }
5538
5539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5540 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5541}
5542
5543#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5544/* Some certificate support -> implement write and parse */
5545
5546int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5547{
5548 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5549 size_t i, n;
5550 const mbedtls_x509_crt *crt;
5551 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5552 ssl->handshake->ciphersuite_info;
5553
5554 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5555
5556 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5557 {
5558 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5559 ssl->state++;
5560 return( 0 );
5561 }
5562
5563#if defined(MBEDTLS_SSL_CLI_C)
5564 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5565 {
5566 if( ssl->handshake->client_auth == 0 )
5567 {
5568 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5569 ssl->state++;
5570 return( 0 );
5571 }
5572 }
5573#endif /* MBEDTLS_SSL_CLI_C */
5574#if defined(MBEDTLS_SSL_SRV_C)
5575 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5576 {
5577 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5578 {
5579 /* Should never happen because we shouldn't have picked the
5580 * ciphersuite if we don't have a certificate. */
5581 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5582 }
5583 }
5584#endif
5585
5586 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5587
5588 /*
5589 * 0 . 0 handshake type
5590 * 1 . 3 handshake length
5591 * 4 . 6 length of all certs
5592 * 7 . 9 length of cert. 1
5593 * 10 . n-1 peer certificate
5594 * n . n+2 length of cert. 2
5595 * n+3 . ... upper level cert, etc.
5596 */
5597 i = 7;
5598 crt = mbedtls_ssl_own_cert( ssl );
5599
5600 while( crt != NULL )
5601 {
5602 n = crt->raw.len;
5603 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5604 {
5605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5606 " > %" MBEDTLS_PRINTF_SIZET,
5607 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5608 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5609 }
5610
5611 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5612 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5613 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5614
5615 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5616 i += n; crt = crt->next;
5617 }
5618
5619 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5620 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5621 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5622
5623 ssl->out_msglen = i;
5624 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5625 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5626
5627 ssl->state++;
5628
5629 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5630 {
5631 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5632 return( ret );
5633 }
5634
5635 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5636
5637 return( ret );
5638}
5639
5640#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5641
5642#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5643static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5644 unsigned char *crt_buf,
5645 size_t crt_buf_len )
5646{
5647 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5648
5649 if( peer_crt == NULL )
5650 return( -1 );
5651
5652 if( peer_crt->raw.len != crt_buf_len )
5653 return( -1 );
5654
5655 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5656}
5657#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5658static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5659 unsigned char *crt_buf,
5660 size_t crt_buf_len )
5661{
5662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5663 unsigned char const * const peer_cert_digest =
5664 ssl->session->peer_cert_digest;
5665 mbedtls_md_type_t const peer_cert_digest_type =
5666 ssl->session->peer_cert_digest_type;
5667 mbedtls_md_info_t const * const digest_info =
5668 mbedtls_md_info_from_type( peer_cert_digest_type );
5669 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5670 size_t digest_len;
5671
5672 if( peer_cert_digest == NULL || digest_info == NULL )
5673 return( -1 );
5674
5675 digest_len = mbedtls_md_get_size( digest_info );
5676 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5677 return( -1 );
5678
5679 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5680 if( ret != 0 )
5681 return( -1 );
5682
5683 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5684}
5685#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5686#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5687
5688/*
5689 * Once the certificate message is read, parse it into a cert chain and
5690 * perform basic checks, but leave actual verification to the caller
5691 */
5692static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5693 mbedtls_x509_crt *chain )
5694{
5695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5696#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5697 int crt_cnt=0;
5698#endif
5699 size_t i, n;
5700 uint8_t alert;
5701
5702 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5703 {
5704 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5705 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5706 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5707 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5708 }
5709
5710 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5711 {
5712 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5713 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5714 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5715 }
5716
5717 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5718 {
5719 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5720 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5721 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5722 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5723 }
5724
5725 i = mbedtls_ssl_hs_hdr_len( ssl );
5726
5727 /*
5728 * Same message structure as in mbedtls_ssl_write_certificate()
5729 */
5730 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5731
5732 if( ssl->in_msg[i] != 0 ||
5733 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5734 {
5735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5736 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5737 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5738 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5739 }
5740
5741 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5742 i += 3;
5743
5744 /* Iterate through and parse the CRTs in the provided chain. */
5745 while( i < ssl->in_hslen )
5746 {
5747 /* Check that there's room for the next CRT's length fields. */
5748 if ( i + 3 > ssl->in_hslen ) {
5749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5750 mbedtls_ssl_send_alert_message( ssl,
5751 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5752 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5753 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5754 }
5755 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5756 * anything beyond 2**16 ~ 64K. */
5757 if( ssl->in_msg[i] != 0 )
5758 {
5759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5760 mbedtls_ssl_send_alert_message( ssl,
5761 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5762 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5763 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5764 }
5765
5766 /* Read length of the next CRT in the chain. */
5767 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5768 | (unsigned int) ssl->in_msg[i + 2];
5769 i += 3;
5770
5771 if( n < 128 || i + n > ssl->in_hslen )
5772 {
5773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5774 mbedtls_ssl_send_alert_message( ssl,
5775 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5776 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5777 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5778 }
5779
5780 /* Check if we're handling the first CRT in the chain. */
5781#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5782 if( crt_cnt++ == 0 &&
5783 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5784 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5785 {
5786 /* During client-side renegotiation, check that the server's
5787 * end-CRTs hasn't changed compared to the initial handshake,
5788 * mitigating the triple handshake attack. On success, reuse
5789 * the original end-CRT instead of parsing it again. */
5790 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5791 if( ssl_check_peer_crt_unchanged( ssl,
5792 &ssl->in_msg[i],
5793 n ) != 0 )
5794 {
5795 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5796 mbedtls_ssl_send_alert_message( ssl,
5797 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5798 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5799 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5800 }
5801
5802 /* Now we can safely free the original chain. */
5803 ssl_clear_peer_cert( ssl->session );
5804 }
5805#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5806
5807 /* Parse the next certificate in the chain. */
5808#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5809 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5810#else
5811 /* If we don't need to store the CRT chain permanently, parse
5812 * it in-place from the input buffer instead of making a copy. */
5813 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5814#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5815 switch( ret )
5816 {
5817 case 0: /*ok*/
5818 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5819 /* Ignore certificate with an unknown algorithm: maybe a
5820 prior certificate was already trusted. */
5821 break;
5822
5823 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5824 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5825 goto crt_parse_der_failed;
5826
5827 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5828 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5829 goto crt_parse_der_failed;
5830
5831 default:
5832 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5833 crt_parse_der_failed:
5834 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5835 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5836 return( ret );
5837 }
5838
5839 i += n;
5840 }
5841
5842 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
5843 return( 0 );
5844}
5845
5846#if defined(MBEDTLS_SSL_SRV_C)
5847static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
5848{
5849 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5850 return( -1 );
5851
5852 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
5853 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
5854 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
5855 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
5856 {
5857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
5858 return( 0 );
5859 }
5860 return( -1 );
5861}
5862#endif /* MBEDTLS_SSL_SRV_C */
5863
5864/* Check if a certificate message is expected.
5865 * Return either
5866 * - SSL_CERTIFICATE_EXPECTED, or
5867 * - SSL_CERTIFICATE_SKIP
5868 * indicating whether a Certificate message is expected or not.
5869 */
5870#define SSL_CERTIFICATE_EXPECTED 0
5871#define SSL_CERTIFICATE_SKIP 1
5872static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
5873 int authmode )
5874{
5875 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5876 ssl->handshake->ciphersuite_info;
5877
5878 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5879 return( SSL_CERTIFICATE_SKIP );
5880
5881#if defined(MBEDTLS_SSL_SRV_C)
5882 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5883 {
5884 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5885 return( SSL_CERTIFICATE_SKIP );
5886
5887 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5888 {
5889 ssl->session_negotiate->verify_result =
5890 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
5891 return( SSL_CERTIFICATE_SKIP );
5892 }
5893 }
5894#else
5895 ((void) authmode);
5896#endif /* MBEDTLS_SSL_SRV_C */
5897
5898 return( SSL_CERTIFICATE_EXPECTED );
5899}
5900
5901static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
5902 int authmode,
5903 mbedtls_x509_crt *chain,
5904 void *rs_ctx )
5905{
5906 int ret = 0;
5907 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5908 ssl->handshake->ciphersuite_info;
5909 int have_ca_chain = 0;
5910
5911 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
5912 void *p_vrfy;
5913
5914 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5915 return( 0 );
5916
5917 if( ssl->f_vrfy != NULL )
5918 {
5919 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
5920 f_vrfy = ssl->f_vrfy;
5921 p_vrfy = ssl->p_vrfy;
5922 }
5923 else
5924 {
5925 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
5926 f_vrfy = ssl->conf->f_vrfy;
5927 p_vrfy = ssl->conf->p_vrfy;
5928 }
5929
5930 /*
5931 * Main check: verify certificate
5932 */
5933#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
5934 if( ssl->conf->f_ca_cb != NULL )
5935 {
5936 ((void) rs_ctx);
5937 have_ca_chain = 1;
5938
5939 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
5940 ret = mbedtls_x509_crt_verify_with_ca_cb(
5941 chain,
5942 ssl->conf->f_ca_cb,
5943 ssl->conf->p_ca_cb,
5944 ssl->conf->cert_profile,
5945 ssl->hostname,
5946 &ssl->session_negotiate->verify_result,
5947 f_vrfy, p_vrfy );
5948 }
5949 else
5950#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
5951 {
5952 mbedtls_x509_crt *ca_chain;
5953 mbedtls_x509_crl *ca_crl;
5954
5955#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
5956 if( ssl->handshake->sni_ca_chain != NULL )
5957 {
5958 ca_chain = ssl->handshake->sni_ca_chain;
5959 ca_crl = ssl->handshake->sni_ca_crl;
5960 }
5961 else
5962#endif
5963 {
5964 ca_chain = ssl->conf->ca_chain;
5965 ca_crl = ssl->conf->ca_crl;
5966 }
5967
5968 if( ca_chain != NULL )
5969 have_ca_chain = 1;
5970
5971 ret = mbedtls_x509_crt_verify_restartable(
5972 chain,
5973 ca_chain, ca_crl,
5974 ssl->conf->cert_profile,
5975 ssl->hostname,
5976 &ssl->session_negotiate->verify_result,
5977 f_vrfy, p_vrfy, rs_ctx );
5978 }
5979
5980 if( ret != 0 )
5981 {
5982 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
5983 }
5984
5985#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
5986 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
5987 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
5988#endif
5989
5990 /*
5991 * Secondary checks: always done, but change 'ret' only if it was 0
5992 */
5993
5994#if defined(MBEDTLS_ECP_C)
5995 {
5996 const mbedtls_pk_context *pk = &chain->pk;
5997
5998 /* If certificate uses an EC key, make sure the curve is OK */
5999 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6000 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6001 {
6002 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6003
6004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6005 if( ret == 0 )
6006 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6007 }
6008 }
6009#endif /* MBEDTLS_ECP_C */
6010
6011 if( mbedtls_ssl_check_cert_usage( chain,
6012 ciphersuite_info,
6013 ! ssl->conf->endpoint,
6014 &ssl->session_negotiate->verify_result ) != 0 )
6015 {
6016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6017 if( ret == 0 )
6018 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6019 }
6020
6021 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6022 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6023 * with details encoded in the verification flags. All other kinds
6024 * of error codes, including those from the user provided f_vrfy
6025 * functions, are treated as fatal and lead to a failure of
6026 * ssl_parse_certificate even if verification was optional. */
6027 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6028 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6029 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6030 {
6031 ret = 0;
6032 }
6033
6034 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6035 {
6036 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6037 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6038 }
6039
6040 if( ret != 0 )
6041 {
6042 uint8_t alert;
6043
6044 /* The certificate may have been rejected for several reasons.
6045 Pick one and send the corresponding alert. Which alert to send
6046 may be a subject of debate in some cases. */
6047 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6048 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6049 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6050 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6051 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6052 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6053 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6054 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6055 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6056 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6057 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6058 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6059 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6060 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6061 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6062 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6063 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6064 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6065 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6066 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6067 else
6068 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6069 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6070 alert );
6071 }
6072
6073#if defined(MBEDTLS_DEBUG_C)
6074 if( ssl->session_negotiate->verify_result != 0 )
6075 {
6076 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6077 (unsigned int) ssl->session_negotiate->verify_result ) );
6078 }
6079 else
6080 {
6081 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6082 }
6083#endif /* MBEDTLS_DEBUG_C */
6084
6085 return( ret );
6086}
6087
6088#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6089static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6090 unsigned char *start, size_t len )
6091{
6092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6093 /* Remember digest of the peer's end-CRT. */
6094 ssl->session_negotiate->peer_cert_digest =
6095 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6096 if( ssl->session_negotiate->peer_cert_digest == NULL )
6097 {
6098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6099 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6100 mbedtls_ssl_send_alert_message( ssl,
6101 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6102 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6103
6104 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6105 }
6106
6107 ret = mbedtls_md( mbedtls_md_info_from_type(
6108 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6109 start, len,
6110 ssl->session_negotiate->peer_cert_digest );
6111
6112 ssl->session_negotiate->peer_cert_digest_type =
6113 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6114 ssl->session_negotiate->peer_cert_digest_len =
6115 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6116
6117 return( ret );
6118}
6119
6120static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6121 unsigned char *start, size_t len )
6122{
6123 unsigned char *end = start + len;
6124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6125
6126 /* Make a copy of the peer's raw public key. */
6127 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6128 ret = mbedtls_pk_parse_subpubkey( &start, end,
6129 &ssl->handshake->peer_pubkey );
6130 if( ret != 0 )
6131 {
6132 /* We should have parsed the public key before. */
6133 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6134 }
6135
6136 return( 0 );
6137}
6138#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6139
6140int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6141{
6142 int ret = 0;
6143 int crt_expected;
6144#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6145 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6146 ? ssl->handshake->sni_authmode
6147 : ssl->conf->authmode;
6148#else
6149 const int authmode = ssl->conf->authmode;
6150#endif
6151 void *rs_ctx = NULL;
6152 mbedtls_x509_crt *chain = NULL;
6153
6154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6155
6156 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6157 if( crt_expected == SSL_CERTIFICATE_SKIP )
6158 {
6159 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6160 goto exit;
6161 }
6162
6163#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6164 if( ssl->handshake->ecrs_enabled &&
6165 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6166 {
6167 chain = ssl->handshake->ecrs_peer_cert;
6168 ssl->handshake->ecrs_peer_cert = NULL;
6169 goto crt_verify;
6170 }
6171#endif
6172
6173 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6174 {
6175 /* mbedtls_ssl_read_record may have sent an alert already. We
6176 let it decide whether to alert. */
6177 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6178 goto exit;
6179 }
6180
6181#if defined(MBEDTLS_SSL_SRV_C)
6182 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6183 {
6184 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6185
6186 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6187 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6188
6189 goto exit;
6190 }
6191#endif /* MBEDTLS_SSL_SRV_C */
6192
6193 /* Clear existing peer CRT structure in case we tried to
6194 * reuse a session but it failed, and allocate a new one. */
6195 ssl_clear_peer_cert( ssl->session_negotiate );
6196
6197 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6198 if( chain == NULL )
6199 {
6200 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6201 sizeof( mbedtls_x509_crt ) ) );
6202 mbedtls_ssl_send_alert_message( ssl,
6203 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6204 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6205
6206 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6207 goto exit;
6208 }
6209 mbedtls_x509_crt_init( chain );
6210
6211 ret = ssl_parse_certificate_chain( ssl, chain );
6212 if( ret != 0 )
6213 goto exit;
6214
6215#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6216 if( ssl->handshake->ecrs_enabled)
6217 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6218
6219crt_verify:
6220 if( ssl->handshake->ecrs_enabled)
6221 rs_ctx = &ssl->handshake->ecrs_ctx;
6222#endif
6223
6224 ret = ssl_parse_certificate_verify( ssl, authmode,
6225 chain, rs_ctx );
6226 if( ret != 0 )
6227 goto exit;
6228
6229#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6230 {
6231 unsigned char *crt_start, *pk_start;
6232 size_t crt_len, pk_len;
6233
6234 /* We parse the CRT chain without copying, so
6235 * these pointers point into the input buffer,
6236 * and are hence still valid after freeing the
6237 * CRT chain. */
6238
6239 crt_start = chain->raw.p;
6240 crt_len = chain->raw.len;
6241
6242 pk_start = chain->pk_raw.p;
6243 pk_len = chain->pk_raw.len;
6244
6245 /* Free the CRT structures before computing
6246 * digest and copying the peer's public key. */
6247 mbedtls_x509_crt_free( chain );
6248 mbedtls_free( chain );
6249 chain = NULL;
6250
6251 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6252 if( ret != 0 )
6253 goto exit;
6254
6255 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6256 if( ret != 0 )
6257 goto exit;
6258 }
6259#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6260 /* Pass ownership to session structure. */
6261 ssl->session_negotiate->peer_cert = chain;
6262 chain = NULL;
6263#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6264
6265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6266
6267exit:
6268
6269 if( ret == 0 )
6270 ssl->state++;
6271
6272#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6273 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6274 {
6275 ssl->handshake->ecrs_peer_cert = chain;
6276 chain = NULL;
6277 }
6278#endif
6279
6280 if( chain != NULL )
6281 {
6282 mbedtls_x509_crt_free( chain );
6283 mbedtls_free( chain );
6284 }
6285
6286 return( ret );
6287}
6288#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6289
Jerry Yu615bd6f2022-02-17 14:25:15 +08006290#if defined(MBEDTLS_SHA256_C)
6291static void ssl_calc_finished_tls_sha256(
6292 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6293{
6294 int len = 12;
6295 const char *sender;
6296 unsigned char padbuf[32];
6297#if defined(MBEDTLS_USE_PSA_CRYPTO)
6298 size_t hash_size;
6299 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6300 psa_status_t status;
6301#else
6302 mbedtls_sha256_context sha256;
6303#endif
6304
6305 mbedtls_ssl_session *session = ssl->session_negotiate;
6306 if( !session )
6307 session = ssl->session;
6308
6309 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6310 ? "client finished"
6311 : "server finished";
6312
6313#if defined(MBEDTLS_USE_PSA_CRYPTO)
6314 sha256_psa = psa_hash_operation_init();
6315
6316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6317
6318 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6319 if( status != PSA_SUCCESS )
6320 {
6321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6322 return;
6323 }
6324
6325 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6326 if( status != PSA_SUCCESS )
6327 {
6328 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6329 return;
6330 }
6331 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6332#else
6333
6334 mbedtls_sha256_init( &sha256 );
6335
6336 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6337
6338 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6339
6340 /*
6341 * TLSv1.2:
6342 * hash = PRF( master, finished_label,
6343 * Hash( handshake ) )[0.11]
6344 */
6345
6346#if !defined(MBEDTLS_SHA256_ALT)
6347 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6348 sha256.state, sizeof( sha256.state ) );
6349#endif
6350
6351 mbedtls_sha256_finish( &sha256, padbuf );
6352 mbedtls_sha256_free( &sha256 );
6353#endif /* MBEDTLS_USE_PSA_CRYPTO */
6354
6355 ssl->handshake->tls_prf( session->master, 48, sender,
6356 padbuf, 32, buf, len );
6357
6358 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6359
6360 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6361
6362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6363}
6364#endif /* MBEDTLS_SHA256_C */
6365
Jerry Yub7ba49e2022-02-17 14:25:53 +08006366
6367#if defined(MBEDTLS_SHA384_C)
6368
6369static void ssl_calc_finished_tls_sha384(
6370 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6371{
6372 int len = 12;
6373 const char *sender;
6374 unsigned char padbuf[48];
6375#if defined(MBEDTLS_USE_PSA_CRYPTO)
6376 size_t hash_size;
6377 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6378 psa_status_t status;
6379#else
6380 mbedtls_sha512_context sha512;
6381#endif
6382
6383 mbedtls_ssl_session *session = ssl->session_negotiate;
6384 if( !session )
6385 session = ssl->session;
6386
6387 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6388 ? "client finished"
6389 : "server finished";
6390
6391#if defined(MBEDTLS_USE_PSA_CRYPTO)
6392 sha384_psa = psa_hash_operation_init();
6393
6394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6395
6396 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6397 if( status != PSA_SUCCESS )
6398 {
6399 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6400 return;
6401 }
6402
6403 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6404 if( status != PSA_SUCCESS )
6405 {
6406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6407 return;
6408 }
6409 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6410#else
6411 mbedtls_sha512_init( &sha512 );
6412
6413 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6414
6415 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6416
6417 /*
6418 * TLSv1.2:
6419 * hash = PRF( master, finished_label,
6420 * Hash( handshake ) )[0.11]
6421 */
6422
6423#if !defined(MBEDTLS_SHA512_ALT)
6424 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6425 sha512.state, sizeof( sha512.state ) );
6426#endif
6427 mbedtls_sha512_finish( &sha512, padbuf );
6428
6429 mbedtls_sha512_free( &sha512 );
6430#endif
6431
6432 ssl->handshake->tls_prf( session->master, 48, sender,
6433 padbuf, 48, buf, len );
6434
6435 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6436
6437 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6438
6439 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6440}
6441#endif /* MBEDTLS_SHA384_C */
6442
Jerry Yuaef00152022-02-17 14:27:31 +08006443void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6444{
6445 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6446
6447 /*
6448 * Free our handshake params
6449 */
6450 mbedtls_ssl_handshake_free( ssl );
6451 mbedtls_free( ssl->handshake );
6452 ssl->handshake = NULL;
6453
6454 /*
6455 * Free the previous transform and swith in the current one
6456 */
6457 if( ssl->transform )
6458 {
6459 mbedtls_ssl_transform_free( ssl->transform );
6460 mbedtls_free( ssl->transform );
6461 }
6462 ssl->transform = ssl->transform_negotiate;
6463 ssl->transform_negotiate = NULL;
6464
6465 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6466}
6467
Jerry Yu2a9fff52022-02-17 14:28:51 +08006468void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6469{
6470 int resume = ssl->handshake->resume;
6471
6472 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6473
6474#if defined(MBEDTLS_SSL_RENEGOTIATION)
6475 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6476 {
6477 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6478 ssl->renego_records_seen = 0;
6479 }
6480#endif
6481
6482 /*
6483 * Free the previous session and switch in the current one
6484 */
6485 if( ssl->session )
6486 {
6487#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6488 /* RFC 7366 3.1: keep the EtM state */
6489 ssl->session_negotiate->encrypt_then_mac =
6490 ssl->session->encrypt_then_mac;
6491#endif
6492
6493 mbedtls_ssl_session_free( ssl->session );
6494 mbedtls_free( ssl->session );
6495 }
6496 ssl->session = ssl->session_negotiate;
6497 ssl->session_negotiate = NULL;
6498
6499 /*
6500 * Add cache entry
6501 */
6502 if( ssl->conf->f_set_cache != NULL &&
6503 ssl->session->id_len != 0 &&
6504 resume == 0 )
6505 {
6506 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6507 ssl->session->id,
6508 ssl->session->id_len,
6509 ssl->session ) != 0 )
6510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6511 }
6512
6513#if defined(MBEDTLS_SSL_PROTO_DTLS)
6514 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6515 ssl->handshake->flight != NULL )
6516 {
6517 /* Cancel handshake timer */
6518 mbedtls_ssl_set_timer( ssl, 0 );
6519
6520 /* Keep last flight around in case we need to resend it:
6521 * we need the handshake and transform structures for that */
6522 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6523 }
6524 else
6525#endif
6526 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6527
6528 ssl->state++;
6529
6530 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6531}
6532
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006533int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6534{
6535 int ret, hash_len;
6536
6537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6538
6539 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6540
6541 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6542
6543 /*
6544 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6545 * may define some other value. Currently (early 2016), no defined
6546 * ciphersuite does this (and this is unlikely to change as activity has
6547 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6548 */
6549 hash_len = 12;
6550
6551#if defined(MBEDTLS_SSL_RENEGOTIATION)
6552 ssl->verify_data_len = hash_len;
6553 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6554#endif
6555
6556 ssl->out_msglen = 4 + hash_len;
6557 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6558 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6559
6560 /*
6561 * In case of session resuming, invert the client and server
6562 * ChangeCipherSpec messages order.
6563 */
6564 if( ssl->handshake->resume != 0 )
6565 {
6566#if defined(MBEDTLS_SSL_CLI_C)
6567 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6568 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6569#endif
6570#if defined(MBEDTLS_SSL_SRV_C)
6571 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6572 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6573#endif
6574 }
6575 else
6576 ssl->state++;
6577
6578 /*
6579 * Switch to our negotiated transform and session parameters for outbound
6580 * data.
6581 */
6582 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6583
6584#if defined(MBEDTLS_SSL_PROTO_DTLS)
6585 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6586 {
6587 unsigned char i;
6588
6589 /* Remember current epoch settings for resending */
6590 ssl->handshake->alt_transform_out = ssl->transform_out;
6591 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6592 sizeof( ssl->handshake->alt_out_ctr ) );
6593
6594 /* Set sequence_number to zero */
6595 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6596
6597
6598 /* Increment epoch */
6599 for( i = 2; i > 0; i-- )
6600 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6601 break;
6602
6603 /* The loop goes to its end iff the counter is wrapping */
6604 if( i == 0 )
6605 {
6606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6607 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6608 }
6609 }
6610 else
6611#endif /* MBEDTLS_SSL_PROTO_DTLS */
6612 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6613
6614 ssl->transform_out = ssl->transform_negotiate;
6615 ssl->session_out = ssl->session_negotiate;
6616
6617#if defined(MBEDTLS_SSL_PROTO_DTLS)
6618 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6619 mbedtls_ssl_send_flight_completed( ssl );
6620#endif
6621
6622 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6623 {
6624 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6625 return( ret );
6626 }
6627
6628#if defined(MBEDTLS_SSL_PROTO_DTLS)
6629 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6630 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6631 {
6632 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6633 return( ret );
6634 }
6635#endif
6636
6637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6638
6639 return( 0 );
6640}
6641
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006642#define SSL_MAX_HASH_LEN 12
6643
6644int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6645{
6646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6647 unsigned int hash_len = 12;
6648 unsigned char buf[SSL_MAX_HASH_LEN];
6649
6650 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6651
6652 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6653
6654 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6655 {
6656 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6657 goto exit;
6658 }
6659
6660 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6661 {
6662 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6663 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6664 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6665 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6666 goto exit;
6667 }
6668
6669 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6670 {
6671 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6672 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6673 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6674 goto exit;
6675 }
6676
6677 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6678 {
6679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6680 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6681 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6682 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6683 goto exit;
6684 }
6685
6686 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6687 buf, hash_len ) != 0 )
6688 {
6689 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6690 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6691 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6692 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6693 goto exit;
6694 }
6695
6696#if defined(MBEDTLS_SSL_RENEGOTIATION)
6697 ssl->verify_data_len = hash_len;
6698 memcpy( ssl->peer_verify_data, buf, hash_len );
6699#endif
6700
6701 if( ssl->handshake->resume != 0 )
6702 {
6703#if defined(MBEDTLS_SSL_CLI_C)
6704 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6705 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6706#endif
6707#if defined(MBEDTLS_SSL_SRV_C)
6708 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6709 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6710#endif
6711 }
6712 else
6713 ssl->state++;
6714
6715#if defined(MBEDTLS_SSL_PROTO_DTLS)
6716 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6717 mbedtls_ssl_recv_flight_completed( ssl );
6718#endif
6719
6720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6721
6722exit:
6723 mbedtls_platform_zeroize( buf, hash_len );
6724 return( ret );
6725}
6726
Jerry Yu392112c2022-02-17 14:34:10 +08006727#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6728/*
6729 * Helper to get TLS 1.2 PRF from ciphersuite
6730 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6731 */
6732static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6733{
6734#if defined(MBEDTLS_SHA384_C)
6735 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6736 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6737
6738 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6739 return( tls_prf_sha384 );
6740#else
6741 (void) ciphersuite_id;
6742#endif
6743 return( tls_prf_sha256 );
6744}
6745#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006746
6747static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6748{
6749 ((void) tls_prf);
6750#if defined(MBEDTLS_SHA384_C)
6751 if( tls_prf == tls_prf_sha384 )
6752 {
6753 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6754 }
6755 else
6756#endif
6757#if defined(MBEDTLS_SHA256_C)
6758 if( tls_prf == tls_prf_sha256 )
6759 {
6760 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6761 }
6762 else
6763#endif
6764 return( MBEDTLS_SSL_TLS_PRF_NONE );
6765}
6766
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006767/*
6768 * Populate a transform structure with session keys and all the other
6769 * necessary information.
6770 *
6771 * Parameters:
6772 * - [in/out]: transform: structure to populate
6773 * [in] must be just initialised with mbedtls_ssl_transform_init()
6774 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6775 * - [in] ciphersuite
6776 * - [in] master
6777 * - [in] encrypt_then_mac
6778 * - [in] compression
6779 * - [in] tls_prf: pointer to PRF to use for key derivation
6780 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006781 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006782 * - [in] endpoint: client or server
6783 * - [in] ssl: used for:
6784 * - ssl->conf->{f,p}_export_keys
6785 * [in] optionally used for:
6786 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6787 */
6788static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6789 int ciphersuite,
6790 const unsigned char master[48],
6791#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6792 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6793 int encrypt_then_mac,
6794#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6795 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6796 ssl_tls_prf_t tls_prf,
6797 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006798 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006799 unsigned endpoint,
6800 const mbedtls_ssl_context *ssl )
6801{
6802 int ret = 0;
6803 unsigned char keyblk[256];
6804 unsigned char *key1;
6805 unsigned char *key2;
6806 unsigned char *mac_enc;
6807 unsigned char *mac_dec;
6808 size_t mac_key_len = 0;
6809 size_t iv_copy_len;
6810 size_t keylen;
6811 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
6812 const mbedtls_cipher_info_t *cipher_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006813#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006814 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006815#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006816
6817#if defined(MBEDTLS_USE_PSA_CRYPTO)
6818 psa_key_type_t key_type;
6819 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6820 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006821 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006822 size_t key_bits;
6823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6824#endif
6825
6826#if !defined(MBEDTLS_DEBUG_C) && \
6827 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6828 if( ssl->f_export_keys == NULL )
6829 {
6830 ssl = NULL; /* make sure we don't use it except for these cases */
6831 (void) ssl;
6832 }
6833#endif
6834
6835 /*
6836 * Some data just needs copying into the structure
6837 */
6838#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
6839 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6840 transform->encrypt_then_mac = encrypt_then_mac;
6841#endif
Glenn Strauss07c64162022-03-14 12:34:51 -04006842 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006843
6844#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6845 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
6846#endif
6847
6848#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04006849 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006850 {
6851 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
6852 * generation separate. This should never happen. */
6853 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6854 }
6855#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6856
6857 /*
6858 * Get various info structures
6859 */
6860 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
6861 if( ciphersuite_info == NULL )
6862 {
6863 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
6864 ciphersuite ) );
6865 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6866 }
6867
6868 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
6869 if( cipher_info == NULL )
6870 {
6871 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
6872 ciphersuite_info->cipher ) );
6873 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6874 }
6875
Neil Armstronge4512952022-03-08 09:08:22 +01006876#if defined(MBEDTLS_USE_PSA_CRYPTO)
6877 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
6878 if( mac_alg == 0 )
6879 {
6880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
6881 (unsigned) ciphersuite_info->mac ) );
6882 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6883 }
6884#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006885 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
6886 if( md_info == NULL )
6887 {
6888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
6889 (unsigned) ciphersuite_info->mac ) );
6890 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6891 }
Neil Armstronge4512952022-03-08 09:08:22 +01006892#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006893
6894#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6895 /* Copy own and peer's CID if the use of the CID
6896 * extension has been negotiated. */
6897 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
6898 {
6899 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
6900
6901 transform->in_cid_len = ssl->own_cid_len;
6902 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
6903 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
6904 transform->in_cid_len );
6905
6906 transform->out_cid_len = ssl->handshake->peer_cid_len;
6907 memcpy( transform->out_cid, ssl->handshake->peer_cid,
6908 ssl->handshake->peer_cid_len );
6909 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
6910 transform->out_cid_len );
6911 }
6912#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
6913
6914 /*
6915 * Compute key block using the PRF
6916 */
6917 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
6918 if( ret != 0 )
6919 {
6920 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6921 return( ret );
6922 }
6923
6924 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
6925 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
6926 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
6927 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
6928 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
6929
6930 /*
6931 * Determine the appropriate key, IV and MAC length.
6932 */
6933
6934 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
6935
6936#if defined(MBEDTLS_GCM_C) || \
6937 defined(MBEDTLS_CCM_C) || \
6938 defined(MBEDTLS_CHACHAPOLY_C)
6939 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
6940 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
6941 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6942 {
6943 size_t explicit_ivlen;
6944
6945 transform->maclen = 0;
6946 mac_key_len = 0;
6947 transform->taglen =
6948 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
6949
6950 /* All modes haves 96-bit IVs, but the length of the static parts vary
6951 * with mode and version:
6952 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
6953 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
6954 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
6955 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
6956 * sequence number).
6957 */
6958 transform->ivlen = 12;
6959 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6960 transform->fixed_ivlen = 12;
6961 else
6962 transform->fixed_ivlen = 4;
6963
6964 /* Minimum length of encrypted record */
6965 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
6966 transform->minlen = explicit_ivlen + transform->taglen;
6967 }
6968 else
6969#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
6970#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6971 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
6972 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
6973 {
Neil Armstronge4512952022-03-08 09:08:22 +01006974#if defined(MBEDTLS_USE_PSA_CRYPTO)
6975 /* Get MAC length */
6976 mac_key_len = PSA_HASH_LENGTH(mac_alg);
6977#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006978 /* Initialize HMAC contexts */
6979 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
6980 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
6981 {
6982 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
6983 goto end;
6984 }
6985
6986 /* Get MAC length */
6987 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01006988#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006989 transform->maclen = mac_key_len;
6990
6991 /* IV length */
6992 transform->ivlen = cipher_info->iv_size;
6993
6994 /* Minimum length */
6995 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
6996 transform->minlen = transform->maclen;
6997 else
6998 {
6999 /*
7000 * GenericBlockCipher:
7001 * 1. if EtM is in use: one block plus MAC
7002 * otherwise: * first multiple of blocklen greater than maclen
7003 * 2. IV
7004 */
7005#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7006 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
7007 {
7008 transform->minlen = transform->maclen
7009 + cipher_info->block_size;
7010 }
7011 else
7012#endif
7013 {
7014 transform->minlen = transform->maclen
7015 + cipher_info->block_size
7016 - transform->maclen % cipher_info->block_size;
7017 }
7018
Glenn Strauss07c64162022-03-14 12:34:51 -04007019 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007020 {
7021 transform->minlen += transform->ivlen;
7022 }
7023 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007024 {
7025 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7026 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7027 goto end;
7028 }
7029 }
7030 }
7031 else
7032#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7033 {
7034 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7035 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7036 }
7037
7038 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7039 (unsigned) keylen,
7040 (unsigned) transform->minlen,
7041 (unsigned) transform->ivlen,
7042 (unsigned) transform->maclen ) );
7043
7044 /*
7045 * Finally setup the cipher contexts, IVs and MAC secrets.
7046 */
7047#if defined(MBEDTLS_SSL_CLI_C)
7048 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7049 {
7050 key1 = keyblk + mac_key_len * 2;
7051 key2 = keyblk + mac_key_len * 2 + keylen;
7052
7053 mac_enc = keyblk;
7054 mac_dec = keyblk + mac_key_len;
7055
7056 /*
7057 * This is not used in TLS v1.1.
7058 */
7059 iv_copy_len = ( transform->fixed_ivlen ) ?
7060 transform->fixed_ivlen : transform->ivlen;
7061 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7062 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7063 iv_copy_len );
7064 }
7065 else
7066#endif /* MBEDTLS_SSL_CLI_C */
7067#if defined(MBEDTLS_SSL_SRV_C)
7068 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7069 {
7070 key1 = keyblk + mac_key_len * 2 + keylen;
7071 key2 = keyblk + mac_key_len * 2;
7072
7073 mac_enc = keyblk + mac_key_len;
7074 mac_dec = keyblk;
7075
7076 /*
7077 * This is not used in TLS v1.1.
7078 */
7079 iv_copy_len = ( transform->fixed_ivlen ) ?
7080 transform->fixed_ivlen : transform->ivlen;
7081 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7082 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7083 iv_copy_len );
7084 }
7085 else
7086#endif /* MBEDTLS_SSL_SRV_C */
7087 {
7088 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7089 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7090 goto end;
7091 }
7092
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007093 if( ssl != NULL && ssl->f_export_keys != NULL )
7094 {
7095 ssl->f_export_keys( ssl->p_export_keys,
7096 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7097 master, 48,
7098 randbytes + 32,
7099 randbytes,
7100 tls_prf_get_type( tls_prf ) );
7101 }
7102
7103#if defined(MBEDTLS_USE_PSA_CRYPTO)
7104 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7105 transform->taglen,
7106 &alg,
7107 &key_type,
7108 &key_bits ) ) != PSA_SUCCESS )
7109 {
7110 ret = psa_ssl_status_to_mbedtls( status );
7111 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7112 goto end;
7113 }
7114
7115 transform->psa_alg = alg;
7116
7117 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7118 {
7119 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7120 psa_set_key_algorithm( &attributes, alg );
7121 psa_set_key_type( &attributes, key_type );
7122
7123 if( ( status = psa_import_key( &attributes,
7124 key1,
7125 PSA_BITS_TO_BYTES( key_bits ),
7126 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7127 {
7128 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7129 ret = psa_ssl_status_to_mbedtls( status );
7130 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7131 goto end;
7132 }
7133
7134 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7135
7136 if( ( status = psa_import_key( &attributes,
7137 key2,
7138 PSA_BITS_TO_BYTES( key_bits ),
7139 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7140 {
7141 ret = psa_ssl_status_to_mbedtls( status );
7142 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7143 goto end;
7144 }
7145 }
7146#else
7147 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7148 cipher_info ) ) != 0 )
7149 {
7150 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7151 goto end;
7152 }
7153
7154 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7155 cipher_info ) ) != 0 )
7156 {
7157 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7158 goto end;
7159 }
7160
7161 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7162 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7163 MBEDTLS_ENCRYPT ) ) != 0 )
7164 {
7165 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7166 goto end;
7167 }
7168
7169 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7170 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7171 MBEDTLS_DECRYPT ) ) != 0 )
7172 {
7173 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7174 goto end;
7175 }
7176
7177#if defined(MBEDTLS_CIPHER_MODE_CBC)
7178 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7179 {
7180 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7181 MBEDTLS_PADDING_NONE ) ) != 0 )
7182 {
7183 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7184 goto end;
7185 }
7186
7187 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7188 MBEDTLS_PADDING_NONE ) ) != 0 )
7189 {
7190 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7191 goto end;
7192 }
7193 }
7194#endif /* MBEDTLS_CIPHER_MODE_CBC */
7195#endif /* MBEDTLS_USE_PSA_CRYPTO */
7196
Neil Armstrong29c0c042022-03-17 17:47:28 +01007197#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7198 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7199 For AEAD-based ciphersuites, there is nothing to do here. */
7200 if( mac_key_len != 0 )
7201 {
7202#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007203 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007204
7205 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007206 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007207 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7208
7209 if( ( status = psa_import_key( &attributes,
7210 mac_enc, mac_key_len,
7211 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7212 {
7213 ret = psa_ssl_status_to_mbedtls( status );
7214 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7215 goto end;
7216 }
7217
Ronald Cronfb39f152022-03-25 14:36:28 +01007218 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7219 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7220 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007221 /* mbedtls_ct_hmac() requires the key to be exportable */
7222 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7223 PSA_KEY_USAGE_VERIFY_HASH );
7224 else
7225 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7226
7227 if( ( status = psa_import_key( &attributes,
7228 mac_dec, mac_key_len,
7229 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7230 {
7231 ret = psa_ssl_status_to_mbedtls( status );
7232 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7233 goto end;
7234 }
7235#else
7236 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7237 if( ret != 0 )
7238 goto end;
7239 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7240 if( ret != 0 )
7241 goto end;
7242#endif /* MBEDTLS_USE_PSA_CRYPTO */
7243 }
7244#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7245
7246 ((void) mac_dec);
7247 ((void) mac_enc);
7248
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007249end:
7250 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7251 return( ret );
7252}
7253
Jerry Yuee40f9d2022-02-17 14:55:16 +08007254#if defined(MBEDTLS_USE_PSA_CRYPTO)
7255int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7256 unsigned char *hash, size_t *hashlen,
7257 unsigned char *data, size_t data_len,
7258 mbedtls_md_type_t md_alg )
7259{
7260 psa_status_t status;
7261 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7262 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7263
7264 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7265
7266 if( ( status = psa_hash_setup( &hash_operation,
7267 hash_alg ) ) != PSA_SUCCESS )
7268 {
7269 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7270 goto exit;
7271 }
7272
7273 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7274 64 ) ) != PSA_SUCCESS )
7275 {
7276 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7277 goto exit;
7278 }
7279
7280 if( ( status = psa_hash_update( &hash_operation,
7281 data, data_len ) ) != PSA_SUCCESS )
7282 {
7283 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7284 goto exit;
7285 }
7286
7287 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7288 hashlen ) ) != PSA_SUCCESS )
7289 {
7290 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7291 goto exit;
7292 }
7293
7294exit:
7295 if( status != PSA_SUCCESS )
7296 {
7297 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7298 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7299 switch( status )
7300 {
7301 case PSA_ERROR_NOT_SUPPORTED:
7302 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7303 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7304 case PSA_ERROR_BUFFER_TOO_SMALL:
7305 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7306 case PSA_ERROR_INSUFFICIENT_MEMORY:
7307 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7308 default:
7309 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7310 }
7311 }
7312 return( 0 );
7313}
7314
7315#else
7316
7317int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7318 unsigned char *hash, size_t *hashlen,
7319 unsigned char *data, size_t data_len,
7320 mbedtls_md_type_t md_alg )
7321{
7322 int ret = 0;
7323 mbedtls_md_context_t ctx;
7324 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7325 *hashlen = mbedtls_md_get_size( md_info );
7326
7327 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7328
7329 mbedtls_md_init( &ctx );
7330
7331 /*
7332 * digitally-signed struct {
7333 * opaque client_random[32];
7334 * opaque server_random[32];
7335 * ServerDHParams params;
7336 * };
7337 */
7338 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7339 {
7340 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7341 goto exit;
7342 }
7343 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7344 {
7345 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7346 goto exit;
7347 }
7348 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7349 {
7350 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7351 goto exit;
7352 }
7353 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7354 {
7355 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7356 goto exit;
7357 }
7358 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7359 {
7360 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7361 goto exit;
7362 }
7363
7364exit:
7365 mbedtls_md_free( &ctx );
7366
7367 if( ret != 0 )
7368 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7369 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7370
7371 return( ret );
7372}
7373#endif /* MBEDTLS_USE_PSA_CRYPTO */
7374
Jerry Yud9d91da2022-02-17 14:57:06 +08007375#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7376
7377/* Find an entry in a signature-hash set matching a given hash algorithm. */
7378mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7379 mbedtls_pk_type_t sig_alg )
7380{
7381 switch( sig_alg )
7382 {
7383 case MBEDTLS_PK_RSA:
7384 return( set->rsa );
7385 case MBEDTLS_PK_ECDSA:
7386 return( set->ecdsa );
7387 default:
7388 return( MBEDTLS_MD_NONE );
7389 }
7390}
7391
7392/* Add a signature-hash-pair to a signature-hash set */
7393void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7394 mbedtls_pk_type_t sig_alg,
7395 mbedtls_md_type_t md_alg )
7396{
7397 switch( sig_alg )
7398 {
7399 case MBEDTLS_PK_RSA:
7400 if( set->rsa == MBEDTLS_MD_NONE )
7401 set->rsa = md_alg;
7402 break;
7403
7404 case MBEDTLS_PK_ECDSA:
7405 if( set->ecdsa == MBEDTLS_MD_NONE )
7406 set->ecdsa = md_alg;
7407 break;
7408
7409 default:
7410 break;
7411 }
7412}
7413
7414/* Allow exactly one hash algorithm for each signature. */
7415void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7416 mbedtls_md_type_t md_alg )
7417{
7418 set->rsa = md_alg;
7419 set->ecdsa = md_alg;
7420}
7421
7422#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7423
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007424/* Serialization of TLS 1.2 sessions:
7425 *
7426 * struct {
7427 * uint64 start_time;
7428 * uint8 ciphersuite[2]; // defined by the standard
7429 * uint8 compression; // 0 or 1
7430 * uint8 session_id_len; // at most 32
7431 * opaque session_id[32];
7432 * opaque master[48]; // fixed length in the standard
7433 * uint32 verify_result;
7434 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7435 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7436 * uint32 ticket_lifetime;
7437 * uint8 mfl_code; // up to 255 according to standard
7438 * uint8 encrypt_then_mac; // 0 or 1
7439 * } serialized_session_tls12;
7440 *
7441 */
7442static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7443 unsigned char *buf,
7444 size_t buf_len )
7445{
7446 unsigned char *p = buf;
7447 size_t used = 0;
7448
7449#if defined(MBEDTLS_HAVE_TIME)
7450 uint64_t start;
7451#endif
7452#if defined(MBEDTLS_X509_CRT_PARSE_C)
7453#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7454 size_t cert_len;
7455#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7456#endif /* MBEDTLS_X509_CRT_PARSE_C */
7457
7458 /*
7459 * Time
7460 */
7461#if defined(MBEDTLS_HAVE_TIME)
7462 used += 8;
7463
7464 if( used <= buf_len )
7465 {
7466 start = (uint64_t) session->start;
7467
7468 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7469 p += 8;
7470 }
7471#endif /* MBEDTLS_HAVE_TIME */
7472
7473 /*
7474 * Basic mandatory fields
7475 */
7476 used += 2 /* ciphersuite */
7477 + 1 /* compression */
7478 + 1 /* id_len */
7479 + sizeof( session->id )
7480 + sizeof( session->master )
7481 + 4; /* verify_result */
7482
7483 if( used <= buf_len )
7484 {
7485 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7486 p += 2;
7487
7488 *p++ = MBEDTLS_BYTE_0( session->compression );
7489
7490 *p++ = MBEDTLS_BYTE_0( session->id_len );
7491 memcpy( p, session->id, 32 );
7492 p += 32;
7493
7494 memcpy( p, session->master, 48 );
7495 p += 48;
7496
7497 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7498 p += 4;
7499 }
7500
7501 /*
7502 * Peer's end-entity certificate
7503 */
7504#if defined(MBEDTLS_X509_CRT_PARSE_C)
7505#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7506 if( session->peer_cert == NULL )
7507 cert_len = 0;
7508 else
7509 cert_len = session->peer_cert->raw.len;
7510
7511 used += 3 + cert_len;
7512
7513 if( used <= buf_len )
7514 {
7515 *p++ = MBEDTLS_BYTE_2( cert_len );
7516 *p++ = MBEDTLS_BYTE_1( cert_len );
7517 *p++ = MBEDTLS_BYTE_0( cert_len );
7518
7519 if( session->peer_cert != NULL )
7520 {
7521 memcpy( p, session->peer_cert->raw.p, cert_len );
7522 p += cert_len;
7523 }
7524 }
7525#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7526 if( session->peer_cert_digest != NULL )
7527 {
7528 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7529 if( used <= buf_len )
7530 {
7531 *p++ = (unsigned char) session->peer_cert_digest_type;
7532 *p++ = (unsigned char) session->peer_cert_digest_len;
7533 memcpy( p, session->peer_cert_digest,
7534 session->peer_cert_digest_len );
7535 p += session->peer_cert_digest_len;
7536 }
7537 }
7538 else
7539 {
7540 used += 2;
7541 if( used <= buf_len )
7542 {
7543 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7544 *p++ = 0;
7545 }
7546 }
7547#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7548#endif /* MBEDTLS_X509_CRT_PARSE_C */
7549
7550 /*
7551 * Session ticket if any, plus associated data
7552 */
7553#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7554 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7555
7556 if( used <= buf_len )
7557 {
7558 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7559 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7560 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7561
7562 if( session->ticket != NULL )
7563 {
7564 memcpy( p, session->ticket, session->ticket_len );
7565 p += session->ticket_len;
7566 }
7567
7568 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7569 p += 4;
7570 }
7571#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7572
7573 /*
7574 * Misc extension-related info
7575 */
7576#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7577 used += 1;
7578
7579 if( used <= buf_len )
7580 *p++ = session->mfl_code;
7581#endif
7582
7583#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7584 used += 1;
7585
7586 if( used <= buf_len )
7587 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7588#endif
7589
7590 return( used );
7591}
7592
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007593static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7594 const unsigned char *buf,
7595 size_t len )
7596{
7597#if defined(MBEDTLS_HAVE_TIME)
7598 uint64_t start;
7599#endif
7600#if defined(MBEDTLS_X509_CRT_PARSE_C)
7601#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7602 size_t cert_len;
7603#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7604#endif /* MBEDTLS_X509_CRT_PARSE_C */
7605
7606 const unsigned char *p = buf;
7607 const unsigned char * const end = buf + len;
7608
7609 /*
7610 * Time
7611 */
7612#if defined(MBEDTLS_HAVE_TIME)
7613 if( 8 > (size_t)( end - p ) )
7614 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7615
7616 start = ( (uint64_t) p[0] << 56 ) |
7617 ( (uint64_t) p[1] << 48 ) |
7618 ( (uint64_t) p[2] << 40 ) |
7619 ( (uint64_t) p[3] << 32 ) |
7620 ( (uint64_t) p[4] << 24 ) |
7621 ( (uint64_t) p[5] << 16 ) |
7622 ( (uint64_t) p[6] << 8 ) |
7623 ( (uint64_t) p[7] );
7624 p += 8;
7625
7626 session->start = (time_t) start;
7627#endif /* MBEDTLS_HAVE_TIME */
7628
7629 /*
7630 * Basic mandatory fields
7631 */
7632 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7633 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7634
7635 session->ciphersuite = ( p[0] << 8 ) | p[1];
7636 p += 2;
7637
7638 session->compression = *p++;
7639
7640 session->id_len = *p++;
7641 memcpy( session->id, p, 32 );
7642 p += 32;
7643
7644 memcpy( session->master, p, 48 );
7645 p += 48;
7646
7647 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7648 ( (uint32_t) p[1] << 16 ) |
7649 ( (uint32_t) p[2] << 8 ) |
7650 ( (uint32_t) p[3] );
7651 p += 4;
7652
7653 /* Immediately clear invalid pointer values that have been read, in case
7654 * we exit early before we replaced them with valid ones. */
7655#if defined(MBEDTLS_X509_CRT_PARSE_C)
7656#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7657 session->peer_cert = NULL;
7658#else
7659 session->peer_cert_digest = NULL;
7660#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7661#endif /* MBEDTLS_X509_CRT_PARSE_C */
7662#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7663 session->ticket = NULL;
7664#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7665
7666 /*
7667 * Peer certificate
7668 */
7669#if defined(MBEDTLS_X509_CRT_PARSE_C)
7670#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7671 /* Deserialize CRT from the end of the ticket. */
7672 if( 3 > (size_t)( end - p ) )
7673 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7674
7675 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7676 p += 3;
7677
7678 if( cert_len != 0 )
7679 {
7680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7681
7682 if( cert_len > (size_t)( end - p ) )
7683 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7684
7685 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7686
7687 if( session->peer_cert == NULL )
7688 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7689
7690 mbedtls_x509_crt_init( session->peer_cert );
7691
7692 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7693 p, cert_len ) ) != 0 )
7694 {
7695 mbedtls_x509_crt_free( session->peer_cert );
7696 mbedtls_free( session->peer_cert );
7697 session->peer_cert = NULL;
7698 return( ret );
7699 }
7700
7701 p += cert_len;
7702 }
7703#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7704 /* Deserialize CRT digest from the end of the ticket. */
7705 if( 2 > (size_t)( end - p ) )
7706 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7707
7708 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7709 session->peer_cert_digest_len = (size_t) *p++;
7710
7711 if( session->peer_cert_digest_len != 0 )
7712 {
7713 const mbedtls_md_info_t *md_info =
7714 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7715 if( md_info == NULL )
7716 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7717 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7718 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7719
7720 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7721 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7722
7723 session->peer_cert_digest =
7724 mbedtls_calloc( 1, session->peer_cert_digest_len );
7725 if( session->peer_cert_digest == NULL )
7726 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7727
7728 memcpy( session->peer_cert_digest, p,
7729 session->peer_cert_digest_len );
7730 p += session->peer_cert_digest_len;
7731 }
7732#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7733#endif /* MBEDTLS_X509_CRT_PARSE_C */
7734
7735 /*
7736 * Session ticket and associated data
7737 */
7738#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7739 if( 3 > (size_t)( end - p ) )
7740 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7741
7742 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7743 p += 3;
7744
7745 if( session->ticket_len != 0 )
7746 {
7747 if( session->ticket_len > (size_t)( end - p ) )
7748 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7749
7750 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7751 if( session->ticket == NULL )
7752 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7753
7754 memcpy( session->ticket, p, session->ticket_len );
7755 p += session->ticket_len;
7756 }
7757
7758 if( 4 > (size_t)( end - p ) )
7759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7760
7761 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7762 ( (uint32_t) p[1] << 16 ) |
7763 ( (uint32_t) p[2] << 8 ) |
7764 ( (uint32_t) p[3] );
7765 p += 4;
7766#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7767
7768 /*
7769 * Misc extension-related info
7770 */
7771#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7772 if( 1 > (size_t)( end - p ) )
7773 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7774
7775 session->mfl_code = *p++;
7776#endif
7777
7778#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7779 if( 1 > (size_t)( end - p ) )
7780 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7781
7782 session->encrypt_then_mac = *p++;
7783#endif
7784
7785 /* Done, should have consumed entire buffer */
7786 if( p != end )
7787 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7788
7789 return( 0 );
7790}
Jerry Yudc7bd172022-02-17 13:44:15 +08007791#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007793#endif /* MBEDTLS_SSL_TLS_C */