blob: 26c009a9e02199572e278ce6880a67177988808e [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
387 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
388 int encrypt_then_mac,
389#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
390 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
391 ssl_tls_prf_t tls_prf,
392 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400393 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800394 unsigned endpoint,
395 const mbedtls_ssl_context *ssl );
396
397#if defined(MBEDTLS_SHA256_C)
398static int tls_prf_sha256( const unsigned char *secret, size_t slen,
399 const char *label,
400 const unsigned char *random, size_t rlen,
401 unsigned char *dstbuf, size_t dlen );
402static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
403static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
404
405#endif /* MBEDTLS_SHA256_C */
406
407#if defined(MBEDTLS_SHA384_C)
408static int tls_prf_sha384( const unsigned char *secret, size_t slen,
409 const char *label,
410 const unsigned char *random, size_t rlen,
411 unsigned char *dstbuf, size_t dlen );
412
413static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
414static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
415#endif /* MBEDTLS_SHA384_C */
416
417static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
418 unsigned char *buf,
419 size_t buf_len );
420static int ssl_session_load_tls12( mbedtls_ssl_session *session,
421 const unsigned char *buf,
422 size_t len );
423#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
424
Jerry Yu53d23e22022-02-09 16:25:09 +0800425static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
426
Jerry Yudb8c48a2022-01-27 14:54:54 +0800427#if defined(MBEDTLS_SHA256_C)
428static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800429#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800430
431#if defined(MBEDTLS_SHA384_C)
432static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800433#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000434
Ron Eldor51d3ab52019-05-12 14:54:30 +0300435int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
436 const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen )
440{
441 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
442
443 switch( prf )
444 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200446#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300447 case MBEDTLS_SSL_TLS_PRF_SHA384:
448 tls_prf = tls_prf_sha384;
449 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200450#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300451#if defined(MBEDTLS_SHA256_C)
452 case MBEDTLS_SSL_TLS_PRF_SHA256:
453 tls_prf = tls_prf_sha256;
454 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300455#endif /* MBEDTLS_SHA256_C */
456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300457 default:
458 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
459 }
460
461 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
462}
463
Jerry Yuc73c6182022-02-08 20:29:25 +0800464#if defined(MBEDTLS_X509_CRT_PARSE_C)
465static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
466{
467#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
468 if( session->peer_cert != NULL )
469 {
470 mbedtls_x509_crt_free( session->peer_cert );
471 mbedtls_free( session->peer_cert );
472 session->peer_cert = NULL;
473 }
474#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
475 if( session->peer_cert_digest != NULL )
476 {
477 /* Zeroization is not necessary. */
478 mbedtls_free( session->peer_cert_digest );
479 session->peer_cert_digest = NULL;
480 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
481 session->peer_cert_digest_len = 0;
482 }
483#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
484}
485#endif /* MBEDTLS_X509_CRT_PARSE_C */
486
487void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
488 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
489{
490 ((void) ciphersuite_info);
491
492#if defined(MBEDTLS_SHA384_C)
493 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
494 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
495 else
496#endif
497#if defined(MBEDTLS_SHA256_C)
498 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
499 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
500 else
501#endif
502 {
503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
504 return;
505 }
506}
507
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100508static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
509 unsigned hs_type,
510 size_t total_hs_len )
511{
512 unsigned char hs_hdr[4];
513
514 /* Build HS header for checksum update. */
515 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
516 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
517 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
518 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
519
520 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
521}
522
523void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
524 unsigned hs_type,
525 unsigned char const *msg,
526 size_t msg_len )
527{
528 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
529 ssl->handshake->update_checksum( ssl, msg, msg_len );
530}
531
Jerry Yuc73c6182022-02-08 20:29:25 +0800532void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
533{
534 ((void) ssl);
535#if defined(MBEDTLS_SHA256_C)
536#if defined(MBEDTLS_USE_PSA_CRYPTO)
537 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
538 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
539#else
540 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
541#endif
542#endif
543#if defined(MBEDTLS_SHA384_C)
544#if defined(MBEDTLS_USE_PSA_CRYPTO)
545 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
546 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
547#else
548 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
549#endif
550#endif
551}
552
553static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
554 const unsigned char *buf, size_t len )
555{
556#if defined(MBEDTLS_SHA256_C)
557#if defined(MBEDTLS_USE_PSA_CRYPTO)
558 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
559#else
560 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
561#endif
562#endif
563#if defined(MBEDTLS_SHA384_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
566#else
567 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
568#endif
569#endif
570}
571
572#if defined(MBEDTLS_SHA256_C)
573static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
574 const unsigned char *buf, size_t len )
575{
576#if defined(MBEDTLS_USE_PSA_CRYPTO)
577 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
578#else
579 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
580#endif
581}
582#endif
583
584#if defined(MBEDTLS_SHA384_C)
585static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
586 const unsigned char *buf, size_t len )
587{
588#if defined(MBEDTLS_USE_PSA_CRYPTO)
589 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
590#else
591 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
592#endif
593}
594#endif
595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500601#if defined(MBEDTLS_USE_PSA_CRYPTO)
602 handshake->fin_sha256_psa = psa_hash_operation_init();
603 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
604#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200606 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200607#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200609#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500610#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500611 handshake->fin_sha384_psa = psa_hash_operation_init();
612 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500613#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200615 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500617#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200618
619 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100620
621#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100622 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100623 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
624#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626#if defined(MBEDTLS_DHM_C)
627 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200628#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629#if defined(MBEDTLS_ECDH_C)
630 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200631#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200632#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200633 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200634#if defined(MBEDTLS_SSL_CLI_C)
635 handshake->ecjpake_cache = NULL;
636 handshake->ecjpake_cache_len = 0;
637#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200638#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200639
Gilles Peskineeccd8882020-03-10 12:19:08 +0100640#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200641 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200642#endif
643
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200644#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
645 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
646#endif
Hanno Becker75173122019-02-06 16:18:31 +0000647
648#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
649 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
650 mbedtls_pk_init( &handshake->peer_pubkey );
651#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200652}
653
Hanno Beckera18d1322018-01-03 14:27:32 +0000654void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200655{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200657
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100658#if defined(MBEDTLS_USE_PSA_CRYPTO)
659 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
660 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100661#else
662 mbedtls_cipher_init( &transform->cipher_ctx_enc );
663 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100664#endif
665
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000666#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100667#if defined(MBEDTLS_USE_PSA_CRYPTO)
668 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
669 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100670#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 mbedtls_md_init( &transform->md_ctx_enc );
672 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000673#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680}
681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000683{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000685 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200690 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200691
692 /*
693 * Either the pointers are now NULL or cleared properly and can be freed.
694 * Now allocate missing structures.
695 */
696 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200698 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200699 }
Paul Bakker48916f92012-09-16 19:57:18 +0000700
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200703 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200704 }
Paul Bakker48916f92012-09-16 19:57:18 +0000705
Paul Bakker82788fb2014-10-20 13:59:19 +0200706 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200708 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200709 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500710#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
711 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400712
Andrzej Kurek4a063792020-10-21 15:08:44 +0200713 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
714 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500715#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000716
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200717 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000718 if( ssl->handshake == NULL ||
719 ssl->transform_negotiate == NULL ||
720 ssl->session_negotiate == NULL )
721 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 mbedtls_free( ssl->handshake );
725 mbedtls_free( ssl->transform_negotiate );
726 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200727
728 ssl->handshake = NULL;
729 ssl->transform_negotiate = NULL;
730 ssl->session_negotiate = NULL;
731
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000733 }
734
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200735 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000737 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200738 ssl_handshake_params_init( ssl->handshake );
739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200741 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
742 {
743 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200744
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200745 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
747 else
748 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200749
Hanno Becker0f57a652020-02-05 10:37:26 +0000750 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200751 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200752#endif
753
Brett Warrene0edc842021-08-17 09:53:13 +0100754/*
755 * curve_list is translated to IANA TLS group identifiers here because
756 * mbedtls_ssl_conf_curves returns void and so can't return
757 * any error codes.
758 */
759#if defined(MBEDTLS_ECP_C)
760#if !defined(MBEDTLS_DEPRECATED_REMOVED)
761 /* Heap allocate and translate curve_list from internal to IANA group ids */
762 if ( ssl->conf->curve_list != NULL )
763 {
764 size_t length;
765 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
766
767 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
768 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
769
770 /* Leave room for zero termination */
771 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
772 if ( group_list == NULL )
773 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
774
775 for( size_t i = 0; i < length; i++ )
776 {
777 const mbedtls_ecp_curve_info *info =
778 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
779 if ( info == NULL )
780 {
781 mbedtls_free( group_list );
782 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
783 }
784 group_list[i] = info->tls_id;
785 }
786
787 group_list[length] = 0;
788
789 ssl->handshake->group_list = group_list;
790 ssl->handshake->group_list_heap_allocated = 1;
791 }
792 else
793 {
794 ssl->handshake->group_list = ssl->conf->group_list;
795 ssl->handshake->group_list_heap_allocated = 0;
796 }
797#endif /* MBEDTLS_DEPRECATED_REMOVED */
798#endif /* MBEDTLS_ECP_C */
799
Jerry Yuf017ee42022-01-12 15:49:48 +0800800#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
801#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800802#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800803 /* Heap allocate and translate sig_hashes from internal hash identifiers to
804 signature algorithms IANA identifiers. */
805 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800806 ssl->conf->sig_hashes != NULL )
807 {
808 const int *md;
809 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800810 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800811 uint16_t *p;
812
Jerry Yub476a442022-01-21 18:14:45 +0800813#if defined(static_assert)
814 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
815 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
816 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800817#endif
818
Jerry Yuf017ee42022-01-12 15:49:48 +0800819 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
820 {
821 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
822 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800823#if defined(MBEDTLS_ECDSA_C)
824 sig_algs_len += sizeof( uint16_t );
825#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800826
Jerry Yub476a442022-01-21 18:14:45 +0800827#if defined(MBEDTLS_RSA_C)
828 sig_algs_len += sizeof( uint16_t );
829#endif
830 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
831 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 }
833
Jerry Yub476a442022-01-21 18:14:45 +0800834 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
836
Jerry Yub476a442022-01-21 18:14:45 +0800837 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
838 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800839 if( ssl->handshake->sig_algs == NULL )
840 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
841
842 p = (uint16_t *)ssl->handshake->sig_algs;
843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
846 if( hash == MBEDTLS_SSL_HASH_NONE )
847 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
850 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800851#endif
852#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800853 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
854 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800855#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857 *p = MBEDTLS_TLS1_3_SIG_NONE;
858 ssl->handshake->sig_algs_heap_allocated = 1;
859 }
860 else
Jerry Yua69269a2022-01-17 21:06:01 +0800861#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800862 {
863 ssl->handshake->sig_algs = ssl->conf->sig_algs;
864 ssl->handshake->sig_algs_heap_allocated = 0;
865 }
866#endif /* MBEDTLS_DEPRECATED_REMOVED */
867#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000868 return( 0 );
869}
870
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200871#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200872/* Dummy cookie callbacks for defaults */
873static int ssl_cookie_write_dummy( void *ctx,
874 unsigned char **p, unsigned char *end,
875 const unsigned char *cli_id, size_t cli_id_len )
876{
877 ((void) ctx);
878 ((void) p);
879 ((void) end);
880 ((void) cli_id);
881 ((void) cli_id_len);
882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200884}
885
886static int ssl_cookie_check_dummy( void *ctx,
887 const unsigned char *cookie, size_t cookie_len,
888 const unsigned char *cli_id, size_t cli_id_len )
889{
890 ((void) ctx);
891 ((void) cookie);
892 ((void) cookie_len);
893 ((void) cli_id);
894 ((void) cli_id_len);
895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200898#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200899
Paul Bakker5121ce52009-01-03 21:22:43 +0000900/*
901 * Initialize an SSL context
902 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200903void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
904{
905 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
906}
907
Jerry Yu60835a82021-08-04 10:13:52 +0800908static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
909{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100910 const mbedtls_ssl_config *conf = ssl->conf;
911
Ronald Cron6f135e12021-12-08 16:57:54 +0100912#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100913 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
914 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000915 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
916 {
917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
918 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
919 }
920
Jerry Yu60835a82021-08-04 10:13:52 +0800921 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
922 return( 0 );
923 }
924#endif
925
926#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100927 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800928 {
929 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
930 return( 0 );
931 }
932#endif
933
Ronald Cron6f135e12021-12-08 16:57:54 +0100934#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100935 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800936 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000937 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
938 {
939 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
940 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
941 }
942
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000943 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
946 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
947 }
948
949
Ronald Crone1d3f062022-02-10 14:50:54 +0100950 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
951 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800952 }
953#endif
954
955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
956 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
957}
958
959static int ssl_conf_check(const mbedtls_ssl_context *ssl)
960{
961 int ret;
962 ret = ssl_conf_version_check( ssl );
963 if( ret != 0 )
964 return( ret );
965
966 /* Space for further checks */
967
968 return( 0 );
969}
970
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200971/*
972 * Setup an SSL context
973 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100974
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200975int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200976 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000977{
Janos Follath865b3eb2019-12-16 11:46:15 +0000978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000979 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
980 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000981
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200982 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000983
Jerry Yu60835a82021-08-04 10:13:52 +0800984 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
985 return( ret );
986
Paul Bakker62f2dee2012-09-28 07:31:51 +0000987 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100988 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000989 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200990
991 /* Set to NULL in case of an error condition */
992 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200993
Darryl Greenb33cc762019-11-28 14:29:44 +0000994#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
995 ssl->in_buf_len = in_buf_len;
996#endif
997 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000998 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000999 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001000 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001001 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001002 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001003 }
1004
Darryl Greenb33cc762019-11-28 14:29:44 +00001005#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1006 ssl->out_buf_len = out_buf_len;
1007#endif
1008 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001009 if( ssl->out_buf == NULL )
1010 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001012 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001013 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001014 }
1015
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001016 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001017
Johan Pascalb62bb512015-12-03 21:56:45 +01001018#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001019 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001020#endif
1021
Paul Bakker48916f92012-09-16 19:57:18 +00001022 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001023 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001024
1025 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001026
1027error:
1028 mbedtls_free( ssl->in_buf );
1029 mbedtls_free( ssl->out_buf );
1030
1031 ssl->conf = NULL;
1032
Darryl Greenb33cc762019-11-28 14:29:44 +00001033#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1034 ssl->in_buf_len = 0;
1035 ssl->out_buf_len = 0;
1036#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001037 ssl->in_buf = NULL;
1038 ssl->out_buf = NULL;
1039
1040 ssl->in_hdr = NULL;
1041 ssl->in_ctr = NULL;
1042 ssl->in_len = NULL;
1043 ssl->in_iv = NULL;
1044 ssl->in_msg = NULL;
1045
1046 ssl->out_hdr = NULL;
1047 ssl->out_ctr = NULL;
1048 ssl->out_len = NULL;
1049 ssl->out_iv = NULL;
1050 ssl->out_msg = NULL;
1051
k-stachowiak9f7798e2018-07-31 16:52:32 +02001052 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001053}
1054
1055/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001056 * Reset an initialized and used SSL context for re-use while retaining
1057 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001058 *
1059 * If partial is non-zero, keep data in the input buffer and client ID.
1060 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001061 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001062void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1063 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001064{
Darryl Greenb33cc762019-11-28 14:29:44 +00001065#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1066 size_t in_buf_len = ssl->in_buf_len;
1067 size_t out_buf_len = ssl->out_buf_len;
1068#else
1069 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1070 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1071#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001072
Hanno Beckerb0302c42021-08-03 09:39:42 +01001073#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1074 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001075#endif
1076
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001077 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001078 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001079
Hanno Beckerb0302c42021-08-03 09:39:42 +01001080 mbedtls_ssl_reset_in_out_pointers( ssl );
1081
1082 /* Reset incoming message parsing */
1083 ssl->in_offt = NULL;
1084 ssl->nb_zero = 0;
1085 ssl->in_msgtype = 0;
1086 ssl->in_msglen = 0;
1087 ssl->in_hslen = 0;
1088 ssl->keep_current_message = 0;
1089 ssl->transform_in = NULL;
1090
1091#if defined(MBEDTLS_SSL_PROTO_DTLS)
1092 ssl->next_record_offset = 0;
1093 ssl->in_epoch = 0;
1094#endif
1095
1096 /* Keep current datagram if partial == 1 */
1097 if( partial == 0 )
1098 {
1099 ssl->in_left = 0;
1100 memset( ssl->in_buf, 0, in_buf_len );
1101 }
1102
1103 /* Reset outgoing message writing */
1104 ssl->out_msgtype = 0;
1105 ssl->out_msglen = 0;
1106 ssl->out_left = 0;
1107 memset( ssl->out_buf, 0, out_buf_len );
1108 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1109 ssl->transform_out = NULL;
1110
1111#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1112 mbedtls_ssl_dtls_replay_reset( ssl );
1113#endif
1114
XiaokangQian2b01dc32022-01-21 02:53:13 +00001115#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001116 if( ssl->transform )
1117 {
1118 mbedtls_ssl_transform_free( ssl->transform );
1119 mbedtls_free( ssl->transform );
1120 ssl->transform = NULL;
1121 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001122#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1123
XiaokangQian2b01dc32022-01-21 02:53:13 +00001124#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1125 mbedtls_ssl_transform_free( ssl->transform_application );
1126 mbedtls_free( ssl->transform_application );
1127 ssl->transform_application = NULL;
1128
1129 if( ssl->handshake != NULL )
1130 {
1131 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1132 mbedtls_free( ssl->handshake->transform_earlydata );
1133 ssl->handshake->transform_earlydata = NULL;
1134
1135 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1136 mbedtls_free( ssl->handshake->transform_handshake );
1137 ssl->handshake->transform_handshake = NULL;
1138 }
1139
XiaokangQian2b01dc32022-01-21 02:53:13 +00001140#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001141}
1142
1143int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1144{
1145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1146
1147 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1148
XiaokangQian78b1fa72022-01-19 06:56:30 +00001149 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001150
1151 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152#if defined(MBEDTLS_SSL_RENEGOTIATION)
1153 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001154 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001155
1156 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1158 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001159#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001161
Hanno Beckerb0302c42021-08-03 09:39:42 +01001162 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001163 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001164 if( ssl->session )
1165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 mbedtls_ssl_session_free( ssl->session );
1167 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001168 ssl->session = NULL;
1169 }
1170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001172 ssl->alpn_chosen = NULL;
1173#endif
1174
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001175#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001176#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001177 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001178#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001179 {
1180 mbedtls_free( ssl->cli_id );
1181 ssl->cli_id = NULL;
1182 ssl->cli_id_len = 0;
1183 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001184#endif
1185
Paul Bakker48916f92012-09-16 19:57:18 +00001186 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1187 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001188
1189 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001190}
1191
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001192/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001193 * Reset an initialized and used SSL context for re-use while retaining
1194 * all application-set variables, function pointers and data.
1195 */
1196int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1197{
Hanno Becker43aefe22020-02-05 10:44:56 +00001198 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001199}
1200
1201/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001202 * SSL set accessors
1203 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001204void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001205{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001206 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001207}
1208
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001209void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001211 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001212}
1213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001215void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001216{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001217 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001218}
1219#endif
1220
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001221void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001222{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001223 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001224}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001227
Hanno Becker1841b0a2018-08-24 11:13:57 +01001228void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1229 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001230{
1231 ssl->disable_datagram_packing = !allow_packing;
1232}
1233
1234void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1235 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001236{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001237 conf->hs_timeout_min = min;
1238 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001239}
1240#endif
1241
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001242void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001243{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001244 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001245}
1246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001248void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001249 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001250 void *p_vrfy )
1251{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001252 conf->f_vrfy = f_vrfy;
1253 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001254}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001256
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001257void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001258 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001259 void *p_rng )
1260{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001261 conf->f_rng = f_rng;
1262 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001263}
1264
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001265void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001266 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001267 void *p_dbg )
1268{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001269 conf->f_dbg = f_dbg;
1270 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001271}
1272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001274 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001275 mbedtls_ssl_send_t *f_send,
1276 mbedtls_ssl_recv_t *f_recv,
1277 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001278{
1279 ssl->p_bio = p_bio;
1280 ssl->f_send = f_send;
1281 ssl->f_recv = f_recv;
1282 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001283}
1284
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001285#if defined(MBEDTLS_SSL_PROTO_DTLS)
1286void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1287{
1288 ssl->mtu = mtu;
1289}
1290#endif
1291
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001292void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001293{
1294 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001295}
1296
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001297void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1298 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001299 mbedtls_ssl_set_timer_t *f_set_timer,
1300 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001301{
1302 ssl->p_timer = p_timer;
1303 ssl->f_set_timer = f_set_timer;
1304 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001305
1306 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001307 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001308}
1309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001311void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001312 void *p_cache,
1313 mbedtls_ssl_cache_get_t *f_get_cache,
1314 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001315{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001316 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001317 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001318 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001319}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322#if defined(MBEDTLS_SSL_CLI_C)
1323int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001324{
Janos Follath865b3eb2019-12-16 11:46:15 +00001325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001326
1327 if( ssl == NULL ||
1328 session == NULL ||
1329 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001330 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001331 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001332 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001333 }
1334
Hanno Beckere810bbc2021-05-14 16:01:05 +01001335 if( ssl->handshake->resume == 1 )
1336 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1337
Hanno Becker52055ae2019-02-06 14:30:46 +00001338 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1339 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001340 return( ret );
1341
Paul Bakker0a597072012-09-25 21:55:46 +00001342 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001343
1344 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001345}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001347
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001348void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1349 const int *ciphersuites )
1350{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001351 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001352}
1353
Ronald Cron6f135e12021-12-08 16:57:54 +01001354#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001355void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001356 const int kex_modes )
1357{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001358 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001359}
Ronald Cron6f135e12021-12-08 16:57:54 +01001360#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001362#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001363void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001364 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001365{
1366 conf->cert_profile = profile;
1367}
1368
Glenn Strauss36872db2022-01-22 05:06:31 -05001369static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1370{
1371 mbedtls_ssl_key_cert *cur = key_cert, *next;
1372
1373 while( cur != NULL )
1374 {
1375 next = cur->next;
1376 mbedtls_free( cur );
1377 cur = next;
1378 }
1379}
1380
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001381/* Append a new keycert entry to a (possibly empty) list */
1382static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1383 mbedtls_x509_crt *cert,
1384 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001385{
niisato8ee24222018-06-25 19:05:48 +09001386 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001387
Glenn Strauss36872db2022-01-22 05:06:31 -05001388 if( cert == NULL )
1389 {
1390 /* Free list if cert is null */
1391 ssl_key_cert_free( *head );
1392 *head = NULL;
1393 return( 0 );
1394 }
1395
niisato8ee24222018-06-25 19:05:48 +09001396 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1397 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001398 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001399
niisato8ee24222018-06-25 19:05:48 +09001400 new_cert->cert = cert;
1401 new_cert->key = key;
1402 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001403
Glenn Strauss36872db2022-01-22 05:06:31 -05001404 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001405 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001406 {
niisato8ee24222018-06-25 19:05:48 +09001407 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001408 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001409 else
1410 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001411 mbedtls_ssl_key_cert *cur = *head;
1412 while( cur->next != NULL )
1413 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001414 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415 }
1416
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001417 return( 0 );
1418}
1419
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001420int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001421 mbedtls_x509_crt *own_cert,
1422 mbedtls_pk_context *pk_key )
1423{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001424 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001425}
1426
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001427void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001428 mbedtls_x509_crt *ca_chain,
1429 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001430{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001431 conf->ca_chain = ca_chain;
1432 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001433
1434#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1435 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1436 * cannot be used together. */
1437 conf->f_ca_cb = NULL;
1438 conf->p_ca_cb = NULL;
1439#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001440}
Hanno Becker5adaad92019-03-27 16:54:37 +00001441
1442#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1443void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001444 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001445 void *p_ca_cb )
1446{
1447 conf->f_ca_cb = f_ca_cb;
1448 conf->p_ca_cb = p_ca_cb;
1449
1450 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1451 * cannot be used together. */
1452 conf->ca_chain = NULL;
1453 conf->ca_crl = NULL;
1454}
1455#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001457
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001458#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001459const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1460 size_t *name_len )
1461{
1462 *name_len = ssl->handshake->sni_name_len;
1463 return( ssl->handshake->sni_name );
1464}
1465
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001466int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1467 mbedtls_x509_crt *own_cert,
1468 mbedtls_pk_context *pk_key )
1469{
1470 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1471 own_cert, pk_key ) );
1472}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001473
1474void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1475 mbedtls_x509_crt *ca_chain,
1476 mbedtls_x509_crl *ca_crl )
1477{
1478 ssl->handshake->sni_ca_chain = ca_chain;
1479 ssl->handshake->sni_ca_crl = ca_crl;
1480}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001481
1482void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1483 int authmode )
1484{
1485 ssl->handshake->sni_authmode = authmode;
1486}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001487#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1488
Hanno Becker8927c832019-04-03 12:52:50 +01001489#if defined(MBEDTLS_X509_CRT_PARSE_C)
1490void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1491 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1492 void *p_vrfy )
1493{
1494 ssl->f_vrfy = f_vrfy;
1495 ssl->p_vrfy = p_vrfy;
1496}
1497#endif
1498
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001499#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001500/*
1501 * Set EC J-PAKE password for current handshake
1502 */
1503int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1504 const unsigned char *pw,
1505 size_t pw_len )
1506{
1507 mbedtls_ecjpake_role role;
1508
Janos Follath8eb64132016-06-03 15:40:57 +01001509 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001510 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1511
1512 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1513 role = MBEDTLS_ECJPAKE_SERVER;
1514 else
1515 role = MBEDTLS_ECJPAKE_CLIENT;
1516
1517 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1518 role,
1519 MBEDTLS_MD_SHA256,
1520 MBEDTLS_ECP_DP_SECP256R1,
1521 pw, pw_len ) );
1522}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001523#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001524
Gilles Peskineeccd8882020-03-10 12:19:08 +01001525#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001526
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001527static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1528{
1529#if defined(MBEDTLS_USE_PSA_CRYPTO)
1530 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1531 return( 1 );
1532#endif /* MBEDTLS_USE_PSA_CRYPTO */
1533
1534 if( conf->psk != NULL )
1535 return( 1 );
1536
1537 return( 0 );
1538}
1539
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001540static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1541{
1542 /* Remove reference to existing PSK, if any. */
1543#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001544 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545 {
1546 /* The maintenance of the PSK key slot is the
1547 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001548 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001549 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001550 /* This and the following branch should never
1551 * be taken simultaenously as we maintain the
1552 * invariant that raw and opaque PSKs are never
1553 * configured simultaneously. As a safeguard,
1554 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001555#endif /* MBEDTLS_USE_PSA_CRYPTO */
1556 if( conf->psk != NULL )
1557 {
1558 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1559
1560 mbedtls_free( conf->psk );
1561 conf->psk = NULL;
1562 conf->psk_len = 0;
1563 }
1564
1565 /* Remove reference to PSK identity, if any. */
1566 if( conf->psk_identity != NULL )
1567 {
1568 mbedtls_free( conf->psk_identity );
1569 conf->psk_identity = NULL;
1570 conf->psk_identity_len = 0;
1571 }
1572}
1573
Hanno Becker7390c712018-11-15 13:33:04 +00001574/* This function assumes that PSK identity in the SSL config is unset.
1575 * It checks that the provided identity is well-formed and attempts
1576 * to make a copy of it in the SSL config.
1577 * On failure, the PSK identity in the config remains unset. */
1578static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1579 unsigned char const *psk_identity,
1580 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001581{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001582 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001583 if( psk_identity == NULL ||
1584 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001585 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001586 {
1587 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1588 }
1589
Hanno Becker7390c712018-11-15 13:33:04 +00001590 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1591 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001592 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001593
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001594 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001595 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001596
1597 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001598}
1599
Hanno Becker7390c712018-11-15 13:33:04 +00001600int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1601 const unsigned char *psk, size_t psk_len,
1602 const unsigned char *psk_identity, size_t psk_identity_len )
1603{
Janos Follath865b3eb2019-12-16 11:46:15 +00001604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001605
1606 /* We currently only support one PSK, raw or opaque. */
1607 if( ssl_conf_psk_is_configured( conf ) )
1608 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001609
1610 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001611 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001612 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001613 if( psk_len == 0 )
1614 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1615 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1616 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1617
Hanno Becker7390c712018-11-15 13:33:04 +00001618 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1619 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1620 conf->psk_len = psk_len;
1621 memcpy( conf->psk, psk, conf->psk_len );
1622
1623 /* Check and set PSK Identity */
1624 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1625 if( ret != 0 )
1626 ssl_conf_remove_psk( conf );
1627
1628 return( ret );
1629}
1630
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001631static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1632{
1633#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001634 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001635 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001636 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001637 }
1638 else
1639#endif /* MBEDTLS_USE_PSA_CRYPTO */
1640 if( ssl->handshake->psk != NULL )
1641 {
1642 mbedtls_platform_zeroize( ssl->handshake->psk,
1643 ssl->handshake->psk_len );
1644 mbedtls_free( ssl->handshake->psk );
1645 ssl->handshake->psk_len = 0;
1646 }
1647}
1648
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001649int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1650 const unsigned char *psk, size_t psk_len )
1651{
1652 if( psk == NULL || ssl->handshake == NULL )
1653 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1654
1655 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1656 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1657
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001658 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001659
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001660 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001661 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001662
1663 ssl->handshake->psk_len = psk_len;
1664 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1665
1666 return( 0 );
1667}
1668
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001669#if defined(MBEDTLS_USE_PSA_CRYPTO)
1670int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001671 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001672 const unsigned char *psk_identity,
1673 size_t psk_identity_len )
1674{
Janos Follath865b3eb2019-12-16 11:46:15 +00001675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001676
1677 /* We currently only support one PSK, raw or opaque. */
1678 if( ssl_conf_psk_is_configured( conf ) )
1679 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680
Hanno Becker7390c712018-11-15 13:33:04 +00001681 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001682 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001683 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001684 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001685
1686 /* Check and set PSK Identity */
1687 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1688 psk_identity_len );
1689 if( ret != 0 )
1690 ssl_conf_remove_psk( conf );
1691
1692 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001693}
1694
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001695int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1696 mbedtls_svc_key_id_t psk )
1697{
1698 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1699 ( ssl->handshake == NULL ) )
1700 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1701
1702 ssl_remove_psk( ssl );
1703 ssl->handshake->psk_opaque = psk;
1704 return( 0 );
1705}
1706#endif /* MBEDTLS_USE_PSA_CRYPTO */
1707
1708void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1709 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1710 size_t),
1711 void *p_psk )
1712{
1713 conf->f_psk = f_psk;
1714 conf->p_psk = p_psk;
1715}
1716#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1717
1718#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001719psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001720 size_t taglen,
1721 psa_algorithm_t *alg,
1722 psa_key_type_t *key_type,
1723 size_t *key_size )
1724{
1725 switch ( mbedtls_cipher_type )
1726 {
1727 case MBEDTLS_CIPHER_AES_128_CBC:
1728 *alg = PSA_ALG_CBC_NO_PADDING;
1729 *key_type = PSA_KEY_TYPE_AES;
1730 *key_size = 128;
1731 break;
1732 case MBEDTLS_CIPHER_AES_128_CCM:
1733 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1734 *key_type = PSA_KEY_TYPE_AES;
1735 *key_size = 128;
1736 break;
1737 case MBEDTLS_CIPHER_AES_128_GCM:
1738 *alg = PSA_ALG_GCM;
1739 *key_type = PSA_KEY_TYPE_AES;
1740 *key_size = 128;
1741 break;
1742 case MBEDTLS_CIPHER_AES_192_CCM:
1743 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1744 *key_type = PSA_KEY_TYPE_AES;
1745 *key_size = 192;
1746 break;
1747 case MBEDTLS_CIPHER_AES_192_GCM:
1748 *alg = PSA_ALG_GCM;
1749 *key_type = PSA_KEY_TYPE_AES;
1750 *key_size = 192;
1751 break;
1752 case MBEDTLS_CIPHER_AES_256_CBC:
1753 *alg = PSA_ALG_CBC_NO_PADDING;
1754 *key_type = PSA_KEY_TYPE_AES;
1755 *key_size = 256;
1756 break;
1757 case MBEDTLS_CIPHER_AES_256_CCM:
1758 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1759 *key_type = PSA_KEY_TYPE_AES;
1760 *key_size = 256;
1761 break;
1762 case MBEDTLS_CIPHER_AES_256_GCM:
1763 *alg = PSA_ALG_GCM;
1764 *key_type = PSA_KEY_TYPE_AES;
1765 *key_size = 256;
1766 break;
1767 case MBEDTLS_CIPHER_ARIA_128_CBC:
1768 *alg = PSA_ALG_CBC_NO_PADDING;
1769 *key_type = PSA_KEY_TYPE_ARIA;
1770 *key_size = 128;
1771 break;
1772 case MBEDTLS_CIPHER_ARIA_128_CCM:
1773 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1774 *key_type = PSA_KEY_TYPE_ARIA;
1775 *key_size = 128;
1776 break;
1777 case MBEDTLS_CIPHER_ARIA_128_GCM:
1778 *alg = PSA_ALG_GCM;
1779 *key_type = PSA_KEY_TYPE_ARIA;
1780 *key_size = 128;
1781 break;
1782 case MBEDTLS_CIPHER_ARIA_192_CCM:
1783 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1784 *key_type = PSA_KEY_TYPE_ARIA;
1785 *key_size = 192;
1786 break;
1787 case MBEDTLS_CIPHER_ARIA_192_GCM:
1788 *alg = PSA_ALG_GCM;
1789 *key_type = PSA_KEY_TYPE_ARIA;
1790 *key_size = 192;
1791 break;
1792 case MBEDTLS_CIPHER_ARIA_256_CBC:
1793 *alg = PSA_ALG_CBC_NO_PADDING;
1794 *key_type = PSA_KEY_TYPE_ARIA;
1795 *key_size = 256;
1796 break;
1797 case MBEDTLS_CIPHER_ARIA_256_CCM:
1798 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1799 *key_type = PSA_KEY_TYPE_ARIA;
1800 *key_size = 256;
1801 break;
1802 case MBEDTLS_CIPHER_ARIA_256_GCM:
1803 *alg = PSA_ALG_GCM;
1804 *key_type = PSA_KEY_TYPE_ARIA;
1805 *key_size = 256;
1806 break;
1807 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1808 *alg = PSA_ALG_CBC_NO_PADDING;
1809 *key_type = PSA_KEY_TYPE_CAMELLIA;
1810 *key_size = 128;
1811 break;
1812 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1813 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1814 *key_type = PSA_KEY_TYPE_CAMELLIA;
1815 *key_size = 128;
1816 break;
1817 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1818 *alg = PSA_ALG_GCM;
1819 *key_type = PSA_KEY_TYPE_CAMELLIA;
1820 *key_size = 128;
1821 break;
1822 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1823 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1824 *key_type = PSA_KEY_TYPE_CAMELLIA;
1825 *key_size = 192;
1826 break;
1827 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1828 *alg = PSA_ALG_GCM;
1829 *key_type = PSA_KEY_TYPE_CAMELLIA;
1830 *key_size = 192;
1831 break;
1832 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1833 *alg = PSA_ALG_CBC_NO_PADDING;
1834 *key_type = PSA_KEY_TYPE_CAMELLIA;
1835 *key_size = 256;
1836 break;
1837 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1838 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1839 *key_type = PSA_KEY_TYPE_CAMELLIA;
1840 *key_size = 256;
1841 break;
1842 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1843 *alg = PSA_ALG_GCM;
1844 *key_type = PSA_KEY_TYPE_CAMELLIA;
1845 *key_size = 256;
1846 break;
1847 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1848 *alg = PSA_ALG_CHACHA20_POLY1305;
1849 *key_type = PSA_KEY_TYPE_CHACHA20;
1850 *key_size = 256;
1851 break;
1852 case MBEDTLS_CIPHER_NULL:
1853 *alg = MBEDTLS_SSL_NULL_CIPHER;
1854 *key_type = 0;
1855 *key_size = 0;
1856 break;
1857 default:
1858 return PSA_ERROR_NOT_SUPPORTED;
1859 }
1860
1861 return PSA_SUCCESS;
1862}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001863#endif /* MBEDTLS_USE_PSA_CRYPTO */
1864
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001865#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001866int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1867 const unsigned char *dhm_P, size_t P_len,
1868 const unsigned char *dhm_G, size_t G_len )
1869{
Janos Follath865b3eb2019-12-16 11:46:15 +00001870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001871
Glenn Strausscee11292021-12-20 01:43:17 -05001872 mbedtls_mpi_free( &conf->dhm_P );
1873 mbedtls_mpi_free( &conf->dhm_G );
1874
Hanno Beckera90658f2017-10-04 15:29:08 +01001875 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1876 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1877 {
1878 mbedtls_mpi_free( &conf->dhm_P );
1879 mbedtls_mpi_free( &conf->dhm_G );
1880 return( ret );
1881 }
1882
1883 return( 0 );
1884}
Paul Bakker5121ce52009-01-03 21:22:43 +00001885
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001886int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001887{
Janos Follath865b3eb2019-12-16 11:46:15 +00001888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001889
Glenn Strausscee11292021-12-20 01:43:17 -05001890 mbedtls_mpi_free( &conf->dhm_P );
1891 mbedtls_mpi_free( &conf->dhm_G );
1892
Gilles Peskinee5702482021-06-11 21:59:08 +02001893 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1894 &conf->dhm_P ) ) != 0 ||
1895 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1896 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001897 {
1898 mbedtls_mpi_free( &conf->dhm_P );
1899 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001900 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001901 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001902
1903 return( 0 );
1904}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001905#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001906
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001907#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1908/*
1909 * Set the minimum length for Diffie-Hellman parameters
1910 */
1911void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1912 unsigned int bitlen )
1913{
1914 conf->dhm_min_bitlen = bitlen;
1915}
1916#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1917
Gilles Peskineeccd8882020-03-10 12:19:08 +01001918#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001919#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001920/*
1921 * Set allowed/preferred hashes for handshake signatures
1922 */
1923void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1924 const int *hashes )
1925{
1926 conf->sig_hashes = hashes;
1927}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001928#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001929
Jerry Yuf017ee42022-01-12 15:49:48 +08001930/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001931void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1932 const uint16_t* sig_algs )
1933{
Jerry Yuf017ee42022-01-12 15:49:48 +08001934#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1935 conf->sig_hashes = NULL;
1936#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1937 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001938}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001939#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001940
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001941#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001942#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001943/*
1944 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001945 *
1946 * mbedtls_ssl_setup() takes the provided list
1947 * and translates it to a list of IANA TLS group identifiers,
1948 * stored in ssl->handshake->group_list.
1949 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001950 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001951void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001952 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001953{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001954 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01001955 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001956}
Brett Warrene0edc842021-08-17 09:53:13 +01001957#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01001958#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001959
Brett Warrene0edc842021-08-17 09:53:13 +01001960/*
1961 * Set the allowed groups
1962 */
1963void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
1964 const uint16_t *group_list )
1965{
1966#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1967 conf->curve_list = NULL;
1968#endif
1969 conf->group_list = group_list;
1970}
1971
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001972#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00001974{
Hanno Becker947194e2017-04-07 13:25:49 +01001975 /* Initialize to suppress unnecessary compiler warning */
1976 size_t hostname_len = 0;
1977
1978 /* Check if new hostname is valid before
1979 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01001980 if( hostname != NULL )
1981 {
1982 hostname_len = strlen( hostname );
1983
1984 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
1985 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1986 }
1987
1988 /* Now it's clear that we will overwrite the old hostname,
1989 * so we can free it safely */
1990
1991 if( ssl->hostname != NULL )
1992 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05001993 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01001994 mbedtls_free( ssl->hostname );
1995 }
1996
1997 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01001998
Paul Bakker5121ce52009-01-03 21:22:43 +00001999 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002000 {
2001 ssl->hostname = NULL;
2002 }
2003 else
2004 {
2005 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002006 if( ssl->hostname == NULL )
2007 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002008
Hanno Becker947194e2017-04-07 13:25:49 +01002009 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002010
Hanno Becker947194e2017-04-07 13:25:49 +01002011 ssl->hostname[hostname_len] = '\0';
2012 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002013
2014 return( 0 );
2015}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002016#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002017
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002018#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002019void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002021 const unsigned char *, size_t),
2022 void *p_sni )
2023{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002024 conf->f_sni = f_sni;
2025 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002026}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002030int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002031{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002032 size_t cur_len, tot_len;
2033 const char **p;
2034
2035 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002036 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2037 * MUST NOT be truncated."
2038 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002039 */
2040 tot_len = 0;
2041 for( p = protos; *p != NULL; p++ )
2042 {
2043 cur_len = strlen( *p );
2044 tot_len += cur_len;
2045
Ronald Cron8216dd32020-04-23 16:41:44 +02002046 if( ( cur_len == 0 ) ||
2047 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2048 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002050 }
2051
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002052 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002053
2054 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002055}
2056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002058{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002059 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002060}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002062
Johan Pascalb62bb512015-12-03 21:56:45 +01002063#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002064void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2065 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002066{
2067 conf->dtls_srtp_mki_support = support_mki_value;
2068}
2069
Ron Eldoref72faf2018-07-12 11:54:20 +03002070int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2071 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002072 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002073{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002074 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002075 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002076 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002077 }
Ron Eldor591f1622018-01-22 12:30:04 +02002078
2079 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002080 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002081 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002082 }
Ron Eldor591f1622018-01-22 12:30:04 +02002083
2084 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2085 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002086 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002087}
2088
Ron Eldoref72faf2018-07-12 11:54:20 +03002089int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002090 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002091{
Johan Pascal253d0262020-09-22 13:04:45 +02002092 const mbedtls_ssl_srtp_profile *p;
2093 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002094
Johan Pascal253d0262020-09-22 13:04:45 +02002095 /* check the profiles list: all entry must be valid,
2096 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002097 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2098 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2099 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002100 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002101 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002102 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002103 list_size++;
2104 }
2105 else
2106 {
2107 /* unsupported value, stop parsing and set the size to an error value */
2108 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002109 }
2110 }
2111
Johan Pascal5ef72d22020-10-28 17:05:47 +01002112 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002113 {
Johan Pascal253d0262020-09-22 13:04:45 +02002114 conf->dtls_srtp_profile_list = NULL;
2115 conf->dtls_srtp_profile_list_len = 0;
2116 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2117 }
2118
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002119 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002120 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002121
2122 return( 0 );
2123}
2124
Johan Pascal5ef72d22020-10-28 17:05:47 +01002125void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2126 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002127{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002128 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2129 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002130 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002131 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002132 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002133 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002134 else
2135 {
2136 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002137 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2138 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002139 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002140}
Johan Pascalb62bb512015-12-03 21:56:45 +01002141#endif /* MBEDTLS_SSL_DTLS_SRTP */
2142
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002143void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002144{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002145 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002146}
2147
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002148void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002149{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002150 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002151}
2152
Janos Follath088ce432017-04-10 12:42:31 +01002153#if defined(MBEDTLS_SSL_SRV_C)
2154void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2155 char cert_req_ca_list )
2156{
2157 conf->cert_req_ca_list = cert_req_ca_list;
2158}
2159#endif
2160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002161#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002162void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002163{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002164 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002165}
2166#endif
2167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002169void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002170{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002171 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002172}
2173#endif
2174
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002176int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002177{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002179 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002180 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002182 }
2183
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002184 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002185
2186 return( 0 );
2187}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002189
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002190void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002191{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002192 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002193}
2194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002196void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002197{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002198 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002199}
2200
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002201void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002202{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002203 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002204}
2205
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002206void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002207 const unsigned char period[8] )
2208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002209 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002210}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002214#if defined(MBEDTLS_SSL_CLI_C)
2215void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002216{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002217 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002218}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002219#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002220
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002221#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002222void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2223 mbedtls_ssl_ticket_write_t *f_ticket_write,
2224 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2225 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002226{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002227 conf->f_ticket_write = f_ticket_write;
2228 conf->f_ticket_parse = f_ticket_parse;
2229 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002230}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002231#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002233
Hanno Becker7e6c1782021-06-08 09:24:55 +01002234void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2235 mbedtls_ssl_export_keys_t *f_export_keys,
2236 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002237{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002238 ssl->f_export_keys = f_export_keys;
2239 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002240}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002241
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002242#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002243void mbedtls_ssl_conf_async_private_cb(
2244 mbedtls_ssl_config *conf,
2245 mbedtls_ssl_async_sign_t *f_async_sign,
2246 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2247 mbedtls_ssl_async_resume_t *f_async_resume,
2248 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002249 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002250{
2251 conf->f_async_sign_start = f_async_sign;
2252 conf->f_async_decrypt_start = f_async_decrypt;
2253 conf->f_async_resume = f_async_resume;
2254 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002255 conf->p_async_config_data = async_config_data;
2256}
2257
Gilles Peskine8f97af72018-04-26 11:46:10 +02002258void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2259{
2260 return( conf->p_async_config_data );
2261}
2262
Gilles Peskine1febfef2018-04-30 11:54:39 +02002263void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002264{
2265 if( ssl->handshake == NULL )
2266 return( NULL );
2267 else
2268 return( ssl->handshake->user_async_ctx );
2269}
2270
Gilles Peskine1febfef2018-04-30 11:54:39 +02002271void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002272 void *ctx )
2273{
2274 if( ssl->handshake != NULL )
2275 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002276}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002277#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002278
Paul Bakker5121ce52009-01-03 21:22:43 +00002279/*
2280 * SSL get accessors
2281 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002282uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002283{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002284 if( ssl->session != NULL )
2285 return( ssl->session->verify_result );
2286
2287 if( ssl->session_negotiate != NULL )
2288 return( ssl->session_negotiate->verify_result );
2289
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002290 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002291}
2292
Glenn Strauss8f526902022-01-13 00:04:49 -05002293int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2294{
2295 if( ssl == NULL || ssl->session == NULL )
2296 return( 0 );
2297
2298 return( ssl->session->ciphersuite );
2299}
2300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002302{
Paul Bakker926c8e42013-03-06 10:23:34 +01002303 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002304 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002307}
2308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002310{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002312 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002313 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002314 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002315 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002316 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002317 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002318 default:
2319 return( "unknown (DTLS)" );
2320 }
2321 }
2322#endif
2323
Glenn Strauss60bfe602022-03-14 19:04:24 -04002324 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002325 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002326 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002327 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002328 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002329 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002330 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002331 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002332 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002333}
2334
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002335#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002336size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2337{
David Horstmann95d516f2021-05-04 18:36:56 +01002338 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002339 size_t read_mfl;
2340
2341 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2342 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2343 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2344 {
2345 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2346 }
2347
2348 /* Check if a smaller max length was negotiated */
2349 if( ssl->session_out != NULL )
2350 {
2351 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2352 if( read_mfl < max_len )
2353 {
2354 max_len = read_mfl;
2355 }
2356 }
2357
2358 // During a handshake, use the value being negotiated
2359 if( ssl->session_negotiate != NULL )
2360 {
2361 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2362 if( read_mfl < max_len )
2363 {
2364 max_len = read_mfl;
2365 }
2366 }
2367
2368 return( max_len );
2369}
2370
2371size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002372{
2373 size_t max_len;
2374
2375 /*
2376 * Assume mfl_code is correct since it was checked when set
2377 */
Angus Grattond8213d02016-05-25 20:56:48 +10002378 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002379
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002380 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002381 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002382 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002383 {
Angus Grattond8213d02016-05-25 20:56:48 +10002384 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002385 }
2386
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002387 /* During a handshake, use the value being negotiated */
2388 if( ssl->session_negotiate != NULL &&
2389 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2390 {
2391 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2392 }
2393
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002394 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002395}
2396#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2397
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002398#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002399size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002400{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002401 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2402 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2403 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2404 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2405 return ( 0 );
2406
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002407 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2408 return( ssl->mtu );
2409
2410 if( ssl->mtu == 0 )
2411 return( ssl->handshake->mtu );
2412
2413 return( ssl->mtu < ssl->handshake->mtu ?
2414 ssl->mtu : ssl->handshake->mtu );
2415}
2416#endif /* MBEDTLS_SSL_PROTO_DTLS */
2417
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002418int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2419{
2420 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2421
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002422#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2423 !defined(MBEDTLS_SSL_PROTO_DTLS)
2424 (void) ssl;
2425#endif
2426
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002427#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002428 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002429
2430 if( max_len > mfl )
2431 max_len = mfl;
2432#endif
2433
2434#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002435 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002436 {
Hanno Becker89490712020-02-05 10:50:12 +00002437 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002438 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2439 const size_t overhead = (size_t) ret;
2440
2441 if( ret < 0 )
2442 return( ret );
2443
2444 if( mtu <= overhead )
2445 {
2446 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2447 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2448 }
2449
2450 if( max_len > mtu - overhead )
2451 max_len = mtu - overhead;
2452 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002453#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002454
Hanno Becker0defedb2018-08-10 12:35:02 +01002455#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2456 !defined(MBEDTLS_SSL_PROTO_DTLS)
2457 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002458#endif
2459
2460 return( (int) max_len );
2461}
2462
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002463int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2464{
2465 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2466
2467#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2468 (void) ssl;
2469#endif
2470
2471#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2472 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2473
2474 if( max_len > mfl )
2475 max_len = mfl;
2476#endif
2477
2478 return( (int) max_len );
2479}
2480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481#if defined(MBEDTLS_X509_CRT_PARSE_C)
2482const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002483{
2484 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002485 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002486
Hanno Beckere6824572019-02-07 13:18:46 +00002487#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002488 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002489#else
2490 return( NULL );
2491#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002492}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002496int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2497 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002498{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002499 int ret;
2500
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002501 if( ssl == NULL ||
2502 dst == NULL ||
2503 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002504 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002507 }
2508
Hanno Beckere810bbc2021-05-14 16:01:05 +01002509 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2510 * idempotent: Each session can only be exported once.
2511 *
2512 * (This is in preparation for TLS 1.3 support where we will
2513 * need the ability to export multiple sessions (aka tickets),
2514 * which will be achieved by calling mbedtls_ssl_get_session()
2515 * multiple times until it fails.)
2516 *
2517 * Check whether we have already exported the current session,
2518 * and fail if so.
2519 */
2520 if( ssl->session->exported == 1 )
2521 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2522
2523 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2524 if( ret != 0 )
2525 return( ret );
2526
2527 /* Remember that we've exported the session. */
2528 ssl->session->exported = 1;
2529 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002530}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002532
Paul Bakker5121ce52009-01-03 21:22:43 +00002533/*
Hanno Beckera835da52019-05-16 12:39:07 +01002534 * Define ticket header determining Mbed TLS version
2535 * and structure of the ticket.
2536 */
2537
Hanno Becker94ef3b32019-05-16 12:50:45 +01002538/*
Hanno Becker50b59662019-05-28 14:30:45 +01002539 * Define bitflag determining compile-time settings influencing
2540 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002541 */
2542
Hanno Becker50b59662019-05-28 14:30:45 +01002543#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002544#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002545#else
Hanno Becker3e088662019-05-29 11:10:18 +01002546#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002547#endif /* MBEDTLS_HAVE_TIME */
2548
2549#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002550#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002551#else
Hanno Becker3e088662019-05-29 11:10:18 +01002552#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002553#endif /* MBEDTLS_X509_CRT_PARSE_C */
2554
2555#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002556#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002557#else
Hanno Becker3e088662019-05-29 11:10:18 +01002558#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002559#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2560
2561#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002562#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002563#else
Hanno Becker3e088662019-05-29 11:10:18 +01002564#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002565#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2566
Hanno Becker94ef3b32019-05-16 12:50:45 +01002567#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002568#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002569#else
Hanno Becker3e088662019-05-29 11:10:18 +01002570#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002571#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2572
Hanno Becker94ef3b32019-05-16 12:50:45 +01002573#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2574#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2575#else
2576#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2577#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2578
Hanno Becker3e088662019-05-29 11:10:18 +01002579#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2580#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2581#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2582#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002583#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2584#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002585
Hanno Becker50b59662019-05-28 14:30:45 +01002586#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002587 ( (uint16_t) ( \
2588 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2589 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2590 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2591 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002592 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002593 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002594
Hanno Beckerf8787072019-05-16 12:41:07 +01002595static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002596 MBEDTLS_VERSION_MAJOR,
2597 MBEDTLS_VERSION_MINOR,
2598 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002599 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2600 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002601};
Hanno Beckera835da52019-05-16 12:39:07 +01002602
2603/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002604 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002605 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002606 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002607 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002608 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002609 * opaque mbedtls_version[3]; // library version: major, minor, patch
2610 * opaque session_format[2]; // library-version specific 16-bit field
2611 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002612 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002613 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002614 * Note: When updating the format, remember to keep
2615 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002616 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002617 * // In this version, `session_format` determines
2618 * // the setting of those compile-time
2619 * // configuration options which influence
2620 * // the structure of mbedtls_ssl_session.
2621 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002622 * uint8_t minor_ver; // Protocol minor version. Possible values:
2623 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002624 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002625 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002626 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002627 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002628 * serialized_session_tls12 data;
2629 *
2630 * };
2631 *
2632 * } serialized_session;
2633 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002634 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002635
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002636static int ssl_session_save( const mbedtls_ssl_session *session,
2637 unsigned char omit_header,
2638 unsigned char *buf,
2639 size_t buf_len,
2640 size_t *olen )
2641{
2642 unsigned char *p = buf;
2643 size_t used = 0;
2644
2645 if( !omit_header )
2646 {
2647 /*
2648 * Add Mbed TLS version identifier
2649 */
2650
2651 used += sizeof( ssl_serialized_session_header );
2652
2653 if( used <= buf_len )
2654 {
2655 memcpy( p, ssl_serialized_session_header,
2656 sizeof( ssl_serialized_session_header ) );
2657 p += sizeof( ssl_serialized_session_header );
2658 }
2659 }
2660
2661 /*
2662 * TLS version identifier
2663 */
2664 used += 1;
2665 if( used <= buf_len )
2666 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002667 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002668 }
2669
2670 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002671 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002672 {
2673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002674 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002675 {
2676 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2677 used += ssl_session_save_tls12( session, p, remaining_len );
2678 break;
2679 }
2680#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2681
2682 default:
2683 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2684 }
2685
2686 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002687 if( used > buf_len )
2688 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002689
2690 return( 0 );
2691}
2692
2693/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002694 * Public wrapper for ssl_session_save()
2695 */
2696int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2697 unsigned char *buf,
2698 size_t buf_len,
2699 size_t *olen )
2700{
2701 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2702}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002703
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002704/*
2705 * Deserialize session, see mbedtls_ssl_session_save() for format.
2706 *
2707 * This internal version is wrapped by a public function that cleans up in
2708 * case of error, and has an extra option omit_header.
2709 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002710static int ssl_session_load( mbedtls_ssl_session *session,
2711 unsigned char omit_header,
2712 const unsigned char *buf,
2713 size_t len )
2714{
2715 const unsigned char *p = buf;
2716 const unsigned char * const end = buf + len;
2717
2718 if( !omit_header )
2719 {
2720 /*
2721 * Check Mbed TLS version identifier
2722 */
2723
2724 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2725 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2726
2727 if( memcmp( p, ssl_serialized_session_header,
2728 sizeof( ssl_serialized_session_header ) ) != 0 )
2729 {
2730 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2731 }
2732 p += sizeof( ssl_serialized_session_header );
2733 }
2734
2735 /*
2736 * TLS version identifier
2737 */
2738 if( 1 > (size_t)( end - p ) )
2739 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002740 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002741
2742 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002743 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002744 {
2745#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002746 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002747 {
2748 size_t remaining_len = ( end - p );
2749 return( ssl_session_load_tls12( session, p, remaining_len ) );
2750 }
2751#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2752
2753 default:
2754 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2755 }
2756}
2757
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002758/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002759 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002760 */
2761int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2762 const unsigned char *buf,
2763 size_t len )
2764{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002765 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002766
2767 if( ret != 0 )
2768 mbedtls_ssl_session_free( session );
2769
2770 return( ret );
2771}
2772
2773/*
Paul Bakker1961b702013-01-25 14:49:24 +01002774 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002775 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002776static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2777{
2778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2779
Ronald Cron66dbf912022-02-02 15:33:46 +01002780 /*
2781 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002782 * that were written into the output buffer by the previous handshake step,
2783 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002784 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2785 * We proceed to the next handshake step only when all data from the
2786 * previous one have been sent to the peer, thus we make sure that this is
2787 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2788 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2789 * we have to wait before to go ahead.
2790 * In the case of TLS 1.3, handshake step handlers do not send data to the
2791 * peer. Data are only sent here and through
2792 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2793 * alert occured.
2794 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002795 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2796 return( ret );
2797
2798#if defined(MBEDTLS_SSL_PROTO_DTLS)
2799 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2800 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2801 {
2802 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2803 return( ret );
2804 }
2805#endif /* MBEDTLS_SSL_PROTO_DTLS */
2806
2807 return( ret );
2808}
2809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002811{
Hanno Becker41934dd2021-08-07 19:13:43 +01002812 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002813
Hanno Becker41934dd2021-08-07 19:13:43 +01002814 if( ssl == NULL ||
2815 ssl->conf == NULL ||
2816 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002817 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002818 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002819 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002820 }
2821
2822 ret = ssl_prepare_handshake_step( ssl );
2823 if( ret != 0 )
2824 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002825
Jerry Yue7047812021-09-13 19:26:39 +08002826 ret = mbedtls_ssl_handle_pending_alert( ssl );
2827 if( ret != 0 )
2828 goto cleanup;
2829
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002831 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002832 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2834 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002835
Ronald Cron9f0fba32022-02-10 16:45:15 +01002836 switch( ssl->state )
2837 {
2838 case MBEDTLS_SSL_HELLO_REQUEST:
2839 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2840 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002841
Ronald Cron9f0fba32022-02-10 16:45:15 +01002842 case MBEDTLS_SSL_CLIENT_HELLO:
2843 ret = mbedtls_ssl_write_client_hello( ssl );
2844 break;
2845
2846 default:
2847#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002848 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002849 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2850 else
2851 ret = mbedtls_ssl_handshake_client_step( ssl );
2852#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2853 ret = mbedtls_ssl_handshake_client_step( ssl );
2854#else
2855 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2856#endif
2857 }
Jerry Yub9930e72021-08-06 17:11:51 +08002858 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002859#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002861 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002862 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002863#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002864 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002865 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002866#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002867
2868#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2869 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2870 ret = mbedtls_ssl_handshake_server_step( ssl );
2871#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2872 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002873#endif
2874
Jerry Yue7047812021-09-13 19:26:39 +08002875 if( ret != 0 )
2876 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002877 /* handshake_step return error. And it is same
2878 * with alert_reason.
2879 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002880 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002881 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002882 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002883 goto cleanup;
2884 }
2885 }
2886
2887cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002888 return( ret );
2889}
2890
2891/*
2892 * Perform the SSL handshake
2893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002895{
2896 int ret = 0;
2897
Hanno Beckera817ea42020-10-20 15:20:23 +01002898 /* Sanity checks */
2899
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002900 if( ssl == NULL || ssl->conf == NULL )
2901 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2902
Hanno Beckera817ea42020-10-20 15:20:23 +01002903#if defined(MBEDTLS_SSL_PROTO_DTLS)
2904 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2905 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2906 {
2907 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2908 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2909 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2910 }
2911#endif /* MBEDTLS_SSL_PROTO_DTLS */
2912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002914
Hanno Beckera817ea42020-10-20 15:20:23 +01002915 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00002916 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01002917 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002919
2920 if( ret != 0 )
2921 break;
2922 }
2923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002925
2926 return( ret );
2927}
2928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929#if defined(MBEDTLS_SSL_RENEGOTIATION)
2930#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002931/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002932 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002935{
Janos Follath865b3eb2019-12-16 11:46:15 +00002936 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002939
2940 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2942 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002943
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002944 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002945 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002946 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002947 return( ret );
2948 }
2949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002951
2952 return( 0 );
2953}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002955
2956/*
2957 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 * - any side: calling mbedtls_ssl_renegotiate(),
2959 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2960 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002961 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002962 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002964 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002965int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002966{
Janos Follath865b3eb2019-12-16 11:46:15 +00002967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002970
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002971 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2972 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002973
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002974 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
2975 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002977 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002979 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002980 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002981 ssl->handshake->out_msg_seq = 1;
2982 else
2983 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002984 }
2985#endif
2986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
2988 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00002989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00002991 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002993 return( ret );
2994 }
2995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002997
2998 return( 0 );
2999}
3000
3001/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003002 * Renegotiate current connection on client,
3003 * or request renegotiation on server
3004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003006{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003008
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003009 if( ssl == NULL || ssl->conf == NULL )
3010 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003013 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003014 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003015 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003016 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003020
3021 /* Did we already try/start sending HelloRequest? */
3022 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003024
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003025 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003026 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003030 /*
3031 * On client, either start the renegotiation process or,
3032 * if already in progress, continue the handshake
3033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003035 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003036 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003038
Hanno Becker40cdaa12020-02-05 10:48:27 +00003039 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003040 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003041 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003042 return( ret );
3043 }
3044 }
3045 else
3046 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003048 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003050 return( ret );
3051 }
3052 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003054
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003055 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003056}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003058
Gilles Peskine9b562d52018-04-25 20:32:43 +02003059void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003060{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003061 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3062
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003063 if( handshake == NULL )
3064 return;
3065
Brett Warrene0edc842021-08-17 09:53:13 +01003066#if defined(MBEDTLS_ECP_C)
3067#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3068 if ( ssl->handshake->group_list_heap_allocated )
3069 mbedtls_free( (void*) handshake->group_list );
3070 handshake->group_list = NULL;
3071#endif /* MBEDTLS_DEPRECATED_REMOVED */
3072#endif /* MBEDTLS_ECP_C */
3073
Jerry Yuf017ee42022-01-12 15:49:48 +08003074#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3075#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3076 if ( ssl->handshake->sig_algs_heap_allocated )
3077 mbedtls_free( (void*) handshake->sig_algs );
3078 handshake->sig_algs = NULL;
3079#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003080#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3081 if( ssl->handshake->certificate_request_context )
3082 {
3083 mbedtls_free( (void*) handshake->certificate_request_context );
3084 }
3085#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003086#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3087
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003088#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3089 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3090 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003091 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003092 handshake->async_in_progress = 0;
3093 }
3094#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3095
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003096#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003097#if defined(MBEDTLS_USE_PSA_CRYPTO)
3098 psa_hash_abort( &handshake->fin_sha256_psa );
3099#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003100 mbedtls_sha256_free( &handshake->fin_sha256 );
3101#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003102#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003103#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003104#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003105 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003106#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003107 mbedtls_sha512_free( &handshake->fin_sha512 );
3108#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003109#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111#if defined(MBEDTLS_DHM_C)
3112 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003113#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114#if defined(MBEDTLS_ECDH_C)
3115 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003116#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003117#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003118 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003119#if defined(MBEDTLS_SSL_CLI_C)
3120 mbedtls_free( handshake->ecjpake_cache );
3121 handshake->ecjpake_cache = NULL;
3122 handshake->ecjpake_cache_len = 0;
3123#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003124#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003125
Janos Follath4ae5c292016-02-10 11:27:43 +00003126#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3127 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003128 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003130#endif
3131
Gilles Peskineeccd8882020-03-10 12:19:08 +01003132#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003133 if( handshake->psk != NULL )
3134 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003135 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003136 mbedtls_free( handshake->psk );
3137 }
3138#endif
3139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3141 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003142 /*
3143 * Free only the linked list wrapper, not the keys themselves
3144 * since the belong to the SNI callback
3145 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003146 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003148
Gilles Peskineeccd8882020-03-10 12:19:08 +01003149#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003150 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003151 if( handshake->ecrs_peer_cert != NULL )
3152 {
3153 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3154 mbedtls_free( handshake->ecrs_peer_cert );
3155 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003156#endif
3157
Hanno Becker75173122019-02-06 16:18:31 +00003158#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3159 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3160 mbedtls_pk_free( &handshake->peer_pubkey );
3161#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3162
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003163#if defined(MBEDTLS_SSL_CLI_C) && \
3164 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3165 mbedtls_free( handshake->cookie );
3166#endif /* MBEDTLS_SSL_CLI_C &&
3167 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003168
3169#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003170 mbedtls_ssl_flight_free( handshake->flight );
3171 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003172#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003173
Ronald Cronf12b81d2022-03-15 10:42:41 +01003174#if defined(MBEDTLS_ECDH_C) && \
3175 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003176 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003177 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003178#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3179
Ronald Cron6f135e12021-12-08 16:57:54 +01003180#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003181 mbedtls_ssl_transform_free( handshake->transform_handshake );
3182 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003183 mbedtls_free( handshake->transform_earlydata );
3184 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003185#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003186
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003187
3188#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3189 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3190 * processes datagrams and the fact that a datagram is allowed to have
3191 * several records in it, it is possible that the I/O buffers are not
3192 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003193 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3194 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003195#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003196
Jerry Yuba9c7272021-10-30 11:54:10 +08003197 /* mbedtls_platform_zeroize MUST be last one in this function */
3198 mbedtls_platform_zeroize( handshake,
3199 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003200}
3201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003203{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003204 if( session == NULL )
3205 return;
3206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003208 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003209#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003210
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003211#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003213#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003214
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003215 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003216}
3217
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003218#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003219
3220#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3221#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3222#else
3223#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3224#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3225
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003226#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003227
3228#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3229#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3230#else
3231#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3232#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3233
3234#if defined(MBEDTLS_SSL_ALPN)
3235#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3236#else
3237#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3238#endif /* MBEDTLS_SSL_ALPN */
3239
3240#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3241#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3242#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3243#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3244
3245#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3246 ( (uint32_t) ( \
3247 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3248 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3249 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3250 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3251 0u ) )
3252
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003253static unsigned char ssl_serialized_context_header[] = {
3254 MBEDTLS_VERSION_MAJOR,
3255 MBEDTLS_VERSION_MINOR,
3256 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003257 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3258 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3259 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3260 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3261 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003262};
3263
Paul Bakker5121ce52009-01-03 21:22:43 +00003264/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003265 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003266 *
3267 * The format of the serialized data is:
3268 * (in the presentation language of TLS, RFC 8446 section 3)
3269 *
3270 * // header
3271 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003272 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003273 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003274 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003275 * Note: When updating the format, remember to keep these
3276 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003277 *
3278 * // session sub-structure
3279 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3280 * // transform sub-structure
3281 * uint8 random[64]; // ServerHello.random+ClientHello.random
3282 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3283 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3284 * // fields from ssl_context
3285 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3286 * uint64 in_window_top; // DTLS: last validated record seq_num
3287 * uint64 in_window; // DTLS: bitmask for replay protection
3288 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3289 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3290 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3291 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3292 *
3293 * Note that many fields of the ssl_context or sub-structures are not
3294 * serialized, as they fall in one of the following categories:
3295 *
3296 * 1. forced value (eg in_left must be 0)
3297 * 2. pointer to dynamically-allocated memory (eg session, transform)
3298 * 3. value can be re-derived from other data (eg session keys from MS)
3299 * 4. value was temporary (eg content of input buffer)
3300 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003301 */
3302int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3303 unsigned char *buf,
3304 size_t buf_len,
3305 size_t *olen )
3306{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003307 unsigned char *p = buf;
3308 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003309 size_t session_len;
3310 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003311
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003312 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003313 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3314 * this function's documentation.
3315 *
3316 * These are due to assumptions/limitations in the implementation. Some of
3317 * them are likely to stay (no handshake in progress) some might go away
3318 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003319 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003320 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003321 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003322 {
3323 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003324 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003325 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003326 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003327 {
3328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003329 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003330 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003331 /* Double-check that sub-structures are indeed ready */
3332 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003333 {
3334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003335 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003336 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003337 /* There must be no pending incoming or outgoing data */
3338 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003339 {
3340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003341 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003342 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003343 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003344 {
3345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003346 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003347 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003348 /* Protocol must be DLTS, not TLS */
3349 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003350 {
3351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003352 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003353 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003354 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003355 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003356 {
3357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003358 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003359 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003360 /* We must be using an AEAD ciphersuite */
3361 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003362 {
3363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003364 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003365 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003366 /* Renegotiation must not be enabled */
3367#if defined(MBEDTLS_SSL_RENEGOTIATION)
3368 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003369 {
3370 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
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#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003374
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003375 /*
3376 * Version and format identifier
3377 */
3378 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003379
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003380 if( used <= buf_len )
3381 {
3382 memcpy( p, ssl_serialized_context_header,
3383 sizeof( ssl_serialized_context_header ) );
3384 p += sizeof( ssl_serialized_context_header );
3385 }
3386
3387 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003388 * Session (length + data)
3389 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003390 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003391 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3392 return( ret );
3393
3394 used += 4 + session_len;
3395 if( used <= buf_len )
3396 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003397 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3398 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003399
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003400 ret = ssl_session_save( ssl->session, 1,
3401 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003402 if( ret != 0 )
3403 return( ret );
3404
3405 p += session_len;
3406 }
3407
3408 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003409 * Transform
3410 */
3411 used += sizeof( ssl->transform->randbytes );
3412 if( used <= buf_len )
3413 {
3414 memcpy( p, ssl->transform->randbytes,
3415 sizeof( ssl->transform->randbytes ) );
3416 p += sizeof( ssl->transform->randbytes );
3417 }
3418
3419#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3420 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3421 if( used <= buf_len )
3422 {
3423 *p++ = ssl->transform->in_cid_len;
3424 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3425 p += ssl->transform->in_cid_len;
3426
3427 *p++ = ssl->transform->out_cid_len;
3428 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3429 p += ssl->transform->out_cid_len;
3430 }
3431#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3432
3433 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003434 * Saved fields from top-level ssl_context structure
3435 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003436 used += 4;
3437 if( used <= buf_len )
3438 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003439 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3440 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003441 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003442
3443#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3444 used += 16;
3445 if( used <= buf_len )
3446 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003447 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3448 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003449
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003450 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3451 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003452 }
3453#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3454
3455#if defined(MBEDTLS_SSL_PROTO_DTLS)
3456 used += 1;
3457 if( used <= buf_len )
3458 {
3459 *p++ = ssl->disable_datagram_packing;
3460 }
3461#endif /* MBEDTLS_SSL_PROTO_DTLS */
3462
Jerry Yuae0b2e22021-10-08 15:21:19 +08003463 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003464 if( used <= buf_len )
3465 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003466 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3467 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003468 }
3469
3470#if defined(MBEDTLS_SSL_PROTO_DTLS)
3471 used += 2;
3472 if( used <= buf_len )
3473 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003474 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3475 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003476 }
3477#endif /* MBEDTLS_SSL_PROTO_DTLS */
3478
3479#if defined(MBEDTLS_SSL_ALPN)
3480 {
3481 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003482 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003483 : 0;
3484
3485 used += 1 + alpn_len;
3486 if( used <= buf_len )
3487 {
3488 *p++ = alpn_len;
3489
3490 if( ssl->alpn_chosen != NULL )
3491 {
3492 memcpy( p, ssl->alpn_chosen, alpn_len );
3493 p += alpn_len;
3494 }
3495 }
3496 }
3497#endif /* MBEDTLS_SSL_ALPN */
3498
3499 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003500 * Done
3501 */
3502 *olen = used;
3503
3504 if( used > buf_len )
3505 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003506
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003507 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3508
Hanno Becker43aefe22020-02-05 10:44:56 +00003509 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003510}
3511
3512/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003513 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003514 *
3515 * This internal version is wrapped by a public function that cleans up in
3516 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003517 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003518static int ssl_context_load( mbedtls_ssl_context *ssl,
3519 const unsigned char *buf,
3520 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003521{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003522 const unsigned char *p = buf;
3523 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003524 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003525 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003526
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003527 /*
3528 * The context should have been freshly setup or reset.
3529 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003530 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003531 * renegotiating, or if the user mistakenly loaded a session first.)
3532 */
3533 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3534 ssl->session != NULL )
3535 {
3536 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3537 }
3538
3539 /*
3540 * We can't check that the config matches the initial one, but we can at
3541 * least check it matches the requirements for serializing.
3542 */
3543 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003544 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3545 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003546#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003547 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003548#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003549 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003550 {
3551 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3552 }
3553
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003554 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3555
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003556 /*
3557 * Check version identifier
3558 */
3559 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3560 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3561
3562 if( memcmp( p, ssl_serialized_context_header,
3563 sizeof( ssl_serialized_context_header ) ) != 0 )
3564 {
3565 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3566 }
3567 p += sizeof( ssl_serialized_context_header );
3568
3569 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003570 * Session
3571 */
3572 if( (size_t)( end - p ) < 4 )
3573 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3574
3575 session_len = ( (size_t) p[0] << 24 ) |
3576 ( (size_t) p[1] << 16 ) |
3577 ( (size_t) p[2] << 8 ) |
3578 ( (size_t) p[3] );
3579 p += 4;
3580
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003581 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003582 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003583 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003584 ssl->session_in = ssl->session;
3585 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003586 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003587
3588 if( (size_t)( end - p ) < session_len )
3589 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3590
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003591 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003592 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003593 {
3594 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003595 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003596 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003597
3598 p += session_len;
3599
3600 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003601 * Transform
3602 */
3603
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003604 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003605 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003606 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003607 ssl->transform_in = ssl->transform;
3608 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003609 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003610
3611 /* Read random bytes and populate structure */
3612 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3613 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003614#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003615 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003616 ssl->session->ciphersuite,
3617 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003618#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3619 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003620 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003621#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3622 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003623 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3624 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003625 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003626 ssl->conf->endpoint,
3627 ssl );
3628 if( ret != 0 )
3629 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003630#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003631 p += sizeof( ssl->transform->randbytes );
3632
3633#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3634 /* Read connection IDs and store them */
3635 if( (size_t)( end - p ) < 1 )
3636 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3637
3638 ssl->transform->in_cid_len = *p++;
3639
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003640 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003641 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3642
3643 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3644 p += ssl->transform->in_cid_len;
3645
3646 ssl->transform->out_cid_len = *p++;
3647
3648 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3649 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3650
3651 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3652 p += ssl->transform->out_cid_len;
3653#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3654
3655 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003656 * Saved fields from top-level ssl_context structure
3657 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003658 if( (size_t)( end - p ) < 4 )
3659 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3660
3661 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3662 ( (uint32_t) p[1] << 16 ) |
3663 ( (uint32_t) p[2] << 8 ) |
3664 ( (uint32_t) p[3] );
3665 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003666
3667#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3668 if( (size_t)( end - p ) < 16 )
3669 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3670
3671 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3672 ( (uint64_t) p[1] << 48 ) |
3673 ( (uint64_t) p[2] << 40 ) |
3674 ( (uint64_t) p[3] << 32 ) |
3675 ( (uint64_t) p[4] << 24 ) |
3676 ( (uint64_t) p[5] << 16 ) |
3677 ( (uint64_t) p[6] << 8 ) |
3678 ( (uint64_t) p[7] );
3679 p += 8;
3680
3681 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3682 ( (uint64_t) p[1] << 48 ) |
3683 ( (uint64_t) p[2] << 40 ) |
3684 ( (uint64_t) p[3] << 32 ) |
3685 ( (uint64_t) p[4] << 24 ) |
3686 ( (uint64_t) p[5] << 16 ) |
3687 ( (uint64_t) p[6] << 8 ) |
3688 ( (uint64_t) p[7] );
3689 p += 8;
3690#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3691
3692#if defined(MBEDTLS_SSL_PROTO_DTLS)
3693 if( (size_t)( end - p ) < 1 )
3694 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3695
3696 ssl->disable_datagram_packing = *p++;
3697#endif /* MBEDTLS_SSL_PROTO_DTLS */
3698
Jerry Yud9a94fe2021-09-28 18:58:59 +08003699 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003700 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003701 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3702 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003703
3704#if defined(MBEDTLS_SSL_PROTO_DTLS)
3705 if( (size_t)( end - p ) < 2 )
3706 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3707
3708 ssl->mtu = ( p[0] << 8 ) | p[1];
3709 p += 2;
3710#endif /* MBEDTLS_SSL_PROTO_DTLS */
3711
3712#if defined(MBEDTLS_SSL_ALPN)
3713 {
3714 uint8_t alpn_len;
3715 const char **cur;
3716
3717 if( (size_t)( end - p ) < 1 )
3718 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3719
3720 alpn_len = *p++;
3721
3722 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3723 {
3724 /* alpn_chosen should point to an item in the configured list */
3725 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3726 {
3727 if( strlen( *cur ) == alpn_len &&
3728 memcmp( p, cur, alpn_len ) == 0 )
3729 {
3730 ssl->alpn_chosen = *cur;
3731 break;
3732 }
3733 }
3734 }
3735
3736 /* can only happen on conf mismatch */
3737 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3738 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3739
3740 p += alpn_len;
3741 }
3742#endif /* MBEDTLS_SSL_ALPN */
3743
3744 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003745 * Forced fields from top-level ssl_context structure
3746 *
3747 * Most of them already set to the correct value by mbedtls_ssl_init() and
3748 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3749 */
3750 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003751 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003752
Hanno Becker361b10d2019-08-30 10:42:49 +01003753 /* Adjust pointers for header fields of outgoing records to
3754 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003755 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003756
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003757#if defined(MBEDTLS_SSL_PROTO_DTLS)
3758 ssl->in_epoch = 1;
3759#endif
3760
3761 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3762 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003763 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3764 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003765 if( ssl->handshake != NULL )
3766 {
3767 mbedtls_ssl_handshake_free( ssl );
3768 mbedtls_free( ssl->handshake );
3769 ssl->handshake = NULL;
3770 }
3771
3772 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003773 * Done - should have consumed entire buffer
3774 */
3775 if( p != end )
3776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003777
3778 return( 0 );
3779}
3780
3781/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003782 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003783 */
3784int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3785 const unsigned char *buf,
3786 size_t len )
3787{
3788 int ret = ssl_context_load( context, buf, len );
3789
3790 if( ret != 0 )
3791 mbedtls_ssl_free( context );
3792
3793 return( ret );
3794}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003795#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003796
3797/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003798 * Free an SSL context
3799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003801{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003802 if( ssl == NULL )
3803 return;
3804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003805 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003806
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003807 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003808 {
sander-visserb8aa2072020-05-06 22:05:13 +02003809#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3810 size_t out_buf_len = ssl->out_buf_len;
3811#else
3812 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3813#endif
3814
Darryl Greenb33cc762019-11-28 14:29:44 +00003815 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003816 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003817 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003818 }
3819
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003820 if( ssl->in_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 in_buf_len = ssl->in_buf_len;
3824#else
3825 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3826#endif
3827
Darryl Greenb33cc762019-11-28 14:29:44 +00003828 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003830 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003831 }
3832
Paul Bakker48916f92012-09-16 19:57:18 +00003833 if( ssl->transform )
3834 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835 mbedtls_ssl_transform_free( ssl->transform );
3836 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003837 }
3838
3839 if( ssl->handshake )
3840 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003841 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003842 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3843 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845 mbedtls_free( ssl->handshake );
3846 mbedtls_free( ssl->transform_negotiate );
3847 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003848 }
3849
Ronald Cron6f135e12021-12-08 16:57:54 +01003850#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003851 mbedtls_ssl_transform_free( ssl->transform_application );
3852 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003853#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003854
Paul Bakkerc0463502013-02-14 11:19:38 +01003855 if( ssl->session )
3856 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003857 mbedtls_ssl_session_free( ssl->session );
3858 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003859 }
3860
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003861#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003862 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003863 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003864 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003865 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003866 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003867#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003868
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003869#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003870 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003871#endif
3872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003874
Paul Bakker86f04f42013-02-14 11:20:09 +01003875 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003876 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003877}
3878
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003879/*
3880 * Initialze mbedtls_ssl_config
3881 */
3882void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3883{
3884 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3885}
3886
Gilles Peskineeccd8882020-03-10 12:19:08 +01003887#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003888#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003889/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003890 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3891 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003892 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3893 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003894static int ssl_preset_default_hashes[] = {
3895#if defined(MBEDTLS_SHA512_C)
3896 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003897#endif
3898#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003899 MBEDTLS_MD_SHA384,
3900#endif
3901#if defined(MBEDTLS_SHA256_C)
3902 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003903#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003904 MBEDTLS_MD_NONE
3905};
Jerry Yuf017ee42022-01-12 15:49:48 +08003906#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3907#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003908
Gilles Peskineae270bf2021-06-02 00:05:29 +02003909/* The selection should be the same as mbedtls_x509_crt_profile_default in
3910 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003911 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003912 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003913 * about this list.
3914 */
Brett Warrene0edc842021-08-17 09:53:13 +01003915static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003916#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003917 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003918#endif
3919#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003920 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003921#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003922#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003923 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003924#endif
3925#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003926 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003927#endif
3928#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003929 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003930#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003931#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003932 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003933#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003934#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003935 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003936#endif
3937#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003938 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003939#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003940 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003941};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003942
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003943static int ssl_preset_suiteb_ciphersuites[] = {
3944 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3945 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3946 0
3947};
3948
Gilles Peskineeccd8882020-03-10 12:19:08 +01003949#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003950#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003951static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003952#if defined(MBEDTLS_SHA256_C)
3953 MBEDTLS_MD_SHA256,
3954#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003955#if defined(MBEDTLS_SHA384_C)
3956 MBEDTLS_MD_SHA384,
3957#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003958 MBEDTLS_MD_NONE
3959};
Jerry Yuf017ee42022-01-12 15:49:48 +08003960#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003961
Jerry Yu909df7b2022-01-22 11:56:27 +08003962/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003963 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08003964 * rules SHOULD be upheld.
3965 * - No duplicate entries.
3966 * - But if there is a good reason, do not change the order of the algorithms.
3967 * - ssl_tls12_present* is for TLS 1.2 use only.
3968 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08003969 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003970static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08003971
Jerry Yued5e9f42022-01-26 11:21:34 +08003972#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3973 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3974 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3975#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3976 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003977
Jerry Yu909df7b2022-01-22 11:56:27 +08003978#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3979 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3980 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3981#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3982 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
3983
Jerry Yued5e9f42022-01-26 11:21:34 +08003984#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
3985 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
3986 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
3987#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3988 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003989
Jerry Yu909df7b2022-01-22 11:56:27 +08003990#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3991 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3992#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
3993
Ronald Cron8540cf62022-03-16 08:01:09 +01003994#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
3995 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
3996#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
3997
3998#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
3999 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4000#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4001
Jerry Yu53037892022-01-25 11:02:06 +08004002#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4003 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4004#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4005
Jerry Yu909df7b2022-01-22 11:56:27 +08004006 MBEDTLS_TLS1_3_SIG_NONE
4007};
4008
4009/* NOTICE: see above */
4010#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4011static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004012#if defined(MBEDTLS_SHA512_C)
4013 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4014#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004015#if defined(MBEDTLS_SHA384_C)
4016 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4017#endif
4018#if defined(MBEDTLS_SHA256_C)
4019 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4020#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004021 MBEDTLS_TLS1_3_SIG_NONE
4022};
4023#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4024/* NOTICE: see above */
4025static uint16_t ssl_preset_suiteb_sig_algs[] = {
4026
Jerry Yu909df7b2022-01-22 11:56:27 +08004027#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4028 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4029 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4030#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4031 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4032
Jerry Yu53037892022-01-25 11:02:06 +08004033#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4034 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4035 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4036#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4037 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004038
4039#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4040 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4041#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004042
Jerry Yu53037892022-01-25 11:02:06 +08004043#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4044 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4045#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4046
Jerry Yu713013f2022-01-17 18:16:35 +08004047 MBEDTLS_TLS1_3_SIG_NONE
4048};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004049
Jerry Yu909df7b2022-01-22 11:56:27 +08004050/* NOTICE: see above */
4051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4052static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004053#if defined(MBEDTLS_SHA256_C)
4054 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4055#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004056#if defined(MBEDTLS_SHA384_C)
4057 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4058#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004059 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004060};
Jerry Yu909df7b2022-01-22 11:56:27 +08004061#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4062
Jerry Yu1a8b4812022-01-20 17:56:50 +08004063#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004064
Brett Warrene0edc842021-08-17 09:53:13 +01004065static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004066#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004067 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004068#endif
4069#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004070 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004071#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004072 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004073};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004074
Jerry Yu1a8b4812022-01-20 17:56:50 +08004075#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004076/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004077 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004078static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004079{
4080 size_t i, j;
4081 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004082
Jerry Yuf377d642022-01-25 10:43:59 +08004083 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004084 {
Jerry Yuf377d642022-01-25 10:43:59 +08004085 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004086 {
Jerry Yuf377d642022-01-25 10:43:59 +08004087 if( sig_algs[i] != sig_algs[j] )
4088 continue;
4089 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4090 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4091 sig_algs[i], j, i );
4092 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004093 }
4094 }
4095 return( ret );
4096}
4097
4098#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4099
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004100/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004101 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004102 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004103int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004104 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004105{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004106#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004108#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004109
Jerry Yu1a8b4812022-01-20 17:56:50 +08004110#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004111 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004112 {
4113 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4114 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4115 }
4116
Jerry Yuf377d642022-01-25 10:43:59 +08004117 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004118 {
4119 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4120 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4121 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004122
4123#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004124 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004125 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004126 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004127 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4128 }
4129
Jerry Yuf377d642022-01-25 10:43:59 +08004130 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004131 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004132 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004133 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4134 }
4135#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004136#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4137
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004138 /* Use the functions here so that they are covered in tests,
4139 * but otherwise access member directly for efficiency */
4140 mbedtls_ssl_conf_endpoint( conf, endpoint );
4141 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004142
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004143 /*
4144 * Things that are common to all presets
4145 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004146#if defined(MBEDTLS_SSL_CLI_C)
4147 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4148 {
4149 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4150#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4151 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4152#endif
4153 }
4154#endif
4155
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004156#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4157 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4158#endif
4159
4160#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4161 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4162#endif
4163
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004164#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004165 conf->f_cookie_write = ssl_cookie_write_dummy;
4166 conf->f_cookie_check = ssl_cookie_check_dummy;
4167#endif
4168
4169#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4170 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4171#endif
4172
Janos Follath088ce432017-04-10 12:42:31 +01004173#if defined(MBEDTLS_SSL_SRV_C)
4174 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004175 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004176#endif
4177
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004178#if defined(MBEDTLS_SSL_PROTO_DTLS)
4179 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4180 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4181#endif
4182
4183#if defined(MBEDTLS_SSL_RENEGOTIATION)
4184 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004185 memset( conf->renego_period, 0x00, 2 );
4186 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004187#endif
4188
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004189#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004190 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4191 {
4192 const unsigned char dhm_p[] =
4193 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4194 const unsigned char dhm_g[] =
4195 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004196
Hanno Beckere2defad2021-07-24 05:59:17 +01004197 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4198 dhm_p, sizeof( dhm_p ),
4199 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4200 {
4201 return( ret );
4202 }
4203 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004204#endif
4205
Ronald Cron6f135e12021-12-08 16:57:54 +01004206#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004207 /*
4208 * Allow all TLS 1.3 key exchange modes by default.
4209 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004210 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004211#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004212
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004213#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian060d8672022-04-21 09:24:56 +00004214 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian75d40ef2022-04-20 11:05:24 +00004215#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
XiaokangQian060d8672022-04-21 09:24:56 +00004216 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004217#endif
XiaokangQian060d8672022-04-21 09:24:56 +00004218#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4219 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4220 endpoint == MBEDTLS_SSL_IS_SERVER )
4221 {
4222 /* DTLS 1.3 not supported yet
4223 * server side hybrid mode not support yet
4224 */
4225 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004226 }
4227 else
4228 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004229 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004230 }
XiaokangQian060d8672022-04-21 09:24:56 +00004231#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4232 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4233#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4234 if( transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4235 {
4236 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4237 }
4238 else
4239 {
4240 /* DTLS 1.3 not supported yet */
4241 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4242 }
4243#endif
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004244
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004245 /*
4246 * Preset-specific defaults
4247 */
4248 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004249 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004250 /*
4251 * NSA Suite B
4252 */
4253 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004254
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004255 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004256
4257#if defined(MBEDTLS_X509_CRT_PARSE_C)
4258 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004259#endif
4260
Gilles Peskineeccd8882020-03-10 12:19:08 +01004261#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004262#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004263 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004264#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004265#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4266 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4267 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4268 else
4269#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4270 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004271#endif
4272
Brett Warrene0edc842021-08-17 09:53:13 +01004273#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4274 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004275#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004276 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004277 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004278
4279 /*
4280 * Default
4281 */
4282 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004283
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004284 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004285
4286#if defined(MBEDTLS_X509_CRT_PARSE_C)
4287 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4288#endif
4289
Gilles Peskineeccd8882020-03-10 12:19:08 +01004290#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004291#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004292 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004293#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004294#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4295 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4296 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4297 else
4298#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4299 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004300#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004301
Brett Warrene0edc842021-08-17 09:53:13 +01004302#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4303 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004304#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004305 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004306
4307#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4308 conf->dhm_min_bitlen = 1024;
4309#endif
4310 }
4311
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004312 return( 0 );
4313}
4314
4315/*
4316 * Free mbedtls_ssl_config
4317 */
4318void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4319{
4320#if defined(MBEDTLS_DHM_C)
4321 mbedtls_mpi_free( &conf->dhm_P );
4322 mbedtls_mpi_free( &conf->dhm_G );
4323#endif
4324
Gilles Peskineeccd8882020-03-10 12:19:08 +01004325#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004326 if( conf->psk != NULL )
4327 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004328 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004329 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004330 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004331 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004332 }
4333
4334 if( conf->psk_identity != NULL )
4335 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004336 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004337 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004338 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004339 conf->psk_identity_len = 0;
4340 }
4341#endif
4342
4343#if defined(MBEDTLS_X509_CRT_PARSE_C)
4344 ssl_key_cert_free( conf->key_cert );
4345#endif
4346
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004347 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004348}
4349
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004350#if defined(MBEDTLS_PK_C) && \
4351 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004352/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004353 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004354 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004355unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004356{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004357#if defined(MBEDTLS_RSA_C)
4358 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4359 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004360#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004361#if defined(MBEDTLS_ECDSA_C)
4362 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4363 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004364#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004365 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004366}
4367
Hanno Becker7e5437a2017-04-28 17:15:26 +01004368unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4369{
4370 switch( type ) {
4371 case MBEDTLS_PK_RSA:
4372 return( MBEDTLS_SSL_SIG_RSA );
4373 case MBEDTLS_PK_ECDSA:
4374 case MBEDTLS_PK_ECKEY:
4375 return( MBEDTLS_SSL_SIG_ECDSA );
4376 default:
4377 return( MBEDTLS_SSL_SIG_ANON );
4378 }
4379}
4380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004381mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004382{
4383 switch( sig )
4384 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004385#if defined(MBEDTLS_RSA_C)
4386 case MBEDTLS_SSL_SIG_RSA:
4387 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004388#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004389#if defined(MBEDTLS_ECDSA_C)
4390 case MBEDTLS_SSL_SIG_ECDSA:
4391 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004392#endif
4393 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004394 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004395 }
4396}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004397#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004398
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004399/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004400 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004402mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004403{
4404 switch( hash )
4405 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004406#if defined(MBEDTLS_MD5_C)
4407 case MBEDTLS_SSL_HASH_MD5:
4408 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004409#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004410#if defined(MBEDTLS_SHA1_C)
4411 case MBEDTLS_SSL_HASH_SHA1:
4412 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004413#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004414#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415 case MBEDTLS_SSL_HASH_SHA224:
4416 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004417#endif
4418#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004419 case MBEDTLS_SSL_HASH_SHA256:
4420 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004421#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004422#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004423 case MBEDTLS_SSL_HASH_SHA384:
4424 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004425#endif
4426#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004427 case MBEDTLS_SSL_HASH_SHA512:
4428 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004429#endif
4430 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004431 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004432 }
4433}
4434
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004435/*
4436 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4437 */
4438unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4439{
4440 switch( md )
4441 {
4442#if defined(MBEDTLS_MD5_C)
4443 case MBEDTLS_MD_MD5:
4444 return( MBEDTLS_SSL_HASH_MD5 );
4445#endif
4446#if defined(MBEDTLS_SHA1_C)
4447 case MBEDTLS_MD_SHA1:
4448 return( MBEDTLS_SSL_HASH_SHA1 );
4449#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004450#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004451 case MBEDTLS_MD_SHA224:
4452 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004453#endif
4454#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004455 case MBEDTLS_MD_SHA256:
4456 return( MBEDTLS_SSL_HASH_SHA256 );
4457#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004458#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004459 case MBEDTLS_MD_SHA384:
4460 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004461#endif
4462#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004463 case MBEDTLS_MD_SHA512:
4464 return( MBEDTLS_SSL_HASH_SHA512 );
4465#endif
4466 default:
4467 return( MBEDTLS_SSL_HASH_NONE );
4468 }
4469}
4470
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004471/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004472 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004473 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004474 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004475int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004476{
Brett Warrene0edc842021-08-17 09:53:13 +01004477 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004478
Brett Warrene0edc842021-08-17 09:53:13 +01004479 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004480 return( -1 );
4481
Brett Warrene0edc842021-08-17 09:53:13 +01004482 for( ; *group_list != 0; group_list++ )
4483 {
4484 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004485 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004486 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004487
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004488 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004489}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004490
4491#if defined(MBEDTLS_ECP_C)
4492/*
4493 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4494 */
4495int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4496{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004497 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004498 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4499}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004500#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004502#if defined(MBEDTLS_X509_CRT_PARSE_C)
4503int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4504 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004505 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004506 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004507{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004508 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004509 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004510 const char *ext_oid;
4511 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004512
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004513 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004514 {
4515 /* Server part of the key exchange */
4516 switch( ciphersuite->key_exchange )
4517 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004518 case MBEDTLS_KEY_EXCHANGE_RSA:
4519 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004520 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004521 break;
4522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4524 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4525 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4526 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004527 break;
4528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004529 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4530 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004531 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004532 break;
4533
4534 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004535 case MBEDTLS_KEY_EXCHANGE_NONE:
4536 case MBEDTLS_KEY_EXCHANGE_PSK:
4537 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4538 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004539 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004540 usage = 0;
4541 }
4542 }
4543 else
4544 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4546 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004547 }
4548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004550 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004551 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004552 ret = -1;
4553 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004555 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004556 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4558 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004559 }
4560 else
4561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004562 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4563 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004564 }
4565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004566 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004567 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004568 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004569 ret = -1;
4570 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004571
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004572 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004573}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004575
Jerry Yu148165c2021-09-24 23:20:59 +08004576#if defined(MBEDTLS_USE_PSA_CRYPTO)
4577int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4578 const mbedtls_md_type_t md,
4579 unsigned char *dst,
4580 size_t dst_len,
4581 size_t *olen )
4582{
Ronald Cronf6893e12022-01-07 22:09:01 +01004583 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4584 psa_hash_operation_t *hash_operation_to_clone;
4585 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4586
Jerry Yu148165c2021-09-24 23:20:59 +08004587 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004588
4589 switch( md )
4590 {
4591#if defined(MBEDTLS_SHA384_C)
4592 case MBEDTLS_MD_SHA384:
4593 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4594 break;
4595#endif
4596
4597#if defined(MBEDTLS_SHA256_C)
4598 case MBEDTLS_MD_SHA256:
4599 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4600 break;
4601#endif
4602
4603 default:
4604 goto exit;
4605 }
4606
4607 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4608 if( status != PSA_SUCCESS )
4609 goto exit;
4610
4611 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4612 if( status != PSA_SUCCESS )
4613 goto exit;
4614
4615exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004616 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004617}
4618#else /* MBEDTLS_USE_PSA_CRYPTO */
4619
Jerry Yu24c0ec32021-09-09 14:21:07 +08004620#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004621static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4622 unsigned char *dst,
4623 size_t dst_len,
4624 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004625{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004626 int ret;
4627 mbedtls_sha512_context sha512;
4628
4629 if( dst_len < 48 )
4630 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4631
4632 mbedtls_sha512_init( &sha512 );
4633 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4634
4635 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4636 {
4637 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4638 goto exit;
4639 }
4640
4641 *olen = 48;
4642
4643exit:
4644
4645 mbedtls_sha512_free( &sha512 );
4646 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004647}
4648#endif /* MBEDTLS_SHA384_C */
4649
4650#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004651static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4652 unsigned char *dst,
4653 size_t dst_len,
4654 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004655{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004656 int ret;
4657 mbedtls_sha256_context sha256;
4658
4659 if( dst_len < 32 )
4660 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4661
4662 mbedtls_sha256_init( &sha256 );
4663 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004664
Jerry Yu24c0ec32021-09-09 14:21:07 +08004665 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4666 {
4667 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4668 goto exit;
4669 }
4670
4671 *olen = 32;
4672
4673exit:
4674
4675 mbedtls_sha256_free( &sha256 );
4676 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004677}
4678#endif /* MBEDTLS_SHA256_C */
4679
Jerry Yu000f9762021-09-14 11:12:51 +08004680int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4681 const mbedtls_md_type_t md,
4682 unsigned char *dst,
4683 size_t dst_len,
4684 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004685{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004686 switch( md )
4687 {
4688
Jerry Yu24c0ec32021-09-09 14:21:07 +08004689#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004690 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004691 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004692#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004693
Jerry Yu24c0ec32021-09-09 14:21:07 +08004694#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004695 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004696 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004697#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004698
4699 default:
4700 break;
4701 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004702 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004703}
XiaokangQian647719a2021-12-07 09:16:29 +00004704
Jerry Yu148165c2021-09-24 23:20:59 +08004705#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004706
Jerry Yudc7bd172022-02-17 13:44:15 +08004707#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4708
4709#if defined(MBEDTLS_USE_PSA_CRYPTO)
4710
4711static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4712 mbedtls_svc_key_id_t key,
4713 psa_algorithm_t alg,
4714 const unsigned char* seed, size_t seed_length,
4715 const unsigned char* label, size_t label_length,
4716 size_t capacity )
4717{
4718 psa_status_t status;
4719
4720 status = psa_key_derivation_setup( derivation, alg );
4721 if( status != PSA_SUCCESS )
4722 return( status );
4723
4724 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4725 {
4726 status = psa_key_derivation_input_bytes( derivation,
4727 PSA_KEY_DERIVATION_INPUT_SEED,
4728 seed, seed_length );
4729 if( status != PSA_SUCCESS )
4730 return( status );
4731
4732 if( mbedtls_svc_key_id_is_null( key ) )
4733 {
4734 status = psa_key_derivation_input_bytes(
4735 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4736 NULL, 0 );
4737 }
4738 else
4739 {
4740 status = psa_key_derivation_input_key(
4741 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4742 }
4743 if( status != PSA_SUCCESS )
4744 return( status );
4745
4746 status = psa_key_derivation_input_bytes( derivation,
4747 PSA_KEY_DERIVATION_INPUT_LABEL,
4748 label, label_length );
4749 if( status != PSA_SUCCESS )
4750 return( status );
4751 }
4752 else
4753 {
4754 return( PSA_ERROR_NOT_SUPPORTED );
4755 }
4756
4757 status = psa_key_derivation_set_capacity( derivation, capacity );
4758 if( status != PSA_SUCCESS )
4759 return( status );
4760
4761 return( PSA_SUCCESS );
4762}
4763
4764static int tls_prf_generic( mbedtls_md_type_t md_type,
4765 const unsigned char *secret, size_t slen,
4766 const char *label,
4767 const unsigned char *random, size_t rlen,
4768 unsigned char *dstbuf, size_t dlen )
4769{
4770 psa_status_t status;
4771 psa_algorithm_t alg;
4772 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4773 psa_key_derivation_operation_t derivation =
4774 PSA_KEY_DERIVATION_OPERATION_INIT;
4775
4776 if( md_type == MBEDTLS_MD_SHA384 )
4777 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4778 else
4779 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4780
4781 /* Normally a "secret" should be long enough to be impossible to
4782 * find by brute force, and in particular should not be empty. But
4783 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4784 * and for this use case it makes sense to have a 0-length "secret".
4785 * Since the key API doesn't allow importing a key of length 0,
4786 * keep master_key=0, which setup_psa_key_derivation() understands
4787 * to mean a 0-length "secret" input. */
4788 if( slen != 0 )
4789 {
4790 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4791 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4792 psa_set_key_algorithm( &key_attributes, alg );
4793 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4794
4795 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4796 if( status != PSA_SUCCESS )
4797 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4798 }
4799
4800 status = setup_psa_key_derivation( &derivation,
4801 master_key, alg,
4802 random, rlen,
4803 (unsigned char const *) label,
4804 (size_t) strlen( label ),
4805 dlen );
4806 if( status != PSA_SUCCESS )
4807 {
4808 psa_key_derivation_abort( &derivation );
4809 psa_destroy_key( master_key );
4810 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4811 }
4812
4813 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4814 if( status != PSA_SUCCESS )
4815 {
4816 psa_key_derivation_abort( &derivation );
4817 psa_destroy_key( master_key );
4818 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4819 }
4820
4821 status = psa_key_derivation_abort( &derivation );
4822 if( status != PSA_SUCCESS )
4823 {
4824 psa_destroy_key( master_key );
4825 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4826 }
4827
4828 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4829 status = psa_destroy_key( master_key );
4830 if( status != PSA_SUCCESS )
4831 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4832
4833 return( 0 );
4834}
4835
4836#else /* MBEDTLS_USE_PSA_CRYPTO */
4837
4838static int tls_prf_generic( mbedtls_md_type_t md_type,
4839 const unsigned char *secret, size_t slen,
4840 const char *label,
4841 const unsigned char *random, size_t rlen,
4842 unsigned char *dstbuf, size_t dlen )
4843{
4844 size_t nb;
4845 size_t i, j, k, md_len;
4846 unsigned char *tmp;
4847 size_t tmp_len = 0;
4848 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
4849 const mbedtls_md_info_t *md_info;
4850 mbedtls_md_context_t md_ctx;
4851 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4852
4853 mbedtls_md_init( &md_ctx );
4854
4855 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
4856 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4857
4858 md_len = mbedtls_md_get_size( md_info );
4859
4860 tmp_len = md_len + strlen( label ) + rlen;
4861 tmp = mbedtls_calloc( 1, tmp_len );
4862 if( tmp == NULL )
4863 {
4864 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4865 goto exit;
4866 }
4867
4868 nb = strlen( label );
4869 memcpy( tmp + md_len, label, nb );
4870 memcpy( tmp + md_len + nb, random, rlen );
4871 nb += rlen;
4872
4873 /*
4874 * Compute P_<hash>(secret, label + random)[0..dlen]
4875 */
4876 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
4877 goto exit;
4878
4879 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
4880 if( ret != 0 )
4881 goto exit;
4882 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
4883 if( ret != 0 )
4884 goto exit;
4885 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4886 if( ret != 0 )
4887 goto exit;
4888
4889 for( i = 0; i < dlen; i += md_len )
4890 {
4891 ret = mbedtls_md_hmac_reset ( &md_ctx );
4892 if( ret != 0 )
4893 goto exit;
4894 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
4895 if( ret != 0 )
4896 goto exit;
4897 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
4898 if( ret != 0 )
4899 goto exit;
4900
4901 ret = mbedtls_md_hmac_reset ( &md_ctx );
4902 if( ret != 0 )
4903 goto exit;
4904 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
4905 if( ret != 0 )
4906 goto exit;
4907 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4908 if( ret != 0 )
4909 goto exit;
4910
4911 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
4912
4913 for( j = 0; j < k; j++ )
4914 dstbuf[i + j] = h_i[j];
4915 }
4916
4917exit:
4918 mbedtls_md_free( &md_ctx );
4919
4920 mbedtls_platform_zeroize( tmp, tmp_len );
4921 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
4922
4923 mbedtls_free( tmp );
4924
4925 return( ret );
4926}
4927#endif /* MBEDTLS_USE_PSA_CRYPTO */
4928
4929#if defined(MBEDTLS_SHA256_C)
4930static int tls_prf_sha256( const unsigned char *secret, size_t slen,
4931 const char *label,
4932 const unsigned char *random, size_t rlen,
4933 unsigned char *dstbuf, size_t dlen )
4934{
4935 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
4936 label, random, rlen, dstbuf, dlen ) );
4937}
4938#endif /* MBEDTLS_SHA256_C */
4939
4940#if defined(MBEDTLS_SHA384_C)
4941static int tls_prf_sha384( const unsigned char *secret, size_t slen,
4942 const char *label,
4943 const unsigned char *random, size_t rlen,
4944 unsigned char *dstbuf, size_t dlen )
4945{
4946 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
4947 label, random, rlen, dstbuf, dlen ) );
4948}
4949#endif /* MBEDTLS_SHA384_C */
4950
Jerry Yuf009d862022-02-17 14:01:37 +08004951/*
4952 * Set appropriate PRF function and other SSL / TLS1.2 functions
4953 *
4954 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08004955 * - hash associated with the ciphersuite (only used by TLS 1.2)
4956 *
4957 * Outputs:
4958 * - the tls_prf, calc_verify and calc_finished members of handshake structure
4959 */
4960static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08004961 mbedtls_md_type_t hash )
4962{
Jerry Yuf009d862022-02-17 14:01:37 +08004963#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01004964 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08004965 {
4966 handshake->tls_prf = tls_prf_sha384;
4967 handshake->calc_verify = ssl_calc_verify_tls_sha384;
4968 handshake->calc_finished = ssl_calc_finished_tls_sha384;
4969 }
4970 else
4971#endif
4972#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08004973 {
Ronald Cron81591aa2022-03-07 09:05:51 +01004974 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004975 handshake->tls_prf = tls_prf_sha256;
4976 handshake->calc_verify = ssl_calc_verify_tls_sha256;
4977 handshake->calc_finished = ssl_calc_finished_tls_sha256;
4978 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004979#else
Jerry Yuf009d862022-02-17 14:01:37 +08004980 {
Jerry Yuf009d862022-02-17 14:01:37 +08004981 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01004982 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004983 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4984 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004985#endif
Jerry Yuf009d862022-02-17 14:01:37 +08004986
4987 return( 0 );
4988}
Jerry Yud6ab2352022-02-17 14:03:43 +08004989
4990#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
4991 defined(MBEDTLS_USE_PSA_CRYPTO)
4992static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
4993{
4994 if( ssl->conf->f_psk != NULL )
4995 {
4996 /* If we've used a callback to select the PSK,
4997 * the static configuration is irrelevant. */
4998 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
4999 return( 1 );
5000
5001 return( 0 );
5002 }
5003
5004 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5005 return( 1 );
5006
5007 return( 0 );
5008}
5009#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5010 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5011
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005012/*
5013 * Compute master secret if needed
5014 *
5015 * Parameters:
5016 * [in/out] handshake
5017 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5018 * (PSA-PSK) ciphersuite_info, psk_opaque
5019 * [out] premaster (cleared)
5020 * [out] master
5021 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5022 * debug: conf->f_dbg, conf->p_dbg
5023 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005024 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005025 */
5026static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5027 unsigned char *master,
5028 const mbedtls_ssl_context *ssl )
5029{
5030 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5031
5032 /* cf. RFC 5246, Section 8.1:
5033 * "The master secret is always exactly 48 bytes in length." */
5034 size_t const master_secret_len = 48;
5035
5036#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5037 unsigned char session_hash[48];
5038#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5039
5040 /* The label for the KDF used for key expansion.
5041 * This is either "master secret" or "extended master secret"
5042 * depending on whether the Extended Master Secret extension
5043 * is used. */
5044 char const *lbl = "master secret";
5045
5046 /* The salt for the KDF used for key expansion.
5047 * - If the Extended Master Secret extension is not used,
5048 * this is ClientHello.Random + ServerHello.Random
5049 * (see Sect. 8.1 in RFC 5246).
5050 * - If the Extended Master Secret extension is used,
5051 * this is the transcript of the handshake so far.
5052 * (see Sect. 4 in RFC 7627). */
5053 unsigned char const *salt = handshake->randbytes;
5054 size_t salt_len = 64;
5055
5056#if !defined(MBEDTLS_DEBUG_C) && \
5057 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5058 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5059 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5060 ssl = NULL; /* make sure we don't use it except for those cases */
5061 (void) ssl;
5062#endif
5063
5064 if( handshake->resume != 0 )
5065 {
5066 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5067 return( 0 );
5068 }
5069
5070#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5071 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5072 {
5073 lbl = "extended master secret";
5074 salt = session_hash;
5075 handshake->calc_verify( ssl, session_hash, &salt_len );
5076
5077 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5078 session_hash, salt_len );
5079 }
5080#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5081
5082#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5083 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5084 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005085 ssl_use_opaque_psk( ssl ) == 1 )
5086 {
5087 /* Perform PSK-to-MS expansion in a single step. */
5088 psa_status_t status;
5089 psa_algorithm_t alg;
5090 mbedtls_svc_key_id_t psk;
5091 psa_key_derivation_operation_t derivation =
5092 PSA_KEY_DERIVATION_OPERATION_INIT;
5093 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5094
5095 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5096
5097 psk = mbedtls_ssl_get_opaque_psk( ssl );
5098
5099 if( hash_alg == MBEDTLS_MD_SHA384 )
5100 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5101 else
5102 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5103
5104 status = setup_psa_key_derivation( &derivation, psk, alg,
5105 salt, salt_len,
5106 (unsigned char const *) lbl,
5107 (size_t) strlen( lbl ),
5108 master_secret_len );
5109 if( status != PSA_SUCCESS )
5110 {
5111 psa_key_derivation_abort( &derivation );
5112 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5113 }
5114
5115 status = psa_key_derivation_output_bytes( &derivation,
5116 master,
5117 master_secret_len );
5118 if( status != PSA_SUCCESS )
5119 {
5120 psa_key_derivation_abort( &derivation );
5121 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5122 }
5123
5124 status = psa_key_derivation_abort( &derivation );
5125 if( status != PSA_SUCCESS )
5126 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5127 }
5128 else
5129#endif
5130 {
5131 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5132 lbl, salt, salt_len,
5133 master,
5134 master_secret_len );
5135 if( ret != 0 )
5136 {
5137 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5138 return( ret );
5139 }
5140
5141 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5142 handshake->premaster,
5143 handshake->pmslen );
5144
5145 mbedtls_platform_zeroize( handshake->premaster,
5146 sizeof(handshake->premaster) );
5147 }
5148
5149 return( 0 );
5150}
5151
Jerry Yud62f87e2022-02-17 14:09:02 +08005152int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5153{
5154 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5155 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5156 ssl->handshake->ciphersuite_info;
5157
5158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5159
5160 /* Set PRF, calc_verify and calc_finished function pointers */
5161 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005162 ciphersuite_info->mac );
5163 if( ret != 0 )
5164 {
5165 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5166 return( ret );
5167 }
5168
5169 /* Compute master secret if needed */
5170 ret = ssl_compute_master( ssl->handshake,
5171 ssl->session_negotiate->master,
5172 ssl );
5173 if( ret != 0 )
5174 {
5175 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5176 return( ret );
5177 }
5178
5179 /* Swap the client and server random values:
5180 * - MS derivation wanted client+server (RFC 5246 8.1)
5181 * - key derivation wants server+client (RFC 5246 6.3) */
5182 {
5183 unsigned char tmp[64];
5184 memcpy( tmp, ssl->handshake->randbytes, 64 );
5185 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5186 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5187 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5188 }
5189
5190 /* Populate transform structure */
5191 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5192 ssl->session_negotiate->ciphersuite,
5193 ssl->session_negotiate->master,
5194#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5195 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5196 ssl->session_negotiate->encrypt_then_mac,
5197#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5198 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5199 ssl->handshake->tls_prf,
5200 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005201 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005202 ssl->conf->endpoint,
5203 ssl );
5204 if( ret != 0 )
5205 {
5206 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5207 return( ret );
5208 }
5209
5210 /* We no longer need Server/ClientHello.random values */
5211 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5212 sizeof( ssl->handshake->randbytes ) );
5213
5214 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5215
5216 return( 0 );
5217}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005218
Ronald Cron4dcbca92022-03-07 10:21:40 +01005219int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5220{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005221 switch( md )
5222 {
5223#if defined(MBEDTLS_SHA384_C)
5224 case MBEDTLS_SSL_HASH_SHA384:
5225 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5226 break;
5227#endif
5228#if defined(MBEDTLS_SHA256_C)
5229 case MBEDTLS_SSL_HASH_SHA256:
5230 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5231 break;
5232#endif
5233 default:
5234 return( -1 );
5235 }
5236
Ronald Cronc2f13a02022-03-07 10:25:24 +01005237 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005238}
5239
Jerry Yu8392e0d2022-02-17 14:10:24 +08005240#if defined(MBEDTLS_SHA256_C)
5241void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5242 unsigned char *hash,
5243 size_t *hlen )
5244{
5245#if defined(MBEDTLS_USE_PSA_CRYPTO)
5246 size_t hash_size;
5247 psa_status_t status;
5248 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5249
5250 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5251 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5252 if( status != PSA_SUCCESS )
5253 {
5254 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5255 return;
5256 }
5257
5258 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5259 if( status != PSA_SUCCESS )
5260 {
5261 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5262 return;
5263 }
5264
5265 *hlen = 32;
5266 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5267 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5268#else
5269 mbedtls_sha256_context sha256;
5270
5271 mbedtls_sha256_init( &sha256 );
5272
5273 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5274
5275 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5276 mbedtls_sha256_finish( &sha256, hash );
5277
5278 *hlen = 32;
5279
5280 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5281 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5282
5283 mbedtls_sha256_free( &sha256 );
5284#endif /* MBEDTLS_USE_PSA_CRYPTO */
5285 return;
5286}
5287#endif /* MBEDTLS_SHA256_C */
5288
Jerry Yuc1cb3842022-02-17 14:13:48 +08005289#if defined(MBEDTLS_SHA384_C)
5290void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5291 unsigned char *hash,
5292 size_t *hlen )
5293{
5294#if defined(MBEDTLS_USE_PSA_CRYPTO)
5295 size_t hash_size;
5296 psa_status_t status;
5297 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5298
5299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5300 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5301 if( status != PSA_SUCCESS )
5302 {
5303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5304 return;
5305 }
5306
5307 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5308 if( status != PSA_SUCCESS )
5309 {
5310 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5311 return;
5312 }
5313
5314 *hlen = 48;
5315 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5317#else
5318 mbedtls_sha512_context sha512;
5319
5320 mbedtls_sha512_init( &sha512 );
5321
5322 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5323
5324 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5325 mbedtls_sha512_finish( &sha512, hash );
5326
5327 *hlen = 48;
5328
5329 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5330 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5331
5332 mbedtls_sha512_free( &sha512 );
5333#endif /* MBEDTLS_USE_PSA_CRYPTO */
5334 return;
5335}
5336#endif /* MBEDTLS_SHA384_C */
5337
Jerry Yuce3dca42022-02-17 14:16:37 +08005338#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5339int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5340{
5341 unsigned char *p = ssl->handshake->premaster;
5342 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5343 const unsigned char *psk = NULL;
5344 size_t psk_len = 0;
5345
5346 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5347 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5348 {
5349 /*
5350 * This should never happen because the existence of a PSK is always
5351 * checked before calling this function
5352 */
5353 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5354 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5355 }
5356
5357 /*
5358 * PMS = struct {
5359 * opaque other_secret<0..2^16-1>;
5360 * opaque psk<0..2^16-1>;
5361 * };
5362 * with "other_secret" depending on the particular key exchange
5363 */
5364#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5365 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5366 {
5367 if( end - p < 2 )
5368 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5369
5370 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5371 p += 2;
5372
5373 if( end < p || (size_t)( end - p ) < psk_len )
5374 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5375
5376 memset( p, 0, psk_len );
5377 p += psk_len;
5378 }
5379 else
5380#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5381#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5382 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5383 {
5384 /*
5385 * other_secret already set by the ClientKeyExchange message,
5386 * and is 48 bytes long
5387 */
5388 if( end - p < 2 )
5389 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5390
5391 *p++ = 0;
5392 *p++ = 48;
5393 p += 48;
5394 }
5395 else
5396#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5397#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5398 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5399 {
5400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5401 size_t len;
5402
5403 /* Write length only when we know the actual value */
5404 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5405 p + 2, end - ( p + 2 ), &len,
5406 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5407 {
5408 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5409 return( ret );
5410 }
5411 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5412 p += 2 + len;
5413
5414 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5415 }
5416 else
5417#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5418#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5419 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5420 {
5421 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5422 size_t zlen;
5423
5424 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5425 p + 2, end - ( p + 2 ),
5426 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5427 {
5428 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5429 return( ret );
5430 }
5431
5432 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5433 p += 2 + zlen;
5434
5435 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5436 MBEDTLS_DEBUG_ECDH_Z );
5437 }
5438 else
5439#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5440 {
5441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5442 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5443 }
5444
5445 /* opaque psk<0..2^16-1>; */
5446 if( end - p < 2 )
5447 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5448
5449 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5450 p += 2;
5451
5452 if( end < p || (size_t)( end - p ) < psk_len )
5453 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5454
5455 memcpy( p, psk, psk_len );
5456 p += psk_len;
5457
5458 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5459
5460 return( 0 );
5461}
5462#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005463
5464#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5465static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5466
5467#if defined(MBEDTLS_SSL_PROTO_DTLS)
5468int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5469{
5470 /* If renegotiation is not enforced, retransmit until we would reach max
5471 * timeout if we were using the usual handshake doubling scheme */
5472 if( ssl->conf->renego_max_records < 0 )
5473 {
5474 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5475 unsigned char doublings = 1;
5476
5477 while( ratio != 0 )
5478 {
5479 ++doublings;
5480 ratio >>= 1;
5481 }
5482
5483 if( ++ssl->renego_records_seen > doublings )
5484 {
5485 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5486 return( 0 );
5487 }
5488 }
5489
5490 return( ssl_write_hello_request( ssl ) );
5491}
5492#endif
5493#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005494
Jerry Yud9526692022-02-17 14:23:47 +08005495/*
5496 * Handshake functions
5497 */
5498#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5499/* No certificate support -> dummy functions */
5500int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5501{
5502 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5503 ssl->handshake->ciphersuite_info;
5504
5505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5506
5507 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5508 {
5509 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5510 ssl->state++;
5511 return( 0 );
5512 }
5513
5514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5515 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5516}
5517
5518int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5519{
5520 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5521 ssl->handshake->ciphersuite_info;
5522
5523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5524
5525 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5526 {
5527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5528 ssl->state++;
5529 return( 0 );
5530 }
5531
5532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5533 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5534}
5535
5536#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5537/* Some certificate support -> implement write and parse */
5538
5539int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5540{
5541 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5542 size_t i, n;
5543 const mbedtls_x509_crt *crt;
5544 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5545 ssl->handshake->ciphersuite_info;
5546
5547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5548
5549 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5550 {
5551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5552 ssl->state++;
5553 return( 0 );
5554 }
5555
5556#if defined(MBEDTLS_SSL_CLI_C)
5557 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5558 {
5559 if( ssl->handshake->client_auth == 0 )
5560 {
5561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5562 ssl->state++;
5563 return( 0 );
5564 }
5565 }
5566#endif /* MBEDTLS_SSL_CLI_C */
5567#if defined(MBEDTLS_SSL_SRV_C)
5568 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5569 {
5570 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5571 {
5572 /* Should never happen because we shouldn't have picked the
5573 * ciphersuite if we don't have a certificate. */
5574 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5575 }
5576 }
5577#endif
5578
5579 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5580
5581 /*
5582 * 0 . 0 handshake type
5583 * 1 . 3 handshake length
5584 * 4 . 6 length of all certs
5585 * 7 . 9 length of cert. 1
5586 * 10 . n-1 peer certificate
5587 * n . n+2 length of cert. 2
5588 * n+3 . ... upper level cert, etc.
5589 */
5590 i = 7;
5591 crt = mbedtls_ssl_own_cert( ssl );
5592
5593 while( crt != NULL )
5594 {
5595 n = crt->raw.len;
5596 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5597 {
5598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5599 " > %" MBEDTLS_PRINTF_SIZET,
5600 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5601 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5602 }
5603
5604 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5605 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5606 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5607
5608 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5609 i += n; crt = crt->next;
5610 }
5611
5612 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5613 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5614 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5615
5616 ssl->out_msglen = i;
5617 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5618 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5619
5620 ssl->state++;
5621
5622 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5623 {
5624 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5625 return( ret );
5626 }
5627
5628 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5629
5630 return( ret );
5631}
5632
5633#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5634
5635#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5636static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5637 unsigned char *crt_buf,
5638 size_t crt_buf_len )
5639{
5640 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5641
5642 if( peer_crt == NULL )
5643 return( -1 );
5644
5645 if( peer_crt->raw.len != crt_buf_len )
5646 return( -1 );
5647
5648 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5649}
5650#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5651static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5652 unsigned char *crt_buf,
5653 size_t crt_buf_len )
5654{
5655 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5656 unsigned char const * const peer_cert_digest =
5657 ssl->session->peer_cert_digest;
5658 mbedtls_md_type_t const peer_cert_digest_type =
5659 ssl->session->peer_cert_digest_type;
5660 mbedtls_md_info_t const * const digest_info =
5661 mbedtls_md_info_from_type( peer_cert_digest_type );
5662 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5663 size_t digest_len;
5664
5665 if( peer_cert_digest == NULL || digest_info == NULL )
5666 return( -1 );
5667
5668 digest_len = mbedtls_md_get_size( digest_info );
5669 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5670 return( -1 );
5671
5672 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5673 if( ret != 0 )
5674 return( -1 );
5675
5676 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5677}
5678#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5679#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5680
5681/*
5682 * Once the certificate message is read, parse it into a cert chain and
5683 * perform basic checks, but leave actual verification to the caller
5684 */
5685static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5686 mbedtls_x509_crt *chain )
5687{
5688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5689#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5690 int crt_cnt=0;
5691#endif
5692 size_t i, n;
5693 uint8_t alert;
5694
5695 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5696 {
5697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5698 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5699 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5700 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5701 }
5702
5703 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5704 {
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_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5711 {
5712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5713 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5714 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5715 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5716 }
5717
5718 i = mbedtls_ssl_hs_hdr_len( ssl );
5719
5720 /*
5721 * Same message structure as in mbedtls_ssl_write_certificate()
5722 */
5723 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5724
5725 if( ssl->in_msg[i] != 0 ||
5726 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5727 {
5728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5729 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5730 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5731 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5732 }
5733
5734 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5735 i += 3;
5736
5737 /* Iterate through and parse the CRTs in the provided chain. */
5738 while( i < ssl->in_hslen )
5739 {
5740 /* Check that there's room for the next CRT's length fields. */
5741 if ( i + 3 > ssl->in_hslen ) {
5742 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5743 mbedtls_ssl_send_alert_message( ssl,
5744 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5745 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5746 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5747 }
5748 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5749 * anything beyond 2**16 ~ 64K. */
5750 if( ssl->in_msg[i] != 0 )
5751 {
5752 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5753 mbedtls_ssl_send_alert_message( ssl,
5754 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5755 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5756 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5757 }
5758
5759 /* Read length of the next CRT in the chain. */
5760 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5761 | (unsigned int) ssl->in_msg[i + 2];
5762 i += 3;
5763
5764 if( n < 128 || i + n > ssl->in_hslen )
5765 {
5766 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5767 mbedtls_ssl_send_alert_message( ssl,
5768 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5769 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5770 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5771 }
5772
5773 /* Check if we're handling the first CRT in the chain. */
5774#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5775 if( crt_cnt++ == 0 &&
5776 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5777 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5778 {
5779 /* During client-side renegotiation, check that the server's
5780 * end-CRTs hasn't changed compared to the initial handshake,
5781 * mitigating the triple handshake attack. On success, reuse
5782 * the original end-CRT instead of parsing it again. */
5783 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5784 if( ssl_check_peer_crt_unchanged( ssl,
5785 &ssl->in_msg[i],
5786 n ) != 0 )
5787 {
5788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5789 mbedtls_ssl_send_alert_message( ssl,
5790 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5791 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5792 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5793 }
5794
5795 /* Now we can safely free the original chain. */
5796 ssl_clear_peer_cert( ssl->session );
5797 }
5798#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5799
5800 /* Parse the next certificate in the chain. */
5801#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5802 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5803#else
5804 /* If we don't need to store the CRT chain permanently, parse
5805 * it in-place from the input buffer instead of making a copy. */
5806 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5807#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5808 switch( ret )
5809 {
5810 case 0: /*ok*/
5811 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5812 /* Ignore certificate with an unknown algorithm: maybe a
5813 prior certificate was already trusted. */
5814 break;
5815
5816 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5817 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5818 goto crt_parse_der_failed;
5819
5820 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5821 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5822 goto crt_parse_der_failed;
5823
5824 default:
5825 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5826 crt_parse_der_failed:
5827 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5828 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5829 return( ret );
5830 }
5831
5832 i += n;
5833 }
5834
5835 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
5836 return( 0 );
5837}
5838
5839#if defined(MBEDTLS_SSL_SRV_C)
5840static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
5841{
5842 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5843 return( -1 );
5844
5845 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
5846 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
5847 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
5848 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
5849 {
5850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
5851 return( 0 );
5852 }
5853 return( -1 );
5854}
5855#endif /* MBEDTLS_SSL_SRV_C */
5856
5857/* Check if a certificate message is expected.
5858 * Return either
5859 * - SSL_CERTIFICATE_EXPECTED, or
5860 * - SSL_CERTIFICATE_SKIP
5861 * indicating whether a Certificate message is expected or not.
5862 */
5863#define SSL_CERTIFICATE_EXPECTED 0
5864#define SSL_CERTIFICATE_SKIP 1
5865static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
5866 int authmode )
5867{
5868 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5869 ssl->handshake->ciphersuite_info;
5870
5871 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5872 return( SSL_CERTIFICATE_SKIP );
5873
5874#if defined(MBEDTLS_SSL_SRV_C)
5875 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5876 {
5877 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5878 return( SSL_CERTIFICATE_SKIP );
5879
5880 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5881 {
5882 ssl->session_negotiate->verify_result =
5883 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
5884 return( SSL_CERTIFICATE_SKIP );
5885 }
5886 }
5887#else
5888 ((void) authmode);
5889#endif /* MBEDTLS_SSL_SRV_C */
5890
5891 return( SSL_CERTIFICATE_EXPECTED );
5892}
5893
5894static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
5895 int authmode,
5896 mbedtls_x509_crt *chain,
5897 void *rs_ctx )
5898{
5899 int ret = 0;
5900 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5901 ssl->handshake->ciphersuite_info;
5902 int have_ca_chain = 0;
5903
5904 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
5905 void *p_vrfy;
5906
5907 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5908 return( 0 );
5909
5910 if( ssl->f_vrfy != NULL )
5911 {
5912 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
5913 f_vrfy = ssl->f_vrfy;
5914 p_vrfy = ssl->p_vrfy;
5915 }
5916 else
5917 {
5918 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
5919 f_vrfy = ssl->conf->f_vrfy;
5920 p_vrfy = ssl->conf->p_vrfy;
5921 }
5922
5923 /*
5924 * Main check: verify certificate
5925 */
5926#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
5927 if( ssl->conf->f_ca_cb != NULL )
5928 {
5929 ((void) rs_ctx);
5930 have_ca_chain = 1;
5931
5932 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
5933 ret = mbedtls_x509_crt_verify_with_ca_cb(
5934 chain,
5935 ssl->conf->f_ca_cb,
5936 ssl->conf->p_ca_cb,
5937 ssl->conf->cert_profile,
5938 ssl->hostname,
5939 &ssl->session_negotiate->verify_result,
5940 f_vrfy, p_vrfy );
5941 }
5942 else
5943#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
5944 {
5945 mbedtls_x509_crt *ca_chain;
5946 mbedtls_x509_crl *ca_crl;
5947
5948#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
5949 if( ssl->handshake->sni_ca_chain != NULL )
5950 {
5951 ca_chain = ssl->handshake->sni_ca_chain;
5952 ca_crl = ssl->handshake->sni_ca_crl;
5953 }
5954 else
5955#endif
5956 {
5957 ca_chain = ssl->conf->ca_chain;
5958 ca_crl = ssl->conf->ca_crl;
5959 }
5960
5961 if( ca_chain != NULL )
5962 have_ca_chain = 1;
5963
5964 ret = mbedtls_x509_crt_verify_restartable(
5965 chain,
5966 ca_chain, ca_crl,
5967 ssl->conf->cert_profile,
5968 ssl->hostname,
5969 &ssl->session_negotiate->verify_result,
5970 f_vrfy, p_vrfy, rs_ctx );
5971 }
5972
5973 if( ret != 0 )
5974 {
5975 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
5976 }
5977
5978#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
5979 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
5980 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
5981#endif
5982
5983 /*
5984 * Secondary checks: always done, but change 'ret' only if it was 0
5985 */
5986
5987#if defined(MBEDTLS_ECP_C)
5988 {
5989 const mbedtls_pk_context *pk = &chain->pk;
5990
5991 /* If certificate uses an EC key, make sure the curve is OK */
5992 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
5993 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
5994 {
5995 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
5996
5997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
5998 if( ret == 0 )
5999 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6000 }
6001 }
6002#endif /* MBEDTLS_ECP_C */
6003
6004 if( mbedtls_ssl_check_cert_usage( chain,
6005 ciphersuite_info,
6006 ! ssl->conf->endpoint,
6007 &ssl->session_negotiate->verify_result ) != 0 )
6008 {
6009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6010 if( ret == 0 )
6011 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6012 }
6013
6014 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6015 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6016 * with details encoded in the verification flags. All other kinds
6017 * of error codes, including those from the user provided f_vrfy
6018 * functions, are treated as fatal and lead to a failure of
6019 * ssl_parse_certificate even if verification was optional. */
6020 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6021 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6022 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6023 {
6024 ret = 0;
6025 }
6026
6027 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6028 {
6029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6030 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6031 }
6032
6033 if( ret != 0 )
6034 {
6035 uint8_t alert;
6036
6037 /* The certificate may have been rejected for several reasons.
6038 Pick one and send the corresponding alert. Which alert to send
6039 may be a subject of debate in some cases. */
6040 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6041 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6042 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6043 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6044 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6045 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6046 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6047 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6048 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6049 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6050 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6051 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6052 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6053 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6054 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6055 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6056 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6057 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6058 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6059 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6060 else
6061 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6062 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6063 alert );
6064 }
6065
6066#if defined(MBEDTLS_DEBUG_C)
6067 if( ssl->session_negotiate->verify_result != 0 )
6068 {
6069 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6070 (unsigned int) ssl->session_negotiate->verify_result ) );
6071 }
6072 else
6073 {
6074 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6075 }
6076#endif /* MBEDTLS_DEBUG_C */
6077
6078 return( ret );
6079}
6080
6081#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6082static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6083 unsigned char *start, size_t len )
6084{
6085 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6086 /* Remember digest of the peer's end-CRT. */
6087 ssl->session_negotiate->peer_cert_digest =
6088 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6089 if( ssl->session_negotiate->peer_cert_digest == NULL )
6090 {
6091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6092 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6093 mbedtls_ssl_send_alert_message( ssl,
6094 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6095 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6096
6097 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6098 }
6099
6100 ret = mbedtls_md( mbedtls_md_info_from_type(
6101 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6102 start, len,
6103 ssl->session_negotiate->peer_cert_digest );
6104
6105 ssl->session_negotiate->peer_cert_digest_type =
6106 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6107 ssl->session_negotiate->peer_cert_digest_len =
6108 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6109
6110 return( ret );
6111}
6112
6113static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6114 unsigned char *start, size_t len )
6115{
6116 unsigned char *end = start + len;
6117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6118
6119 /* Make a copy of the peer's raw public key. */
6120 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6121 ret = mbedtls_pk_parse_subpubkey( &start, end,
6122 &ssl->handshake->peer_pubkey );
6123 if( ret != 0 )
6124 {
6125 /* We should have parsed the public key before. */
6126 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6127 }
6128
6129 return( 0 );
6130}
6131#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6132
6133int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6134{
6135 int ret = 0;
6136 int crt_expected;
6137#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6138 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6139 ? ssl->handshake->sni_authmode
6140 : ssl->conf->authmode;
6141#else
6142 const int authmode = ssl->conf->authmode;
6143#endif
6144 void *rs_ctx = NULL;
6145 mbedtls_x509_crt *chain = NULL;
6146
6147 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6148
6149 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6150 if( crt_expected == SSL_CERTIFICATE_SKIP )
6151 {
6152 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6153 goto exit;
6154 }
6155
6156#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6157 if( ssl->handshake->ecrs_enabled &&
6158 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6159 {
6160 chain = ssl->handshake->ecrs_peer_cert;
6161 ssl->handshake->ecrs_peer_cert = NULL;
6162 goto crt_verify;
6163 }
6164#endif
6165
6166 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6167 {
6168 /* mbedtls_ssl_read_record may have sent an alert already. We
6169 let it decide whether to alert. */
6170 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6171 goto exit;
6172 }
6173
6174#if defined(MBEDTLS_SSL_SRV_C)
6175 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6176 {
6177 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6178
6179 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6180 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6181
6182 goto exit;
6183 }
6184#endif /* MBEDTLS_SSL_SRV_C */
6185
6186 /* Clear existing peer CRT structure in case we tried to
6187 * reuse a session but it failed, and allocate a new one. */
6188 ssl_clear_peer_cert( ssl->session_negotiate );
6189
6190 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6191 if( chain == NULL )
6192 {
6193 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6194 sizeof( mbedtls_x509_crt ) ) );
6195 mbedtls_ssl_send_alert_message( ssl,
6196 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6197 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6198
6199 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6200 goto exit;
6201 }
6202 mbedtls_x509_crt_init( chain );
6203
6204 ret = ssl_parse_certificate_chain( ssl, chain );
6205 if( ret != 0 )
6206 goto exit;
6207
6208#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6209 if( ssl->handshake->ecrs_enabled)
6210 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6211
6212crt_verify:
6213 if( ssl->handshake->ecrs_enabled)
6214 rs_ctx = &ssl->handshake->ecrs_ctx;
6215#endif
6216
6217 ret = ssl_parse_certificate_verify( ssl, authmode,
6218 chain, rs_ctx );
6219 if( ret != 0 )
6220 goto exit;
6221
6222#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6223 {
6224 unsigned char *crt_start, *pk_start;
6225 size_t crt_len, pk_len;
6226
6227 /* We parse the CRT chain without copying, so
6228 * these pointers point into the input buffer,
6229 * and are hence still valid after freeing the
6230 * CRT chain. */
6231
6232 crt_start = chain->raw.p;
6233 crt_len = chain->raw.len;
6234
6235 pk_start = chain->pk_raw.p;
6236 pk_len = chain->pk_raw.len;
6237
6238 /* Free the CRT structures before computing
6239 * digest and copying the peer's public key. */
6240 mbedtls_x509_crt_free( chain );
6241 mbedtls_free( chain );
6242 chain = NULL;
6243
6244 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6245 if( ret != 0 )
6246 goto exit;
6247
6248 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6249 if( ret != 0 )
6250 goto exit;
6251 }
6252#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6253 /* Pass ownership to session structure. */
6254 ssl->session_negotiate->peer_cert = chain;
6255 chain = NULL;
6256#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6257
6258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6259
6260exit:
6261
6262 if( ret == 0 )
6263 ssl->state++;
6264
6265#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6266 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6267 {
6268 ssl->handshake->ecrs_peer_cert = chain;
6269 chain = NULL;
6270 }
6271#endif
6272
6273 if( chain != NULL )
6274 {
6275 mbedtls_x509_crt_free( chain );
6276 mbedtls_free( chain );
6277 }
6278
6279 return( ret );
6280}
6281#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6282
Jerry Yu615bd6f2022-02-17 14:25:15 +08006283#if defined(MBEDTLS_SHA256_C)
6284static void ssl_calc_finished_tls_sha256(
6285 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6286{
6287 int len = 12;
6288 const char *sender;
6289 unsigned char padbuf[32];
6290#if defined(MBEDTLS_USE_PSA_CRYPTO)
6291 size_t hash_size;
6292 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6293 psa_status_t status;
6294#else
6295 mbedtls_sha256_context sha256;
6296#endif
6297
6298 mbedtls_ssl_session *session = ssl->session_negotiate;
6299 if( !session )
6300 session = ssl->session;
6301
6302 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6303 ? "client finished"
6304 : "server finished";
6305
6306#if defined(MBEDTLS_USE_PSA_CRYPTO)
6307 sha256_psa = psa_hash_operation_init();
6308
6309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6310
6311 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6312 if( status != PSA_SUCCESS )
6313 {
6314 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6315 return;
6316 }
6317
6318 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6319 if( status != PSA_SUCCESS )
6320 {
6321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6322 return;
6323 }
6324 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6325#else
6326
6327 mbedtls_sha256_init( &sha256 );
6328
6329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6330
6331 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6332
6333 /*
6334 * TLSv1.2:
6335 * hash = PRF( master, finished_label,
6336 * Hash( handshake ) )[0.11]
6337 */
6338
6339#if !defined(MBEDTLS_SHA256_ALT)
6340 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6341 sha256.state, sizeof( sha256.state ) );
6342#endif
6343
6344 mbedtls_sha256_finish( &sha256, padbuf );
6345 mbedtls_sha256_free( &sha256 );
6346#endif /* MBEDTLS_USE_PSA_CRYPTO */
6347
6348 ssl->handshake->tls_prf( session->master, 48, sender,
6349 padbuf, 32, buf, len );
6350
6351 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6352
6353 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6354
6355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6356}
6357#endif /* MBEDTLS_SHA256_C */
6358
Jerry Yub7ba49e2022-02-17 14:25:53 +08006359
6360#if defined(MBEDTLS_SHA384_C)
6361
6362static void ssl_calc_finished_tls_sha384(
6363 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6364{
6365 int len = 12;
6366 const char *sender;
6367 unsigned char padbuf[48];
6368#if defined(MBEDTLS_USE_PSA_CRYPTO)
6369 size_t hash_size;
6370 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6371 psa_status_t status;
6372#else
6373 mbedtls_sha512_context sha512;
6374#endif
6375
6376 mbedtls_ssl_session *session = ssl->session_negotiate;
6377 if( !session )
6378 session = ssl->session;
6379
6380 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6381 ? "client finished"
6382 : "server finished";
6383
6384#if defined(MBEDTLS_USE_PSA_CRYPTO)
6385 sha384_psa = psa_hash_operation_init();
6386
6387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6388
6389 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6390 if( status != PSA_SUCCESS )
6391 {
6392 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6393 return;
6394 }
6395
6396 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6397 if( status != PSA_SUCCESS )
6398 {
6399 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6400 return;
6401 }
6402 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6403#else
6404 mbedtls_sha512_init( &sha512 );
6405
6406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6407
6408 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6409
6410 /*
6411 * TLSv1.2:
6412 * hash = PRF( master, finished_label,
6413 * Hash( handshake ) )[0.11]
6414 */
6415
6416#if !defined(MBEDTLS_SHA512_ALT)
6417 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6418 sha512.state, sizeof( sha512.state ) );
6419#endif
6420 mbedtls_sha512_finish( &sha512, padbuf );
6421
6422 mbedtls_sha512_free( &sha512 );
6423#endif
6424
6425 ssl->handshake->tls_prf( session->master, 48, sender,
6426 padbuf, 48, buf, len );
6427
6428 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6429
6430 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6431
6432 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6433}
6434#endif /* MBEDTLS_SHA384_C */
6435
Jerry Yuaef00152022-02-17 14:27:31 +08006436void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6437{
6438 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6439
6440 /*
6441 * Free our handshake params
6442 */
6443 mbedtls_ssl_handshake_free( ssl );
6444 mbedtls_free( ssl->handshake );
6445 ssl->handshake = NULL;
6446
6447 /*
6448 * Free the previous transform and swith in the current one
6449 */
6450 if( ssl->transform )
6451 {
6452 mbedtls_ssl_transform_free( ssl->transform );
6453 mbedtls_free( ssl->transform );
6454 }
6455 ssl->transform = ssl->transform_negotiate;
6456 ssl->transform_negotiate = NULL;
6457
6458 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6459}
6460
Jerry Yu2a9fff52022-02-17 14:28:51 +08006461void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6462{
6463 int resume = ssl->handshake->resume;
6464
6465 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6466
6467#if defined(MBEDTLS_SSL_RENEGOTIATION)
6468 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6469 {
6470 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6471 ssl->renego_records_seen = 0;
6472 }
6473#endif
6474
6475 /*
6476 * Free the previous session and switch in the current one
6477 */
6478 if( ssl->session )
6479 {
6480#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6481 /* RFC 7366 3.1: keep the EtM state */
6482 ssl->session_negotiate->encrypt_then_mac =
6483 ssl->session->encrypt_then_mac;
6484#endif
6485
6486 mbedtls_ssl_session_free( ssl->session );
6487 mbedtls_free( ssl->session );
6488 }
6489 ssl->session = ssl->session_negotiate;
6490 ssl->session_negotiate = NULL;
6491
6492 /*
6493 * Add cache entry
6494 */
6495 if( ssl->conf->f_set_cache != NULL &&
6496 ssl->session->id_len != 0 &&
6497 resume == 0 )
6498 {
6499 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6500 ssl->session->id,
6501 ssl->session->id_len,
6502 ssl->session ) != 0 )
6503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6504 }
6505
6506#if defined(MBEDTLS_SSL_PROTO_DTLS)
6507 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6508 ssl->handshake->flight != NULL )
6509 {
6510 /* Cancel handshake timer */
6511 mbedtls_ssl_set_timer( ssl, 0 );
6512
6513 /* Keep last flight around in case we need to resend it:
6514 * we need the handshake and transform structures for that */
6515 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6516 }
6517 else
6518#endif
6519 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6520
6521 ssl->state++;
6522
6523 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6524}
6525
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006526int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6527{
6528 int ret, hash_len;
6529
6530 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6531
6532 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6533
6534 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6535
6536 /*
6537 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6538 * may define some other value. Currently (early 2016), no defined
6539 * ciphersuite does this (and this is unlikely to change as activity has
6540 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6541 */
6542 hash_len = 12;
6543
6544#if defined(MBEDTLS_SSL_RENEGOTIATION)
6545 ssl->verify_data_len = hash_len;
6546 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6547#endif
6548
6549 ssl->out_msglen = 4 + hash_len;
6550 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6551 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6552
6553 /*
6554 * In case of session resuming, invert the client and server
6555 * ChangeCipherSpec messages order.
6556 */
6557 if( ssl->handshake->resume != 0 )
6558 {
6559#if defined(MBEDTLS_SSL_CLI_C)
6560 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6561 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6562#endif
6563#if defined(MBEDTLS_SSL_SRV_C)
6564 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6565 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6566#endif
6567 }
6568 else
6569 ssl->state++;
6570
6571 /*
6572 * Switch to our negotiated transform and session parameters for outbound
6573 * data.
6574 */
6575 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6576
6577#if defined(MBEDTLS_SSL_PROTO_DTLS)
6578 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6579 {
6580 unsigned char i;
6581
6582 /* Remember current epoch settings for resending */
6583 ssl->handshake->alt_transform_out = ssl->transform_out;
6584 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6585 sizeof( ssl->handshake->alt_out_ctr ) );
6586
6587 /* Set sequence_number to zero */
6588 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6589
6590
6591 /* Increment epoch */
6592 for( i = 2; i > 0; i-- )
6593 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6594 break;
6595
6596 /* The loop goes to its end iff the counter is wrapping */
6597 if( i == 0 )
6598 {
6599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6600 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6601 }
6602 }
6603 else
6604#endif /* MBEDTLS_SSL_PROTO_DTLS */
6605 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6606
6607 ssl->transform_out = ssl->transform_negotiate;
6608 ssl->session_out = ssl->session_negotiate;
6609
6610#if defined(MBEDTLS_SSL_PROTO_DTLS)
6611 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6612 mbedtls_ssl_send_flight_completed( ssl );
6613#endif
6614
6615 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6616 {
6617 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6618 return( ret );
6619 }
6620
6621#if defined(MBEDTLS_SSL_PROTO_DTLS)
6622 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6623 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6624 {
6625 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6626 return( ret );
6627 }
6628#endif
6629
6630 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6631
6632 return( 0 );
6633}
6634
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006635#define SSL_MAX_HASH_LEN 12
6636
6637int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6638{
6639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6640 unsigned int hash_len = 12;
6641 unsigned char buf[SSL_MAX_HASH_LEN];
6642
6643 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6644
6645 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6646
6647 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6648 {
6649 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6650 goto exit;
6651 }
6652
6653 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6654 {
6655 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6656 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6657 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6658 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6659 goto exit;
6660 }
6661
6662 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6663 {
6664 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6665 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6666 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6667 goto exit;
6668 }
6669
6670 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6671 {
6672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6673 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6674 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6675 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6676 goto exit;
6677 }
6678
6679 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6680 buf, hash_len ) != 0 )
6681 {
6682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6683 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6684 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6685 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6686 goto exit;
6687 }
6688
6689#if defined(MBEDTLS_SSL_RENEGOTIATION)
6690 ssl->verify_data_len = hash_len;
6691 memcpy( ssl->peer_verify_data, buf, hash_len );
6692#endif
6693
6694 if( ssl->handshake->resume != 0 )
6695 {
6696#if defined(MBEDTLS_SSL_CLI_C)
6697 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6698 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6699#endif
6700#if defined(MBEDTLS_SSL_SRV_C)
6701 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6702 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6703#endif
6704 }
6705 else
6706 ssl->state++;
6707
6708#if defined(MBEDTLS_SSL_PROTO_DTLS)
6709 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6710 mbedtls_ssl_recv_flight_completed( ssl );
6711#endif
6712
6713 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6714
6715exit:
6716 mbedtls_platform_zeroize( buf, hash_len );
6717 return( ret );
6718}
6719
Jerry Yu392112c2022-02-17 14:34:10 +08006720#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6721/*
6722 * Helper to get TLS 1.2 PRF from ciphersuite
6723 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6724 */
6725static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6726{
6727#if defined(MBEDTLS_SHA384_C)
6728 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6729 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6730
6731 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6732 return( tls_prf_sha384 );
6733#else
6734 (void) ciphersuite_id;
6735#endif
6736 return( tls_prf_sha256 );
6737}
6738#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006739
6740static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6741{
6742 ((void) tls_prf);
6743#if defined(MBEDTLS_SHA384_C)
6744 if( tls_prf == tls_prf_sha384 )
6745 {
6746 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6747 }
6748 else
6749#endif
6750#if defined(MBEDTLS_SHA256_C)
6751 if( tls_prf == tls_prf_sha256 )
6752 {
6753 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6754 }
6755 else
6756#endif
6757 return( MBEDTLS_SSL_TLS_PRF_NONE );
6758}
6759
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006760/*
6761 * Populate a transform structure with session keys and all the other
6762 * necessary information.
6763 *
6764 * Parameters:
6765 * - [in/out]: transform: structure to populate
6766 * [in] must be just initialised with mbedtls_ssl_transform_init()
6767 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6768 * - [in] ciphersuite
6769 * - [in] master
6770 * - [in] encrypt_then_mac
6771 * - [in] compression
6772 * - [in] tls_prf: pointer to PRF to use for key derivation
6773 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006774 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006775 * - [in] endpoint: client or server
6776 * - [in] ssl: used for:
6777 * - ssl->conf->{f,p}_export_keys
6778 * [in] optionally used for:
6779 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6780 */
6781static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6782 int ciphersuite,
6783 const unsigned char master[48],
6784#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6785 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6786 int encrypt_then_mac,
6787#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6788 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6789 ssl_tls_prf_t tls_prf,
6790 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006791 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006792 unsigned endpoint,
6793 const mbedtls_ssl_context *ssl )
6794{
6795 int ret = 0;
6796 unsigned char keyblk[256];
6797 unsigned char *key1;
6798 unsigned char *key2;
6799 unsigned char *mac_enc;
6800 unsigned char *mac_dec;
6801 size_t mac_key_len = 0;
6802 size_t iv_copy_len;
6803 size_t keylen;
6804 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
6805 const mbedtls_cipher_info_t *cipher_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006806#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006807 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006808#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006809
6810#if defined(MBEDTLS_USE_PSA_CRYPTO)
6811 psa_key_type_t key_type;
6812 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6813 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006814 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006815 size_t key_bits;
6816 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6817#endif
6818
6819#if !defined(MBEDTLS_DEBUG_C) && \
6820 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6821 if( ssl->f_export_keys == NULL )
6822 {
6823 ssl = NULL; /* make sure we don't use it except for these cases */
6824 (void) ssl;
6825 }
6826#endif
6827
6828 /*
6829 * Some data just needs copying into the structure
6830 */
6831#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
6832 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6833 transform->encrypt_then_mac = encrypt_then_mac;
6834#endif
Glenn Strauss07c64162022-03-14 12:34:51 -04006835 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006836
6837#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6838 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
6839#endif
6840
6841#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04006842 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006843 {
6844 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
6845 * generation separate. This should never happen. */
6846 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6847 }
6848#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6849
6850 /*
6851 * Get various info structures
6852 */
6853 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
6854 if( ciphersuite_info == NULL )
6855 {
6856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
6857 ciphersuite ) );
6858 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6859 }
6860
6861 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
6862 if( cipher_info == NULL )
6863 {
6864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
6865 ciphersuite_info->cipher ) );
6866 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6867 }
6868
Neil Armstronge4512952022-03-08 09:08:22 +01006869#if defined(MBEDTLS_USE_PSA_CRYPTO)
6870 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
6871 if( mac_alg == 0 )
6872 {
6873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
6874 (unsigned) ciphersuite_info->mac ) );
6875 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6876 }
6877#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006878 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
6879 if( md_info == NULL )
6880 {
6881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
6882 (unsigned) ciphersuite_info->mac ) );
6883 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6884 }
Neil Armstronge4512952022-03-08 09:08:22 +01006885#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006886
6887#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6888 /* Copy own and peer's CID if the use of the CID
6889 * extension has been negotiated. */
6890 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
6891 {
6892 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
6893
6894 transform->in_cid_len = ssl->own_cid_len;
6895 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
6896 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
6897 transform->in_cid_len );
6898
6899 transform->out_cid_len = ssl->handshake->peer_cid_len;
6900 memcpy( transform->out_cid, ssl->handshake->peer_cid,
6901 ssl->handshake->peer_cid_len );
6902 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
6903 transform->out_cid_len );
6904 }
6905#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
6906
6907 /*
6908 * Compute key block using the PRF
6909 */
6910 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
6911 if( ret != 0 )
6912 {
6913 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6914 return( ret );
6915 }
6916
6917 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
6918 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
6919 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
6920 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
6921 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
6922
6923 /*
6924 * Determine the appropriate key, IV and MAC length.
6925 */
6926
6927 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
6928
6929#if defined(MBEDTLS_GCM_C) || \
6930 defined(MBEDTLS_CCM_C) || \
6931 defined(MBEDTLS_CHACHAPOLY_C)
6932 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
6933 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
6934 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6935 {
6936 size_t explicit_ivlen;
6937
6938 transform->maclen = 0;
6939 mac_key_len = 0;
6940 transform->taglen =
6941 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
6942
6943 /* All modes haves 96-bit IVs, but the length of the static parts vary
6944 * with mode and version:
6945 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
6946 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
6947 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
6948 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
6949 * sequence number).
6950 */
6951 transform->ivlen = 12;
6952 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6953 transform->fixed_ivlen = 12;
6954 else
6955 transform->fixed_ivlen = 4;
6956
6957 /* Minimum length of encrypted record */
6958 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
6959 transform->minlen = explicit_ivlen + transform->taglen;
6960 }
6961 else
6962#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
6963#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6964 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
6965 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
6966 {
Neil Armstronge4512952022-03-08 09:08:22 +01006967#if defined(MBEDTLS_USE_PSA_CRYPTO)
6968 /* Get MAC length */
6969 mac_key_len = PSA_HASH_LENGTH(mac_alg);
6970#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006971 /* Initialize HMAC contexts */
6972 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
6973 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
6974 {
6975 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
6976 goto end;
6977 }
6978
6979 /* Get MAC length */
6980 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01006981#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006982 transform->maclen = mac_key_len;
6983
6984 /* IV length */
6985 transform->ivlen = cipher_info->iv_size;
6986
6987 /* Minimum length */
6988 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
6989 transform->minlen = transform->maclen;
6990 else
6991 {
6992 /*
6993 * GenericBlockCipher:
6994 * 1. if EtM is in use: one block plus MAC
6995 * otherwise: * first multiple of blocklen greater than maclen
6996 * 2. IV
6997 */
6998#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6999 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
7000 {
7001 transform->minlen = transform->maclen
7002 + cipher_info->block_size;
7003 }
7004 else
7005#endif
7006 {
7007 transform->minlen = transform->maclen
7008 + cipher_info->block_size
7009 - transform->maclen % cipher_info->block_size;
7010 }
7011
Glenn Strauss07c64162022-03-14 12:34:51 -04007012 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007013 {
7014 transform->minlen += transform->ivlen;
7015 }
7016 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007017 {
7018 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7019 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7020 goto end;
7021 }
7022 }
7023 }
7024 else
7025#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7026 {
7027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7028 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7029 }
7030
7031 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7032 (unsigned) keylen,
7033 (unsigned) transform->minlen,
7034 (unsigned) transform->ivlen,
7035 (unsigned) transform->maclen ) );
7036
7037 /*
7038 * Finally setup the cipher contexts, IVs and MAC secrets.
7039 */
7040#if defined(MBEDTLS_SSL_CLI_C)
7041 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7042 {
7043 key1 = keyblk + mac_key_len * 2;
7044 key2 = keyblk + mac_key_len * 2 + keylen;
7045
7046 mac_enc = keyblk;
7047 mac_dec = keyblk + mac_key_len;
7048
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007049 iv_copy_len = ( transform->fixed_ivlen ) ?
7050 transform->fixed_ivlen : transform->ivlen;
7051 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7052 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7053 iv_copy_len );
7054 }
7055 else
7056#endif /* MBEDTLS_SSL_CLI_C */
7057#if defined(MBEDTLS_SSL_SRV_C)
7058 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7059 {
7060 key1 = keyblk + mac_key_len * 2 + keylen;
7061 key2 = keyblk + mac_key_len * 2;
7062
7063 mac_enc = keyblk + mac_key_len;
7064 mac_dec = keyblk;
7065
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007066 iv_copy_len = ( transform->fixed_ivlen ) ?
7067 transform->fixed_ivlen : transform->ivlen;
7068 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7069 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7070 iv_copy_len );
7071 }
7072 else
7073#endif /* MBEDTLS_SSL_SRV_C */
7074 {
7075 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7076 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7077 goto end;
7078 }
7079
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007080 if( ssl != NULL && ssl->f_export_keys != NULL )
7081 {
7082 ssl->f_export_keys( ssl->p_export_keys,
7083 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7084 master, 48,
7085 randbytes + 32,
7086 randbytes,
7087 tls_prf_get_type( tls_prf ) );
7088 }
7089
7090#if defined(MBEDTLS_USE_PSA_CRYPTO)
7091 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7092 transform->taglen,
7093 &alg,
7094 &key_type,
7095 &key_bits ) ) != PSA_SUCCESS )
7096 {
7097 ret = psa_ssl_status_to_mbedtls( status );
7098 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7099 goto end;
7100 }
7101
7102 transform->psa_alg = alg;
7103
7104 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7105 {
7106 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7107 psa_set_key_algorithm( &attributes, alg );
7108 psa_set_key_type( &attributes, key_type );
7109
7110 if( ( status = psa_import_key( &attributes,
7111 key1,
7112 PSA_BITS_TO_BYTES( key_bits ),
7113 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7114 {
7115 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7116 ret = psa_ssl_status_to_mbedtls( status );
7117 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7118 goto end;
7119 }
7120
7121 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7122
7123 if( ( status = psa_import_key( &attributes,
7124 key2,
7125 PSA_BITS_TO_BYTES( key_bits ),
7126 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7127 {
7128 ret = psa_ssl_status_to_mbedtls( status );
7129 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7130 goto end;
7131 }
7132 }
7133#else
7134 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7135 cipher_info ) ) != 0 )
7136 {
7137 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7138 goto end;
7139 }
7140
7141 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7142 cipher_info ) ) != 0 )
7143 {
7144 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7145 goto end;
7146 }
7147
7148 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7149 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7150 MBEDTLS_ENCRYPT ) ) != 0 )
7151 {
7152 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7153 goto end;
7154 }
7155
7156 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7157 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7158 MBEDTLS_DECRYPT ) ) != 0 )
7159 {
7160 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7161 goto end;
7162 }
7163
7164#if defined(MBEDTLS_CIPHER_MODE_CBC)
7165 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7166 {
7167 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7168 MBEDTLS_PADDING_NONE ) ) != 0 )
7169 {
7170 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7171 goto end;
7172 }
7173
7174 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7175 MBEDTLS_PADDING_NONE ) ) != 0 )
7176 {
7177 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7178 goto end;
7179 }
7180 }
7181#endif /* MBEDTLS_CIPHER_MODE_CBC */
7182#endif /* MBEDTLS_USE_PSA_CRYPTO */
7183
Neil Armstrong29c0c042022-03-17 17:47:28 +01007184#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7185 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7186 For AEAD-based ciphersuites, there is nothing to do here. */
7187 if( mac_key_len != 0 )
7188 {
7189#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007190 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007191
7192 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007193 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007194 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7195
7196 if( ( status = psa_import_key( &attributes,
7197 mac_enc, mac_key_len,
7198 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7199 {
7200 ret = psa_ssl_status_to_mbedtls( status );
7201 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7202 goto end;
7203 }
7204
Ronald Cronfb39f152022-03-25 14:36:28 +01007205 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7206 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7207 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007208 /* mbedtls_ct_hmac() requires the key to be exportable */
7209 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7210 PSA_KEY_USAGE_VERIFY_HASH );
7211 else
7212 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7213
7214 if( ( status = psa_import_key( &attributes,
7215 mac_dec, mac_key_len,
7216 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7217 {
7218 ret = psa_ssl_status_to_mbedtls( status );
7219 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7220 goto end;
7221 }
7222#else
7223 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7224 if( ret != 0 )
7225 goto end;
7226 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7227 if( ret != 0 )
7228 goto end;
7229#endif /* MBEDTLS_USE_PSA_CRYPTO */
7230 }
7231#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7232
7233 ((void) mac_dec);
7234 ((void) mac_enc);
7235
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007236end:
7237 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7238 return( ret );
7239}
7240
Jerry Yuee40f9d2022-02-17 14:55:16 +08007241#if defined(MBEDTLS_USE_PSA_CRYPTO)
7242int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7243 unsigned char *hash, size_t *hashlen,
7244 unsigned char *data, size_t data_len,
7245 mbedtls_md_type_t md_alg )
7246{
7247 psa_status_t status;
7248 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7249 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7250
7251 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7252
7253 if( ( status = psa_hash_setup( &hash_operation,
7254 hash_alg ) ) != PSA_SUCCESS )
7255 {
7256 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7257 goto exit;
7258 }
7259
7260 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7261 64 ) ) != PSA_SUCCESS )
7262 {
7263 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7264 goto exit;
7265 }
7266
7267 if( ( status = psa_hash_update( &hash_operation,
7268 data, data_len ) ) != PSA_SUCCESS )
7269 {
7270 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7271 goto exit;
7272 }
7273
7274 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7275 hashlen ) ) != PSA_SUCCESS )
7276 {
7277 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7278 goto exit;
7279 }
7280
7281exit:
7282 if( status != PSA_SUCCESS )
7283 {
7284 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7285 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7286 switch( status )
7287 {
7288 case PSA_ERROR_NOT_SUPPORTED:
7289 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7290 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7291 case PSA_ERROR_BUFFER_TOO_SMALL:
7292 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7293 case PSA_ERROR_INSUFFICIENT_MEMORY:
7294 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7295 default:
7296 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7297 }
7298 }
7299 return( 0 );
7300}
7301
7302#else
7303
7304int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7305 unsigned char *hash, size_t *hashlen,
7306 unsigned char *data, size_t data_len,
7307 mbedtls_md_type_t md_alg )
7308{
7309 int ret = 0;
7310 mbedtls_md_context_t ctx;
7311 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7312 *hashlen = mbedtls_md_get_size( md_info );
7313
7314 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7315
7316 mbedtls_md_init( &ctx );
7317
7318 /*
7319 * digitally-signed struct {
7320 * opaque client_random[32];
7321 * opaque server_random[32];
7322 * ServerDHParams params;
7323 * };
7324 */
7325 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7326 {
7327 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7328 goto exit;
7329 }
7330 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7331 {
7332 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7333 goto exit;
7334 }
7335 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7336 {
7337 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7338 goto exit;
7339 }
7340 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7341 {
7342 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7343 goto exit;
7344 }
7345 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7346 {
7347 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7348 goto exit;
7349 }
7350
7351exit:
7352 mbedtls_md_free( &ctx );
7353
7354 if( ret != 0 )
7355 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7356 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7357
7358 return( ret );
7359}
7360#endif /* MBEDTLS_USE_PSA_CRYPTO */
7361
Jerry Yud9d91da2022-02-17 14:57:06 +08007362#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7363
7364/* Find an entry in a signature-hash set matching a given hash algorithm. */
7365mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7366 mbedtls_pk_type_t sig_alg )
7367{
7368 switch( sig_alg )
7369 {
7370 case MBEDTLS_PK_RSA:
7371 return( set->rsa );
7372 case MBEDTLS_PK_ECDSA:
7373 return( set->ecdsa );
7374 default:
7375 return( MBEDTLS_MD_NONE );
7376 }
7377}
7378
7379/* Add a signature-hash-pair to a signature-hash set */
7380void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7381 mbedtls_pk_type_t sig_alg,
7382 mbedtls_md_type_t md_alg )
7383{
7384 switch( sig_alg )
7385 {
7386 case MBEDTLS_PK_RSA:
7387 if( set->rsa == MBEDTLS_MD_NONE )
7388 set->rsa = md_alg;
7389 break;
7390
7391 case MBEDTLS_PK_ECDSA:
7392 if( set->ecdsa == MBEDTLS_MD_NONE )
7393 set->ecdsa = md_alg;
7394 break;
7395
7396 default:
7397 break;
7398 }
7399}
7400
7401/* Allow exactly one hash algorithm for each signature. */
7402void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7403 mbedtls_md_type_t md_alg )
7404{
7405 set->rsa = md_alg;
7406 set->ecdsa = md_alg;
7407}
7408
7409#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7410
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007411/* Serialization of TLS 1.2 sessions:
7412 *
7413 * struct {
7414 * uint64 start_time;
7415 * uint8 ciphersuite[2]; // defined by the standard
7416 * uint8 compression; // 0 or 1
7417 * uint8 session_id_len; // at most 32
7418 * opaque session_id[32];
7419 * opaque master[48]; // fixed length in the standard
7420 * uint32 verify_result;
7421 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7422 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7423 * uint32 ticket_lifetime;
7424 * uint8 mfl_code; // up to 255 according to standard
7425 * uint8 encrypt_then_mac; // 0 or 1
7426 * } serialized_session_tls12;
7427 *
7428 */
7429static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7430 unsigned char *buf,
7431 size_t buf_len )
7432{
7433 unsigned char *p = buf;
7434 size_t used = 0;
7435
7436#if defined(MBEDTLS_HAVE_TIME)
7437 uint64_t start;
7438#endif
7439#if defined(MBEDTLS_X509_CRT_PARSE_C)
7440#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7441 size_t cert_len;
7442#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7443#endif /* MBEDTLS_X509_CRT_PARSE_C */
7444
7445 /*
7446 * Time
7447 */
7448#if defined(MBEDTLS_HAVE_TIME)
7449 used += 8;
7450
7451 if( used <= buf_len )
7452 {
7453 start = (uint64_t) session->start;
7454
7455 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7456 p += 8;
7457 }
7458#endif /* MBEDTLS_HAVE_TIME */
7459
7460 /*
7461 * Basic mandatory fields
7462 */
7463 used += 2 /* ciphersuite */
7464 + 1 /* compression */
7465 + 1 /* id_len */
7466 + sizeof( session->id )
7467 + sizeof( session->master )
7468 + 4; /* verify_result */
7469
7470 if( used <= buf_len )
7471 {
7472 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7473 p += 2;
7474
7475 *p++ = MBEDTLS_BYTE_0( session->compression );
7476
7477 *p++ = MBEDTLS_BYTE_0( session->id_len );
7478 memcpy( p, session->id, 32 );
7479 p += 32;
7480
7481 memcpy( p, session->master, 48 );
7482 p += 48;
7483
7484 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7485 p += 4;
7486 }
7487
7488 /*
7489 * Peer's end-entity certificate
7490 */
7491#if defined(MBEDTLS_X509_CRT_PARSE_C)
7492#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7493 if( session->peer_cert == NULL )
7494 cert_len = 0;
7495 else
7496 cert_len = session->peer_cert->raw.len;
7497
7498 used += 3 + cert_len;
7499
7500 if( used <= buf_len )
7501 {
7502 *p++ = MBEDTLS_BYTE_2( cert_len );
7503 *p++ = MBEDTLS_BYTE_1( cert_len );
7504 *p++ = MBEDTLS_BYTE_0( cert_len );
7505
7506 if( session->peer_cert != NULL )
7507 {
7508 memcpy( p, session->peer_cert->raw.p, cert_len );
7509 p += cert_len;
7510 }
7511 }
7512#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7513 if( session->peer_cert_digest != NULL )
7514 {
7515 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7516 if( used <= buf_len )
7517 {
7518 *p++ = (unsigned char) session->peer_cert_digest_type;
7519 *p++ = (unsigned char) session->peer_cert_digest_len;
7520 memcpy( p, session->peer_cert_digest,
7521 session->peer_cert_digest_len );
7522 p += session->peer_cert_digest_len;
7523 }
7524 }
7525 else
7526 {
7527 used += 2;
7528 if( used <= buf_len )
7529 {
7530 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7531 *p++ = 0;
7532 }
7533 }
7534#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7535#endif /* MBEDTLS_X509_CRT_PARSE_C */
7536
7537 /*
7538 * Session ticket if any, plus associated data
7539 */
7540#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7541 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7542
7543 if( used <= buf_len )
7544 {
7545 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7546 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7547 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7548
7549 if( session->ticket != NULL )
7550 {
7551 memcpy( p, session->ticket, session->ticket_len );
7552 p += session->ticket_len;
7553 }
7554
7555 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7556 p += 4;
7557 }
7558#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7559
7560 /*
7561 * Misc extension-related info
7562 */
7563#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7564 used += 1;
7565
7566 if( used <= buf_len )
7567 *p++ = session->mfl_code;
7568#endif
7569
7570#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7571 used += 1;
7572
7573 if( used <= buf_len )
7574 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7575#endif
7576
7577 return( used );
7578}
7579
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007580static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7581 const unsigned char *buf,
7582 size_t len )
7583{
7584#if defined(MBEDTLS_HAVE_TIME)
7585 uint64_t start;
7586#endif
7587#if defined(MBEDTLS_X509_CRT_PARSE_C)
7588#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7589 size_t cert_len;
7590#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7591#endif /* MBEDTLS_X509_CRT_PARSE_C */
7592
7593 const unsigned char *p = buf;
7594 const unsigned char * const end = buf + len;
7595
7596 /*
7597 * Time
7598 */
7599#if defined(MBEDTLS_HAVE_TIME)
7600 if( 8 > (size_t)( end - p ) )
7601 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7602
7603 start = ( (uint64_t) p[0] << 56 ) |
7604 ( (uint64_t) p[1] << 48 ) |
7605 ( (uint64_t) p[2] << 40 ) |
7606 ( (uint64_t) p[3] << 32 ) |
7607 ( (uint64_t) p[4] << 24 ) |
7608 ( (uint64_t) p[5] << 16 ) |
7609 ( (uint64_t) p[6] << 8 ) |
7610 ( (uint64_t) p[7] );
7611 p += 8;
7612
7613 session->start = (time_t) start;
7614#endif /* MBEDTLS_HAVE_TIME */
7615
7616 /*
7617 * Basic mandatory fields
7618 */
7619 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7620 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7621
7622 session->ciphersuite = ( p[0] << 8 ) | p[1];
7623 p += 2;
7624
7625 session->compression = *p++;
7626
7627 session->id_len = *p++;
7628 memcpy( session->id, p, 32 );
7629 p += 32;
7630
7631 memcpy( session->master, p, 48 );
7632 p += 48;
7633
7634 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7635 ( (uint32_t) p[1] << 16 ) |
7636 ( (uint32_t) p[2] << 8 ) |
7637 ( (uint32_t) p[3] );
7638 p += 4;
7639
7640 /* Immediately clear invalid pointer values that have been read, in case
7641 * we exit early before we replaced them with valid ones. */
7642#if defined(MBEDTLS_X509_CRT_PARSE_C)
7643#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7644 session->peer_cert = NULL;
7645#else
7646 session->peer_cert_digest = NULL;
7647#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7648#endif /* MBEDTLS_X509_CRT_PARSE_C */
7649#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7650 session->ticket = NULL;
7651#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7652
7653 /*
7654 * Peer certificate
7655 */
7656#if defined(MBEDTLS_X509_CRT_PARSE_C)
7657#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7658 /* Deserialize CRT from the end of the ticket. */
7659 if( 3 > (size_t)( end - p ) )
7660 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7661
7662 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7663 p += 3;
7664
7665 if( cert_len != 0 )
7666 {
7667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7668
7669 if( cert_len > (size_t)( end - p ) )
7670 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7671
7672 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7673
7674 if( session->peer_cert == NULL )
7675 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7676
7677 mbedtls_x509_crt_init( session->peer_cert );
7678
7679 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7680 p, cert_len ) ) != 0 )
7681 {
7682 mbedtls_x509_crt_free( session->peer_cert );
7683 mbedtls_free( session->peer_cert );
7684 session->peer_cert = NULL;
7685 return( ret );
7686 }
7687
7688 p += cert_len;
7689 }
7690#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7691 /* Deserialize CRT digest from the end of the ticket. */
7692 if( 2 > (size_t)( end - p ) )
7693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7694
7695 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7696 session->peer_cert_digest_len = (size_t) *p++;
7697
7698 if( session->peer_cert_digest_len != 0 )
7699 {
7700 const mbedtls_md_info_t *md_info =
7701 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7702 if( md_info == NULL )
7703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7704 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7706
7707 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7709
7710 session->peer_cert_digest =
7711 mbedtls_calloc( 1, session->peer_cert_digest_len );
7712 if( session->peer_cert_digest == NULL )
7713 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7714
7715 memcpy( session->peer_cert_digest, p,
7716 session->peer_cert_digest_len );
7717 p += session->peer_cert_digest_len;
7718 }
7719#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7720#endif /* MBEDTLS_X509_CRT_PARSE_C */
7721
7722 /*
7723 * Session ticket and associated data
7724 */
7725#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7726 if( 3 > (size_t)( end - p ) )
7727 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7728
7729 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7730 p += 3;
7731
7732 if( session->ticket_len != 0 )
7733 {
7734 if( session->ticket_len > (size_t)( end - p ) )
7735 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7736
7737 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7738 if( session->ticket == NULL )
7739 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7740
7741 memcpy( session->ticket, p, session->ticket_len );
7742 p += session->ticket_len;
7743 }
7744
7745 if( 4 > (size_t)( end - p ) )
7746 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7747
7748 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7749 ( (uint32_t) p[1] << 16 ) |
7750 ( (uint32_t) p[2] << 8 ) |
7751 ( (uint32_t) p[3] );
7752 p += 4;
7753#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7754
7755 /*
7756 * Misc extension-related info
7757 */
7758#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7759 if( 1 > (size_t)( end - p ) )
7760 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7761
7762 session->mfl_code = *p++;
7763#endif
7764
7765#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7766 if( 1 > (size_t)( end - p ) )
7767 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7768
7769 session->encrypt_then_mac = *p++;
7770#endif
7771
7772 /* Done, should have consumed entire buffer */
7773 if( p != end )
7774 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7775
7776 return( 0 );
7777}
Jerry Yudc7bd172022-02-17 13:44:15 +08007778#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7779
XiaokangQian75d40ef2022-04-20 11:05:24 +00007780int mbedtls_ssl_validate_ciphersuite(
7781 const mbedtls_ssl_context *ssl,
7782 const mbedtls_ssl_ciphersuite_t *suite_info,
7783 mbedtls_ssl_protocol_version min_tls_version,
7784 mbedtls_ssl_protocol_version max_tls_version )
7785{
7786 (void) ssl;
7787
7788 if( suite_info == NULL )
7789 return( -1 );
7790
7791 if( ( suite_info->min_tls_version > max_tls_version ) ||
7792 ( suite_info->max_tls_version < min_tls_version ) )
7793 {
7794 return( -1 );
7795 }
7796
XiaokangQian060d8672022-04-21 09:24:56 +00007797#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00007798#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7799 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
7800 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
7801 {
7802 return( -1 );
7803 }
7804#endif
7805
7806 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
7807#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
7808 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
7809 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
7810 {
7811 return( -1 );
7812 }
7813#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
7814#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7815
7816 return( 0 );
7817}
7818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007819#endif /* MBEDTLS_SSL_TLS_C */