blob: 99b7d04d91fdcbef85741a70680ad1e31b222cd0 [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],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800387 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200388#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800389 ssl_tls_prf_t tls_prf,
390 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400391 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800392 unsigned endpoint,
393 const mbedtls_ssl_context *ssl );
394
395#if defined(MBEDTLS_SHA256_C)
396static int tls_prf_sha256( const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen );
400static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
401static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
402
403#endif /* MBEDTLS_SHA256_C */
404
405#if defined(MBEDTLS_SHA384_C)
406static int tls_prf_sha384( const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen );
410
411static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
412static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
413#endif /* MBEDTLS_SHA384_C */
414
415static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
416 unsigned char *buf,
417 size_t buf_len );
418static int ssl_session_load_tls12( mbedtls_ssl_session *session,
419 const unsigned char *buf,
420 size_t len );
421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
422
Jerry Yu53d23e22022-02-09 16:25:09 +0800423static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
424
Jerry Yudb8c48a2022-01-27 14:54:54 +0800425#if defined(MBEDTLS_SHA256_C)
426static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800427#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800428
429#if defined(MBEDTLS_SHA384_C)
430static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800431#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000432
Ron Eldor51d3ab52019-05-12 14:54:30 +0300433int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
434 const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen )
438{
439 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
440
441 switch( prf )
442 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300443#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200444#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300445 case MBEDTLS_SSL_TLS_PRF_SHA384:
446 tls_prf = tls_prf_sha384;
447 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200448#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300449#if defined(MBEDTLS_SHA256_C)
450 case MBEDTLS_SSL_TLS_PRF_SHA256:
451 tls_prf = tls_prf_sha256;
452 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300453#endif /* MBEDTLS_SHA256_C */
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300455 default:
456 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
457 }
458
459 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
460}
461
Jerry Yuc73c6182022-02-08 20:29:25 +0800462#if defined(MBEDTLS_X509_CRT_PARSE_C)
463static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
464{
465#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
466 if( session->peer_cert != NULL )
467 {
468 mbedtls_x509_crt_free( session->peer_cert );
469 mbedtls_free( session->peer_cert );
470 session->peer_cert = NULL;
471 }
472#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
473 if( session->peer_cert_digest != NULL )
474 {
475 /* Zeroization is not necessary. */
476 mbedtls_free( session->peer_cert_digest );
477 session->peer_cert_digest = NULL;
478 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
479 session->peer_cert_digest_len = 0;
480 }
481#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
482}
483#endif /* MBEDTLS_X509_CRT_PARSE_C */
484
485void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
487{
488 ((void) ciphersuite_info);
489
490#if defined(MBEDTLS_SHA384_C)
491 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
492 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
493 else
494#endif
495#if defined(MBEDTLS_SHA256_C)
496 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
497 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
498 else
499#endif
500 {
501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
502 return;
503 }
504}
505
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100506static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
507 unsigned hs_type,
508 size_t total_hs_len )
509{
510 unsigned char hs_hdr[4];
511
512 /* Build HS header for checksum update. */
513 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
514 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
515 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
516 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
517
518 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
519}
520
521void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
522 unsigned hs_type,
523 unsigned char const *msg,
524 size_t msg_len )
525{
526 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
527 ssl->handshake->update_checksum( ssl, msg, msg_len );
528}
529
Jerry Yuc73c6182022-02-08 20:29:25 +0800530void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
531{
532 ((void) ssl);
533#if defined(MBEDTLS_SHA256_C)
534#if defined(MBEDTLS_USE_PSA_CRYPTO)
535 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
536 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
537#else
538 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
539#endif
540#endif
541#if defined(MBEDTLS_SHA384_C)
542#if defined(MBEDTLS_USE_PSA_CRYPTO)
543 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
544 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
545#else
546 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
547#endif
548#endif
549}
550
551static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
552 const unsigned char *buf, size_t len )
553{
554#if defined(MBEDTLS_SHA256_C)
555#if defined(MBEDTLS_USE_PSA_CRYPTO)
556 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
557#else
558 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
559#endif
560#endif
561#if defined(MBEDTLS_SHA384_C)
562#if defined(MBEDTLS_USE_PSA_CRYPTO)
563 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
564#else
565 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
566#endif
567#endif
568}
569
570#if defined(MBEDTLS_SHA256_C)
571static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
572 const unsigned char *buf, size_t len )
573{
574#if defined(MBEDTLS_USE_PSA_CRYPTO)
575 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
576#else
577 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
578#endif
579}
580#endif
581
582#if defined(MBEDTLS_SHA384_C)
583static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
584 const unsigned char *buf, size_t len )
585{
586#if defined(MBEDTLS_USE_PSA_CRYPTO)
587 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
588#else
589 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
590#endif
591}
592#endif
593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200595{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500599#if defined(MBEDTLS_USE_PSA_CRYPTO)
600 handshake->fin_sha256_psa = psa_hash_operation_init();
601 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
602#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200604 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200605#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500606#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200607#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500609 handshake->fin_sha384_psa = psa_hash_operation_init();
610 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500611#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200613 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200614#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500615#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616
617 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100618
619#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100620 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100621 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
622#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#if defined(MBEDTLS_DHM_C)
625 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200626#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200627#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200629#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200630#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200632#if defined(MBEDTLS_SSL_CLI_C)
633 handshake->ecjpake_cache = NULL;
634 handshake->ecjpake_cache_len = 0;
635#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200636#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200637
Gilles Peskineeccd8882020-03-10 12:19:08 +0100638#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200639 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200640#endif
641
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200642#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
643 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
644#endif
Hanno Becker75173122019-02-06 16:18:31 +0000645
646#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
647 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
648 mbedtls_pk_init( &handshake->peer_pubkey );
649#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200650}
651
Hanno Beckera18d1322018-01-03 14:27:32 +0000652void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200653{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200655
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
658 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100659#else
660 mbedtls_cipher_init( &transform->cipher_ctx_enc );
661 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100662#endif
663
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100665#if defined(MBEDTLS_USE_PSA_CRYPTO)
666 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
667 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100668#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 mbedtls_md_init( &transform->md_ctx_enc );
670 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000671#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100672#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200673}
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200676{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678}
679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000681{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200682 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000683 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200685 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200688 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689
690 /*
691 * Either the pointers are now NULL or cleared properly and can be freed.
692 * Now allocate missing structures.
693 */
694 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200695 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200696 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 }
Paul Bakker48916f92012-09-16 19:57:18 +0000698
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200699 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200700 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200701 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 }
Paul Bakker48916f92012-09-16 19:57:18 +0000703
Paul Bakker82788fb2014-10-20 13:59:19 +0200704 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200705 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200706 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500708#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
709 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400710
Andrzej Kurek4a063792020-10-21 15:08:44 +0200711 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
712 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500713#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000714
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000716 if( ssl->handshake == NULL ||
717 ssl->transform_negotiate == NULL ||
718 ssl->session_negotiate == NULL )
719 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200720 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 mbedtls_free( ssl->handshake );
723 mbedtls_free( ssl->transform_negotiate );
724 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725
726 ssl->handshake = NULL;
727 ssl->transform_negotiate = NULL;
728 ssl->session_negotiate = NULL;
729
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200730 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000731 }
732
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200733 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200734 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000735 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200736 ssl_handshake_params_init( ssl->handshake );
737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200739 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
740 {
741 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200742
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200743 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
744 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
745 else
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200747
Hanno Becker0f57a652020-02-05 10:37:26 +0000748 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200749 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200750#endif
751
Brett Warrene0edc842021-08-17 09:53:13 +0100752/*
753 * curve_list is translated to IANA TLS group identifiers here because
754 * mbedtls_ssl_conf_curves returns void and so can't return
755 * any error codes.
756 */
757#if defined(MBEDTLS_ECP_C)
758#if !defined(MBEDTLS_DEPRECATED_REMOVED)
759 /* Heap allocate and translate curve_list from internal to IANA group ids */
760 if ( ssl->conf->curve_list != NULL )
761 {
762 size_t length;
763 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
764
765 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
766 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
767
768 /* Leave room for zero termination */
769 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
770 if ( group_list == NULL )
771 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
772
773 for( size_t i = 0; i < length; i++ )
774 {
775 const mbedtls_ecp_curve_info *info =
776 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
777 if ( info == NULL )
778 {
779 mbedtls_free( group_list );
780 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
781 }
782 group_list[i] = info->tls_id;
783 }
784
785 group_list[length] = 0;
786
787 ssl->handshake->group_list = group_list;
788 ssl->handshake->group_list_heap_allocated = 1;
789 }
790 else
791 {
792 ssl->handshake->group_list = ssl->conf->group_list;
793 ssl->handshake->group_list_heap_allocated = 0;
794 }
795#endif /* MBEDTLS_DEPRECATED_REMOVED */
796#endif /* MBEDTLS_ECP_C */
797
Jerry Yuf017ee42022-01-12 15:49:48 +0800798#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
799#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800800#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800801 /* Heap allocate and translate sig_hashes from internal hash identifiers to
802 signature algorithms IANA identifiers. */
803 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800804 ssl->conf->sig_hashes != NULL )
805 {
806 const int *md;
807 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800808 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800809 uint16_t *p;
810
Jerry Yub476a442022-01-21 18:14:45 +0800811#if defined(static_assert)
812 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
813 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
814 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800815#endif
816
Jerry Yuf017ee42022-01-12 15:49:48 +0800817 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
818 {
819 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
820 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800821#if defined(MBEDTLS_ECDSA_C)
822 sig_algs_len += sizeof( uint16_t );
823#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800824
Jerry Yub476a442022-01-21 18:14:45 +0800825#if defined(MBEDTLS_RSA_C)
826 sig_algs_len += sizeof( uint16_t );
827#endif
828 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
829 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 }
831
Jerry Yub476a442022-01-21 18:14:45 +0800832 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800833 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
834
Jerry Yub476a442022-01-21 18:14:45 +0800835 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
836 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800837 if( ssl->handshake->sig_algs == NULL )
838 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
839
840 p = (uint16_t *)ssl->handshake->sig_algs;
841 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
842 {
843 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
844 if( hash == MBEDTLS_SSL_HASH_NONE )
845 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800846#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800847 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
848 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800849#endif
850#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800851 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
852 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800853#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800854 }
855 *p = MBEDTLS_TLS1_3_SIG_NONE;
856 ssl->handshake->sig_algs_heap_allocated = 1;
857 }
858 else
Jerry Yua69269a2022-01-17 21:06:01 +0800859#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800860 {
861 ssl->handshake->sig_algs = ssl->conf->sig_algs;
862 ssl->handshake->sig_algs_heap_allocated = 0;
863 }
864#endif /* MBEDTLS_DEPRECATED_REMOVED */
865#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000866 return( 0 );
867}
868
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200869#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200870/* Dummy cookie callbacks for defaults */
871static int ssl_cookie_write_dummy( void *ctx,
872 unsigned char **p, unsigned char *end,
873 const unsigned char *cli_id, size_t cli_id_len )
874{
875 ((void) ctx);
876 ((void) p);
877 ((void) end);
878 ((void) cli_id);
879 ((void) cli_id_len);
880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200882}
883
884static int ssl_cookie_check_dummy( void *ctx,
885 const unsigned char *cookie, size_t cookie_len,
886 const unsigned char *cli_id, size_t cli_id_len )
887{
888 ((void) ctx);
889 ((void) cookie);
890 ((void) cookie_len);
891 ((void) cli_id);
892 ((void) cli_id_len);
893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200896#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897
Paul Bakker5121ce52009-01-03 21:22:43 +0000898/*
899 * Initialize an SSL context
900 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200901void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
902{
903 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
904}
905
Jerry Yu60835a82021-08-04 10:13:52 +0800906static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
907{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100908 const mbedtls_ssl_config *conf = ssl->conf;
909
Ronald Cron6f135e12021-12-08 16:57:54 +0100910#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100911 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
912 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000913 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
914 {
915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
916 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
917 }
918
Jerry Yu60835a82021-08-04 10:13:52 +0800919 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
920 return( 0 );
921 }
922#endif
923
924#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100925 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800926 {
927 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
928 return( 0 );
929 }
930#endif
931
Ronald Cron6f135e12021-12-08 16:57:54 +0100932#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100933 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800934 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000935 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
936 {
937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
938 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
939 }
940
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000941 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
947
Ronald Crone1d3f062022-02-10 14:50:54 +0100948 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
949 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800950 }
951#endif
952
953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
954 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
955}
956
957static int ssl_conf_check(const mbedtls_ssl_context *ssl)
958{
959 int ret;
960 ret = ssl_conf_version_check( ssl );
961 if( ret != 0 )
962 return( ret );
963
964 /* Space for further checks */
965
966 return( 0 );
967}
968
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200969/*
970 * Setup an SSL context
971 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100972
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200973int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200974 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000975{
Janos Follath865b3eb2019-12-16 11:46:15 +0000976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000977 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
978 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000979
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200980 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000981
Jerry Yu60835a82021-08-04 10:13:52 +0800982 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
983 return( ret );
984
Paul Bakker62f2dee2012-09-28 07:31:51 +0000985 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100986 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000987 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200988
989 /* Set to NULL in case of an error condition */
990 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200991
Darryl Greenb33cc762019-11-28 14:29:44 +0000992#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
993 ssl->in_buf_len = in_buf_len;
994#endif
995 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000996 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000997 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200999 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001000 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001001 }
1002
Darryl Greenb33cc762019-11-28 14:29:44 +00001003#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1004 ssl->out_buf_len = out_buf_len;
1005#endif
1006 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001007 if( ssl->out_buf == NULL )
1008 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001010 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001011 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001012 }
1013
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001014 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001015
Johan Pascalb62bb512015-12-03 21:56:45 +01001016#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001017 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001018#endif
1019
Paul Bakker48916f92012-09-16 19:57:18 +00001020 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001021 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001022
1023 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001024
1025error:
1026 mbedtls_free( ssl->in_buf );
1027 mbedtls_free( ssl->out_buf );
1028
1029 ssl->conf = NULL;
1030
Darryl Greenb33cc762019-11-28 14:29:44 +00001031#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1032 ssl->in_buf_len = 0;
1033 ssl->out_buf_len = 0;
1034#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001035 ssl->in_buf = NULL;
1036 ssl->out_buf = NULL;
1037
1038 ssl->in_hdr = NULL;
1039 ssl->in_ctr = NULL;
1040 ssl->in_len = NULL;
1041 ssl->in_iv = NULL;
1042 ssl->in_msg = NULL;
1043
1044 ssl->out_hdr = NULL;
1045 ssl->out_ctr = NULL;
1046 ssl->out_len = NULL;
1047 ssl->out_iv = NULL;
1048 ssl->out_msg = NULL;
1049
k-stachowiak9f7798e2018-07-31 16:52:32 +02001050 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001051}
1052
1053/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001054 * Reset an initialized and used SSL context for re-use while retaining
1055 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001056 *
1057 * If partial is non-zero, keep data in the input buffer and client ID.
1058 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001059 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001060void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1061 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001062{
Darryl Greenb33cc762019-11-28 14:29:44 +00001063#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1064 size_t in_buf_len = ssl->in_buf_len;
1065 size_t out_buf_len = ssl->out_buf_len;
1066#else
1067 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1068 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1069#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001070
Hanno Beckerb0302c42021-08-03 09:39:42 +01001071#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1072 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001073#endif
1074
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001075 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001076 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001077
Hanno Beckerb0302c42021-08-03 09:39:42 +01001078 mbedtls_ssl_reset_in_out_pointers( ssl );
1079
1080 /* Reset incoming message parsing */
1081 ssl->in_offt = NULL;
1082 ssl->nb_zero = 0;
1083 ssl->in_msgtype = 0;
1084 ssl->in_msglen = 0;
1085 ssl->in_hslen = 0;
1086 ssl->keep_current_message = 0;
1087 ssl->transform_in = NULL;
1088
1089#if defined(MBEDTLS_SSL_PROTO_DTLS)
1090 ssl->next_record_offset = 0;
1091 ssl->in_epoch = 0;
1092#endif
1093
1094 /* Keep current datagram if partial == 1 */
1095 if( partial == 0 )
1096 {
1097 ssl->in_left = 0;
1098 memset( ssl->in_buf, 0, in_buf_len );
1099 }
1100
1101 /* Reset outgoing message writing */
1102 ssl->out_msgtype = 0;
1103 ssl->out_msglen = 0;
1104 ssl->out_left = 0;
1105 memset( ssl->out_buf, 0, out_buf_len );
1106 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1107 ssl->transform_out = NULL;
1108
1109#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1110 mbedtls_ssl_dtls_replay_reset( ssl );
1111#endif
1112
XiaokangQian2b01dc32022-01-21 02:53:13 +00001113#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001114 if( ssl->transform )
1115 {
1116 mbedtls_ssl_transform_free( ssl->transform );
1117 mbedtls_free( ssl->transform );
1118 ssl->transform = NULL;
1119 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001120#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1121
XiaokangQian2b01dc32022-01-21 02:53:13 +00001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1123 mbedtls_ssl_transform_free( ssl->transform_application );
1124 mbedtls_free( ssl->transform_application );
1125 ssl->transform_application = NULL;
1126
1127 if( ssl->handshake != NULL )
1128 {
1129 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1130 mbedtls_free( ssl->handshake->transform_earlydata );
1131 ssl->handshake->transform_earlydata = NULL;
1132
1133 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1134 mbedtls_free( ssl->handshake->transform_handshake );
1135 ssl->handshake->transform_handshake = NULL;
1136 }
1137
XiaokangQian2b01dc32022-01-21 02:53:13 +00001138#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001139}
1140
1141int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1142{
1143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1144
1145 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1146
XiaokangQian78b1fa72022-01-19 06:56:30 +00001147 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001148
1149 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150#if defined(MBEDTLS_SSL_RENEGOTIATION)
1151 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001152 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001153
1154 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1156 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001157#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001159
Hanno Beckerb0302c42021-08-03 09:39:42 +01001160 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001161 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001162 if( ssl->session )
1163 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 mbedtls_ssl_session_free( ssl->session );
1165 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001166 ssl->session = NULL;
1167 }
1168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001170 ssl->alpn_chosen = NULL;
1171#endif
1172
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001173#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001174#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001175 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001176#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001177 {
1178 mbedtls_free( ssl->cli_id );
1179 ssl->cli_id = NULL;
1180 ssl->cli_id_len = 0;
1181 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001182#endif
1183
Paul Bakker48916f92012-09-16 19:57:18 +00001184 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1185 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001186
1187 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001188}
1189
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001190/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001191 * Reset an initialized and used SSL context for re-use while retaining
1192 * all application-set variables, function pointers and data.
1193 */
1194int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1195{
Hanno Becker43aefe22020-02-05 10:44:56 +00001196 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001197}
1198
1199/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001200 * SSL set accessors
1201 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001202void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001203{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001204 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001205}
1206
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001207void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001209 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001210}
1211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001212#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001213void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001215 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001216}
1217#endif
1218
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001219void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001220{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001221 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001222}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001225
Hanno Becker1841b0a2018-08-24 11:13:57 +01001226void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1227 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001228{
1229 ssl->disable_datagram_packing = !allow_packing;
1230}
1231
1232void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1233 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->hs_timeout_min = min;
1236 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001237}
1238#endif
1239
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001240void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001243}
1244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001246void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001247 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001248 void *p_vrfy )
1249{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001250 conf->f_vrfy = f_vrfy;
1251 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001252}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001254
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001255void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001256 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001257 void *p_rng )
1258{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001259 conf->f_rng = f_rng;
1260 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001261}
1262
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001263void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001264 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001265 void *p_dbg )
1266{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001267 conf->f_dbg = f_dbg;
1268 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001269}
1270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001272 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001273 mbedtls_ssl_send_t *f_send,
1274 mbedtls_ssl_recv_t *f_recv,
1275 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001276{
1277 ssl->p_bio = p_bio;
1278 ssl->f_send = f_send;
1279 ssl->f_recv = f_recv;
1280 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001281}
1282
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001283#if defined(MBEDTLS_SSL_PROTO_DTLS)
1284void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1285{
1286 ssl->mtu = mtu;
1287}
1288#endif
1289
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001290void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001291{
1292 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001293}
1294
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001295void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1296 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001297 mbedtls_ssl_set_timer_t *f_set_timer,
1298 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001299{
1300 ssl->p_timer = p_timer;
1301 ssl->f_set_timer = f_set_timer;
1302 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001303
1304 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001305 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001306}
1307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001309void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001310 void *p_cache,
1311 mbedtls_ssl_cache_get_t *f_get_cache,
1312 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001313{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001314 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001315 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001316 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001317}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#if defined(MBEDTLS_SSL_CLI_C)
1321int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001322{
Janos Follath865b3eb2019-12-16 11:46:15 +00001323 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001324
1325 if( ssl == NULL ||
1326 session == NULL ||
1327 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001328 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001331 }
1332
Hanno Beckere810bbc2021-05-14 16:01:05 +01001333 if( ssl->handshake->resume == 1 )
1334 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1335
Hanno Becker52055ae2019-02-06 14:30:46 +00001336 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1337 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001338 return( ret );
1339
Paul Bakker0a597072012-09-25 21:55:46 +00001340 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001341
1342 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001343}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001345
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001346void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1347 const int *ciphersuites )
1348{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001349 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001350}
1351
Ronald Cron6f135e12021-12-08 16:57:54 +01001352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001353void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001354 const int kex_modes )
1355{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001356 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001357}
Ronald Cron6f135e12021-12-08 16:57:54 +01001358#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001361void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001362 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001363{
1364 conf->cert_profile = profile;
1365}
1366
Glenn Strauss36872db2022-01-22 05:06:31 -05001367static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1368{
1369 mbedtls_ssl_key_cert *cur = key_cert, *next;
1370
1371 while( cur != NULL )
1372 {
1373 next = cur->next;
1374 mbedtls_free( cur );
1375 cur = next;
1376 }
1377}
1378
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001379/* Append a new keycert entry to a (possibly empty) list */
1380static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1381 mbedtls_x509_crt *cert,
1382 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001383{
niisato8ee24222018-06-25 19:05:48 +09001384 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001385
Glenn Strauss36872db2022-01-22 05:06:31 -05001386 if( cert == NULL )
1387 {
1388 /* Free list if cert is null */
1389 ssl_key_cert_free( *head );
1390 *head = NULL;
1391 return( 0 );
1392 }
1393
niisato8ee24222018-06-25 19:05:48 +09001394 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1395 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001396 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001397
niisato8ee24222018-06-25 19:05:48 +09001398 new_cert->cert = cert;
1399 new_cert->key = key;
1400 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001401
Glenn Strauss36872db2022-01-22 05:06:31 -05001402 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001403 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001404 {
niisato8ee24222018-06-25 19:05:48 +09001405 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001406 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001407 else
1408 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001409 mbedtls_ssl_key_cert *cur = *head;
1410 while( cur->next != NULL )
1411 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001412 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001413 }
1414
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001415 return( 0 );
1416}
1417
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001418int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001419 mbedtls_x509_crt *own_cert,
1420 mbedtls_pk_context *pk_key )
1421{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001422 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001423}
1424
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001425void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001426 mbedtls_x509_crt *ca_chain,
1427 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001428{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001429 conf->ca_chain = ca_chain;
1430 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001431
1432#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1433 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1434 * cannot be used together. */
1435 conf->f_ca_cb = NULL;
1436 conf->p_ca_cb = NULL;
1437#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001438}
Hanno Becker5adaad92019-03-27 16:54:37 +00001439
1440#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1441void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001442 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001443 void *p_ca_cb )
1444{
1445 conf->f_ca_cb = f_ca_cb;
1446 conf->p_ca_cb = p_ca_cb;
1447
1448 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1449 * cannot be used together. */
1450 conf->ca_chain = NULL;
1451 conf->ca_crl = NULL;
1452}
1453#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001455
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001456#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001457const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1458 size_t *name_len )
1459{
1460 *name_len = ssl->handshake->sni_name_len;
1461 return( ssl->handshake->sni_name );
1462}
1463
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001464int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1465 mbedtls_x509_crt *own_cert,
1466 mbedtls_pk_context *pk_key )
1467{
1468 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1469 own_cert, pk_key ) );
1470}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001471
1472void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1473 mbedtls_x509_crt *ca_chain,
1474 mbedtls_x509_crl *ca_crl )
1475{
1476 ssl->handshake->sni_ca_chain = ca_chain;
1477 ssl->handshake->sni_ca_crl = ca_crl;
1478}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001479
1480void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1481 int authmode )
1482{
1483 ssl->handshake->sni_authmode = authmode;
1484}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001485#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1486
Hanno Becker8927c832019-04-03 12:52:50 +01001487#if defined(MBEDTLS_X509_CRT_PARSE_C)
1488void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1489 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1490 void *p_vrfy )
1491{
1492 ssl->f_vrfy = f_vrfy;
1493 ssl->p_vrfy = p_vrfy;
1494}
1495#endif
1496
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001497#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001498/*
1499 * Set EC J-PAKE password for current handshake
1500 */
1501int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1502 const unsigned char *pw,
1503 size_t pw_len )
1504{
1505 mbedtls_ecjpake_role role;
1506
Janos Follath8eb64132016-06-03 15:40:57 +01001507 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001508 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1509
1510 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1511 role = MBEDTLS_ECJPAKE_SERVER;
1512 else
1513 role = MBEDTLS_ECJPAKE_CLIENT;
1514
1515 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1516 role,
1517 MBEDTLS_MD_SHA256,
1518 MBEDTLS_ECP_DP_SECP256R1,
1519 pw, pw_len ) );
1520}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001521#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001522
Gilles Peskineeccd8882020-03-10 12:19:08 +01001523#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001524
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001525static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1526{
1527#if defined(MBEDTLS_USE_PSA_CRYPTO)
1528 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1529 return( 1 );
Neil Armstrong8ecd6682022-05-05 11:40:35 +02001530#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001531 if( conf->psk != NULL )
1532 return( 1 );
1533
1534 return( 0 );
1535}
1536
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001537static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1538{
1539 /* Remove reference to existing PSK, if any. */
1540#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001541 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001542 {
Neil Armstrong8ecd6682022-05-05 11:40:35 +02001543 /* The maintenance of the PSK key slot is the
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001544 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001545 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001546 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02001547#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001548 if( conf->psk != NULL )
1549 {
1550 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1551
1552 mbedtls_free( conf->psk );
1553 conf->psk = NULL;
1554 conf->psk_len = 0;
1555 }
1556
1557 /* Remove reference to PSK identity, if any. */
1558 if( conf->psk_identity != NULL )
1559 {
1560 mbedtls_free( conf->psk_identity );
1561 conf->psk_identity = NULL;
1562 conf->psk_identity_len = 0;
1563 }
1564}
1565
Hanno Becker7390c712018-11-15 13:33:04 +00001566/* This function assumes that PSK identity in the SSL config is unset.
1567 * It checks that the provided identity is well-formed and attempts
1568 * to make a copy of it in the SSL config.
1569 * On failure, the PSK identity in the config remains unset. */
1570static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1571 unsigned char const *psk_identity,
1572 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001573{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001574 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001575 if( psk_identity == NULL ||
1576 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001577 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001578 {
1579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1580 }
1581
Hanno Becker7390c712018-11-15 13:33:04 +00001582 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1583 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001584 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001585
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001586 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001587 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001588
1589 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001590}
1591
Hanno Becker7390c712018-11-15 13:33:04 +00001592int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1593 const unsigned char *psk, size_t psk_len,
1594 const unsigned char *psk_identity, size_t psk_identity_len )
1595{
Janos Follath865b3eb2019-12-16 11:46:15 +00001596 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001597
1598 /* We currently only support one PSK, raw or opaque. */
1599 if( ssl_conf_psk_is_configured( conf ) )
1600 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001601
1602 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001603 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001604 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001605 if( psk_len == 0 )
1606 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1607 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1608 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1609
Hanno Becker7390c712018-11-15 13:33:04 +00001610 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1611 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1612 conf->psk_len = psk_len;
1613 memcpy( conf->psk, psk, conf->psk_len );
1614
1615 /* Check and set PSK Identity */
1616 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1617 if( ret != 0 )
1618 ssl_conf_remove_psk( conf );
1619
1620 return( ret );
1621}
1622
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001623static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1624{
1625#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001626 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001627 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001628 /* The maintenance of the external PSK key slot is the
1629 * user's responsibility. */
1630 if( ssl->handshake->psk_opaque_is_internal )
1631 {
1632 psa_destroy_key( ssl->handshake->psk_opaque );
1633 ssl->handshake->psk_opaque_is_internal = 0;
1634 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001635 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001636 }
Neil Armstronge952a302022-05-03 10:22:14 +02001637#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001638 if( ssl->handshake->psk != NULL )
1639 {
1640 mbedtls_platform_zeroize( ssl->handshake->psk,
1641 ssl->handshake->psk_len );
1642 mbedtls_free( ssl->handshake->psk );
1643 ssl->handshake->psk_len = 0;
1644 }
Neil Armstronge952a302022-05-03 10:22:14 +02001645#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001646}
1647
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001648int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1649 const unsigned char *psk, size_t psk_len )
1650{
Neil Armstrong501c9322022-05-03 09:35:09 +02001651#if defined(MBEDTLS_USE_PSA_CRYPTO)
1652 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1653 psa_status_t status;
1654 psa_algorithm_t alg;
1655 mbedtls_svc_key_id_t key;
1656#endif /* MBEDTLS_USE_PSA_CRYPTO */
1657
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001658 if( psk == NULL || ssl->handshake == NULL )
1659 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1660
1661 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1662 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1663
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001664 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001665
Neil Armstrong501c9322022-05-03 09:35:09 +02001666#if defined(MBEDTLS_USE_PSA_CRYPTO)
1667 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1668 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1669 else
1670 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1671
1672 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1673 psa_set_key_algorithm( &key_attributes, alg );
1674 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1675
1676 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1677 if( status != PSA_SUCCESS )
1678 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1679
1680 /* Allow calling psa_destroy_key() on psk remove */
1681 ssl->handshake->psk_opaque_is_internal = 1;
1682 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1683#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001684 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001685 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001686
1687 ssl->handshake->psk_len = psk_len;
1688 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1689
1690 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001691#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001692}
1693
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001694#if defined(MBEDTLS_USE_PSA_CRYPTO)
1695int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001696 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001697 const unsigned char *psk_identity,
1698 size_t psk_identity_len )
1699{
Janos Follath865b3eb2019-12-16 11:46:15 +00001700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001701
1702 /* We currently only support one PSK, raw or opaque. */
1703 if( ssl_conf_psk_is_configured( conf ) )
1704 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001705
Hanno Becker7390c712018-11-15 13:33:04 +00001706 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001707 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001709 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001710
1711 /* Check and set PSK Identity */
1712 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1713 psk_identity_len );
1714 if( ret != 0 )
1715 ssl_conf_remove_psk( conf );
1716
1717 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001718}
1719
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001720int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1721 mbedtls_svc_key_id_t psk )
1722{
1723 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1724 ( ssl->handshake == NULL ) )
1725 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1726
1727 ssl_remove_psk( ssl );
1728 ssl->handshake->psk_opaque = psk;
1729 return( 0 );
1730}
1731#endif /* MBEDTLS_USE_PSA_CRYPTO */
1732
1733void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1734 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1735 size_t),
1736 void *p_psk )
1737{
1738 conf->f_psk = f_psk;
1739 conf->p_psk = p_psk;
1740}
1741#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1742
1743#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001744static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1745 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001746{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001747#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001748 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001749 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001750#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001751 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001752 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001753 return( MBEDTLS_SSL_MODE_STREAM );
1754}
1755
1756#else /* MBEDTLS_USE_PSA_CRYPTO */
1757
1758static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1759 mbedtls_cipher_mode_t mode )
1760{
1761#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1762 if( mode == MBEDTLS_MODE_CBC )
1763 return( MBEDTLS_SSL_MODE_CBC );
1764#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1765
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001766#if defined(MBEDTLS_GCM_C) || \
1767 defined(MBEDTLS_CCM_C) || \
1768 defined(MBEDTLS_CHACHAPOLY_C)
1769 if( mode == MBEDTLS_MODE_GCM ||
1770 mode == MBEDTLS_MODE_CCM ||
1771 mode == MBEDTLS_MODE_CHACHAPOLY )
1772 return( MBEDTLS_SSL_MODE_AEAD );
1773#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001774
1775 return( MBEDTLS_SSL_MODE_STREAM );
1776}
Gilles Peskine301711e2022-04-26 16:57:05 +02001777#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001778
Gilles Peskinee108d982022-04-26 16:50:40 +02001779static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1780 mbedtls_ssl_mode_t base_mode,
1781 int encrypt_then_mac )
1782{
1783#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1784 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1785 base_mode == MBEDTLS_SSL_MODE_CBC )
1786 {
1787 return( MBEDTLS_SSL_MODE_CBC_ETM );
1788 }
1789#else
1790 (void) encrypt_then_mac;
1791#endif
1792 return( base_mode );
1793}
1794
Neil Armstrongab555e02022-04-04 11:07:59 +02001795mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001796 const mbedtls_ssl_transform *transform )
1797{
Gilles Peskinee108d982022-04-26 16:50:40 +02001798 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001799#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001800 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001801#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001802 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1803#endif
1804 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001805
Gilles Peskinee108d982022-04-26 16:50:40 +02001806 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001807#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001808 encrypt_then_mac = transform->encrypt_then_mac;
1809#endif
1810 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001811}
1812
Neil Armstrongab555e02022-04-04 11:07:59 +02001813mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001814#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001815 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001816#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001817 const mbedtls_ssl_ciphersuite_t *suite )
1818{
Gilles Peskinee108d982022-04-26 16:50:40 +02001819 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1820
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001821#if defined(MBEDTLS_USE_PSA_CRYPTO)
1822 psa_status_t status;
1823 psa_algorithm_t alg;
1824 psa_key_type_t type;
1825 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001826 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1827 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001828 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001829#else
1830 const mbedtls_cipher_info_t *cipher =
1831 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001832 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001833 {
1834 base_mode =
1835 mbedtls_ssl_get_base_mode(
1836 mbedtls_cipher_info_get_mode( cipher ) );
1837 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001838#endif /* MBEDTLS_USE_PSA_CRYPTO */
1839
Gilles Peskinee108d982022-04-26 16:50:40 +02001840#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1841 int encrypt_then_mac = 0;
1842#endif
1843 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001844}
1845
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001846#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001847psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001848 size_t taglen,
1849 psa_algorithm_t *alg,
1850 psa_key_type_t *key_type,
1851 size_t *key_size )
1852{
1853 switch ( mbedtls_cipher_type )
1854 {
1855 case MBEDTLS_CIPHER_AES_128_CBC:
1856 *alg = PSA_ALG_CBC_NO_PADDING;
1857 *key_type = PSA_KEY_TYPE_AES;
1858 *key_size = 128;
1859 break;
1860 case MBEDTLS_CIPHER_AES_128_CCM:
1861 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1862 *key_type = PSA_KEY_TYPE_AES;
1863 *key_size = 128;
1864 break;
1865 case MBEDTLS_CIPHER_AES_128_GCM:
1866 *alg = PSA_ALG_GCM;
1867 *key_type = PSA_KEY_TYPE_AES;
1868 *key_size = 128;
1869 break;
1870 case MBEDTLS_CIPHER_AES_192_CCM:
1871 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1872 *key_type = PSA_KEY_TYPE_AES;
1873 *key_size = 192;
1874 break;
1875 case MBEDTLS_CIPHER_AES_192_GCM:
1876 *alg = PSA_ALG_GCM;
1877 *key_type = PSA_KEY_TYPE_AES;
1878 *key_size = 192;
1879 break;
1880 case MBEDTLS_CIPHER_AES_256_CBC:
1881 *alg = PSA_ALG_CBC_NO_PADDING;
1882 *key_type = PSA_KEY_TYPE_AES;
1883 *key_size = 256;
1884 break;
1885 case MBEDTLS_CIPHER_AES_256_CCM:
1886 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1887 *key_type = PSA_KEY_TYPE_AES;
1888 *key_size = 256;
1889 break;
1890 case MBEDTLS_CIPHER_AES_256_GCM:
1891 *alg = PSA_ALG_GCM;
1892 *key_type = PSA_KEY_TYPE_AES;
1893 *key_size = 256;
1894 break;
1895 case MBEDTLS_CIPHER_ARIA_128_CBC:
1896 *alg = PSA_ALG_CBC_NO_PADDING;
1897 *key_type = PSA_KEY_TYPE_ARIA;
1898 *key_size = 128;
1899 break;
1900 case MBEDTLS_CIPHER_ARIA_128_CCM:
1901 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1902 *key_type = PSA_KEY_TYPE_ARIA;
1903 *key_size = 128;
1904 break;
1905 case MBEDTLS_CIPHER_ARIA_128_GCM:
1906 *alg = PSA_ALG_GCM;
1907 *key_type = PSA_KEY_TYPE_ARIA;
1908 *key_size = 128;
1909 break;
1910 case MBEDTLS_CIPHER_ARIA_192_CCM:
1911 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1912 *key_type = PSA_KEY_TYPE_ARIA;
1913 *key_size = 192;
1914 break;
1915 case MBEDTLS_CIPHER_ARIA_192_GCM:
1916 *alg = PSA_ALG_GCM;
1917 *key_type = PSA_KEY_TYPE_ARIA;
1918 *key_size = 192;
1919 break;
1920 case MBEDTLS_CIPHER_ARIA_256_CBC:
1921 *alg = PSA_ALG_CBC_NO_PADDING;
1922 *key_type = PSA_KEY_TYPE_ARIA;
1923 *key_size = 256;
1924 break;
1925 case MBEDTLS_CIPHER_ARIA_256_CCM:
1926 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1927 *key_type = PSA_KEY_TYPE_ARIA;
1928 *key_size = 256;
1929 break;
1930 case MBEDTLS_CIPHER_ARIA_256_GCM:
1931 *alg = PSA_ALG_GCM;
1932 *key_type = PSA_KEY_TYPE_ARIA;
1933 *key_size = 256;
1934 break;
1935 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1936 *alg = PSA_ALG_CBC_NO_PADDING;
1937 *key_type = PSA_KEY_TYPE_CAMELLIA;
1938 *key_size = 128;
1939 break;
1940 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1941 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1942 *key_type = PSA_KEY_TYPE_CAMELLIA;
1943 *key_size = 128;
1944 break;
1945 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1946 *alg = PSA_ALG_GCM;
1947 *key_type = PSA_KEY_TYPE_CAMELLIA;
1948 *key_size = 128;
1949 break;
1950 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1951 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1952 *key_type = PSA_KEY_TYPE_CAMELLIA;
1953 *key_size = 192;
1954 break;
1955 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1956 *alg = PSA_ALG_GCM;
1957 *key_type = PSA_KEY_TYPE_CAMELLIA;
1958 *key_size = 192;
1959 break;
1960 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1961 *alg = PSA_ALG_CBC_NO_PADDING;
1962 *key_type = PSA_KEY_TYPE_CAMELLIA;
1963 *key_size = 256;
1964 break;
1965 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1966 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1967 *key_type = PSA_KEY_TYPE_CAMELLIA;
1968 *key_size = 256;
1969 break;
1970 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1971 *alg = PSA_ALG_GCM;
1972 *key_type = PSA_KEY_TYPE_CAMELLIA;
1973 *key_size = 256;
1974 break;
1975 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1976 *alg = PSA_ALG_CHACHA20_POLY1305;
1977 *key_type = PSA_KEY_TYPE_CHACHA20;
1978 *key_size = 256;
1979 break;
1980 case MBEDTLS_CIPHER_NULL:
1981 *alg = MBEDTLS_SSL_NULL_CIPHER;
1982 *key_type = 0;
1983 *key_size = 0;
1984 break;
1985 default:
1986 return PSA_ERROR_NOT_SUPPORTED;
1987 }
1988
1989 return PSA_SUCCESS;
1990}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001991#endif /* MBEDTLS_USE_PSA_CRYPTO */
1992
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001993#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001994int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1995 const unsigned char *dhm_P, size_t P_len,
1996 const unsigned char *dhm_G, size_t G_len )
1997{
Janos Follath865b3eb2019-12-16 11:46:15 +00001998 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001999
Glenn Strausscee11292021-12-20 01:43:17 -05002000 mbedtls_mpi_free( &conf->dhm_P );
2001 mbedtls_mpi_free( &conf->dhm_G );
2002
Hanno Beckera90658f2017-10-04 15:29:08 +01002003 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2004 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2005 {
2006 mbedtls_mpi_free( &conf->dhm_P );
2007 mbedtls_mpi_free( &conf->dhm_G );
2008 return( ret );
2009 }
2010
2011 return( 0 );
2012}
Paul Bakker5121ce52009-01-03 21:22:43 +00002013
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002014int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002015{
Janos Follath865b3eb2019-12-16 11:46:15 +00002016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002017
Glenn Strausscee11292021-12-20 01:43:17 -05002018 mbedtls_mpi_free( &conf->dhm_P );
2019 mbedtls_mpi_free( &conf->dhm_G );
2020
Gilles Peskinee5702482021-06-11 21:59:08 +02002021 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2022 &conf->dhm_P ) ) != 0 ||
2023 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2024 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002025 {
2026 mbedtls_mpi_free( &conf->dhm_P );
2027 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002028 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002029 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002030
2031 return( 0 );
2032}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002033#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002034
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002035#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2036/*
2037 * Set the minimum length for Diffie-Hellman parameters
2038 */
2039void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2040 unsigned int bitlen )
2041{
2042 conf->dhm_min_bitlen = bitlen;
2043}
2044#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2045
Gilles Peskineeccd8882020-03-10 12:19:08 +01002046#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002047#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002048/*
2049 * Set allowed/preferred hashes for handshake signatures
2050 */
2051void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2052 const int *hashes )
2053{
2054 conf->sig_hashes = hashes;
2055}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002056#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002057
Jerry Yuf017ee42022-01-12 15:49:48 +08002058/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002059void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2060 const uint16_t* sig_algs )
2061{
Jerry Yuf017ee42022-01-12 15:49:48 +08002062#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2063 conf->sig_hashes = NULL;
2064#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2065 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002066}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002067#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002068
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002069#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002070#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002071/*
2072 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002073 *
2074 * mbedtls_ssl_setup() takes the provided list
2075 * and translates it to a list of IANA TLS group identifiers,
2076 * stored in ssl->handshake->group_list.
2077 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002078 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002079void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002080 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002081{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002082 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002083 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002084}
Brett Warrene0edc842021-08-17 09:53:13 +01002085#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002086#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002087
Brett Warrene0edc842021-08-17 09:53:13 +01002088/*
2089 * Set the allowed groups
2090 */
2091void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2092 const uint16_t *group_list )
2093{
2094#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2095 conf->curve_list = NULL;
2096#endif
2097 conf->group_list = group_list;
2098}
2099
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002100#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002102{
Hanno Becker947194e2017-04-07 13:25:49 +01002103 /* Initialize to suppress unnecessary compiler warning */
2104 size_t hostname_len = 0;
2105
2106 /* Check if new hostname is valid before
2107 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002108 if( hostname != NULL )
2109 {
2110 hostname_len = strlen( hostname );
2111
2112 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2113 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2114 }
2115
2116 /* Now it's clear that we will overwrite the old hostname,
2117 * so we can free it safely */
2118
2119 if( ssl->hostname != NULL )
2120 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002121 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002122 mbedtls_free( ssl->hostname );
2123 }
2124
2125 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002126
Paul Bakker5121ce52009-01-03 21:22:43 +00002127 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002128 {
2129 ssl->hostname = NULL;
2130 }
2131 else
2132 {
2133 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002134 if( ssl->hostname == NULL )
2135 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002136
Hanno Becker947194e2017-04-07 13:25:49 +01002137 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002138
Hanno Becker947194e2017-04-07 13:25:49 +01002139 ssl->hostname[hostname_len] = '\0';
2140 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002141
2142 return( 0 );
2143}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002144#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002145
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002146#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002147void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002149 const unsigned char *, size_t),
2150 void *p_sni )
2151{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002152 conf->f_sni = f_sni;
2153 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002154}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002158int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002159{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002160 size_t cur_len, tot_len;
2161 const char **p;
2162
2163 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002164 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2165 * MUST NOT be truncated."
2166 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002167 */
2168 tot_len = 0;
2169 for( p = protos; *p != NULL; p++ )
2170 {
2171 cur_len = strlen( *p );
2172 tot_len += cur_len;
2173
Ronald Cron8216dd32020-04-23 16:41:44 +02002174 if( ( cur_len == 0 ) ||
2175 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2176 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002178 }
2179
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002180 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002181
2182 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002183}
2184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002186{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002187 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002188}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002190
Johan Pascalb62bb512015-12-03 21:56:45 +01002191#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002192void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2193 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002194{
2195 conf->dtls_srtp_mki_support = support_mki_value;
2196}
2197
Ron Eldoref72faf2018-07-12 11:54:20 +03002198int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2199 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002200 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002201{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002202 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002203 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002204 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002205 }
Ron Eldor591f1622018-01-22 12:30:04 +02002206
2207 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002208 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002209 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002210 }
Ron Eldor591f1622018-01-22 12:30:04 +02002211
2212 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2213 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002214 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002215}
2216
Ron Eldoref72faf2018-07-12 11:54:20 +03002217int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002218 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002219{
Johan Pascal253d0262020-09-22 13:04:45 +02002220 const mbedtls_ssl_srtp_profile *p;
2221 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002222
Johan Pascal253d0262020-09-22 13:04:45 +02002223 /* check the profiles list: all entry must be valid,
2224 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002225 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2226 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2227 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002228 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002229 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002230 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002231 list_size++;
2232 }
2233 else
2234 {
2235 /* unsupported value, stop parsing and set the size to an error value */
2236 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002237 }
2238 }
2239
Johan Pascal5ef72d22020-10-28 17:05:47 +01002240 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002241 {
Johan Pascal253d0262020-09-22 13:04:45 +02002242 conf->dtls_srtp_profile_list = NULL;
2243 conf->dtls_srtp_profile_list_len = 0;
2244 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2245 }
2246
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002247 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002248 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002249
2250 return( 0 );
2251}
2252
Johan Pascal5ef72d22020-10-28 17:05:47 +01002253void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2254 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002255{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002256 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2257 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002258 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002259 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002260 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002261 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002262 else
2263 {
2264 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002265 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2266 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002267 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002268}
Johan Pascalb62bb512015-12-03 21:56:45 +01002269#endif /* MBEDTLS_SSL_DTLS_SRTP */
2270
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002271void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002272{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002273 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002274}
2275
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002276void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002277{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002278 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002279}
2280
Janos Follath088ce432017-04-10 12:42:31 +01002281#if defined(MBEDTLS_SSL_SRV_C)
2282void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2283 char cert_req_ca_list )
2284{
2285 conf->cert_req_ca_list = cert_req_ca_list;
2286}
2287#endif
2288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002290void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002291{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002292 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002293}
2294#endif
2295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002296#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002297void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002298{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002299 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002300}
2301#endif
2302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002304int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002305{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002307 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002308 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002310 }
2311
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002312 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002313
2314 return( 0 );
2315}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002317
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002318void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002319{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002320 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002321}
2322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002324void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002325{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002326 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002327}
2328
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002329void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002330{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002331 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002332}
2333
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002334void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002335 const unsigned char period[8] )
2336{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002337 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002338}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002342#if defined(MBEDTLS_SSL_CLI_C)
2343void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002344{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002345 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002346}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002347#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002348
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002349#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002350void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2351 mbedtls_ssl_ticket_write_t *f_ticket_write,
2352 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2353 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002354{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002355 conf->f_ticket_write = f_ticket_write;
2356 conf->f_ticket_parse = f_ticket_parse;
2357 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002358}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002359#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002361
Hanno Becker7e6c1782021-06-08 09:24:55 +01002362void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2363 mbedtls_ssl_export_keys_t *f_export_keys,
2364 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002365{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002366 ssl->f_export_keys = f_export_keys;
2367 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002368}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002369
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002370#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002371void mbedtls_ssl_conf_async_private_cb(
2372 mbedtls_ssl_config *conf,
2373 mbedtls_ssl_async_sign_t *f_async_sign,
2374 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2375 mbedtls_ssl_async_resume_t *f_async_resume,
2376 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002377 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002378{
2379 conf->f_async_sign_start = f_async_sign;
2380 conf->f_async_decrypt_start = f_async_decrypt;
2381 conf->f_async_resume = f_async_resume;
2382 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002383 conf->p_async_config_data = async_config_data;
2384}
2385
Gilles Peskine8f97af72018-04-26 11:46:10 +02002386void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2387{
2388 return( conf->p_async_config_data );
2389}
2390
Gilles Peskine1febfef2018-04-30 11:54:39 +02002391void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002392{
2393 if( ssl->handshake == NULL )
2394 return( NULL );
2395 else
2396 return( ssl->handshake->user_async_ctx );
2397}
2398
Gilles Peskine1febfef2018-04-30 11:54:39 +02002399void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002400 void *ctx )
2401{
2402 if( ssl->handshake != NULL )
2403 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002404}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002405#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002406
Paul Bakker5121ce52009-01-03 21:22:43 +00002407/*
2408 * SSL get accessors
2409 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002410uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002411{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002412 if( ssl->session != NULL )
2413 return( ssl->session->verify_result );
2414
2415 if( ssl->session_negotiate != NULL )
2416 return( ssl->session_negotiate->verify_result );
2417
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002418 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002419}
2420
Glenn Strauss8f526902022-01-13 00:04:49 -05002421int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2422{
2423 if( ssl == NULL || ssl->session == NULL )
2424 return( 0 );
2425
2426 return( ssl->session->ciphersuite );
2427}
2428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002430{
Paul Bakker926c8e42013-03-06 10:23:34 +01002431 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002432 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002435}
2436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002438{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002440 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002441 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002442 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002443 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002444 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002445 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002446 default:
2447 return( "unknown (DTLS)" );
2448 }
2449 }
2450#endif
2451
Glenn Strauss60bfe602022-03-14 19:04:24 -04002452 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002453 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002454 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002455 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002456 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002457 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002458 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002459 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002460 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002461}
2462
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002463#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002464size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2465{
David Horstmann95d516f2021-05-04 18:36:56 +01002466 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002467 size_t read_mfl;
2468
2469 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2470 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2471 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2472 {
2473 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2474 }
2475
2476 /* Check if a smaller max length was negotiated */
2477 if( ssl->session_out != NULL )
2478 {
2479 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2480 if( read_mfl < max_len )
2481 {
2482 max_len = read_mfl;
2483 }
2484 }
2485
2486 // During a handshake, use the value being negotiated
2487 if( ssl->session_negotiate != NULL )
2488 {
2489 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2490 if( read_mfl < max_len )
2491 {
2492 max_len = read_mfl;
2493 }
2494 }
2495
2496 return( max_len );
2497}
2498
2499size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002500{
2501 size_t max_len;
2502
2503 /*
2504 * Assume mfl_code is correct since it was checked when set
2505 */
Angus Grattond8213d02016-05-25 20:56:48 +10002506 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002507
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002508 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002509 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002510 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002511 {
Angus Grattond8213d02016-05-25 20:56:48 +10002512 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002513 }
2514
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002515 /* During a handshake, use the value being negotiated */
2516 if( ssl->session_negotiate != NULL &&
2517 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2518 {
2519 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2520 }
2521
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002522 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002523}
2524#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2525
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002526#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002527size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002528{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002529 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2530 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2531 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2532 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2533 return ( 0 );
2534
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002535 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2536 return( ssl->mtu );
2537
2538 if( ssl->mtu == 0 )
2539 return( ssl->handshake->mtu );
2540
2541 return( ssl->mtu < ssl->handshake->mtu ?
2542 ssl->mtu : ssl->handshake->mtu );
2543}
2544#endif /* MBEDTLS_SSL_PROTO_DTLS */
2545
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002546int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2547{
2548 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2549
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002550#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2551 !defined(MBEDTLS_SSL_PROTO_DTLS)
2552 (void) ssl;
2553#endif
2554
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002555#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002556 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002557
2558 if( max_len > mfl )
2559 max_len = mfl;
2560#endif
2561
2562#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002563 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002564 {
Hanno Becker89490712020-02-05 10:50:12 +00002565 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002566 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2567 const size_t overhead = (size_t) ret;
2568
2569 if( ret < 0 )
2570 return( ret );
2571
2572 if( mtu <= overhead )
2573 {
2574 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2575 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2576 }
2577
2578 if( max_len > mtu - overhead )
2579 max_len = mtu - overhead;
2580 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002581#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002582
Hanno Becker0defedb2018-08-10 12:35:02 +01002583#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2584 !defined(MBEDTLS_SSL_PROTO_DTLS)
2585 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002586#endif
2587
2588 return( (int) max_len );
2589}
2590
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002591int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2592{
2593 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2594
2595#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2596 (void) ssl;
2597#endif
2598
2599#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2600 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2601
2602 if( max_len > mfl )
2603 max_len = mfl;
2604#endif
2605
2606 return( (int) max_len );
2607}
2608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#if defined(MBEDTLS_X509_CRT_PARSE_C)
2610const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002611{
2612 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002613 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002614
Hanno Beckere6824572019-02-07 13:18:46 +00002615#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002616 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002617#else
2618 return( NULL );
2619#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002620}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002624int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2625 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002626{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002627 int ret;
2628
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002629 if( ssl == NULL ||
2630 dst == NULL ||
2631 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002632 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002633 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002635 }
2636
Hanno Beckere810bbc2021-05-14 16:01:05 +01002637 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2638 * idempotent: Each session can only be exported once.
2639 *
2640 * (This is in preparation for TLS 1.3 support where we will
2641 * need the ability to export multiple sessions (aka tickets),
2642 * which will be achieved by calling mbedtls_ssl_get_session()
2643 * multiple times until it fails.)
2644 *
2645 * Check whether we have already exported the current session,
2646 * and fail if so.
2647 */
2648 if( ssl->session->exported == 1 )
2649 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2650
2651 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2652 if( ret != 0 )
2653 return( ret );
2654
2655 /* Remember that we've exported the session. */
2656 ssl->session->exported = 1;
2657 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002658}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002660
Paul Bakker5121ce52009-01-03 21:22:43 +00002661/*
Hanno Beckera835da52019-05-16 12:39:07 +01002662 * Define ticket header determining Mbed TLS version
2663 * and structure of the ticket.
2664 */
2665
Hanno Becker94ef3b32019-05-16 12:50:45 +01002666/*
Hanno Becker50b59662019-05-28 14:30:45 +01002667 * Define bitflag determining compile-time settings influencing
2668 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002669 */
2670
Hanno Becker50b59662019-05-28 14:30:45 +01002671#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002672#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002673#else
Hanno Becker3e088662019-05-29 11:10:18 +01002674#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002675#endif /* MBEDTLS_HAVE_TIME */
2676
2677#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002678#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002679#else
Hanno Becker3e088662019-05-29 11:10:18 +01002680#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002681#endif /* MBEDTLS_X509_CRT_PARSE_C */
2682
2683#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002684#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002685#else
Hanno Becker3e088662019-05-29 11:10:18 +01002686#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002687#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2688
2689#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002690#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002691#else
Hanno Becker3e088662019-05-29 11:10:18 +01002692#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002693#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2694
Hanno Becker94ef3b32019-05-16 12:50:45 +01002695#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002696#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002697#else
Hanno Becker3e088662019-05-29 11:10:18 +01002698#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002699#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2700
Hanno Becker94ef3b32019-05-16 12:50:45 +01002701#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2702#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2703#else
2704#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2705#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2706
Hanno Becker3e088662019-05-29 11:10:18 +01002707#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2708#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2709#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2710#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002711#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2712#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002713
Hanno Becker50b59662019-05-28 14:30:45 +01002714#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002715 ( (uint16_t) ( \
2716 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2717 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2718 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2719 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002720 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002721 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002722
Hanno Beckerf8787072019-05-16 12:41:07 +01002723static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002724 MBEDTLS_VERSION_MAJOR,
2725 MBEDTLS_VERSION_MINOR,
2726 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002727 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2728 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002729};
Hanno Beckera835da52019-05-16 12:39:07 +01002730
2731/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002732 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002733 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002734 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002735 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002736 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002737 * opaque mbedtls_version[3]; // library version: major, minor, patch
2738 * opaque session_format[2]; // library-version specific 16-bit field
2739 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002740 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002741 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002742 * Note: When updating the format, remember to keep
2743 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002744 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002745 * // In this version, `session_format` determines
2746 * // the setting of those compile-time
2747 * // configuration options which influence
2748 * // the structure of mbedtls_ssl_session.
2749 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002750 * uint8_t minor_ver; // Protocol minor version. Possible values:
2751 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002752 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002753 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002754 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002755 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002756 * serialized_session_tls12 data;
2757 *
2758 * };
2759 *
2760 * } serialized_session;
2761 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002762 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002763
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002764static int ssl_session_save( const mbedtls_ssl_session *session,
2765 unsigned char omit_header,
2766 unsigned char *buf,
2767 size_t buf_len,
2768 size_t *olen )
2769{
2770 unsigned char *p = buf;
2771 size_t used = 0;
2772
2773 if( !omit_header )
2774 {
2775 /*
2776 * Add Mbed TLS version identifier
2777 */
2778
2779 used += sizeof( ssl_serialized_session_header );
2780
2781 if( used <= buf_len )
2782 {
2783 memcpy( p, ssl_serialized_session_header,
2784 sizeof( ssl_serialized_session_header ) );
2785 p += sizeof( ssl_serialized_session_header );
2786 }
2787 }
2788
2789 /*
2790 * TLS version identifier
2791 */
2792 used += 1;
2793 if( used <= buf_len )
2794 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002795 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002796 }
2797
2798 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002799 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002800 {
2801#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002802 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002803 {
2804 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2805 used += ssl_session_save_tls12( session, p, remaining_len );
2806 break;
2807 }
2808#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2809
2810 default:
2811 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2812 }
2813
2814 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002815 if( used > buf_len )
2816 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002817
2818 return( 0 );
2819}
2820
2821/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002822 * Public wrapper for ssl_session_save()
2823 */
2824int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2825 unsigned char *buf,
2826 size_t buf_len,
2827 size_t *olen )
2828{
2829 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2830}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002831
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002832/*
2833 * Deserialize session, see mbedtls_ssl_session_save() for format.
2834 *
2835 * This internal version is wrapped by a public function that cleans up in
2836 * case of error, and has an extra option omit_header.
2837 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002838static int ssl_session_load( mbedtls_ssl_session *session,
2839 unsigned char omit_header,
2840 const unsigned char *buf,
2841 size_t len )
2842{
2843 const unsigned char *p = buf;
2844 const unsigned char * const end = buf + len;
2845
2846 if( !omit_header )
2847 {
2848 /*
2849 * Check Mbed TLS version identifier
2850 */
2851
2852 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2853 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2854
2855 if( memcmp( p, ssl_serialized_session_header,
2856 sizeof( ssl_serialized_session_header ) ) != 0 )
2857 {
2858 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2859 }
2860 p += sizeof( ssl_serialized_session_header );
2861 }
2862
2863 /*
2864 * TLS version identifier
2865 */
2866 if( 1 > (size_t)( end - p ) )
2867 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002868 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002869
2870 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002871 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002872 {
2873#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002874 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002875 {
2876 size_t remaining_len = ( end - p );
2877 return( ssl_session_load_tls12( session, p, remaining_len ) );
2878 }
2879#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2880
2881 default:
2882 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2883 }
2884}
2885
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002886/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002887 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002888 */
2889int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2890 const unsigned char *buf,
2891 size_t len )
2892{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002893 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002894
2895 if( ret != 0 )
2896 mbedtls_ssl_session_free( session );
2897
2898 return( ret );
2899}
2900
2901/*
Paul Bakker1961b702013-01-25 14:49:24 +01002902 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002903 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002904static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2905{
2906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2907
Ronald Cron66dbf912022-02-02 15:33:46 +01002908 /*
2909 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002910 * that were written into the output buffer by the previous handshake step,
2911 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002912 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2913 * We proceed to the next handshake step only when all data from the
2914 * previous one have been sent to the peer, thus we make sure that this is
2915 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2916 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2917 * we have to wait before to go ahead.
2918 * In the case of TLS 1.3, handshake step handlers do not send data to the
2919 * peer. Data are only sent here and through
2920 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2921 * alert occured.
2922 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002923 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2924 return( ret );
2925
2926#if defined(MBEDTLS_SSL_PROTO_DTLS)
2927 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2928 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2929 {
2930 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2931 return( ret );
2932 }
2933#endif /* MBEDTLS_SSL_PROTO_DTLS */
2934
2935 return( ret );
2936}
2937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002939{
Hanno Becker41934dd2021-08-07 19:13:43 +01002940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002941
Hanno Becker41934dd2021-08-07 19:13:43 +01002942 if( ssl == NULL ||
2943 ssl->conf == NULL ||
2944 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002945 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002946 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002947 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002948 }
2949
2950 ret = ssl_prepare_handshake_step( ssl );
2951 if( ret != 0 )
2952 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002953
Jerry Yue7047812021-09-13 19:26:39 +08002954 ret = mbedtls_ssl_handle_pending_alert( ssl );
2955 if( ret != 0 )
2956 goto cleanup;
2957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002959 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002960 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2962 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002963
Ronald Cron9f0fba32022-02-10 16:45:15 +01002964 switch( ssl->state )
2965 {
2966 case MBEDTLS_SSL_HELLO_REQUEST:
2967 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2968 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002969
Ronald Cron9f0fba32022-02-10 16:45:15 +01002970 case MBEDTLS_SSL_CLIENT_HELLO:
2971 ret = mbedtls_ssl_write_client_hello( ssl );
2972 break;
2973
2974 default:
2975#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002976 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002977 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2978 else
2979 ret = mbedtls_ssl_handshake_client_step( ssl );
2980#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2981 ret = mbedtls_ssl_handshake_client_step( ssl );
2982#else
2983 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2984#endif
2985 }
Jerry Yub9930e72021-08-06 17:11:51 +08002986 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002987#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002989 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002990 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002991#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002992 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002993 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002994#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002995
2996#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2997 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2998 ret = mbedtls_ssl_handshake_server_step( ssl );
2999#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3000 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003001#endif
3002
Jerry Yue7047812021-09-13 19:26:39 +08003003 if( ret != 0 )
3004 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003005 /* handshake_step return error. And it is same
3006 * with alert_reason.
3007 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003008 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003009 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003010 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003011 goto cleanup;
3012 }
3013 }
3014
3015cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003016 return( ret );
3017}
3018
3019/*
3020 * Perform the SSL handshake
3021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003023{
3024 int ret = 0;
3025
Hanno Beckera817ea42020-10-20 15:20:23 +01003026 /* Sanity checks */
3027
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003028 if( ssl == NULL || ssl->conf == NULL )
3029 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3030
Hanno Beckera817ea42020-10-20 15:20:23 +01003031#if defined(MBEDTLS_SSL_PROTO_DTLS)
3032 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3033 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3034 {
3035 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3036 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3037 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3038 }
3039#endif /* MBEDTLS_SSL_PROTO_DTLS */
3040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003042
Hanno Beckera817ea42020-10-20 15:20:23 +01003043 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003044 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003045 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003047
3048 if( ret != 0 )
3049 break;
3050 }
3051
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003053
3054 return( ret );
3055}
3056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057#if defined(MBEDTLS_SSL_RENEGOTIATION)
3058#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003059/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003060 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003063{
Janos Follath865b3eb2019-12-16 11:46:15 +00003064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003067
3068 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3070 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003071
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003072 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003073 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003074 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003075 return( ret );
3076 }
3077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003079
3080 return( 0 );
3081}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003083
3084/*
3085 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 * - any side: calling mbedtls_ssl_renegotiate(),
3087 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3088 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003089 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003090 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003092 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003093int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003094{
Janos Follath865b3eb2019-12-16 11:46:15 +00003095 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003098
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003099 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3100 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003101
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003102 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3103 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003107 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003108 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003109 ssl->handshake->out_msg_seq = 1;
3110 else
3111 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003112 }
3113#endif
3114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003115 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3116 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003119 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003121 return( ret );
3122 }
3123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003125
3126 return( 0 );
3127}
3128
3129/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003130 * Renegotiate current connection on client,
3131 * or request renegotiation on server
3132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003134{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003136
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003137 if( ssl == NULL || ssl->conf == NULL )
3138 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003141 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003142 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003143 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003144 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003148
3149 /* Did we already try/start sending HelloRequest? */
3150 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003152
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003153 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003154 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003158 /*
3159 * On client, either start the renegotiation process or,
3160 * if already in progress, continue the handshake
3161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003162 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003163 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003164 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003166
Hanno Becker40cdaa12020-02-05 10:48:27 +00003167 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003168 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003169 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003170 return( ret );
3171 }
3172 }
3173 else
3174 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003176 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003178 return( ret );
3179 }
3180 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003182
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003183 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003184}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003186
Gilles Peskine9b562d52018-04-25 20:32:43 +02003187void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003188{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003189 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3190
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003191 if( handshake == NULL )
3192 return;
3193
Brett Warrene0edc842021-08-17 09:53:13 +01003194#if defined(MBEDTLS_ECP_C)
3195#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3196 if ( ssl->handshake->group_list_heap_allocated )
3197 mbedtls_free( (void*) handshake->group_list );
3198 handshake->group_list = NULL;
3199#endif /* MBEDTLS_DEPRECATED_REMOVED */
3200#endif /* MBEDTLS_ECP_C */
3201
Jerry Yuf017ee42022-01-12 15:49:48 +08003202#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3203#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3204 if ( ssl->handshake->sig_algs_heap_allocated )
3205 mbedtls_free( (void*) handshake->sig_algs );
3206 handshake->sig_algs = NULL;
3207#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003208#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3209 if( ssl->handshake->certificate_request_context )
3210 {
3211 mbedtls_free( (void*) handshake->certificate_request_context );
3212 }
3213#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003214#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3215
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003216#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3217 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3218 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003219 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003220 handshake->async_in_progress = 0;
3221 }
3222#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3223
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003224#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003225#if defined(MBEDTLS_USE_PSA_CRYPTO)
3226 psa_hash_abort( &handshake->fin_sha256_psa );
3227#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003228 mbedtls_sha256_free( &handshake->fin_sha256 );
3229#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003230#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003231#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003232#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003233 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003234#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003235 mbedtls_sha512_free( &handshake->fin_sha512 );
3236#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003237#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239#if defined(MBEDTLS_DHM_C)
3240 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003241#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003242#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003244#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003245#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003246 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003247#if defined(MBEDTLS_SSL_CLI_C)
3248 mbedtls_free( handshake->ecjpake_cache );
3249 handshake->ecjpake_cache = NULL;
3250 handshake->ecjpake_cache_len = 0;
3251#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003252#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003253
Janos Follath4ae5c292016-02-10 11:27:43 +00003254#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3255 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003256 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003258#endif
3259
Gilles Peskineeccd8882020-03-10 12:19:08 +01003260#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003261#if defined(MBEDTLS_USE_PSA_CRYPTO)
3262 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3263 {
3264 /* The maintenance of the external PSK key slot is the
3265 * user's responsibility. */
3266 if( ssl->handshake->psk_opaque_is_internal )
3267 {
3268 psa_destroy_key( ssl->handshake->psk_opaque );
3269 ssl->handshake->psk_opaque_is_internal = 0;
3270 }
3271 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3272 }
Neil Armstronge952a302022-05-03 10:22:14 +02003273#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003274 if( handshake->psk != NULL )
3275 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003276 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003277 mbedtls_free( handshake->psk );
3278 }
Neil Armstronge952a302022-05-03 10:22:14 +02003279#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003280#endif
3281
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3283 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003284 /*
3285 * Free only the linked list wrapper, not the keys themselves
3286 * since the belong to the SNI callback
3287 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003288 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003290
Gilles Peskineeccd8882020-03-10 12:19:08 +01003291#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003292 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003293 if( handshake->ecrs_peer_cert != NULL )
3294 {
3295 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3296 mbedtls_free( handshake->ecrs_peer_cert );
3297 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003298#endif
3299
Hanno Becker75173122019-02-06 16:18:31 +00003300#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3301 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3302 mbedtls_pk_free( &handshake->peer_pubkey );
3303#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3304
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003305#if defined(MBEDTLS_SSL_CLI_C) && \
3306 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3307 mbedtls_free( handshake->cookie );
3308#endif /* MBEDTLS_SSL_CLI_C &&
3309 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003310
3311#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003312 mbedtls_ssl_flight_free( handshake->flight );
3313 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003314#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003315
Ronald Cronf12b81d2022-03-15 10:42:41 +01003316#if defined(MBEDTLS_ECDH_C) && \
3317 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003318 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003319 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003320#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3321
Ronald Cron6f135e12021-12-08 16:57:54 +01003322#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003323 mbedtls_ssl_transform_free( handshake->transform_handshake );
3324 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003325 mbedtls_free( handshake->transform_earlydata );
3326 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003327#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003328
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003329
3330#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3331 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3332 * processes datagrams and the fact that a datagram is allowed to have
3333 * several records in it, it is possible that the I/O buffers are not
3334 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003335 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3336 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003337#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003338
Jerry Yuba9c7272021-10-30 11:54:10 +08003339 /* mbedtls_platform_zeroize MUST be last one in this function */
3340 mbedtls_platform_zeroize( handshake,
3341 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003342}
3343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003345{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003346 if( session == NULL )
3347 return;
3348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003350 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003351#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003352
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003353#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003355#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003356
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003357 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003358}
3359
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003360#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003361
3362#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3363#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3364#else
3365#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3366#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3367
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003368#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003369
3370#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3371#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3372#else
3373#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3374#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3375
3376#if defined(MBEDTLS_SSL_ALPN)
3377#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3378#else
3379#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3380#endif /* MBEDTLS_SSL_ALPN */
3381
3382#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3383#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3384#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3385#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3386
3387#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3388 ( (uint32_t) ( \
3389 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3390 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3391 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3392 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3393 0u ) )
3394
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003395static unsigned char ssl_serialized_context_header[] = {
3396 MBEDTLS_VERSION_MAJOR,
3397 MBEDTLS_VERSION_MINOR,
3398 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003399 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3400 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3401 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3402 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3403 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003404};
3405
Paul Bakker5121ce52009-01-03 21:22:43 +00003406/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003407 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003408 *
3409 * The format of the serialized data is:
3410 * (in the presentation language of TLS, RFC 8446 section 3)
3411 *
3412 * // header
3413 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003414 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003415 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003416 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003417 * Note: When updating the format, remember to keep these
3418 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003419 *
3420 * // session sub-structure
3421 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3422 * // transform sub-structure
3423 * uint8 random[64]; // ServerHello.random+ClientHello.random
3424 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3425 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3426 * // fields from ssl_context
3427 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3428 * uint64 in_window_top; // DTLS: last validated record seq_num
3429 * uint64 in_window; // DTLS: bitmask for replay protection
3430 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3431 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3432 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3433 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3434 *
3435 * Note that many fields of the ssl_context or sub-structures are not
3436 * serialized, as they fall in one of the following categories:
3437 *
3438 * 1. forced value (eg in_left must be 0)
3439 * 2. pointer to dynamically-allocated memory (eg session, transform)
3440 * 3. value can be re-derived from other data (eg session keys from MS)
3441 * 4. value was temporary (eg content of input buffer)
3442 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003443 */
3444int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3445 unsigned char *buf,
3446 size_t buf_len,
3447 size_t *olen )
3448{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003449 unsigned char *p = buf;
3450 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003451 size_t session_len;
3452 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003453
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003454 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003455 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3456 * this function's documentation.
3457 *
3458 * These are due to assumptions/limitations in the implementation. Some of
3459 * them are likely to stay (no handshake in progress) some might go away
3460 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003461 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003462 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003463 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003464 {
3465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003466 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003467 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003468 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003469 {
3470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003471 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003472 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003473 /* Double-check that sub-structures are indeed ready */
3474 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003475 {
3476 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003477 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003478 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003479 /* There must be no pending incoming or outgoing data */
3480 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003481 {
3482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003483 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003484 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003485 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003486 {
3487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003488 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003489 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003490 /* Protocol must be DLTS, not TLS */
3491 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003492 {
3493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003494 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003495 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003496 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003497 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003498 {
3499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003500 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003501 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003502 /* We must be using an AEAD ciphersuite */
3503 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003504 {
3505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003507 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003508 /* Renegotiation must not be enabled */
3509#if defined(MBEDTLS_SSL_RENEGOTIATION)
3510 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003511 {
3512 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003513 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003514 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003515#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003516
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003517 /*
3518 * Version and format identifier
3519 */
3520 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003521
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003522 if( used <= buf_len )
3523 {
3524 memcpy( p, ssl_serialized_context_header,
3525 sizeof( ssl_serialized_context_header ) );
3526 p += sizeof( ssl_serialized_context_header );
3527 }
3528
3529 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003530 * Session (length + data)
3531 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003532 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003533 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3534 return( ret );
3535
3536 used += 4 + session_len;
3537 if( used <= buf_len )
3538 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003539 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3540 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003541
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003542 ret = ssl_session_save( ssl->session, 1,
3543 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003544 if( ret != 0 )
3545 return( ret );
3546
3547 p += session_len;
3548 }
3549
3550 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003551 * Transform
3552 */
3553 used += sizeof( ssl->transform->randbytes );
3554 if( used <= buf_len )
3555 {
3556 memcpy( p, ssl->transform->randbytes,
3557 sizeof( ssl->transform->randbytes ) );
3558 p += sizeof( ssl->transform->randbytes );
3559 }
3560
3561#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3562 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3563 if( used <= buf_len )
3564 {
3565 *p++ = ssl->transform->in_cid_len;
3566 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3567 p += ssl->transform->in_cid_len;
3568
3569 *p++ = ssl->transform->out_cid_len;
3570 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3571 p += ssl->transform->out_cid_len;
3572 }
3573#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3574
3575 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003576 * Saved fields from top-level ssl_context structure
3577 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003578 used += 4;
3579 if( used <= buf_len )
3580 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003581 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3582 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003583 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003584
3585#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3586 used += 16;
3587 if( used <= buf_len )
3588 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003589 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3590 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003591
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003592 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3593 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003594 }
3595#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3596
3597#if defined(MBEDTLS_SSL_PROTO_DTLS)
3598 used += 1;
3599 if( used <= buf_len )
3600 {
3601 *p++ = ssl->disable_datagram_packing;
3602 }
3603#endif /* MBEDTLS_SSL_PROTO_DTLS */
3604
Jerry Yuae0b2e22021-10-08 15:21:19 +08003605 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003606 if( used <= buf_len )
3607 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003608 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3609 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003610 }
3611
3612#if defined(MBEDTLS_SSL_PROTO_DTLS)
3613 used += 2;
3614 if( used <= buf_len )
3615 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003616 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3617 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003618 }
3619#endif /* MBEDTLS_SSL_PROTO_DTLS */
3620
3621#if defined(MBEDTLS_SSL_ALPN)
3622 {
3623 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003624 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003625 : 0;
3626
3627 used += 1 + alpn_len;
3628 if( used <= buf_len )
3629 {
3630 *p++ = alpn_len;
3631
3632 if( ssl->alpn_chosen != NULL )
3633 {
3634 memcpy( p, ssl->alpn_chosen, alpn_len );
3635 p += alpn_len;
3636 }
3637 }
3638 }
3639#endif /* MBEDTLS_SSL_ALPN */
3640
3641 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003642 * Done
3643 */
3644 *olen = used;
3645
3646 if( used > buf_len )
3647 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003648
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003649 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3650
Hanno Becker43aefe22020-02-05 10:44:56 +00003651 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003652}
3653
3654/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003655 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003656 *
3657 * This internal version is wrapped by a public function that cleans up in
3658 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003659 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003660static int ssl_context_load( mbedtls_ssl_context *ssl,
3661 const unsigned char *buf,
3662 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003663{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003664 const unsigned char *p = buf;
3665 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003666 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003668
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003669 /*
3670 * The context should have been freshly setup or reset.
3671 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003672 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003673 * renegotiating, or if the user mistakenly loaded a session first.)
3674 */
3675 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3676 ssl->session != NULL )
3677 {
3678 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3679 }
3680
3681 /*
3682 * We can't check that the config matches the initial one, but we can at
3683 * least check it matches the requirements for serializing.
3684 */
3685 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003686 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3687 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003688#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003689 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003690#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003691 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003692 {
3693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3694 }
3695
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003696 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3697
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003698 /*
3699 * Check version identifier
3700 */
3701 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3703
3704 if( memcmp( p, ssl_serialized_context_header,
3705 sizeof( ssl_serialized_context_header ) ) != 0 )
3706 {
3707 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3708 }
3709 p += sizeof( ssl_serialized_context_header );
3710
3711 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003712 * Session
3713 */
3714 if( (size_t)( end - p ) < 4 )
3715 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3716
3717 session_len = ( (size_t) p[0] << 24 ) |
3718 ( (size_t) p[1] << 16 ) |
3719 ( (size_t) p[2] << 8 ) |
3720 ( (size_t) p[3] );
3721 p += 4;
3722
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003723 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003724 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003725 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003726 ssl->session_in = ssl->session;
3727 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003728 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729
3730 if( (size_t)( end - p ) < session_len )
3731 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3732
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003733 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003734 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003735 {
3736 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003737 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003738 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003739
3740 p += session_len;
3741
3742 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003743 * Transform
3744 */
3745
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003746 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003747 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003748 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003749 ssl->transform_in = ssl->transform;
3750 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003751 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003752
3753 /* Read random bytes and populate structure */
3754 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003756#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003757 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003758 ssl->session->ciphersuite,
3759 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003760#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003761 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003762#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003763 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3764 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003765 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003766 ssl->conf->endpoint,
3767 ssl );
3768 if( ret != 0 )
3769 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003770#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003771 p += sizeof( ssl->transform->randbytes );
3772
3773#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3774 /* Read connection IDs and store them */
3775 if( (size_t)( end - p ) < 1 )
3776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3777
3778 ssl->transform->in_cid_len = *p++;
3779
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003780 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003781 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3782
3783 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3784 p += ssl->transform->in_cid_len;
3785
3786 ssl->transform->out_cid_len = *p++;
3787
3788 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3790
3791 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3792 p += ssl->transform->out_cid_len;
3793#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3794
3795 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003796 * Saved fields from top-level ssl_context structure
3797 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003798 if( (size_t)( end - p ) < 4 )
3799 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3800
3801 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3802 ( (uint32_t) p[1] << 16 ) |
3803 ( (uint32_t) p[2] << 8 ) |
3804 ( (uint32_t) p[3] );
3805 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003806
3807#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3808 if( (size_t)( end - p ) < 16 )
3809 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3810
3811 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3812 ( (uint64_t) p[1] << 48 ) |
3813 ( (uint64_t) p[2] << 40 ) |
3814 ( (uint64_t) p[3] << 32 ) |
3815 ( (uint64_t) p[4] << 24 ) |
3816 ( (uint64_t) p[5] << 16 ) |
3817 ( (uint64_t) p[6] << 8 ) |
3818 ( (uint64_t) p[7] );
3819 p += 8;
3820
3821 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3822 ( (uint64_t) p[1] << 48 ) |
3823 ( (uint64_t) p[2] << 40 ) |
3824 ( (uint64_t) p[3] << 32 ) |
3825 ( (uint64_t) p[4] << 24 ) |
3826 ( (uint64_t) p[5] << 16 ) |
3827 ( (uint64_t) p[6] << 8 ) |
3828 ( (uint64_t) p[7] );
3829 p += 8;
3830#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3831
3832#if defined(MBEDTLS_SSL_PROTO_DTLS)
3833 if( (size_t)( end - p ) < 1 )
3834 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3835
3836 ssl->disable_datagram_packing = *p++;
3837#endif /* MBEDTLS_SSL_PROTO_DTLS */
3838
Jerry Yud9a94fe2021-09-28 18:58:59 +08003839 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003840 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003841 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3842 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003843
3844#if defined(MBEDTLS_SSL_PROTO_DTLS)
3845 if( (size_t)( end - p ) < 2 )
3846 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3847
3848 ssl->mtu = ( p[0] << 8 ) | p[1];
3849 p += 2;
3850#endif /* MBEDTLS_SSL_PROTO_DTLS */
3851
3852#if defined(MBEDTLS_SSL_ALPN)
3853 {
3854 uint8_t alpn_len;
3855 const char **cur;
3856
3857 if( (size_t)( end - p ) < 1 )
3858 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3859
3860 alpn_len = *p++;
3861
3862 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3863 {
3864 /* alpn_chosen should point to an item in the configured list */
3865 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3866 {
3867 if( strlen( *cur ) == alpn_len &&
3868 memcmp( p, cur, alpn_len ) == 0 )
3869 {
3870 ssl->alpn_chosen = *cur;
3871 break;
3872 }
3873 }
3874 }
3875
3876 /* can only happen on conf mismatch */
3877 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3878 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3879
3880 p += alpn_len;
3881 }
3882#endif /* MBEDTLS_SSL_ALPN */
3883
3884 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003885 * Forced fields from top-level ssl_context structure
3886 *
3887 * Most of them already set to the correct value by mbedtls_ssl_init() and
3888 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3889 */
3890 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003891 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003892
Hanno Becker361b10d2019-08-30 10:42:49 +01003893 /* Adjust pointers for header fields of outgoing records to
3894 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003895 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003896
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003897#if defined(MBEDTLS_SSL_PROTO_DTLS)
3898 ssl->in_epoch = 1;
3899#endif
3900
3901 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3902 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003903 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3904 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003905 if( ssl->handshake != NULL )
3906 {
3907 mbedtls_ssl_handshake_free( ssl );
3908 mbedtls_free( ssl->handshake );
3909 ssl->handshake = NULL;
3910 }
3911
3912 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003913 * Done - should have consumed entire buffer
3914 */
3915 if( p != end )
3916 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003917
3918 return( 0 );
3919}
3920
3921/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003922 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003923 */
3924int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3925 const unsigned char *buf,
3926 size_t len )
3927{
3928 int ret = ssl_context_load( context, buf, len );
3929
3930 if( ret != 0 )
3931 mbedtls_ssl_free( context );
3932
3933 return( ret );
3934}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003935#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003936
3937/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003938 * Free an SSL context
3939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003940void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003941{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003942 if( ssl == NULL )
3943 return;
3944
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003946
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003947 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003948 {
sander-visserb8aa2072020-05-06 22:05:13 +02003949#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3950 size_t out_buf_len = ssl->out_buf_len;
3951#else
3952 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3953#endif
3954
Darryl Greenb33cc762019-11-28 14:29:44 +00003955 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003956 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003957 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003958 }
3959
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003960 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003961 {
sander-visserb8aa2072020-05-06 22:05:13 +02003962#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3963 size_t in_buf_len = ssl->in_buf_len;
3964#else
3965 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3966#endif
3967
Darryl Greenb33cc762019-11-28 14:29:44 +00003968 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003969 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003970 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003971 }
3972
Paul Bakker48916f92012-09-16 19:57:18 +00003973 if( ssl->transform )
3974 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003975 mbedtls_ssl_transform_free( ssl->transform );
3976 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003977 }
3978
3979 if( ssl->handshake )
3980 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003981 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003982 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3983 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985 mbedtls_free( ssl->handshake );
3986 mbedtls_free( ssl->transform_negotiate );
3987 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003988 }
3989
Ronald Cron6f135e12021-12-08 16:57:54 +01003990#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003991 mbedtls_ssl_transform_free( ssl->transform_application );
3992 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003993#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003994
Paul Bakkerc0463502013-02-14 11:19:38 +01003995 if( ssl->session )
3996 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003997 mbedtls_ssl_session_free( ssl->session );
3998 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003999 }
4000
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004001#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004002 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004003 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004004 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004006 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004007#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004008
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004009#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004010 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004011#endif
4012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004014
Paul Bakker86f04f42013-02-14 11:20:09 +01004015 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004016 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004017}
4018
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004019/*
4020 * Initialze mbedtls_ssl_config
4021 */
4022void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4023{
4024 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4025}
4026
Gilles Peskineeccd8882020-03-10 12:19:08 +01004027#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004028#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02004029/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02004030 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
4031 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004032 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
4033 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004034static int ssl_preset_default_hashes[] = {
4035#if defined(MBEDTLS_SHA512_C)
4036 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004037#endif
4038#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004039 MBEDTLS_MD_SHA384,
4040#endif
4041#if defined(MBEDTLS_SHA256_C)
4042 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004043#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004044 MBEDTLS_MD_NONE
4045};
Jerry Yuf017ee42022-01-12 15:49:48 +08004046#endif /* !MBEDTLS_DEPRECATED_REMOVED */
4047#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004048
Gilles Peskineae270bf2021-06-02 00:05:29 +02004049/* The selection should be the same as mbedtls_x509_crt_profile_default in
4050 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004051 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004052 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004053 * about this list.
4054 */
Brett Warrene0edc842021-08-17 09:53:13 +01004055static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004056#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004057 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004058#endif
4059#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004060 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004061#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004062#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004063 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004064#endif
4065#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004066 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004067#endif
4068#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004069 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004070#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004071#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004072 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004073#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004074#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004075 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004076#endif
4077#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004078 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004079#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004080 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004081};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004082
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004083static int ssl_preset_suiteb_ciphersuites[] = {
4084 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4085 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4086 0
4087};
4088
Gilles Peskineeccd8882020-03-10 12:19:08 +01004089#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004090#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004091static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08004092#if defined(MBEDTLS_SHA256_C)
4093 MBEDTLS_MD_SHA256,
4094#endif
Jerry Yu713013f2022-01-17 18:16:35 +08004095#if defined(MBEDTLS_SHA384_C)
4096 MBEDTLS_MD_SHA384,
4097#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004098 MBEDTLS_MD_NONE
4099};
Jerry Yuf017ee42022-01-12 15:49:48 +08004100#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004101
Jerry Yu909df7b2022-01-22 11:56:27 +08004102/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004103 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004104 * rules SHOULD be upheld.
4105 * - No duplicate entries.
4106 * - But if there is a good reason, do not change the order of the algorithms.
4107 * - ssl_tls12_present* is for TLS 1.2 use only.
4108 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004109 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004110static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004111
Jerry Yued5e9f42022-01-26 11:21:34 +08004112#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4113 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4114 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4115#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4116 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004117
Jerry Yu909df7b2022-01-22 11:56:27 +08004118#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4119 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4120 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4121#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4122 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4123
Jerry Yued5e9f42022-01-26 11:21:34 +08004124#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4125 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4126 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4127#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4128 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004129
Jerry Yu909df7b2022-01-22 11:56:27 +08004130#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4131 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4132#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4133
Ronald Cron8540cf62022-03-16 08:01:09 +01004134#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4135 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4136#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4137
4138#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4139 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4140#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4141
Jerry Yu53037892022-01-25 11:02:06 +08004142#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4143 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4144#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4145
Jerry Yu909df7b2022-01-22 11:56:27 +08004146 MBEDTLS_TLS1_3_SIG_NONE
4147};
4148
4149/* NOTICE: see above */
4150#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4151static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004152#if defined(MBEDTLS_SHA512_C)
4153 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4154#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004155#if defined(MBEDTLS_SHA384_C)
4156 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4157#endif
4158#if defined(MBEDTLS_SHA256_C)
4159 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4160#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004161 MBEDTLS_TLS1_3_SIG_NONE
4162};
4163#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4164/* NOTICE: see above */
4165static uint16_t ssl_preset_suiteb_sig_algs[] = {
4166
Jerry Yu909df7b2022-01-22 11:56:27 +08004167#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4168 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4169 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4170#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4171 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4172
Jerry Yu53037892022-01-25 11:02:06 +08004173#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4174 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4175 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4176#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4177 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004178
4179#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4180 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4181#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004182
Jerry Yu53037892022-01-25 11:02:06 +08004183#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4184 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4185#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4186
Jerry Yu713013f2022-01-17 18:16:35 +08004187 MBEDTLS_TLS1_3_SIG_NONE
4188};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004189
Jerry Yu909df7b2022-01-22 11:56:27 +08004190/* NOTICE: see above */
4191#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4192static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004193#if defined(MBEDTLS_SHA256_C)
4194 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4195#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004196#if defined(MBEDTLS_SHA384_C)
4197 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4198#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004199 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004200};
Jerry Yu909df7b2022-01-22 11:56:27 +08004201#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4202
Jerry Yu1a8b4812022-01-20 17:56:50 +08004203#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004204
Brett Warrene0edc842021-08-17 09:53:13 +01004205static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004206#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004207 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004208#endif
4209#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004210 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004211#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004212 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004213};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004214
Jerry Yu1a8b4812022-01-20 17:56:50 +08004215#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004216/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004217 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004218static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004219{
4220 size_t i, j;
4221 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004222
Jerry Yuf377d642022-01-25 10:43:59 +08004223 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004224 {
Jerry Yuf377d642022-01-25 10:43:59 +08004225 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004226 {
Jerry Yuf377d642022-01-25 10:43:59 +08004227 if( sig_algs[i] != sig_algs[j] )
4228 continue;
4229 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4230 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4231 sig_algs[i], j, i );
4232 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004233 }
4234 }
4235 return( ret );
4236}
4237
4238#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4239
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004240/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004241 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004242 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004243int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004244 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004245{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004246#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004247 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004248#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004249
Jerry Yu1a8b4812022-01-20 17:56:50 +08004250#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004251 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004252 {
4253 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4254 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4255 }
4256
Jerry Yuf377d642022-01-25 10:43:59 +08004257 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004258 {
4259 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4260 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4261 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004262
4263#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004264 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004265 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004266 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004267 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4268 }
4269
Jerry Yuf377d642022-01-25 10:43:59 +08004270 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004271 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004272 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004273 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4274 }
4275#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004276#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4277
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004278 /* Use the functions here so that they are covered in tests,
4279 * but otherwise access member directly for efficiency */
4280 mbedtls_ssl_conf_endpoint( conf, endpoint );
4281 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004282
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004283 /*
4284 * Things that are common to all presets
4285 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004286#if defined(MBEDTLS_SSL_CLI_C)
4287 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4288 {
4289 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4290#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4291 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4292#endif
4293 }
4294#endif
4295
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004296#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4297 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4298#endif
4299
4300#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4301 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4302#endif
4303
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004304#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004305 conf->f_cookie_write = ssl_cookie_write_dummy;
4306 conf->f_cookie_check = ssl_cookie_check_dummy;
4307#endif
4308
4309#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4310 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4311#endif
4312
Janos Follath088ce432017-04-10 12:42:31 +01004313#if defined(MBEDTLS_SSL_SRV_C)
4314 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004315 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004316#endif
4317
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004318#if defined(MBEDTLS_SSL_PROTO_DTLS)
4319 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4320 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4321#endif
4322
4323#if defined(MBEDTLS_SSL_RENEGOTIATION)
4324 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004325 memset( conf->renego_period, 0x00, 2 );
4326 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004327#endif
4328
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004329#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004330 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4331 {
4332 const unsigned char dhm_p[] =
4333 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4334 const unsigned char dhm_g[] =
4335 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004336
Hanno Beckere2defad2021-07-24 05:59:17 +01004337 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4338 dhm_p, sizeof( dhm_p ),
4339 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4340 {
4341 return( ret );
4342 }
4343 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004344#endif
4345
Ronald Cron6f135e12021-12-08 16:57:54 +01004346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004347 /*
4348 * Allow all TLS 1.3 key exchange modes by default.
4349 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004350 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004351#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004352
XiaokangQian4d3a6042022-04-21 13:46:17 +00004353 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4354 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004355#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004356 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004357 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004358#else
XiaokangQian060d8672022-04-21 09:24:56 +00004359 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004360#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004361 }
4362 else
4363 {
4364#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4365 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4366 {
4367 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4368 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4369 }
4370 else
4371 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4372 {
4373 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4374 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4375 }
4376#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4377 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4378 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4379#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4380 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4381 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4382#else
4383 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4384#endif
4385 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004386
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004387 /*
4388 * Preset-specific defaults
4389 */
4390 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004391 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004392 /*
4393 * NSA Suite B
4394 */
4395 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004396
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004397 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004398
4399#if defined(MBEDTLS_X509_CRT_PARSE_C)
4400 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004401#endif
4402
Gilles Peskineeccd8882020-03-10 12:19:08 +01004403#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004404#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004405 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004406#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004407#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4408 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4409 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4410 else
4411#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4412 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004413#endif
4414
Brett Warrene0edc842021-08-17 09:53:13 +01004415#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4416 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004417#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004418 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004419 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004420
4421 /*
4422 * Default
4423 */
4424 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004425
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004426 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004427
4428#if defined(MBEDTLS_X509_CRT_PARSE_C)
4429 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4430#endif
4431
Gilles Peskineeccd8882020-03-10 12:19:08 +01004432#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004433#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004434 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004435#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004436#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4437 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4438 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4439 else
4440#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4441 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004442#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004443
Brett Warrene0edc842021-08-17 09:53:13 +01004444#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4445 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004446#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004447 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004448
4449#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4450 conf->dhm_min_bitlen = 1024;
4451#endif
4452 }
4453
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004454 return( 0 );
4455}
4456
4457/*
4458 * Free mbedtls_ssl_config
4459 */
4460void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4461{
4462#if defined(MBEDTLS_DHM_C)
4463 mbedtls_mpi_free( &conf->dhm_P );
4464 mbedtls_mpi_free( &conf->dhm_G );
4465#endif
4466
Gilles Peskineeccd8882020-03-10 12:19:08 +01004467#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004468#if defined(MBEDTLS_USE_PSA_CRYPTO)
4469 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4470 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004471 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4472 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004473#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004474 if( conf->psk != NULL )
4475 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004476 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004477 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004478 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004479 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004480 }
4481
4482 if( conf->psk_identity != NULL )
4483 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004484 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004485 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004486 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004487 conf->psk_identity_len = 0;
4488 }
4489#endif
4490
4491#if defined(MBEDTLS_X509_CRT_PARSE_C)
4492 ssl_key_cert_free( conf->key_cert );
4493#endif
4494
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004495 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004496}
4497
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004498#if defined(MBEDTLS_PK_C) && \
4499 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004500/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004501 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004503unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004504{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004505#if defined(MBEDTLS_RSA_C)
4506 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4507 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004508#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509#if defined(MBEDTLS_ECDSA_C)
4510 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4511 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004512#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004513 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004514}
4515
Hanno Becker7e5437a2017-04-28 17:15:26 +01004516unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4517{
4518 switch( type ) {
4519 case MBEDTLS_PK_RSA:
4520 return( MBEDTLS_SSL_SIG_RSA );
4521 case MBEDTLS_PK_ECDSA:
4522 case MBEDTLS_PK_ECKEY:
4523 return( MBEDTLS_SSL_SIG_ECDSA );
4524 default:
4525 return( MBEDTLS_SSL_SIG_ANON );
4526 }
4527}
4528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004529mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004530{
4531 switch( sig )
4532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_RSA_C)
4534 case MBEDTLS_SSL_SIG_RSA:
4535 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004536#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537#if defined(MBEDTLS_ECDSA_C)
4538 case MBEDTLS_SSL_SIG_ECDSA:
4539 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004540#endif
4541 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004542 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004543 }
4544}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004545#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004546
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004547/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004548 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004550mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004551{
4552 switch( hash )
4553 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004554#if defined(MBEDTLS_MD5_C)
4555 case MBEDTLS_SSL_HASH_MD5:
4556 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004557#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004558#if defined(MBEDTLS_SHA1_C)
4559 case MBEDTLS_SSL_HASH_SHA1:
4560 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004561#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004562#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004563 case MBEDTLS_SSL_HASH_SHA224:
4564 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004565#endif
4566#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004567 case MBEDTLS_SSL_HASH_SHA256:
4568 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004569#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004570#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571 case MBEDTLS_SSL_HASH_SHA384:
4572 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004573#endif
4574#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575 case MBEDTLS_SSL_HASH_SHA512:
4576 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004577#endif
4578 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004580 }
4581}
4582
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004583/*
4584 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4585 */
4586unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4587{
4588 switch( md )
4589 {
4590#if defined(MBEDTLS_MD5_C)
4591 case MBEDTLS_MD_MD5:
4592 return( MBEDTLS_SSL_HASH_MD5 );
4593#endif
4594#if defined(MBEDTLS_SHA1_C)
4595 case MBEDTLS_MD_SHA1:
4596 return( MBEDTLS_SSL_HASH_SHA1 );
4597#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004598#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004599 case MBEDTLS_MD_SHA224:
4600 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004601#endif
4602#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004603 case MBEDTLS_MD_SHA256:
4604 return( MBEDTLS_SSL_HASH_SHA256 );
4605#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004606#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004607 case MBEDTLS_MD_SHA384:
4608 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004609#endif
4610#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004611 case MBEDTLS_MD_SHA512:
4612 return( MBEDTLS_SSL_HASH_SHA512 );
4613#endif
4614 default:
4615 return( MBEDTLS_SSL_HASH_NONE );
4616 }
4617}
4618
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004619/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004620 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004621 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004622 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004623int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004624{
Brett Warrene0edc842021-08-17 09:53:13 +01004625 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004626
Brett Warrene0edc842021-08-17 09:53:13 +01004627 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004628 return( -1 );
4629
Brett Warrene0edc842021-08-17 09:53:13 +01004630 for( ; *group_list != 0; group_list++ )
4631 {
4632 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004633 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004634 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004635
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004636 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004637}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004638
4639#if defined(MBEDTLS_ECP_C)
4640/*
4641 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4642 */
4643int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4644{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004645 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004646 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4647}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004648#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650#if defined(MBEDTLS_X509_CRT_PARSE_C)
4651int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4652 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004653 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004654 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004655{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004656 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004657 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004658 const char *ext_oid;
4659 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004662 {
4663 /* Server part of the key exchange */
4664 switch( ciphersuite->key_exchange )
4665 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666 case MBEDTLS_KEY_EXCHANGE_RSA:
4667 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004668 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004669 break;
4670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004671 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4672 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4673 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4674 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004675 break;
4676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004677 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4678 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004679 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004680 break;
4681
4682 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004683 case MBEDTLS_KEY_EXCHANGE_NONE:
4684 case MBEDTLS_KEY_EXCHANGE_PSK:
4685 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4686 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004687 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004688 usage = 0;
4689 }
4690 }
4691 else
4692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4694 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004695 }
4696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004698 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004699 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004700 ret = -1;
4701 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004703 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4706 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004707 }
4708 else
4709 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4711 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004712 }
4713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004715 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004716 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004717 ret = -1;
4718 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004719
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004720 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004721}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004722#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004723
Jerry Yu148165c2021-09-24 23:20:59 +08004724#if defined(MBEDTLS_USE_PSA_CRYPTO)
4725int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4726 const mbedtls_md_type_t md,
4727 unsigned char *dst,
4728 size_t dst_len,
4729 size_t *olen )
4730{
Ronald Cronf6893e12022-01-07 22:09:01 +01004731 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4732 psa_hash_operation_t *hash_operation_to_clone;
4733 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4734
Jerry Yu148165c2021-09-24 23:20:59 +08004735 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004736
4737 switch( md )
4738 {
4739#if defined(MBEDTLS_SHA384_C)
4740 case MBEDTLS_MD_SHA384:
4741 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4742 break;
4743#endif
4744
4745#if defined(MBEDTLS_SHA256_C)
4746 case MBEDTLS_MD_SHA256:
4747 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4748 break;
4749#endif
4750
4751 default:
4752 goto exit;
4753 }
4754
4755 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4756 if( status != PSA_SUCCESS )
4757 goto exit;
4758
4759 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4760 if( status != PSA_SUCCESS )
4761 goto exit;
4762
4763exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004764 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004765}
4766#else /* MBEDTLS_USE_PSA_CRYPTO */
4767
Jerry Yu24c0ec32021-09-09 14:21:07 +08004768#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004769static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4770 unsigned char *dst,
4771 size_t dst_len,
4772 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004773{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004774 int ret;
4775 mbedtls_sha512_context sha512;
4776
4777 if( dst_len < 48 )
4778 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4779
4780 mbedtls_sha512_init( &sha512 );
4781 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4782
4783 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4784 {
4785 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4786 goto exit;
4787 }
4788
4789 *olen = 48;
4790
4791exit:
4792
4793 mbedtls_sha512_free( &sha512 );
4794 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004795}
4796#endif /* MBEDTLS_SHA384_C */
4797
4798#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004799static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4800 unsigned char *dst,
4801 size_t dst_len,
4802 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004803{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004804 int ret;
4805 mbedtls_sha256_context sha256;
4806
4807 if( dst_len < 32 )
4808 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4809
4810 mbedtls_sha256_init( &sha256 );
4811 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004812
Jerry Yu24c0ec32021-09-09 14:21:07 +08004813 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4814 {
4815 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4816 goto exit;
4817 }
4818
4819 *olen = 32;
4820
4821exit:
4822
4823 mbedtls_sha256_free( &sha256 );
4824 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004825}
4826#endif /* MBEDTLS_SHA256_C */
4827
Jerry Yu000f9762021-09-14 11:12:51 +08004828int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4829 const mbedtls_md_type_t md,
4830 unsigned char *dst,
4831 size_t dst_len,
4832 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004833{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004834 switch( md )
4835 {
4836
Jerry Yu24c0ec32021-09-09 14:21:07 +08004837#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004838 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004839 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004840#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004841
Jerry Yu24c0ec32021-09-09 14:21:07 +08004842#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004843 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004844 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004845#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004846
4847 default:
4848 break;
4849 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004850 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004851}
XiaokangQian647719a2021-12-07 09:16:29 +00004852
Jerry Yu148165c2021-09-24 23:20:59 +08004853#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004854
Jerry Yudc7bd172022-02-17 13:44:15 +08004855#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4856
4857#if defined(MBEDTLS_USE_PSA_CRYPTO)
4858
4859static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4860 mbedtls_svc_key_id_t key,
4861 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004862 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004863 const unsigned char* seed, size_t seed_length,
4864 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004865 const unsigned char* other_secret,
4866 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004867 size_t capacity )
4868{
4869 psa_status_t status;
4870
4871 status = psa_key_derivation_setup( derivation, alg );
4872 if( status != PSA_SUCCESS )
4873 return( status );
4874
4875 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4876 {
4877 status = psa_key_derivation_input_bytes( derivation,
4878 PSA_KEY_DERIVATION_INPUT_SEED,
4879 seed, seed_length );
4880 if( status != PSA_SUCCESS )
4881 return( status );
4882
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004883 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02004884 {
4885 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004886 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
4887 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02004888 if( status != PSA_SUCCESS )
4889 return( status );
4890 }
4891
Jerry Yudc7bd172022-02-17 13:44:15 +08004892 if( mbedtls_svc_key_id_is_null( key ) )
4893 {
4894 status = psa_key_derivation_input_bytes(
4895 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004896 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08004897 }
4898 else
4899 {
4900 status = psa_key_derivation_input_key(
4901 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4902 }
4903 if( status != PSA_SUCCESS )
4904 return( status );
4905
4906 status = psa_key_derivation_input_bytes( derivation,
4907 PSA_KEY_DERIVATION_INPUT_LABEL,
4908 label, label_length );
4909 if( status != PSA_SUCCESS )
4910 return( status );
4911 }
4912 else
4913 {
4914 return( PSA_ERROR_NOT_SUPPORTED );
4915 }
4916
4917 status = psa_key_derivation_set_capacity( derivation, capacity );
4918 if( status != PSA_SUCCESS )
4919 return( status );
4920
4921 return( PSA_SUCCESS );
4922}
4923
4924static int tls_prf_generic( mbedtls_md_type_t md_type,
4925 const unsigned char *secret, size_t slen,
4926 const char *label,
4927 const unsigned char *random, size_t rlen,
4928 unsigned char *dstbuf, size_t dlen )
4929{
4930 psa_status_t status;
4931 psa_algorithm_t alg;
4932 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4933 psa_key_derivation_operation_t derivation =
4934 PSA_KEY_DERIVATION_OPERATION_INIT;
4935
4936 if( md_type == MBEDTLS_MD_SHA384 )
4937 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4938 else
4939 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4940
4941 /* Normally a "secret" should be long enough to be impossible to
4942 * find by brute force, and in particular should not be empty. But
4943 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4944 * and for this use case it makes sense to have a 0-length "secret".
4945 * Since the key API doesn't allow importing a key of length 0,
4946 * keep master_key=0, which setup_psa_key_derivation() understands
4947 * to mean a 0-length "secret" input. */
4948 if( slen != 0 )
4949 {
4950 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4951 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4952 psa_set_key_algorithm( &key_attributes, alg );
4953 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4954
4955 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4956 if( status != PSA_SUCCESS )
4957 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4958 }
4959
4960 status = setup_psa_key_derivation( &derivation,
4961 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004962 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08004963 random, rlen,
4964 (unsigned char const *) label,
4965 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02004966 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08004967 dlen );
4968 if( status != PSA_SUCCESS )
4969 {
4970 psa_key_derivation_abort( &derivation );
4971 psa_destroy_key( master_key );
4972 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4973 }
4974
4975 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4976 if( status != PSA_SUCCESS )
4977 {
4978 psa_key_derivation_abort( &derivation );
4979 psa_destroy_key( master_key );
4980 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4981 }
4982
4983 status = psa_key_derivation_abort( &derivation );
4984 if( status != PSA_SUCCESS )
4985 {
4986 psa_destroy_key( master_key );
4987 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4988 }
4989
4990 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4991 status = psa_destroy_key( master_key );
4992 if( status != PSA_SUCCESS )
4993 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4994
4995 return( 0 );
4996}
4997
4998#else /* MBEDTLS_USE_PSA_CRYPTO */
4999
5000static int tls_prf_generic( mbedtls_md_type_t md_type,
5001 const unsigned char *secret, size_t slen,
5002 const char *label,
5003 const unsigned char *random, size_t rlen,
5004 unsigned char *dstbuf, size_t dlen )
5005{
5006 size_t nb;
5007 size_t i, j, k, md_len;
5008 unsigned char *tmp;
5009 size_t tmp_len = 0;
5010 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5011 const mbedtls_md_info_t *md_info;
5012 mbedtls_md_context_t md_ctx;
5013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5014
5015 mbedtls_md_init( &md_ctx );
5016
5017 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5018 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5019
5020 md_len = mbedtls_md_get_size( md_info );
5021
5022 tmp_len = md_len + strlen( label ) + rlen;
5023 tmp = mbedtls_calloc( 1, tmp_len );
5024 if( tmp == NULL )
5025 {
5026 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5027 goto exit;
5028 }
5029
5030 nb = strlen( label );
5031 memcpy( tmp + md_len, label, nb );
5032 memcpy( tmp + md_len + nb, random, rlen );
5033 nb += rlen;
5034
5035 /*
5036 * Compute P_<hash>(secret, label + random)[0..dlen]
5037 */
5038 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5039 goto exit;
5040
5041 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5042 if( ret != 0 )
5043 goto exit;
5044 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5045 if( ret != 0 )
5046 goto exit;
5047 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5048 if( ret != 0 )
5049 goto exit;
5050
5051 for( i = 0; i < dlen; i += md_len )
5052 {
5053 ret = mbedtls_md_hmac_reset ( &md_ctx );
5054 if( ret != 0 )
5055 goto exit;
5056 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5057 if( ret != 0 )
5058 goto exit;
5059 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5060 if( ret != 0 )
5061 goto exit;
5062
5063 ret = mbedtls_md_hmac_reset ( &md_ctx );
5064 if( ret != 0 )
5065 goto exit;
5066 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5067 if( ret != 0 )
5068 goto exit;
5069 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5070 if( ret != 0 )
5071 goto exit;
5072
5073 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5074
5075 for( j = 0; j < k; j++ )
5076 dstbuf[i + j] = h_i[j];
5077 }
5078
5079exit:
5080 mbedtls_md_free( &md_ctx );
5081
5082 mbedtls_platform_zeroize( tmp, tmp_len );
5083 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5084
5085 mbedtls_free( tmp );
5086
5087 return( ret );
5088}
5089#endif /* MBEDTLS_USE_PSA_CRYPTO */
5090
5091#if defined(MBEDTLS_SHA256_C)
5092static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5093 const char *label,
5094 const unsigned char *random, size_t rlen,
5095 unsigned char *dstbuf, size_t dlen )
5096{
5097 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5098 label, random, rlen, dstbuf, dlen ) );
5099}
5100#endif /* MBEDTLS_SHA256_C */
5101
5102#if defined(MBEDTLS_SHA384_C)
5103static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5104 const char *label,
5105 const unsigned char *random, size_t rlen,
5106 unsigned char *dstbuf, size_t dlen )
5107{
5108 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5109 label, random, rlen, dstbuf, dlen ) );
5110}
5111#endif /* MBEDTLS_SHA384_C */
5112
Jerry Yuf009d862022-02-17 14:01:37 +08005113/*
5114 * Set appropriate PRF function and other SSL / TLS1.2 functions
5115 *
5116 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005117 * - hash associated with the ciphersuite (only used by TLS 1.2)
5118 *
5119 * Outputs:
5120 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5121 */
5122static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005123 mbedtls_md_type_t hash )
5124{
Jerry Yuf009d862022-02-17 14:01:37 +08005125#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005126 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005127 {
5128 handshake->tls_prf = tls_prf_sha384;
5129 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5130 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5131 }
5132 else
5133#endif
5134#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005135 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005136 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005137 handshake->tls_prf = tls_prf_sha256;
5138 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5139 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5140 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005141#else
Jerry Yuf009d862022-02-17 14:01:37 +08005142 {
Jerry Yuf009d862022-02-17 14:01:37 +08005143 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005144 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005145 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5146 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005147#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005148
5149 return( 0 );
5150}
Jerry Yud6ab2352022-02-17 14:03:43 +08005151
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005152/*
5153 * Compute master secret if needed
5154 *
5155 * Parameters:
5156 * [in/out] handshake
5157 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5158 * (PSA-PSK) ciphersuite_info, psk_opaque
5159 * [out] premaster (cleared)
5160 * [out] master
5161 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5162 * debug: conf->f_dbg, conf->p_dbg
5163 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005164 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005165 */
5166static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5167 unsigned char *master,
5168 const mbedtls_ssl_context *ssl )
5169{
5170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5171
5172 /* cf. RFC 5246, Section 8.1:
5173 * "The master secret is always exactly 48 bytes in length." */
5174 size_t const master_secret_len = 48;
5175
5176#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5177 unsigned char session_hash[48];
5178#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5179
5180 /* The label for the KDF used for key expansion.
5181 * This is either "master secret" or "extended master secret"
5182 * depending on whether the Extended Master Secret extension
5183 * is used. */
5184 char const *lbl = "master secret";
5185
Przemek Stekielae4ed302022-04-05 17:15:55 +02005186 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005187 * - If the Extended Master Secret extension is not used,
5188 * this is ClientHello.Random + ServerHello.Random
5189 * (see Sect. 8.1 in RFC 5246).
5190 * - If the Extended Master Secret extension is used,
5191 * this is the transcript of the handshake so far.
5192 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005193 unsigned char const *seed = handshake->randbytes;
5194 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005195
5196#if !defined(MBEDTLS_DEBUG_C) && \
5197 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5198 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5199 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5200 ssl = NULL; /* make sure we don't use it except for those cases */
5201 (void) ssl;
5202#endif
5203
5204 if( handshake->resume != 0 )
5205 {
5206 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5207 return( 0 );
5208 }
5209
5210#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5211 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5212 {
5213 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005214 seed = session_hash;
5215 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005216
5217 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005218 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005219 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005220#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005221
Przemek Stekiel99114f32022-04-22 11:20:09 +02005222#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005223 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005224 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005225 {
5226 /* Perform PSK-to-MS expansion in a single step. */
5227 psa_status_t status;
5228 psa_algorithm_t alg;
5229 mbedtls_svc_key_id_t psk;
5230 psa_key_derivation_operation_t derivation =
5231 PSA_KEY_DERIVATION_OPERATION_INIT;
5232 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5233
5234 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5235
5236 psk = mbedtls_ssl_get_opaque_psk( ssl );
5237
5238 if( hash_alg == MBEDTLS_MD_SHA384 )
5239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5240 else
5241 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5242
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005243 size_t other_secret_len = 0;
5244 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005245
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005246 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005247 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005248 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005249 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005250 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005251 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005252 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005253 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005254 other_secret_len = 48;
5255 other_secret = handshake->premaster + 2;
5256 break;
5257 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005258 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005259 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5260 other_secret = handshake->premaster + 2;
5261 break;
5262 default:
5263 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005264 }
5265
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005266 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005267 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005268 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005269 (unsigned char const *) lbl,
5270 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005271 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005272 master_secret_len );
5273 if( status != PSA_SUCCESS )
5274 {
5275 psa_key_derivation_abort( &derivation );
5276 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5277 }
5278
5279 status = psa_key_derivation_output_bytes( &derivation,
5280 master,
5281 master_secret_len );
5282 if( status != PSA_SUCCESS )
5283 {
5284 psa_key_derivation_abort( &derivation );
5285 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5286 }
5287
5288 status = psa_key_derivation_abort( &derivation );
5289 if( status != PSA_SUCCESS )
5290 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5291 }
5292 else
5293#endif
5294 {
5295 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005296 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005297 master,
5298 master_secret_len );
5299 if( ret != 0 )
5300 {
5301 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5302 return( ret );
5303 }
5304
5305 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5306 handshake->premaster,
5307 handshake->pmslen );
5308
5309 mbedtls_platform_zeroize( handshake->premaster,
5310 sizeof(handshake->premaster) );
5311 }
5312
5313 return( 0 );
5314}
5315
Jerry Yud62f87e2022-02-17 14:09:02 +08005316int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5317{
5318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5319 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5320 ssl->handshake->ciphersuite_info;
5321
5322 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5323
5324 /* Set PRF, calc_verify and calc_finished function pointers */
5325 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005326 ciphersuite_info->mac );
5327 if( ret != 0 )
5328 {
5329 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5330 return( ret );
5331 }
5332
5333 /* Compute master secret if needed */
5334 ret = ssl_compute_master( ssl->handshake,
5335 ssl->session_negotiate->master,
5336 ssl );
5337 if( ret != 0 )
5338 {
5339 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5340 return( ret );
5341 }
5342
5343 /* Swap the client and server random values:
5344 * - MS derivation wanted client+server (RFC 5246 8.1)
5345 * - key derivation wants server+client (RFC 5246 6.3) */
5346 {
5347 unsigned char tmp[64];
5348 memcpy( tmp, ssl->handshake->randbytes, 64 );
5349 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5350 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5351 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5352 }
5353
5354 /* Populate transform structure */
5355 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5356 ssl->session_negotiate->ciphersuite,
5357 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005358#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005359 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005360#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005361 ssl->handshake->tls_prf,
5362 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005363 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005364 ssl->conf->endpoint,
5365 ssl );
5366 if( ret != 0 )
5367 {
5368 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5369 return( ret );
5370 }
5371
5372 /* We no longer need Server/ClientHello.random values */
5373 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5374 sizeof( ssl->handshake->randbytes ) );
5375
5376 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5377
5378 return( 0 );
5379}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005380
Ronald Cron4dcbca92022-03-07 10:21:40 +01005381int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5382{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005383 switch( md )
5384 {
5385#if defined(MBEDTLS_SHA384_C)
5386 case MBEDTLS_SSL_HASH_SHA384:
5387 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5388 break;
5389#endif
5390#if defined(MBEDTLS_SHA256_C)
5391 case MBEDTLS_SSL_HASH_SHA256:
5392 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5393 break;
5394#endif
5395 default:
5396 return( -1 );
5397 }
5398
Ronald Cronc2f13a02022-03-07 10:25:24 +01005399 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005400}
5401
Jerry Yu8392e0d2022-02-17 14:10:24 +08005402#if defined(MBEDTLS_SHA256_C)
5403void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5404 unsigned char *hash,
5405 size_t *hlen )
5406{
5407#if defined(MBEDTLS_USE_PSA_CRYPTO)
5408 size_t hash_size;
5409 psa_status_t status;
5410 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5411
5412 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5413 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5414 if( status != PSA_SUCCESS )
5415 {
5416 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5417 return;
5418 }
5419
5420 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5421 if( status != PSA_SUCCESS )
5422 {
5423 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5424 return;
5425 }
5426
5427 *hlen = 32;
5428 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5429 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5430#else
5431 mbedtls_sha256_context sha256;
5432
5433 mbedtls_sha256_init( &sha256 );
5434
5435 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5436
5437 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5438 mbedtls_sha256_finish( &sha256, hash );
5439
5440 *hlen = 32;
5441
5442 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5443 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5444
5445 mbedtls_sha256_free( &sha256 );
5446#endif /* MBEDTLS_USE_PSA_CRYPTO */
5447 return;
5448}
5449#endif /* MBEDTLS_SHA256_C */
5450
Jerry Yuc1cb3842022-02-17 14:13:48 +08005451#if defined(MBEDTLS_SHA384_C)
5452void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5453 unsigned char *hash,
5454 size_t *hlen )
5455{
5456#if defined(MBEDTLS_USE_PSA_CRYPTO)
5457 size_t hash_size;
5458 psa_status_t status;
5459 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5460
5461 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5462 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5463 if( status != PSA_SUCCESS )
5464 {
5465 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5466 return;
5467 }
5468
5469 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5470 if( status != PSA_SUCCESS )
5471 {
5472 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5473 return;
5474 }
5475
5476 *hlen = 48;
5477 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5479#else
5480 mbedtls_sha512_context sha512;
5481
5482 mbedtls_sha512_init( &sha512 );
5483
5484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5485
5486 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5487 mbedtls_sha512_finish( &sha512, hash );
5488
5489 *hlen = 48;
5490
5491 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5493
5494 mbedtls_sha512_free( &sha512 );
5495#endif /* MBEDTLS_USE_PSA_CRYPTO */
5496 return;
5497}
5498#endif /* MBEDTLS_SHA384_C */
5499
Neil Armstrong80f6f322022-05-03 17:56:38 +02005500#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5501 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005502int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5503{
5504 unsigned char *p = ssl->handshake->premaster;
5505 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5506 const unsigned char *psk = NULL;
5507 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005508 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005509
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005510 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005511 {
5512 /*
5513 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005514 * checked before calling this function.
5515 *
5516 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005517 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005518 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005519 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5520 {
5521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5522 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5523 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005524 }
5525
5526 /*
5527 * PMS = struct {
5528 * opaque other_secret<0..2^16-1>;
5529 * opaque psk<0..2^16-1>;
5530 * };
5531 * with "other_secret" depending on the particular key exchange
5532 */
5533#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5534 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5535 {
5536 if( end - p < 2 )
5537 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5538
5539 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5540 p += 2;
5541
5542 if( end < p || (size_t)( end - p ) < psk_len )
5543 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5544
5545 memset( p, 0, psk_len );
5546 p += psk_len;
5547 }
5548 else
5549#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5550#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5551 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5552 {
5553 /*
5554 * other_secret already set by the ClientKeyExchange message,
5555 * and is 48 bytes long
5556 */
5557 if( end - p < 2 )
5558 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5559
5560 *p++ = 0;
5561 *p++ = 48;
5562 p += 48;
5563 }
5564 else
5565#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5566#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5567 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5568 {
5569 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5570 size_t len;
5571
5572 /* Write length only when we know the actual value */
5573 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5574 p + 2, end - ( p + 2 ), &len,
5575 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5576 {
5577 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5578 return( ret );
5579 }
5580 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5581 p += 2 + len;
5582
5583 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5584 }
5585 else
5586#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005587#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005588 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5589 {
5590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5591 size_t zlen;
5592
5593 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5594 p + 2, end - ( p + 2 ),
5595 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5596 {
5597 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5598 return( ret );
5599 }
5600
5601 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5602 p += 2 + zlen;
5603
5604 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5605 MBEDTLS_DEBUG_ECDH_Z );
5606 }
5607 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005608#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005609 {
5610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5611 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5612 }
5613
5614 /* opaque psk<0..2^16-1>; */
5615 if( end - p < 2 )
5616 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5617
5618 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5619 p += 2;
5620
5621 if( end < p || (size_t)( end - p ) < psk_len )
5622 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5623
5624 memcpy( p, psk, psk_len );
5625 p += psk_len;
5626
5627 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5628
5629 return( 0 );
5630}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005631#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005632
5633#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5634static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5635
5636#if defined(MBEDTLS_SSL_PROTO_DTLS)
5637int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5638{
5639 /* If renegotiation is not enforced, retransmit until we would reach max
5640 * timeout if we were using the usual handshake doubling scheme */
5641 if( ssl->conf->renego_max_records < 0 )
5642 {
5643 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5644 unsigned char doublings = 1;
5645
5646 while( ratio != 0 )
5647 {
5648 ++doublings;
5649 ratio >>= 1;
5650 }
5651
5652 if( ++ssl->renego_records_seen > doublings )
5653 {
5654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5655 return( 0 );
5656 }
5657 }
5658
5659 return( ssl_write_hello_request( ssl ) );
5660}
5661#endif
5662#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005663
Jerry Yud9526692022-02-17 14:23:47 +08005664/*
5665 * Handshake functions
5666 */
5667#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5668/* No certificate support -> dummy functions */
5669int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5670{
5671 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5672 ssl->handshake->ciphersuite_info;
5673
5674 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5675
5676 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5677 {
5678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5679 ssl->state++;
5680 return( 0 );
5681 }
5682
5683 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5684 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5685}
5686
5687int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5688{
5689 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5690 ssl->handshake->ciphersuite_info;
5691
5692 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5693
5694 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5695 {
5696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5697 ssl->state++;
5698 return( 0 );
5699 }
5700
5701 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5702 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5703}
5704
5705#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5706/* Some certificate support -> implement write and parse */
5707
5708int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5709{
5710 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5711 size_t i, n;
5712 const mbedtls_x509_crt *crt;
5713 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5714 ssl->handshake->ciphersuite_info;
5715
5716 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5717
5718 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5719 {
5720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5721 ssl->state++;
5722 return( 0 );
5723 }
5724
5725#if defined(MBEDTLS_SSL_CLI_C)
5726 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5727 {
5728 if( ssl->handshake->client_auth == 0 )
5729 {
5730 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5731 ssl->state++;
5732 return( 0 );
5733 }
5734 }
5735#endif /* MBEDTLS_SSL_CLI_C */
5736#if defined(MBEDTLS_SSL_SRV_C)
5737 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5738 {
5739 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5740 {
5741 /* Should never happen because we shouldn't have picked the
5742 * ciphersuite if we don't have a certificate. */
5743 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5744 }
5745 }
5746#endif
5747
5748 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5749
5750 /*
5751 * 0 . 0 handshake type
5752 * 1 . 3 handshake length
5753 * 4 . 6 length of all certs
5754 * 7 . 9 length of cert. 1
5755 * 10 . n-1 peer certificate
5756 * n . n+2 length of cert. 2
5757 * n+3 . ... upper level cert, etc.
5758 */
5759 i = 7;
5760 crt = mbedtls_ssl_own_cert( ssl );
5761
5762 while( crt != NULL )
5763 {
5764 n = crt->raw.len;
5765 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5766 {
5767 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5768 " > %" MBEDTLS_PRINTF_SIZET,
5769 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5770 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5771 }
5772
5773 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5774 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5775 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5776
5777 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5778 i += n; crt = crt->next;
5779 }
5780
5781 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5782 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5783 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5784
5785 ssl->out_msglen = i;
5786 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5787 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5788
5789 ssl->state++;
5790
5791 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5792 {
5793 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5794 return( ret );
5795 }
5796
5797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5798
5799 return( ret );
5800}
5801
5802#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5803
5804#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5805static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5806 unsigned char *crt_buf,
5807 size_t crt_buf_len )
5808{
5809 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5810
5811 if( peer_crt == NULL )
5812 return( -1 );
5813
5814 if( peer_crt->raw.len != crt_buf_len )
5815 return( -1 );
5816
5817 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5818}
5819#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5820static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5821 unsigned char *crt_buf,
5822 size_t crt_buf_len )
5823{
5824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5825 unsigned char const * const peer_cert_digest =
5826 ssl->session->peer_cert_digest;
5827 mbedtls_md_type_t const peer_cert_digest_type =
5828 ssl->session->peer_cert_digest_type;
5829 mbedtls_md_info_t const * const digest_info =
5830 mbedtls_md_info_from_type( peer_cert_digest_type );
5831 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5832 size_t digest_len;
5833
5834 if( peer_cert_digest == NULL || digest_info == NULL )
5835 return( -1 );
5836
5837 digest_len = mbedtls_md_get_size( digest_info );
5838 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5839 return( -1 );
5840
5841 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5842 if( ret != 0 )
5843 return( -1 );
5844
5845 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5846}
5847#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5848#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5849
5850/*
5851 * Once the certificate message is read, parse it into a cert chain and
5852 * perform basic checks, but leave actual verification to the caller
5853 */
5854static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5855 mbedtls_x509_crt *chain )
5856{
5857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5858#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5859 int crt_cnt=0;
5860#endif
5861 size_t i, n;
5862 uint8_t alert;
5863
5864 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5865 {
5866 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5867 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5868 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5869 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5870 }
5871
5872 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5873 {
5874 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5875 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5876 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5877 }
5878
5879 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5880 {
5881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5882 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5883 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5884 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5885 }
5886
5887 i = mbedtls_ssl_hs_hdr_len( ssl );
5888
5889 /*
5890 * Same message structure as in mbedtls_ssl_write_certificate()
5891 */
5892 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5893
5894 if( ssl->in_msg[i] != 0 ||
5895 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5896 {
5897 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5898 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5899 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5900 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5901 }
5902
5903 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5904 i += 3;
5905
5906 /* Iterate through and parse the CRTs in the provided chain. */
5907 while( i < ssl->in_hslen )
5908 {
5909 /* Check that there's room for the next CRT's length fields. */
5910 if ( i + 3 > ssl->in_hslen ) {
5911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5912 mbedtls_ssl_send_alert_message( ssl,
5913 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5914 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5915 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5916 }
5917 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5918 * anything beyond 2**16 ~ 64K. */
5919 if( ssl->in_msg[i] != 0 )
5920 {
5921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5922 mbedtls_ssl_send_alert_message( ssl,
5923 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5924 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5925 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5926 }
5927
5928 /* Read length of the next CRT in the chain. */
5929 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5930 | (unsigned int) ssl->in_msg[i + 2];
5931 i += 3;
5932
5933 if( n < 128 || i + n > ssl->in_hslen )
5934 {
5935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5936 mbedtls_ssl_send_alert_message( ssl,
5937 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5938 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5939 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5940 }
5941
5942 /* Check if we're handling the first CRT in the chain. */
5943#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5944 if( crt_cnt++ == 0 &&
5945 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5946 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5947 {
5948 /* During client-side renegotiation, check that the server's
5949 * end-CRTs hasn't changed compared to the initial handshake,
5950 * mitigating the triple handshake attack. On success, reuse
5951 * the original end-CRT instead of parsing it again. */
5952 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5953 if( ssl_check_peer_crt_unchanged( ssl,
5954 &ssl->in_msg[i],
5955 n ) != 0 )
5956 {
5957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5958 mbedtls_ssl_send_alert_message( ssl,
5959 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5960 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5961 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5962 }
5963
5964 /* Now we can safely free the original chain. */
5965 ssl_clear_peer_cert( ssl->session );
5966 }
5967#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5968
5969 /* Parse the next certificate in the chain. */
5970#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5971 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5972#else
5973 /* If we don't need to store the CRT chain permanently, parse
5974 * it in-place from the input buffer instead of making a copy. */
5975 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5976#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5977 switch( ret )
5978 {
5979 case 0: /*ok*/
5980 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5981 /* Ignore certificate with an unknown algorithm: maybe a
5982 prior certificate was already trusted. */
5983 break;
5984
5985 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5986 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5987 goto crt_parse_der_failed;
5988
5989 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5990 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5991 goto crt_parse_der_failed;
5992
5993 default:
5994 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5995 crt_parse_der_failed:
5996 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5997 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5998 return( ret );
5999 }
6000
6001 i += n;
6002 }
6003
6004 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6005 return( 0 );
6006}
6007
6008#if defined(MBEDTLS_SSL_SRV_C)
6009static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6010{
6011 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6012 return( -1 );
6013
6014 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6015 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6016 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6017 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6018 {
6019 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
6020 return( 0 );
6021 }
6022 return( -1 );
6023}
6024#endif /* MBEDTLS_SSL_SRV_C */
6025
6026/* Check if a certificate message is expected.
6027 * Return either
6028 * - SSL_CERTIFICATE_EXPECTED, or
6029 * - SSL_CERTIFICATE_SKIP
6030 * indicating whether a Certificate message is expected or not.
6031 */
6032#define SSL_CERTIFICATE_EXPECTED 0
6033#define SSL_CERTIFICATE_SKIP 1
6034static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6035 int authmode )
6036{
6037 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6038 ssl->handshake->ciphersuite_info;
6039
6040 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6041 return( SSL_CERTIFICATE_SKIP );
6042
6043#if defined(MBEDTLS_SSL_SRV_C)
6044 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6045 {
6046 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6047 return( SSL_CERTIFICATE_SKIP );
6048
6049 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6050 {
6051 ssl->session_negotiate->verify_result =
6052 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6053 return( SSL_CERTIFICATE_SKIP );
6054 }
6055 }
6056#else
6057 ((void) authmode);
6058#endif /* MBEDTLS_SSL_SRV_C */
6059
6060 return( SSL_CERTIFICATE_EXPECTED );
6061}
6062
6063static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6064 int authmode,
6065 mbedtls_x509_crt *chain,
6066 void *rs_ctx )
6067{
6068 int ret = 0;
6069 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6070 ssl->handshake->ciphersuite_info;
6071 int have_ca_chain = 0;
6072
6073 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6074 void *p_vrfy;
6075
6076 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6077 return( 0 );
6078
6079 if( ssl->f_vrfy != NULL )
6080 {
6081 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6082 f_vrfy = ssl->f_vrfy;
6083 p_vrfy = ssl->p_vrfy;
6084 }
6085 else
6086 {
6087 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6088 f_vrfy = ssl->conf->f_vrfy;
6089 p_vrfy = ssl->conf->p_vrfy;
6090 }
6091
6092 /*
6093 * Main check: verify certificate
6094 */
6095#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6096 if( ssl->conf->f_ca_cb != NULL )
6097 {
6098 ((void) rs_ctx);
6099 have_ca_chain = 1;
6100
6101 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6102 ret = mbedtls_x509_crt_verify_with_ca_cb(
6103 chain,
6104 ssl->conf->f_ca_cb,
6105 ssl->conf->p_ca_cb,
6106 ssl->conf->cert_profile,
6107 ssl->hostname,
6108 &ssl->session_negotiate->verify_result,
6109 f_vrfy, p_vrfy );
6110 }
6111 else
6112#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6113 {
6114 mbedtls_x509_crt *ca_chain;
6115 mbedtls_x509_crl *ca_crl;
6116
6117#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6118 if( ssl->handshake->sni_ca_chain != NULL )
6119 {
6120 ca_chain = ssl->handshake->sni_ca_chain;
6121 ca_crl = ssl->handshake->sni_ca_crl;
6122 }
6123 else
6124#endif
6125 {
6126 ca_chain = ssl->conf->ca_chain;
6127 ca_crl = ssl->conf->ca_crl;
6128 }
6129
6130 if( ca_chain != NULL )
6131 have_ca_chain = 1;
6132
6133 ret = mbedtls_x509_crt_verify_restartable(
6134 chain,
6135 ca_chain, ca_crl,
6136 ssl->conf->cert_profile,
6137 ssl->hostname,
6138 &ssl->session_negotiate->verify_result,
6139 f_vrfy, p_vrfy, rs_ctx );
6140 }
6141
6142 if( ret != 0 )
6143 {
6144 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6145 }
6146
6147#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6148 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6149 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6150#endif
6151
6152 /*
6153 * Secondary checks: always done, but change 'ret' only if it was 0
6154 */
6155
6156#if defined(MBEDTLS_ECP_C)
6157 {
6158 const mbedtls_pk_context *pk = &chain->pk;
6159
6160 /* If certificate uses an EC key, make sure the curve is OK */
6161 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6162 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6163 {
6164 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6165
6166 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6167 if( ret == 0 )
6168 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6169 }
6170 }
6171#endif /* MBEDTLS_ECP_C */
6172
6173 if( mbedtls_ssl_check_cert_usage( chain,
6174 ciphersuite_info,
6175 ! ssl->conf->endpoint,
6176 &ssl->session_negotiate->verify_result ) != 0 )
6177 {
6178 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6179 if( ret == 0 )
6180 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6181 }
6182
6183 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6184 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6185 * with details encoded in the verification flags. All other kinds
6186 * of error codes, including those from the user provided f_vrfy
6187 * functions, are treated as fatal and lead to a failure of
6188 * ssl_parse_certificate even if verification was optional. */
6189 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6190 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6191 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6192 {
6193 ret = 0;
6194 }
6195
6196 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6197 {
6198 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6199 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6200 }
6201
6202 if( ret != 0 )
6203 {
6204 uint8_t alert;
6205
6206 /* The certificate may have been rejected for several reasons.
6207 Pick one and send the corresponding alert. Which alert to send
6208 may be a subject of debate in some cases. */
6209 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6210 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6211 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6212 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6213 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6214 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6215 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6216 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6217 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6218 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6219 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6220 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6221 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6222 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6223 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6224 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6225 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6226 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6227 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6228 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6229 else
6230 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6231 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6232 alert );
6233 }
6234
6235#if defined(MBEDTLS_DEBUG_C)
6236 if( ssl->session_negotiate->verify_result != 0 )
6237 {
6238 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6239 (unsigned int) ssl->session_negotiate->verify_result ) );
6240 }
6241 else
6242 {
6243 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6244 }
6245#endif /* MBEDTLS_DEBUG_C */
6246
6247 return( ret );
6248}
6249
6250#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6251static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6252 unsigned char *start, size_t len )
6253{
6254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6255 /* Remember digest of the peer's end-CRT. */
6256 ssl->session_negotiate->peer_cert_digest =
6257 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6258 if( ssl->session_negotiate->peer_cert_digest == NULL )
6259 {
6260 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6261 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6262 mbedtls_ssl_send_alert_message( ssl,
6263 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6264 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6265
6266 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6267 }
6268
6269 ret = mbedtls_md( mbedtls_md_info_from_type(
6270 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6271 start, len,
6272 ssl->session_negotiate->peer_cert_digest );
6273
6274 ssl->session_negotiate->peer_cert_digest_type =
6275 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6276 ssl->session_negotiate->peer_cert_digest_len =
6277 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6278
6279 return( ret );
6280}
6281
6282static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6283 unsigned char *start, size_t len )
6284{
6285 unsigned char *end = start + len;
6286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6287
6288 /* Make a copy of the peer's raw public key. */
6289 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6290 ret = mbedtls_pk_parse_subpubkey( &start, end,
6291 &ssl->handshake->peer_pubkey );
6292 if( ret != 0 )
6293 {
6294 /* We should have parsed the public key before. */
6295 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6296 }
6297
6298 return( 0 );
6299}
6300#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6301
6302int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6303{
6304 int ret = 0;
6305 int crt_expected;
6306#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6307 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6308 ? ssl->handshake->sni_authmode
6309 : ssl->conf->authmode;
6310#else
6311 const int authmode = ssl->conf->authmode;
6312#endif
6313 void *rs_ctx = NULL;
6314 mbedtls_x509_crt *chain = NULL;
6315
6316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6317
6318 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6319 if( crt_expected == SSL_CERTIFICATE_SKIP )
6320 {
6321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6322 goto exit;
6323 }
6324
6325#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6326 if( ssl->handshake->ecrs_enabled &&
6327 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6328 {
6329 chain = ssl->handshake->ecrs_peer_cert;
6330 ssl->handshake->ecrs_peer_cert = NULL;
6331 goto crt_verify;
6332 }
6333#endif
6334
6335 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6336 {
6337 /* mbedtls_ssl_read_record may have sent an alert already. We
6338 let it decide whether to alert. */
6339 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6340 goto exit;
6341 }
6342
6343#if defined(MBEDTLS_SSL_SRV_C)
6344 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6345 {
6346 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6347
6348 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6349 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6350
6351 goto exit;
6352 }
6353#endif /* MBEDTLS_SSL_SRV_C */
6354
6355 /* Clear existing peer CRT structure in case we tried to
6356 * reuse a session but it failed, and allocate a new one. */
6357 ssl_clear_peer_cert( ssl->session_negotiate );
6358
6359 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6360 if( chain == NULL )
6361 {
6362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6363 sizeof( mbedtls_x509_crt ) ) );
6364 mbedtls_ssl_send_alert_message( ssl,
6365 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6366 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6367
6368 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6369 goto exit;
6370 }
6371 mbedtls_x509_crt_init( chain );
6372
6373 ret = ssl_parse_certificate_chain( ssl, chain );
6374 if( ret != 0 )
6375 goto exit;
6376
6377#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6378 if( ssl->handshake->ecrs_enabled)
6379 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6380
6381crt_verify:
6382 if( ssl->handshake->ecrs_enabled)
6383 rs_ctx = &ssl->handshake->ecrs_ctx;
6384#endif
6385
6386 ret = ssl_parse_certificate_verify( ssl, authmode,
6387 chain, rs_ctx );
6388 if( ret != 0 )
6389 goto exit;
6390
6391#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6392 {
6393 unsigned char *crt_start, *pk_start;
6394 size_t crt_len, pk_len;
6395
6396 /* We parse the CRT chain without copying, so
6397 * these pointers point into the input buffer,
6398 * and are hence still valid after freeing the
6399 * CRT chain. */
6400
6401 crt_start = chain->raw.p;
6402 crt_len = chain->raw.len;
6403
6404 pk_start = chain->pk_raw.p;
6405 pk_len = chain->pk_raw.len;
6406
6407 /* Free the CRT structures before computing
6408 * digest and copying the peer's public key. */
6409 mbedtls_x509_crt_free( chain );
6410 mbedtls_free( chain );
6411 chain = NULL;
6412
6413 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6414 if( ret != 0 )
6415 goto exit;
6416
6417 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6418 if( ret != 0 )
6419 goto exit;
6420 }
6421#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6422 /* Pass ownership to session structure. */
6423 ssl->session_negotiate->peer_cert = chain;
6424 chain = NULL;
6425#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6426
6427 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6428
6429exit:
6430
6431 if( ret == 0 )
6432 ssl->state++;
6433
6434#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6435 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6436 {
6437 ssl->handshake->ecrs_peer_cert = chain;
6438 chain = NULL;
6439 }
6440#endif
6441
6442 if( chain != NULL )
6443 {
6444 mbedtls_x509_crt_free( chain );
6445 mbedtls_free( chain );
6446 }
6447
6448 return( ret );
6449}
6450#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6451
Jerry Yu615bd6f2022-02-17 14:25:15 +08006452#if defined(MBEDTLS_SHA256_C)
6453static void ssl_calc_finished_tls_sha256(
6454 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6455{
6456 int len = 12;
6457 const char *sender;
6458 unsigned char padbuf[32];
6459#if defined(MBEDTLS_USE_PSA_CRYPTO)
6460 size_t hash_size;
6461 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6462 psa_status_t status;
6463#else
6464 mbedtls_sha256_context sha256;
6465#endif
6466
6467 mbedtls_ssl_session *session = ssl->session_negotiate;
6468 if( !session )
6469 session = ssl->session;
6470
6471 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6472 ? "client finished"
6473 : "server finished";
6474
6475#if defined(MBEDTLS_USE_PSA_CRYPTO)
6476 sha256_psa = psa_hash_operation_init();
6477
6478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6479
6480 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6481 if( status != PSA_SUCCESS )
6482 {
6483 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6484 return;
6485 }
6486
6487 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6488 if( status != PSA_SUCCESS )
6489 {
6490 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6491 return;
6492 }
6493 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6494#else
6495
6496 mbedtls_sha256_init( &sha256 );
6497
6498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6499
6500 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6501
6502 /*
6503 * TLSv1.2:
6504 * hash = PRF( master, finished_label,
6505 * Hash( handshake ) )[0.11]
6506 */
6507
6508#if !defined(MBEDTLS_SHA256_ALT)
6509 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6510 sha256.state, sizeof( sha256.state ) );
6511#endif
6512
6513 mbedtls_sha256_finish( &sha256, padbuf );
6514 mbedtls_sha256_free( &sha256 );
6515#endif /* MBEDTLS_USE_PSA_CRYPTO */
6516
6517 ssl->handshake->tls_prf( session->master, 48, sender,
6518 padbuf, 32, buf, len );
6519
6520 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6521
6522 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6523
6524 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6525}
6526#endif /* MBEDTLS_SHA256_C */
6527
Jerry Yub7ba49e2022-02-17 14:25:53 +08006528
6529#if defined(MBEDTLS_SHA384_C)
6530
6531static void ssl_calc_finished_tls_sha384(
6532 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6533{
6534 int len = 12;
6535 const char *sender;
6536 unsigned char padbuf[48];
6537#if defined(MBEDTLS_USE_PSA_CRYPTO)
6538 size_t hash_size;
6539 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6540 psa_status_t status;
6541#else
6542 mbedtls_sha512_context sha512;
6543#endif
6544
6545 mbedtls_ssl_session *session = ssl->session_negotiate;
6546 if( !session )
6547 session = ssl->session;
6548
6549 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6550 ? "client finished"
6551 : "server finished";
6552
6553#if defined(MBEDTLS_USE_PSA_CRYPTO)
6554 sha384_psa = psa_hash_operation_init();
6555
6556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6557
6558 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6559 if( status != PSA_SUCCESS )
6560 {
6561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6562 return;
6563 }
6564
6565 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6566 if( status != PSA_SUCCESS )
6567 {
6568 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6569 return;
6570 }
6571 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6572#else
6573 mbedtls_sha512_init( &sha512 );
6574
6575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6576
6577 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6578
6579 /*
6580 * TLSv1.2:
6581 * hash = PRF( master, finished_label,
6582 * Hash( handshake ) )[0.11]
6583 */
6584
6585#if !defined(MBEDTLS_SHA512_ALT)
6586 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6587 sha512.state, sizeof( sha512.state ) );
6588#endif
6589 mbedtls_sha512_finish( &sha512, padbuf );
6590
6591 mbedtls_sha512_free( &sha512 );
6592#endif
6593
6594 ssl->handshake->tls_prf( session->master, 48, sender,
6595 padbuf, 48, buf, len );
6596
6597 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6598
6599 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6600
6601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6602}
6603#endif /* MBEDTLS_SHA384_C */
6604
Jerry Yuaef00152022-02-17 14:27:31 +08006605void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6606{
6607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6608
6609 /*
6610 * Free our handshake params
6611 */
6612 mbedtls_ssl_handshake_free( ssl );
6613 mbedtls_free( ssl->handshake );
6614 ssl->handshake = NULL;
6615
6616 /*
6617 * Free the previous transform and swith in the current one
6618 */
6619 if( ssl->transform )
6620 {
6621 mbedtls_ssl_transform_free( ssl->transform );
6622 mbedtls_free( ssl->transform );
6623 }
6624 ssl->transform = ssl->transform_negotiate;
6625 ssl->transform_negotiate = NULL;
6626
6627 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6628}
6629
Jerry Yu2a9fff52022-02-17 14:28:51 +08006630void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6631{
6632 int resume = ssl->handshake->resume;
6633
6634 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6635
6636#if defined(MBEDTLS_SSL_RENEGOTIATION)
6637 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6638 {
6639 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6640 ssl->renego_records_seen = 0;
6641 }
6642#endif
6643
6644 /*
6645 * Free the previous session and switch in the current one
6646 */
6647 if( ssl->session )
6648 {
6649#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6650 /* RFC 7366 3.1: keep the EtM state */
6651 ssl->session_negotiate->encrypt_then_mac =
6652 ssl->session->encrypt_then_mac;
6653#endif
6654
6655 mbedtls_ssl_session_free( ssl->session );
6656 mbedtls_free( ssl->session );
6657 }
6658 ssl->session = ssl->session_negotiate;
6659 ssl->session_negotiate = NULL;
6660
6661 /*
6662 * Add cache entry
6663 */
6664 if( ssl->conf->f_set_cache != NULL &&
6665 ssl->session->id_len != 0 &&
6666 resume == 0 )
6667 {
6668 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6669 ssl->session->id,
6670 ssl->session->id_len,
6671 ssl->session ) != 0 )
6672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6673 }
6674
6675#if defined(MBEDTLS_SSL_PROTO_DTLS)
6676 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6677 ssl->handshake->flight != NULL )
6678 {
6679 /* Cancel handshake timer */
6680 mbedtls_ssl_set_timer( ssl, 0 );
6681
6682 /* Keep last flight around in case we need to resend it:
6683 * we need the handshake and transform structures for that */
6684 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6685 }
6686 else
6687#endif
6688 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6689
6690 ssl->state++;
6691
6692 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6693}
6694
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006695int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6696{
6697 int ret, hash_len;
6698
6699 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6700
6701 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6702
6703 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6704
6705 /*
6706 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6707 * may define some other value. Currently (early 2016), no defined
6708 * ciphersuite does this (and this is unlikely to change as activity has
6709 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6710 */
6711 hash_len = 12;
6712
6713#if defined(MBEDTLS_SSL_RENEGOTIATION)
6714 ssl->verify_data_len = hash_len;
6715 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6716#endif
6717
6718 ssl->out_msglen = 4 + hash_len;
6719 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6720 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6721
6722 /*
6723 * In case of session resuming, invert the client and server
6724 * ChangeCipherSpec messages order.
6725 */
6726 if( ssl->handshake->resume != 0 )
6727 {
6728#if defined(MBEDTLS_SSL_CLI_C)
6729 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6730 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6731#endif
6732#if defined(MBEDTLS_SSL_SRV_C)
6733 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6734 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6735#endif
6736 }
6737 else
6738 ssl->state++;
6739
6740 /*
6741 * Switch to our negotiated transform and session parameters for outbound
6742 * data.
6743 */
6744 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6745
6746#if defined(MBEDTLS_SSL_PROTO_DTLS)
6747 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6748 {
6749 unsigned char i;
6750
6751 /* Remember current epoch settings for resending */
6752 ssl->handshake->alt_transform_out = ssl->transform_out;
6753 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6754 sizeof( ssl->handshake->alt_out_ctr ) );
6755
6756 /* Set sequence_number to zero */
6757 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6758
6759
6760 /* Increment epoch */
6761 for( i = 2; i > 0; i-- )
6762 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6763 break;
6764
6765 /* The loop goes to its end iff the counter is wrapping */
6766 if( i == 0 )
6767 {
6768 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6769 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6770 }
6771 }
6772 else
6773#endif /* MBEDTLS_SSL_PROTO_DTLS */
6774 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6775
6776 ssl->transform_out = ssl->transform_negotiate;
6777 ssl->session_out = ssl->session_negotiate;
6778
6779#if defined(MBEDTLS_SSL_PROTO_DTLS)
6780 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6781 mbedtls_ssl_send_flight_completed( ssl );
6782#endif
6783
6784 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6785 {
6786 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6787 return( ret );
6788 }
6789
6790#if defined(MBEDTLS_SSL_PROTO_DTLS)
6791 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6792 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6793 {
6794 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6795 return( ret );
6796 }
6797#endif
6798
6799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6800
6801 return( 0 );
6802}
6803
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006804#define SSL_MAX_HASH_LEN 12
6805
6806int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6807{
6808 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6809 unsigned int hash_len = 12;
6810 unsigned char buf[SSL_MAX_HASH_LEN];
6811
6812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6813
6814 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6815
6816 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6817 {
6818 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6819 goto exit;
6820 }
6821
6822 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6823 {
6824 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6825 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6826 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6827 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6828 goto exit;
6829 }
6830
6831 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6832 {
6833 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6834 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6835 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6836 goto exit;
6837 }
6838
6839 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6840 {
6841 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6842 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6843 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6844 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6845 goto exit;
6846 }
6847
6848 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6849 buf, hash_len ) != 0 )
6850 {
6851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6852 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6853 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6854 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6855 goto exit;
6856 }
6857
6858#if defined(MBEDTLS_SSL_RENEGOTIATION)
6859 ssl->verify_data_len = hash_len;
6860 memcpy( ssl->peer_verify_data, buf, hash_len );
6861#endif
6862
6863 if( ssl->handshake->resume != 0 )
6864 {
6865#if defined(MBEDTLS_SSL_CLI_C)
6866 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6867 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6868#endif
6869#if defined(MBEDTLS_SSL_SRV_C)
6870 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6871 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6872#endif
6873 }
6874 else
6875 ssl->state++;
6876
6877#if defined(MBEDTLS_SSL_PROTO_DTLS)
6878 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6879 mbedtls_ssl_recv_flight_completed( ssl );
6880#endif
6881
6882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6883
6884exit:
6885 mbedtls_platform_zeroize( buf, hash_len );
6886 return( ret );
6887}
6888
Jerry Yu392112c2022-02-17 14:34:10 +08006889#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6890/*
6891 * Helper to get TLS 1.2 PRF from ciphersuite
6892 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6893 */
6894static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6895{
6896#if defined(MBEDTLS_SHA384_C)
6897 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6898 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6899
6900 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6901 return( tls_prf_sha384 );
6902#else
6903 (void) ciphersuite_id;
6904#endif
6905 return( tls_prf_sha256 );
6906}
6907#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006908
6909static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6910{
6911 ((void) tls_prf);
6912#if defined(MBEDTLS_SHA384_C)
6913 if( tls_prf == tls_prf_sha384 )
6914 {
6915 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6916 }
6917 else
6918#endif
6919#if defined(MBEDTLS_SHA256_C)
6920 if( tls_prf == tls_prf_sha256 )
6921 {
6922 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6923 }
6924 else
6925#endif
6926 return( MBEDTLS_SSL_TLS_PRF_NONE );
6927}
6928
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006929/*
6930 * Populate a transform structure with session keys and all the other
6931 * necessary information.
6932 *
6933 * Parameters:
6934 * - [in/out]: transform: structure to populate
6935 * [in] must be just initialised with mbedtls_ssl_transform_init()
6936 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6937 * - [in] ciphersuite
6938 * - [in] master
6939 * - [in] encrypt_then_mac
6940 * - [in] compression
6941 * - [in] tls_prf: pointer to PRF to use for key derivation
6942 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006943 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006944 * - [in] endpoint: client or server
6945 * - [in] ssl: used for:
6946 * - ssl->conf->{f,p}_export_keys
6947 * [in] optionally used for:
6948 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6949 */
6950static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6951 int ciphersuite,
6952 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006953#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006954 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006955#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006956 ssl_tls_prf_t tls_prf,
6957 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006958 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006959 unsigned endpoint,
6960 const mbedtls_ssl_context *ssl )
6961{
6962 int ret = 0;
6963 unsigned char keyblk[256];
6964 unsigned char *key1;
6965 unsigned char *key2;
6966 unsigned char *mac_enc;
6967 unsigned char *mac_dec;
6968 size_t mac_key_len = 0;
6969 size_t iv_copy_len;
6970 size_t keylen;
6971 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02006972 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01006973#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02006974 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006975 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006976#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006977
6978#if defined(MBEDTLS_USE_PSA_CRYPTO)
6979 psa_key_type_t key_type;
6980 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6981 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006982 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006983 size_t key_bits;
6984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6985#endif
6986
6987#if !defined(MBEDTLS_DEBUG_C) && \
6988 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6989 if( ssl->f_export_keys == NULL )
6990 {
6991 ssl = NULL; /* make sure we don't use it except for these cases */
6992 (void) ssl;
6993 }
6994#endif
6995
6996 /*
6997 * Some data just needs copying into the structure
6998 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006999#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007000 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007001#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007002 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007003
7004#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7005 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7006#endif
7007
7008#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007009 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007010 {
7011 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7012 * generation separate. This should never happen. */
7013 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7014 }
7015#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7016
7017 /*
7018 * Get various info structures
7019 */
7020 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7021 if( ciphersuite_info == NULL )
7022 {
7023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7024 ciphersuite ) );
7025 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7026 }
7027
Neil Armstrongab555e02022-04-04 11:07:59 +02007028 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007029#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007030 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007031#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007032 ciphersuite_info );
7033
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007034 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7035 transform->taglen =
7036 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7037
7038#if defined(MBEDTLS_USE_PSA_CRYPTO)
7039 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7040 transform->taglen,
7041 &alg,
7042 &key_type,
7043 &key_bits ) ) != PSA_SUCCESS )
7044 {
7045 ret = psa_ssl_status_to_mbedtls( status );
7046 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7047 goto end;
7048 }
7049#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007050 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7051 if( cipher_info == NULL )
7052 {
7053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7054 ciphersuite_info->cipher ) );
7055 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7056 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007057#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007058
Neil Armstronge4512952022-03-08 09:08:22 +01007059#if defined(MBEDTLS_USE_PSA_CRYPTO)
7060 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7061 if( mac_alg == 0 )
7062 {
7063 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7064 (unsigned) ciphersuite_info->mac ) );
7065 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7066 }
7067#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007068 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7069 if( md_info == NULL )
7070 {
7071 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7072 (unsigned) ciphersuite_info->mac ) );
7073 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7074 }
Neil Armstronge4512952022-03-08 09:08:22 +01007075#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007076
7077#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7078 /* Copy own and peer's CID if the use of the CID
7079 * extension has been negotiated. */
7080 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7081 {
7082 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7083
7084 transform->in_cid_len = ssl->own_cid_len;
7085 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7086 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7087 transform->in_cid_len );
7088
7089 transform->out_cid_len = ssl->handshake->peer_cid_len;
7090 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7091 ssl->handshake->peer_cid_len );
7092 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7093 transform->out_cid_len );
7094 }
7095#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7096
7097 /*
7098 * Compute key block using the PRF
7099 */
7100 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7101 if( ret != 0 )
7102 {
7103 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7104 return( ret );
7105 }
7106
7107 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7108 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7109 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7110 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7111 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7112
7113 /*
7114 * Determine the appropriate key, IV and MAC length.
7115 */
7116
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007117#if defined(MBEDTLS_USE_PSA_CRYPTO)
7118 keylen = PSA_BITS_TO_BYTES(key_bits);
7119#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007120 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007121#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007122
7123#if defined(MBEDTLS_GCM_C) || \
7124 defined(MBEDTLS_CCM_C) || \
7125 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007126 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007127 {
7128 size_t explicit_ivlen;
7129
7130 transform->maclen = 0;
7131 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007132
7133 /* All modes haves 96-bit IVs, but the length of the static parts vary
7134 * with mode and version:
7135 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7136 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7137 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7138 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7139 * sequence number).
7140 */
7141 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007142#if defined(MBEDTLS_USE_PSA_CRYPTO)
7143 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7144#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007145 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007146#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007147 transform->fixed_ivlen = 12;
7148 else
7149 transform->fixed_ivlen = 4;
7150
7151 /* Minimum length of encrypted record */
7152 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7153 transform->minlen = explicit_ivlen + transform->taglen;
7154 }
7155 else
7156#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7157#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007158 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7159 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7160 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007161 {
Neil Armstronge4512952022-03-08 09:08:22 +01007162#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007163 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007164#else
7165 size_t block_size = cipher_info->block_size;
7166#endif /* MBEDTLS_USE_PSA_CRYPTO */
7167
7168#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007169 /* Get MAC length */
7170 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7171#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007172 /* Initialize HMAC contexts */
7173 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7174 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7175 {
7176 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7177 goto end;
7178 }
7179
7180 /* Get MAC length */
7181 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007182#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007183 transform->maclen = mac_key_len;
7184
7185 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007186#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007187 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007188#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007189 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007190#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007191
7192 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007193 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007194 transform->minlen = transform->maclen;
7195 else
7196 {
7197 /*
7198 * GenericBlockCipher:
7199 * 1. if EtM is in use: one block plus MAC
7200 * otherwise: * first multiple of blocklen greater than maclen
7201 * 2. IV
7202 */
7203#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007204 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007205 {
7206 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007207 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007208 }
7209 else
7210#endif
7211 {
7212 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007213 + block_size
7214 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007215 }
7216
Glenn Strauss07c64162022-03-14 12:34:51 -04007217 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007218 {
7219 transform->minlen += transform->ivlen;
7220 }
7221 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007222 {
7223 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7224 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7225 goto end;
7226 }
7227 }
7228 }
7229 else
7230#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7231 {
7232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7233 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7234 }
7235
7236 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7237 (unsigned) keylen,
7238 (unsigned) transform->minlen,
7239 (unsigned) transform->ivlen,
7240 (unsigned) transform->maclen ) );
7241
7242 /*
7243 * Finally setup the cipher contexts, IVs and MAC secrets.
7244 */
7245#if defined(MBEDTLS_SSL_CLI_C)
7246 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7247 {
7248 key1 = keyblk + mac_key_len * 2;
7249 key2 = keyblk + mac_key_len * 2 + keylen;
7250
7251 mac_enc = keyblk;
7252 mac_dec = keyblk + mac_key_len;
7253
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007254 iv_copy_len = ( transform->fixed_ivlen ) ?
7255 transform->fixed_ivlen : transform->ivlen;
7256 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7257 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7258 iv_copy_len );
7259 }
7260 else
7261#endif /* MBEDTLS_SSL_CLI_C */
7262#if defined(MBEDTLS_SSL_SRV_C)
7263 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7264 {
7265 key1 = keyblk + mac_key_len * 2 + keylen;
7266 key2 = keyblk + mac_key_len * 2;
7267
7268 mac_enc = keyblk + mac_key_len;
7269 mac_dec = keyblk;
7270
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007271 iv_copy_len = ( transform->fixed_ivlen ) ?
7272 transform->fixed_ivlen : transform->ivlen;
7273 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7274 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7275 iv_copy_len );
7276 }
7277 else
7278#endif /* MBEDTLS_SSL_SRV_C */
7279 {
7280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7281 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7282 goto end;
7283 }
7284
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007285 if( ssl != NULL && ssl->f_export_keys != NULL )
7286 {
7287 ssl->f_export_keys( ssl->p_export_keys,
7288 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7289 master, 48,
7290 randbytes + 32,
7291 randbytes,
7292 tls_prf_get_type( tls_prf ) );
7293 }
7294
7295#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007296 transform->psa_alg = alg;
7297
7298 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7299 {
7300 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7301 psa_set_key_algorithm( &attributes, alg );
7302 psa_set_key_type( &attributes, key_type );
7303
7304 if( ( status = psa_import_key( &attributes,
7305 key1,
7306 PSA_BITS_TO_BYTES( key_bits ),
7307 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7308 {
7309 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7310 ret = psa_ssl_status_to_mbedtls( status );
7311 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7312 goto end;
7313 }
7314
7315 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7316
7317 if( ( status = psa_import_key( &attributes,
7318 key2,
7319 PSA_BITS_TO_BYTES( key_bits ),
7320 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7321 {
7322 ret = psa_ssl_status_to_mbedtls( status );
7323 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7324 goto end;
7325 }
7326 }
7327#else
7328 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7329 cipher_info ) ) != 0 )
7330 {
7331 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7332 goto end;
7333 }
7334
7335 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7336 cipher_info ) ) != 0 )
7337 {
7338 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7339 goto end;
7340 }
7341
7342 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7343 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7344 MBEDTLS_ENCRYPT ) ) != 0 )
7345 {
7346 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7347 goto end;
7348 }
7349
7350 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7351 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7352 MBEDTLS_DECRYPT ) ) != 0 )
7353 {
7354 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7355 goto end;
7356 }
7357
7358#if defined(MBEDTLS_CIPHER_MODE_CBC)
7359 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7360 {
7361 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7362 MBEDTLS_PADDING_NONE ) ) != 0 )
7363 {
7364 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7365 goto end;
7366 }
7367
7368 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7369 MBEDTLS_PADDING_NONE ) ) != 0 )
7370 {
7371 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7372 goto end;
7373 }
7374 }
7375#endif /* MBEDTLS_CIPHER_MODE_CBC */
7376#endif /* MBEDTLS_USE_PSA_CRYPTO */
7377
Neil Armstrong29c0c042022-03-17 17:47:28 +01007378#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7379 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7380 For AEAD-based ciphersuites, there is nothing to do here. */
7381 if( mac_key_len != 0 )
7382 {
7383#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007384 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007385
7386 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007387 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007388 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7389
7390 if( ( status = psa_import_key( &attributes,
7391 mac_enc, mac_key_len,
7392 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7393 {
7394 ret = psa_ssl_status_to_mbedtls( status );
7395 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7396 goto end;
7397 }
7398
Ronald Cronfb39f152022-03-25 14:36:28 +01007399 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7400 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7401 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007402 /* mbedtls_ct_hmac() requires the key to be exportable */
7403 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7404 PSA_KEY_USAGE_VERIFY_HASH );
7405 else
7406 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7407
7408 if( ( status = psa_import_key( &attributes,
7409 mac_dec, mac_key_len,
7410 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7411 {
7412 ret = psa_ssl_status_to_mbedtls( status );
7413 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7414 goto end;
7415 }
7416#else
7417 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7418 if( ret != 0 )
7419 goto end;
7420 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7421 if( ret != 0 )
7422 goto end;
7423#endif /* MBEDTLS_USE_PSA_CRYPTO */
7424 }
7425#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7426
7427 ((void) mac_dec);
7428 ((void) mac_enc);
7429
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007430end:
7431 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7432 return( ret );
7433}
7434
Jerry Yuee40f9d2022-02-17 14:55:16 +08007435#if defined(MBEDTLS_USE_PSA_CRYPTO)
7436int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7437 unsigned char *hash, size_t *hashlen,
7438 unsigned char *data, size_t data_len,
7439 mbedtls_md_type_t md_alg )
7440{
7441 psa_status_t status;
7442 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7443 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7444
7445 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7446
7447 if( ( status = psa_hash_setup( &hash_operation,
7448 hash_alg ) ) != PSA_SUCCESS )
7449 {
7450 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7451 goto exit;
7452 }
7453
7454 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7455 64 ) ) != PSA_SUCCESS )
7456 {
7457 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7458 goto exit;
7459 }
7460
7461 if( ( status = psa_hash_update( &hash_operation,
7462 data, data_len ) ) != PSA_SUCCESS )
7463 {
7464 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7465 goto exit;
7466 }
7467
7468 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7469 hashlen ) ) != PSA_SUCCESS )
7470 {
7471 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7472 goto exit;
7473 }
7474
7475exit:
7476 if( status != PSA_SUCCESS )
7477 {
7478 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7479 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7480 switch( status )
7481 {
7482 case PSA_ERROR_NOT_SUPPORTED:
7483 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7484 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7485 case PSA_ERROR_BUFFER_TOO_SMALL:
7486 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7487 case PSA_ERROR_INSUFFICIENT_MEMORY:
7488 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7489 default:
7490 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7491 }
7492 }
7493 return( 0 );
7494}
7495
7496#else
7497
7498int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7499 unsigned char *hash, size_t *hashlen,
7500 unsigned char *data, size_t data_len,
7501 mbedtls_md_type_t md_alg )
7502{
7503 int ret = 0;
7504 mbedtls_md_context_t ctx;
7505 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7506 *hashlen = mbedtls_md_get_size( md_info );
7507
7508 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7509
7510 mbedtls_md_init( &ctx );
7511
7512 /*
7513 * digitally-signed struct {
7514 * opaque client_random[32];
7515 * opaque server_random[32];
7516 * ServerDHParams params;
7517 * };
7518 */
7519 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7520 {
7521 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7522 goto exit;
7523 }
7524 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7525 {
7526 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7527 goto exit;
7528 }
7529 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7530 {
7531 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7532 goto exit;
7533 }
7534 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7535 {
7536 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7537 goto exit;
7538 }
7539 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7540 {
7541 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7542 goto exit;
7543 }
7544
7545exit:
7546 mbedtls_md_free( &ctx );
7547
7548 if( ret != 0 )
7549 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7550 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7551
7552 return( ret );
7553}
7554#endif /* MBEDTLS_USE_PSA_CRYPTO */
7555
Jerry Yud9d91da2022-02-17 14:57:06 +08007556#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7557
7558/* Find an entry in a signature-hash set matching a given hash algorithm. */
7559mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7560 mbedtls_pk_type_t sig_alg )
7561{
7562 switch( sig_alg )
7563 {
7564 case MBEDTLS_PK_RSA:
7565 return( set->rsa );
7566 case MBEDTLS_PK_ECDSA:
7567 return( set->ecdsa );
7568 default:
7569 return( MBEDTLS_MD_NONE );
7570 }
7571}
7572
7573/* Add a signature-hash-pair to a signature-hash set */
7574void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7575 mbedtls_pk_type_t sig_alg,
7576 mbedtls_md_type_t md_alg )
7577{
7578 switch( sig_alg )
7579 {
7580 case MBEDTLS_PK_RSA:
7581 if( set->rsa == MBEDTLS_MD_NONE )
7582 set->rsa = md_alg;
7583 break;
7584
7585 case MBEDTLS_PK_ECDSA:
7586 if( set->ecdsa == MBEDTLS_MD_NONE )
7587 set->ecdsa = md_alg;
7588 break;
7589
7590 default:
7591 break;
7592 }
7593}
7594
7595/* Allow exactly one hash algorithm for each signature. */
7596void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7597 mbedtls_md_type_t md_alg )
7598{
7599 set->rsa = md_alg;
7600 set->ecdsa = md_alg;
7601}
7602
7603#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7604
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007605/* Serialization of TLS 1.2 sessions:
7606 *
7607 * struct {
7608 * uint64 start_time;
7609 * uint8 ciphersuite[2]; // defined by the standard
7610 * uint8 compression; // 0 or 1
7611 * uint8 session_id_len; // at most 32
7612 * opaque session_id[32];
7613 * opaque master[48]; // fixed length in the standard
7614 * uint32 verify_result;
7615 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7616 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7617 * uint32 ticket_lifetime;
7618 * uint8 mfl_code; // up to 255 according to standard
7619 * uint8 encrypt_then_mac; // 0 or 1
7620 * } serialized_session_tls12;
7621 *
7622 */
7623static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7624 unsigned char *buf,
7625 size_t buf_len )
7626{
7627 unsigned char *p = buf;
7628 size_t used = 0;
7629
7630#if defined(MBEDTLS_HAVE_TIME)
7631 uint64_t start;
7632#endif
7633#if defined(MBEDTLS_X509_CRT_PARSE_C)
7634#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7635 size_t cert_len;
7636#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7637#endif /* MBEDTLS_X509_CRT_PARSE_C */
7638
7639 /*
7640 * Time
7641 */
7642#if defined(MBEDTLS_HAVE_TIME)
7643 used += 8;
7644
7645 if( used <= buf_len )
7646 {
7647 start = (uint64_t) session->start;
7648
7649 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7650 p += 8;
7651 }
7652#endif /* MBEDTLS_HAVE_TIME */
7653
7654 /*
7655 * Basic mandatory fields
7656 */
7657 used += 2 /* ciphersuite */
7658 + 1 /* compression */
7659 + 1 /* id_len */
7660 + sizeof( session->id )
7661 + sizeof( session->master )
7662 + 4; /* verify_result */
7663
7664 if( used <= buf_len )
7665 {
7666 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7667 p += 2;
7668
7669 *p++ = MBEDTLS_BYTE_0( session->compression );
7670
7671 *p++ = MBEDTLS_BYTE_0( session->id_len );
7672 memcpy( p, session->id, 32 );
7673 p += 32;
7674
7675 memcpy( p, session->master, 48 );
7676 p += 48;
7677
7678 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7679 p += 4;
7680 }
7681
7682 /*
7683 * Peer's end-entity certificate
7684 */
7685#if defined(MBEDTLS_X509_CRT_PARSE_C)
7686#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7687 if( session->peer_cert == NULL )
7688 cert_len = 0;
7689 else
7690 cert_len = session->peer_cert->raw.len;
7691
7692 used += 3 + cert_len;
7693
7694 if( used <= buf_len )
7695 {
7696 *p++ = MBEDTLS_BYTE_2( cert_len );
7697 *p++ = MBEDTLS_BYTE_1( cert_len );
7698 *p++ = MBEDTLS_BYTE_0( cert_len );
7699
7700 if( session->peer_cert != NULL )
7701 {
7702 memcpy( p, session->peer_cert->raw.p, cert_len );
7703 p += cert_len;
7704 }
7705 }
7706#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7707 if( session->peer_cert_digest != NULL )
7708 {
7709 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7710 if( used <= buf_len )
7711 {
7712 *p++ = (unsigned char) session->peer_cert_digest_type;
7713 *p++ = (unsigned char) session->peer_cert_digest_len;
7714 memcpy( p, session->peer_cert_digest,
7715 session->peer_cert_digest_len );
7716 p += session->peer_cert_digest_len;
7717 }
7718 }
7719 else
7720 {
7721 used += 2;
7722 if( used <= buf_len )
7723 {
7724 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7725 *p++ = 0;
7726 }
7727 }
7728#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7729#endif /* MBEDTLS_X509_CRT_PARSE_C */
7730
7731 /*
7732 * Session ticket if any, plus associated data
7733 */
7734#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7735 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7736
7737 if( used <= buf_len )
7738 {
7739 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7740 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7741 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7742
7743 if( session->ticket != NULL )
7744 {
7745 memcpy( p, session->ticket, session->ticket_len );
7746 p += session->ticket_len;
7747 }
7748
7749 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7750 p += 4;
7751 }
7752#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7753
7754 /*
7755 * Misc extension-related info
7756 */
7757#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7758 used += 1;
7759
7760 if( used <= buf_len )
7761 *p++ = session->mfl_code;
7762#endif
7763
7764#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7765 used += 1;
7766
7767 if( used <= buf_len )
7768 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7769#endif
7770
7771 return( used );
7772}
7773
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007774static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7775 const unsigned char *buf,
7776 size_t len )
7777{
7778#if defined(MBEDTLS_HAVE_TIME)
7779 uint64_t start;
7780#endif
7781#if defined(MBEDTLS_X509_CRT_PARSE_C)
7782#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7783 size_t cert_len;
7784#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7785#endif /* MBEDTLS_X509_CRT_PARSE_C */
7786
7787 const unsigned char *p = buf;
7788 const unsigned char * const end = buf + len;
7789
7790 /*
7791 * Time
7792 */
7793#if defined(MBEDTLS_HAVE_TIME)
7794 if( 8 > (size_t)( end - p ) )
7795 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7796
7797 start = ( (uint64_t) p[0] << 56 ) |
7798 ( (uint64_t) p[1] << 48 ) |
7799 ( (uint64_t) p[2] << 40 ) |
7800 ( (uint64_t) p[3] << 32 ) |
7801 ( (uint64_t) p[4] << 24 ) |
7802 ( (uint64_t) p[5] << 16 ) |
7803 ( (uint64_t) p[6] << 8 ) |
7804 ( (uint64_t) p[7] );
7805 p += 8;
7806
7807 session->start = (time_t) start;
7808#endif /* MBEDTLS_HAVE_TIME */
7809
7810 /*
7811 * Basic mandatory fields
7812 */
7813 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7814 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7815
7816 session->ciphersuite = ( p[0] << 8 ) | p[1];
7817 p += 2;
7818
7819 session->compression = *p++;
7820
7821 session->id_len = *p++;
7822 memcpy( session->id, p, 32 );
7823 p += 32;
7824
7825 memcpy( session->master, p, 48 );
7826 p += 48;
7827
7828 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7829 ( (uint32_t) p[1] << 16 ) |
7830 ( (uint32_t) p[2] << 8 ) |
7831 ( (uint32_t) p[3] );
7832 p += 4;
7833
7834 /* Immediately clear invalid pointer values that have been read, in case
7835 * we exit early before we replaced them with valid ones. */
7836#if defined(MBEDTLS_X509_CRT_PARSE_C)
7837#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7838 session->peer_cert = NULL;
7839#else
7840 session->peer_cert_digest = NULL;
7841#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7842#endif /* MBEDTLS_X509_CRT_PARSE_C */
7843#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7844 session->ticket = NULL;
7845#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7846
7847 /*
7848 * Peer certificate
7849 */
7850#if defined(MBEDTLS_X509_CRT_PARSE_C)
7851#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7852 /* Deserialize CRT from the end of the ticket. */
7853 if( 3 > (size_t)( end - p ) )
7854 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7855
7856 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7857 p += 3;
7858
7859 if( cert_len != 0 )
7860 {
7861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7862
7863 if( cert_len > (size_t)( end - p ) )
7864 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7865
7866 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7867
7868 if( session->peer_cert == NULL )
7869 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7870
7871 mbedtls_x509_crt_init( session->peer_cert );
7872
7873 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7874 p, cert_len ) ) != 0 )
7875 {
7876 mbedtls_x509_crt_free( session->peer_cert );
7877 mbedtls_free( session->peer_cert );
7878 session->peer_cert = NULL;
7879 return( ret );
7880 }
7881
7882 p += cert_len;
7883 }
7884#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7885 /* Deserialize CRT digest from the end of the ticket. */
7886 if( 2 > (size_t)( end - p ) )
7887 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7888
7889 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7890 session->peer_cert_digest_len = (size_t) *p++;
7891
7892 if( session->peer_cert_digest_len != 0 )
7893 {
7894 const mbedtls_md_info_t *md_info =
7895 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7896 if( md_info == NULL )
7897 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7898 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7899 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7900
7901 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7902 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7903
7904 session->peer_cert_digest =
7905 mbedtls_calloc( 1, session->peer_cert_digest_len );
7906 if( session->peer_cert_digest == NULL )
7907 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7908
7909 memcpy( session->peer_cert_digest, p,
7910 session->peer_cert_digest_len );
7911 p += session->peer_cert_digest_len;
7912 }
7913#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7914#endif /* MBEDTLS_X509_CRT_PARSE_C */
7915
7916 /*
7917 * Session ticket and associated data
7918 */
7919#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7920 if( 3 > (size_t)( end - p ) )
7921 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7922
7923 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7924 p += 3;
7925
7926 if( session->ticket_len != 0 )
7927 {
7928 if( session->ticket_len > (size_t)( end - p ) )
7929 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7930
7931 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7932 if( session->ticket == NULL )
7933 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7934
7935 memcpy( session->ticket, p, session->ticket_len );
7936 p += session->ticket_len;
7937 }
7938
7939 if( 4 > (size_t)( end - p ) )
7940 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7941
7942 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7943 ( (uint32_t) p[1] << 16 ) |
7944 ( (uint32_t) p[2] << 8 ) |
7945 ( (uint32_t) p[3] );
7946 p += 4;
7947#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7948
7949 /*
7950 * Misc extension-related info
7951 */
7952#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7953 if( 1 > (size_t)( end - p ) )
7954 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7955
7956 session->mfl_code = *p++;
7957#endif
7958
7959#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7960 if( 1 > (size_t)( end - p ) )
7961 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7962
7963 session->encrypt_then_mac = *p++;
7964#endif
7965
7966 /* Done, should have consumed entire buffer */
7967 if( p != end )
7968 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7969
7970 return( 0 );
7971}
Jerry Yudc7bd172022-02-17 13:44:15 +08007972#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7973
XiaokangQian75d40ef2022-04-20 11:05:24 +00007974int mbedtls_ssl_validate_ciphersuite(
7975 const mbedtls_ssl_context *ssl,
7976 const mbedtls_ssl_ciphersuite_t *suite_info,
7977 mbedtls_ssl_protocol_version min_tls_version,
7978 mbedtls_ssl_protocol_version max_tls_version )
7979{
7980 (void) ssl;
7981
7982 if( suite_info == NULL )
7983 return( -1 );
7984
7985 if( ( suite_info->min_tls_version > max_tls_version ) ||
7986 ( suite_info->max_tls_version < min_tls_version ) )
7987 {
7988 return( -1 );
7989 }
7990
XiaokangQian060d8672022-04-21 09:24:56 +00007991#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00007992#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7993 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
7994 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
7995 {
7996 return( -1 );
7997 }
7998#endif
7999
8000 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8001#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8002 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8003 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8004 {
8005 return( -1 );
8006 }
8007#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8008#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8009
8010 return( 0 );
8011}
8012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008013#endif /* MBEDTLS_SSL_TLS_C */