blob: b3f132d6f4c490cc54949291cad022bbe56948fc [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
387 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
388 int encrypt_then_mac,
389#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
390 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
391 ssl_tls_prf_t tls_prf,
392 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400393 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800394 unsigned endpoint,
395 const mbedtls_ssl_context *ssl );
396
397#if defined(MBEDTLS_SHA256_C)
398static int tls_prf_sha256( const unsigned char *secret, size_t slen,
399 const char *label,
400 const unsigned char *random, size_t rlen,
401 unsigned char *dstbuf, size_t dlen );
402static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
403static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
404
405#endif /* MBEDTLS_SHA256_C */
406
407#if defined(MBEDTLS_SHA384_C)
408static int tls_prf_sha384( const unsigned char *secret, size_t slen,
409 const char *label,
410 const unsigned char *random, size_t rlen,
411 unsigned char *dstbuf, size_t dlen );
412
413static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
414static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
415#endif /* MBEDTLS_SHA384_C */
416
417static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
418 unsigned char *buf,
419 size_t buf_len );
420static int ssl_session_load_tls12( mbedtls_ssl_session *session,
421 const unsigned char *buf,
422 size_t len );
423#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
424
Jerry Yu53d23e22022-02-09 16:25:09 +0800425static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
426
Jerry Yudb8c48a2022-01-27 14:54:54 +0800427#if defined(MBEDTLS_SHA256_C)
428static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800429#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800430
431#if defined(MBEDTLS_SHA384_C)
432static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800433#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000434
Ron Eldor51d3ab52019-05-12 14:54:30 +0300435int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
436 const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen )
440{
441 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
442
443 switch( prf )
444 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200446#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300447 case MBEDTLS_SSL_TLS_PRF_SHA384:
448 tls_prf = tls_prf_sha384;
449 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200450#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300451#if defined(MBEDTLS_SHA256_C)
452 case MBEDTLS_SSL_TLS_PRF_SHA256:
453 tls_prf = tls_prf_sha256;
454 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300455#endif /* MBEDTLS_SHA256_C */
456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300457 default:
458 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
459 }
460
461 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
462}
463
Jerry Yuc73c6182022-02-08 20:29:25 +0800464#if defined(MBEDTLS_X509_CRT_PARSE_C)
465static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
466{
467#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
468 if( session->peer_cert != NULL )
469 {
470 mbedtls_x509_crt_free( session->peer_cert );
471 mbedtls_free( session->peer_cert );
472 session->peer_cert = NULL;
473 }
474#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
475 if( session->peer_cert_digest != NULL )
476 {
477 /* Zeroization is not necessary. */
478 mbedtls_free( session->peer_cert_digest );
479 session->peer_cert_digest = NULL;
480 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
481 session->peer_cert_digest_len = 0;
482 }
483#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
484}
485#endif /* MBEDTLS_X509_CRT_PARSE_C */
486
487void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
488 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
489{
490 ((void) ciphersuite_info);
491
492#if defined(MBEDTLS_SHA384_C)
493 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
494 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
495 else
496#endif
497#if defined(MBEDTLS_SHA256_C)
498 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
499 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
500 else
501#endif
502 {
503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
504 return;
505 }
506}
507
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100508static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
509 unsigned hs_type,
510 size_t total_hs_len )
511{
512 unsigned char hs_hdr[4];
513
514 /* Build HS header for checksum update. */
515 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
516 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
517 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
518 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
519
520 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
521}
522
523void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
524 unsigned hs_type,
525 unsigned char const *msg,
526 size_t msg_len )
527{
528 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
529 ssl->handshake->update_checksum( ssl, msg, msg_len );
530}
531
Jerry Yuc73c6182022-02-08 20:29:25 +0800532void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
533{
534 ((void) ssl);
535#if defined(MBEDTLS_SHA256_C)
536#if defined(MBEDTLS_USE_PSA_CRYPTO)
537 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
538 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
539#else
540 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
541#endif
542#endif
543#if defined(MBEDTLS_SHA384_C)
544#if defined(MBEDTLS_USE_PSA_CRYPTO)
545 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
546 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
547#else
548 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
549#endif
550#endif
551}
552
553static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
554 const unsigned char *buf, size_t len )
555{
556#if defined(MBEDTLS_SHA256_C)
557#if defined(MBEDTLS_USE_PSA_CRYPTO)
558 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
559#else
560 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
561#endif
562#endif
563#if defined(MBEDTLS_SHA384_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
566#else
567 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
568#endif
569#endif
570}
571
572#if defined(MBEDTLS_SHA256_C)
573static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
574 const unsigned char *buf, size_t len )
575{
576#if defined(MBEDTLS_USE_PSA_CRYPTO)
577 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
578#else
579 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
580#endif
581}
582#endif
583
584#if defined(MBEDTLS_SHA384_C)
585static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
586 const unsigned char *buf, size_t len )
587{
588#if defined(MBEDTLS_USE_PSA_CRYPTO)
589 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
590#else
591 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
592#endif
593}
594#endif
595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500601#if defined(MBEDTLS_USE_PSA_CRYPTO)
602 handshake->fin_sha256_psa = psa_hash_operation_init();
603 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
604#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200606 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200607#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200609#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500610#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500611 handshake->fin_sha384_psa = psa_hash_operation_init();
612 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500613#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200615 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500617#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200618
619 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100620
621#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100622 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100623 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
624#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626#if defined(MBEDTLS_DHM_C)
627 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200628#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629#if defined(MBEDTLS_ECDH_C)
630 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200631#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200632#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200633 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200634#if defined(MBEDTLS_SSL_CLI_C)
635 handshake->ecjpake_cache = NULL;
636 handshake->ecjpake_cache_len = 0;
637#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200638#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200639
Gilles Peskineeccd8882020-03-10 12:19:08 +0100640#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200641 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200642#endif
643
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200644#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
645 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
646#endif
Hanno Becker75173122019-02-06 16:18:31 +0000647
648#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
649 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
650 mbedtls_pk_init( &handshake->peer_pubkey );
651#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200652}
653
Hanno Beckera18d1322018-01-03 14:27:32 +0000654void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200655{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200657
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100658#if defined(MBEDTLS_USE_PSA_CRYPTO)
659 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
660 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100661#else
662 mbedtls_cipher_init( &transform->cipher_ctx_enc );
663 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100664#endif
665
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000666#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100667#if defined(MBEDTLS_USE_PSA_CRYPTO)
668 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
669 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100670#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 mbedtls_md_init( &transform->md_ctx_enc );
672 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000673#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680}
681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000683{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000685 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200690 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200691
692 /*
693 * Either the pointers are now NULL or cleared properly and can be freed.
694 * Now allocate missing structures.
695 */
696 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200698 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200699 }
Paul Bakker48916f92012-09-16 19:57:18 +0000700
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200703 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200704 }
Paul Bakker48916f92012-09-16 19:57:18 +0000705
Paul Bakker82788fb2014-10-20 13:59:19 +0200706 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200708 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200709 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500710#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
711 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400712
Andrzej Kurek4a063792020-10-21 15:08:44 +0200713 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
714 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500715#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000716
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200717 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000718 if( ssl->handshake == NULL ||
719 ssl->transform_negotiate == NULL ||
720 ssl->session_negotiate == NULL )
721 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 mbedtls_free( ssl->handshake );
725 mbedtls_free( ssl->transform_negotiate );
726 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200727
728 ssl->handshake = NULL;
729 ssl->transform_negotiate = NULL;
730 ssl->session_negotiate = NULL;
731
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000733 }
734
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200735 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000737 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200738 ssl_handshake_params_init( ssl->handshake );
739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200741 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
742 {
743 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200744
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200745 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
747 else
748 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200749
Hanno Becker0f57a652020-02-05 10:37:26 +0000750 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200751 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200752#endif
753
Brett Warrene0edc842021-08-17 09:53:13 +0100754/*
755 * curve_list is translated to IANA TLS group identifiers here because
756 * mbedtls_ssl_conf_curves returns void and so can't return
757 * any error codes.
758 */
759#if defined(MBEDTLS_ECP_C)
760#if !defined(MBEDTLS_DEPRECATED_REMOVED)
761 /* Heap allocate and translate curve_list from internal to IANA group ids */
762 if ( ssl->conf->curve_list != NULL )
763 {
764 size_t length;
765 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
766
767 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
768 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
769
770 /* Leave room for zero termination */
771 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
772 if ( group_list == NULL )
773 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
774
775 for( size_t i = 0; i < length; i++ )
776 {
777 const mbedtls_ecp_curve_info *info =
778 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
779 if ( info == NULL )
780 {
781 mbedtls_free( group_list );
782 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
783 }
784 group_list[i] = info->tls_id;
785 }
786
787 group_list[length] = 0;
788
789 ssl->handshake->group_list = group_list;
790 ssl->handshake->group_list_heap_allocated = 1;
791 }
792 else
793 {
794 ssl->handshake->group_list = ssl->conf->group_list;
795 ssl->handshake->group_list_heap_allocated = 0;
796 }
797#endif /* MBEDTLS_DEPRECATED_REMOVED */
798#endif /* MBEDTLS_ECP_C */
799
Jerry Yuf017ee42022-01-12 15:49:48 +0800800#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
801#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800802#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800803 /* Heap allocate and translate sig_hashes from internal hash identifiers to
804 signature algorithms IANA identifiers. */
805 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800806 ssl->conf->sig_hashes != NULL )
807 {
808 const int *md;
809 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800810 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800811 uint16_t *p;
812
Jerry Yub476a442022-01-21 18:14:45 +0800813#if defined(static_assert)
814 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
815 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
816 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800817#endif
818
Jerry Yuf017ee42022-01-12 15:49:48 +0800819 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
820 {
821 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
822 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800823#if defined(MBEDTLS_ECDSA_C)
824 sig_algs_len += sizeof( uint16_t );
825#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800826
Jerry Yub476a442022-01-21 18:14:45 +0800827#if defined(MBEDTLS_RSA_C)
828 sig_algs_len += sizeof( uint16_t );
829#endif
830 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
831 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 }
833
Jerry Yub476a442022-01-21 18:14:45 +0800834 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
836
Jerry Yub476a442022-01-21 18:14:45 +0800837 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
838 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800839 if( ssl->handshake->sig_algs == NULL )
840 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
841
842 p = (uint16_t *)ssl->handshake->sig_algs;
843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
846 if( hash == MBEDTLS_SSL_HASH_NONE )
847 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
850 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800851#endif
852#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800853 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
854 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800855#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857 *p = MBEDTLS_TLS1_3_SIG_NONE;
858 ssl->handshake->sig_algs_heap_allocated = 1;
859 }
860 else
Jerry Yua69269a2022-01-17 21:06:01 +0800861#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800862 {
863 ssl->handshake->sig_algs = ssl->conf->sig_algs;
864 ssl->handshake->sig_algs_heap_allocated = 0;
865 }
866#endif /* MBEDTLS_DEPRECATED_REMOVED */
867#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000868 return( 0 );
869}
870
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200871#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200872/* Dummy cookie callbacks for defaults */
873static int ssl_cookie_write_dummy( void *ctx,
874 unsigned char **p, unsigned char *end,
875 const unsigned char *cli_id, size_t cli_id_len )
876{
877 ((void) ctx);
878 ((void) p);
879 ((void) end);
880 ((void) cli_id);
881 ((void) cli_id_len);
882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200884}
885
886static int ssl_cookie_check_dummy( void *ctx,
887 const unsigned char *cookie, size_t cookie_len,
888 const unsigned char *cli_id, size_t cli_id_len )
889{
890 ((void) ctx);
891 ((void) cookie);
892 ((void) cookie_len);
893 ((void) cli_id);
894 ((void) cli_id_len);
895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200898#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200899
Paul Bakker5121ce52009-01-03 21:22:43 +0000900/*
901 * Initialize an SSL context
902 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200903void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
904{
905 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
906}
907
Jerry Yu60835a82021-08-04 10:13:52 +0800908static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
909{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100910 const mbedtls_ssl_config *conf = ssl->conf;
911
Ronald Cron6f135e12021-12-08 16:57:54 +0100912#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100913 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
914 {
915 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jerry Yu60835a82021-08-04 10:13:52 +0800916 {
Ronald Cron086ee0b2022-03-15 15:18:51 +0100917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
Jerry Yu60835a82021-08-04 10:13:52 +0800918 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
919 }
Ronald Cron37bdaab2022-03-30 16:45:51 +0200920
921 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
922 {
923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
924 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
925 }
926
Jerry Yu60835a82021-08-04 10:13:52 +0800927 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
928 return( 0 );
929 }
930#endif
931
932#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100933 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800934 {
935 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
936 return( 0 );
937 }
938#endif
939
Ronald Cron6f135e12021-12-08 16:57:54 +0100940#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100941 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800942 {
Ronald Crone1d3f062022-02-10 14:50:54 +0100943 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
946 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
947 }
Ronald Cron37bdaab2022-03-30 16:45:51 +0200948
949 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
950 {
951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
952 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
953 }
954
Ronald Crone1d3f062022-02-10 14:50:54 +0100955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
956 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800957 }
958#endif
959
960 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
961 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
962}
963
964static int ssl_conf_check(const mbedtls_ssl_context *ssl)
965{
966 int ret;
967 ret = ssl_conf_version_check( ssl );
968 if( ret != 0 )
969 return( ret );
970
971 /* Space for further checks */
972
973 return( 0 );
974}
975
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200976/*
977 * Setup an SSL context
978 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100979
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200980int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200981 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000982{
Janos Follath865b3eb2019-12-16 11:46:15 +0000983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000984 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
985 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000986
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200987 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000988
Jerry Yu60835a82021-08-04 10:13:52 +0800989 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
990 return( ret );
991
Paul Bakker62f2dee2012-09-28 07:31:51 +0000992 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100993 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000994 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200995
996 /* Set to NULL in case of an error condition */
997 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200998
Darryl Greenb33cc762019-11-28 14:29:44 +0000999#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1000 ssl->in_buf_len = in_buf_len;
1001#endif
1002 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001003 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001006 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001007 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001008 }
1009
Darryl Greenb33cc762019-11-28 14:29:44 +00001010#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1011 ssl->out_buf_len = out_buf_len;
1012#endif
1013 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001014 if( ssl->out_buf == NULL )
1015 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001017 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001018 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001019 }
1020
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001021 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001022
Johan Pascalb62bb512015-12-03 21:56:45 +01001023#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001024 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001025#endif
1026
Paul Bakker48916f92012-09-16 19:57:18 +00001027 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001028 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001029
1030 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001031
1032error:
1033 mbedtls_free( ssl->in_buf );
1034 mbedtls_free( ssl->out_buf );
1035
1036 ssl->conf = NULL;
1037
Darryl Greenb33cc762019-11-28 14:29:44 +00001038#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1039 ssl->in_buf_len = 0;
1040 ssl->out_buf_len = 0;
1041#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001042 ssl->in_buf = NULL;
1043 ssl->out_buf = NULL;
1044
1045 ssl->in_hdr = NULL;
1046 ssl->in_ctr = NULL;
1047 ssl->in_len = NULL;
1048 ssl->in_iv = NULL;
1049 ssl->in_msg = NULL;
1050
1051 ssl->out_hdr = NULL;
1052 ssl->out_ctr = NULL;
1053 ssl->out_len = NULL;
1054 ssl->out_iv = NULL;
1055 ssl->out_msg = NULL;
1056
k-stachowiak9f7798e2018-07-31 16:52:32 +02001057 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001058}
1059
1060/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001061 * Reset an initialized and used SSL context for re-use while retaining
1062 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001063 *
1064 * If partial is non-zero, keep data in the input buffer and client ID.
1065 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001066 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001067void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1068 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001069{
Darryl Greenb33cc762019-11-28 14:29:44 +00001070#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1071 size_t in_buf_len = ssl->in_buf_len;
1072 size_t out_buf_len = ssl->out_buf_len;
1073#else
1074 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1075 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Hanno Beckerb0302c42021-08-03 09:39:42 +01001078#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1079 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001080#endif
1081
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001082 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001083 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001084
Hanno Beckerb0302c42021-08-03 09:39:42 +01001085 mbedtls_ssl_reset_in_out_pointers( ssl );
1086
1087 /* Reset incoming message parsing */
1088 ssl->in_offt = NULL;
1089 ssl->nb_zero = 0;
1090 ssl->in_msgtype = 0;
1091 ssl->in_msglen = 0;
1092 ssl->in_hslen = 0;
1093 ssl->keep_current_message = 0;
1094 ssl->transform_in = NULL;
1095
1096#if defined(MBEDTLS_SSL_PROTO_DTLS)
1097 ssl->next_record_offset = 0;
1098 ssl->in_epoch = 0;
1099#endif
1100
1101 /* Keep current datagram if partial == 1 */
1102 if( partial == 0 )
1103 {
1104 ssl->in_left = 0;
1105 memset( ssl->in_buf, 0, in_buf_len );
1106 }
1107
1108 /* Reset outgoing message writing */
1109 ssl->out_msgtype = 0;
1110 ssl->out_msglen = 0;
1111 ssl->out_left = 0;
1112 memset( ssl->out_buf, 0, out_buf_len );
1113 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1114 ssl->transform_out = NULL;
1115
1116#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1117 mbedtls_ssl_dtls_replay_reset( ssl );
1118#endif
1119
XiaokangQian2b01dc32022-01-21 02:53:13 +00001120#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001121 if( ssl->transform )
1122 {
1123 mbedtls_ssl_transform_free( ssl->transform );
1124 mbedtls_free( ssl->transform );
1125 ssl->transform = NULL;
1126 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001127#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1128
XiaokangQian2b01dc32022-01-21 02:53:13 +00001129#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1130 mbedtls_ssl_transform_free( ssl->transform_application );
1131 mbedtls_free( ssl->transform_application );
1132 ssl->transform_application = NULL;
1133
1134 if( ssl->handshake != NULL )
1135 {
1136 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1137 mbedtls_free( ssl->handshake->transform_earlydata );
1138 ssl->handshake->transform_earlydata = NULL;
1139
1140 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1141 mbedtls_free( ssl->handshake->transform_handshake );
1142 ssl->handshake->transform_handshake = NULL;
1143 }
1144
XiaokangQian2b01dc32022-01-21 02:53:13 +00001145#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001146}
1147
1148int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1149{
1150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1151
1152 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1153
XiaokangQian78b1fa72022-01-19 06:56:30 +00001154 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001155
1156 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157#if defined(MBEDTLS_SSL_RENEGOTIATION)
1158 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001159 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001160
1161 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1163 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001164#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001166
Hanno Beckerb0302c42021-08-03 09:39:42 +01001167 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001168 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001169 if( ssl->session )
1170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 mbedtls_ssl_session_free( ssl->session );
1172 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001173 ssl->session = NULL;
1174 }
1175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001177 ssl->alpn_chosen = NULL;
1178#endif
1179
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001180#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001181#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001182 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001183#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001184 {
1185 mbedtls_free( ssl->cli_id );
1186 ssl->cli_id = NULL;
1187 ssl->cli_id_len = 0;
1188 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001189#endif
1190
Paul Bakker48916f92012-09-16 19:57:18 +00001191 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1192 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001193
1194 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001195}
1196
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001197/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001198 * Reset an initialized and used SSL context for re-use while retaining
1199 * all application-set variables, function pointers and data.
1200 */
1201int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1202{
Hanno Becker43aefe22020-02-05 10:44:56 +00001203 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001204}
1205
1206/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001207 * SSL set accessors
1208 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001209void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001211 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001212}
1213
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001214void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001216 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001217}
1218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001220void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001221{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001222 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001223}
1224#endif
1225
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001226void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001227{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001228 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001229}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001232
Hanno Becker1841b0a2018-08-24 11:13:57 +01001233void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1234 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001235{
1236 ssl->disable_datagram_packing = !allow_packing;
1237}
1238
1239void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1240 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->hs_timeout_min = min;
1243 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001244}
1245#endif
1246
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001247void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001248{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001249 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001250}
1251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001253void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001254 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001255 void *p_vrfy )
1256{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001257 conf->f_vrfy = f_vrfy;
1258 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001259}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001261
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001262void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001263 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001264 void *p_rng )
1265{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001266 conf->f_rng = f_rng;
1267 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001268}
1269
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001270void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001271 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001272 void *p_dbg )
1273{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001274 conf->f_dbg = f_dbg;
1275 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001276}
1277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001279 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001280 mbedtls_ssl_send_t *f_send,
1281 mbedtls_ssl_recv_t *f_recv,
1282 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001283{
1284 ssl->p_bio = p_bio;
1285 ssl->f_send = f_send;
1286 ssl->f_recv = f_recv;
1287 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001288}
1289
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001290#if defined(MBEDTLS_SSL_PROTO_DTLS)
1291void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1292{
1293 ssl->mtu = mtu;
1294}
1295#endif
1296
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001297void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001298{
1299 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001300}
1301
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001302void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1303 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_set_timer_t *f_set_timer,
1305 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001306{
1307 ssl->p_timer = p_timer;
1308 ssl->f_set_timer = f_set_timer;
1309 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001310
1311 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001312 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001313}
1314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss2ed95272022-01-21 18:02:17 -05001316void mbedtls_ssl_conf_cert_cb( mbedtls_ssl_config *conf,
1317 int (*f_cert_cb)(mbedtls_ssl_context *) )
1318{
1319 conf->f_cert_cb = f_cert_cb;
1320}
1321#endif /* MBEDTLS_SSL_SRV_C */
1322
1323#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001324void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001325 void *p_cache,
1326 mbedtls_ssl_cache_get_t *f_get_cache,
1327 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001328{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001329 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001330 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001331 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001332}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#if defined(MBEDTLS_SSL_CLI_C)
1336int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001337{
Janos Follath865b3eb2019-12-16 11:46:15 +00001338 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001339
1340 if( ssl == NULL ||
1341 session == NULL ||
1342 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001343 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001346 }
1347
Hanno Beckere810bbc2021-05-14 16:01:05 +01001348 if( ssl->handshake->resume == 1 )
1349 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1350
Hanno Becker52055ae2019-02-06 14:30:46 +00001351 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1352 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001353 return( ret );
1354
Paul Bakker0a597072012-09-25 21:55:46 +00001355 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001356
1357 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001358}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001360
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001361void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1362 const int *ciphersuites )
1363{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001364 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001365}
1366
Ronald Cron6f135e12021-12-08 16:57:54 +01001367#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001368void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001369 const int kex_modes )
1370{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001371 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001372}
Ronald Cron6f135e12021-12-08 16:57:54 +01001373#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001376void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001377 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001378{
1379 conf->cert_profile = profile;
1380}
1381
Glenn Strauss36872db2022-01-22 05:06:31 -05001382static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1383{
1384 mbedtls_ssl_key_cert *cur = key_cert, *next;
1385
1386 while( cur != NULL )
1387 {
1388 next = cur->next;
1389 mbedtls_free( cur );
1390 cur = next;
1391 }
1392}
1393
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001394/* Append a new keycert entry to a (possibly empty) list */
1395static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1396 mbedtls_x509_crt *cert,
1397 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001398{
niisato8ee24222018-06-25 19:05:48 +09001399 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001400
Glenn Strauss36872db2022-01-22 05:06:31 -05001401 if( cert == NULL )
1402 {
1403 /* Free list if cert is null */
1404 ssl_key_cert_free( *head );
1405 *head = NULL;
1406 return( 0 );
1407 }
1408
niisato8ee24222018-06-25 19:05:48 +09001409 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1410 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001411 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001412
niisato8ee24222018-06-25 19:05:48 +09001413 new_cert->cert = cert;
1414 new_cert->key = key;
1415 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001416
Glenn Strauss36872db2022-01-22 05:06:31 -05001417 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001418 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001419 {
niisato8ee24222018-06-25 19:05:48 +09001420 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001421 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001422 else
1423 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001424 mbedtls_ssl_key_cert *cur = *head;
1425 while( cur->next != NULL )
1426 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001427 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001428 }
1429
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001430 return( 0 );
1431}
1432
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001433int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001434 mbedtls_x509_crt *own_cert,
1435 mbedtls_pk_context *pk_key )
1436{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001437 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001438}
1439
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001440void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001441 mbedtls_x509_crt *ca_chain,
1442 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001443{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001444 conf->ca_chain = ca_chain;
1445 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001446
1447#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1448 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1449 * cannot be used together. */
1450 conf->f_ca_cb = NULL;
1451 conf->p_ca_cb = NULL;
1452#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001453}
Hanno Becker5adaad92019-03-27 16:54:37 +00001454
1455#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1456void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001457 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001458 void *p_ca_cb )
1459{
1460 conf->f_ca_cb = f_ca_cb;
1461 conf->p_ca_cb = p_ca_cb;
1462
1463 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1464 * cannot be used together. */
1465 conf->ca_chain = NULL;
1466 conf->ca_crl = NULL;
1467}
1468#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001470
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001471#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001472const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1473 size_t *name_len )
1474{
1475 *name_len = ssl->handshake->sni_name_len;
1476 return( ssl->handshake->sni_name );
1477}
1478
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001479int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1480 mbedtls_x509_crt *own_cert,
1481 mbedtls_pk_context *pk_key )
1482{
1483 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1484 own_cert, pk_key ) );
1485}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001486
1487void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1488 mbedtls_x509_crt *ca_chain,
1489 mbedtls_x509_crl *ca_crl )
1490{
1491 ssl->handshake->sni_ca_chain = ca_chain;
1492 ssl->handshake->sni_ca_crl = ca_crl;
1493}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001494
1495void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1496 int authmode )
1497{
1498 ssl->handshake->sni_authmode = authmode;
1499}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001500#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1501
Hanno Becker8927c832019-04-03 12:52:50 +01001502#if defined(MBEDTLS_X509_CRT_PARSE_C)
1503void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1504 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1505 void *p_vrfy )
1506{
1507 ssl->f_vrfy = f_vrfy;
1508 ssl->p_vrfy = p_vrfy;
1509}
1510#endif
1511
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001512#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001513/*
1514 * Set EC J-PAKE password for current handshake
1515 */
1516int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1517 const unsigned char *pw,
1518 size_t pw_len )
1519{
1520 mbedtls_ecjpake_role role;
1521
Janos Follath8eb64132016-06-03 15:40:57 +01001522 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001523 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1524
1525 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1526 role = MBEDTLS_ECJPAKE_SERVER;
1527 else
1528 role = MBEDTLS_ECJPAKE_CLIENT;
1529
1530 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1531 role,
1532 MBEDTLS_MD_SHA256,
1533 MBEDTLS_ECP_DP_SECP256R1,
1534 pw, pw_len ) );
1535}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001536#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001537
Gilles Peskineeccd8882020-03-10 12:19:08 +01001538#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001539
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001540static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1541{
1542#if defined(MBEDTLS_USE_PSA_CRYPTO)
1543 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1544 return( 1 );
1545#endif /* MBEDTLS_USE_PSA_CRYPTO */
1546
1547 if( conf->psk != NULL )
1548 return( 1 );
1549
1550 return( 0 );
1551}
1552
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001553static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1554{
1555 /* Remove reference to existing PSK, if any. */
1556#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001557 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001558 {
1559 /* The maintenance of the PSK key slot is the
1560 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001561 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001562 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001563 /* This and the following branch should never
1564 * be taken simultaenously as we maintain the
1565 * invariant that raw and opaque PSKs are never
1566 * configured simultaneously. As a safeguard,
1567 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001568#endif /* MBEDTLS_USE_PSA_CRYPTO */
1569 if( conf->psk != NULL )
1570 {
1571 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1572
1573 mbedtls_free( conf->psk );
1574 conf->psk = NULL;
1575 conf->psk_len = 0;
1576 }
1577
1578 /* Remove reference to PSK identity, if any. */
1579 if( conf->psk_identity != NULL )
1580 {
1581 mbedtls_free( conf->psk_identity );
1582 conf->psk_identity = NULL;
1583 conf->psk_identity_len = 0;
1584 }
1585}
1586
Hanno Becker7390c712018-11-15 13:33:04 +00001587/* This function assumes that PSK identity in the SSL config is unset.
1588 * It checks that the provided identity is well-formed and attempts
1589 * to make a copy of it in the SSL config.
1590 * On failure, the PSK identity in the config remains unset. */
1591static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1592 unsigned char const *psk_identity,
1593 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001594{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001595 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001596 if( psk_identity == NULL ||
1597 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001598 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001599 {
1600 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1601 }
1602
Hanno Becker7390c712018-11-15 13:33:04 +00001603 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1604 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001605 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001606
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001607 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001608 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001609
1610 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001611}
1612
Hanno Becker7390c712018-11-15 13:33:04 +00001613int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1614 const unsigned char *psk, size_t psk_len,
1615 const unsigned char *psk_identity, size_t psk_identity_len )
1616{
Janos Follath865b3eb2019-12-16 11:46:15 +00001617 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001618
1619 /* We currently only support one PSK, raw or opaque. */
1620 if( ssl_conf_psk_is_configured( conf ) )
1621 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001622
1623 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001624 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001625 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001626 if( psk_len == 0 )
1627 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1628 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1630
Hanno Becker7390c712018-11-15 13:33:04 +00001631 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1632 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1633 conf->psk_len = psk_len;
1634 memcpy( conf->psk, psk, conf->psk_len );
1635
1636 /* Check and set PSK Identity */
1637 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1638 if( ret != 0 )
1639 ssl_conf_remove_psk( conf );
1640
1641 return( ret );
1642}
1643
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001644static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1645{
1646#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001647 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001648 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001649 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001650 }
1651 else
1652#endif /* MBEDTLS_USE_PSA_CRYPTO */
1653 if( ssl->handshake->psk != NULL )
1654 {
1655 mbedtls_platform_zeroize( ssl->handshake->psk,
1656 ssl->handshake->psk_len );
1657 mbedtls_free( ssl->handshake->psk );
1658 ssl->handshake->psk_len = 0;
1659 }
1660}
1661
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001662int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1663 const unsigned char *psk, size_t psk_len )
1664{
1665 if( psk == NULL || ssl->handshake == NULL )
1666 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1667
1668 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1669 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1670
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001671 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001672
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001673 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001674 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001675
1676 ssl->handshake->psk_len = psk_len;
1677 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1678
1679 return( 0 );
1680}
1681
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001682#if defined(MBEDTLS_USE_PSA_CRYPTO)
1683int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001684 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001685 const unsigned char *psk_identity,
1686 size_t psk_identity_len )
1687{
Janos Follath865b3eb2019-12-16 11:46:15 +00001688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001689
1690 /* We currently only support one PSK, raw or opaque. */
1691 if( ssl_conf_psk_is_configured( conf ) )
1692 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001693
Hanno Becker7390c712018-11-15 13:33:04 +00001694 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001695 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001697 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001698
1699 /* Check and set PSK Identity */
1700 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1701 psk_identity_len );
1702 if( ret != 0 )
1703 ssl_conf_remove_psk( conf );
1704
1705 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706}
1707
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001708int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1709 mbedtls_svc_key_id_t psk )
1710{
1711 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1712 ( ssl->handshake == NULL ) )
1713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1714
1715 ssl_remove_psk( ssl );
1716 ssl->handshake->psk_opaque = psk;
1717 return( 0 );
1718}
1719#endif /* MBEDTLS_USE_PSA_CRYPTO */
1720
1721void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1722 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1723 size_t),
1724 void *p_psk )
1725{
1726 conf->f_psk = f_psk;
1727 conf->p_psk = p_psk;
1728}
1729#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1730
1731#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001732psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001733 size_t taglen,
1734 psa_algorithm_t *alg,
1735 psa_key_type_t *key_type,
1736 size_t *key_size )
1737{
1738 switch ( mbedtls_cipher_type )
1739 {
1740 case MBEDTLS_CIPHER_AES_128_CBC:
1741 *alg = PSA_ALG_CBC_NO_PADDING;
1742 *key_type = PSA_KEY_TYPE_AES;
1743 *key_size = 128;
1744 break;
1745 case MBEDTLS_CIPHER_AES_128_CCM:
1746 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1747 *key_type = PSA_KEY_TYPE_AES;
1748 *key_size = 128;
1749 break;
1750 case MBEDTLS_CIPHER_AES_128_GCM:
1751 *alg = PSA_ALG_GCM;
1752 *key_type = PSA_KEY_TYPE_AES;
1753 *key_size = 128;
1754 break;
1755 case MBEDTLS_CIPHER_AES_192_CCM:
1756 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1757 *key_type = PSA_KEY_TYPE_AES;
1758 *key_size = 192;
1759 break;
1760 case MBEDTLS_CIPHER_AES_192_GCM:
1761 *alg = PSA_ALG_GCM;
1762 *key_type = PSA_KEY_TYPE_AES;
1763 *key_size = 192;
1764 break;
1765 case MBEDTLS_CIPHER_AES_256_CBC:
1766 *alg = PSA_ALG_CBC_NO_PADDING;
1767 *key_type = PSA_KEY_TYPE_AES;
1768 *key_size = 256;
1769 break;
1770 case MBEDTLS_CIPHER_AES_256_CCM:
1771 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1772 *key_type = PSA_KEY_TYPE_AES;
1773 *key_size = 256;
1774 break;
1775 case MBEDTLS_CIPHER_AES_256_GCM:
1776 *alg = PSA_ALG_GCM;
1777 *key_type = PSA_KEY_TYPE_AES;
1778 *key_size = 256;
1779 break;
1780 case MBEDTLS_CIPHER_ARIA_128_CBC:
1781 *alg = PSA_ALG_CBC_NO_PADDING;
1782 *key_type = PSA_KEY_TYPE_ARIA;
1783 *key_size = 128;
1784 break;
1785 case MBEDTLS_CIPHER_ARIA_128_CCM:
1786 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1787 *key_type = PSA_KEY_TYPE_ARIA;
1788 *key_size = 128;
1789 break;
1790 case MBEDTLS_CIPHER_ARIA_128_GCM:
1791 *alg = PSA_ALG_GCM;
1792 *key_type = PSA_KEY_TYPE_ARIA;
1793 *key_size = 128;
1794 break;
1795 case MBEDTLS_CIPHER_ARIA_192_CCM:
1796 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1797 *key_type = PSA_KEY_TYPE_ARIA;
1798 *key_size = 192;
1799 break;
1800 case MBEDTLS_CIPHER_ARIA_192_GCM:
1801 *alg = PSA_ALG_GCM;
1802 *key_type = PSA_KEY_TYPE_ARIA;
1803 *key_size = 192;
1804 break;
1805 case MBEDTLS_CIPHER_ARIA_256_CBC:
1806 *alg = PSA_ALG_CBC_NO_PADDING;
1807 *key_type = PSA_KEY_TYPE_ARIA;
1808 *key_size = 256;
1809 break;
1810 case MBEDTLS_CIPHER_ARIA_256_CCM:
1811 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1812 *key_type = PSA_KEY_TYPE_ARIA;
1813 *key_size = 256;
1814 break;
1815 case MBEDTLS_CIPHER_ARIA_256_GCM:
1816 *alg = PSA_ALG_GCM;
1817 *key_type = PSA_KEY_TYPE_ARIA;
1818 *key_size = 256;
1819 break;
1820 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1821 *alg = PSA_ALG_CBC_NO_PADDING;
1822 *key_type = PSA_KEY_TYPE_CAMELLIA;
1823 *key_size = 128;
1824 break;
1825 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1826 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1827 *key_type = PSA_KEY_TYPE_CAMELLIA;
1828 *key_size = 128;
1829 break;
1830 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1831 *alg = PSA_ALG_GCM;
1832 *key_type = PSA_KEY_TYPE_CAMELLIA;
1833 *key_size = 128;
1834 break;
1835 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1836 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1837 *key_type = PSA_KEY_TYPE_CAMELLIA;
1838 *key_size = 192;
1839 break;
1840 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1841 *alg = PSA_ALG_GCM;
1842 *key_type = PSA_KEY_TYPE_CAMELLIA;
1843 *key_size = 192;
1844 break;
1845 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1846 *alg = PSA_ALG_CBC_NO_PADDING;
1847 *key_type = PSA_KEY_TYPE_CAMELLIA;
1848 *key_size = 256;
1849 break;
1850 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1851 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1852 *key_type = PSA_KEY_TYPE_CAMELLIA;
1853 *key_size = 256;
1854 break;
1855 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1856 *alg = PSA_ALG_GCM;
1857 *key_type = PSA_KEY_TYPE_CAMELLIA;
1858 *key_size = 256;
1859 break;
1860 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1861 *alg = PSA_ALG_CHACHA20_POLY1305;
1862 *key_type = PSA_KEY_TYPE_CHACHA20;
1863 *key_size = 256;
1864 break;
1865 case MBEDTLS_CIPHER_NULL:
1866 *alg = MBEDTLS_SSL_NULL_CIPHER;
1867 *key_type = 0;
1868 *key_size = 0;
1869 break;
1870 default:
1871 return PSA_ERROR_NOT_SUPPORTED;
1872 }
1873
1874 return PSA_SUCCESS;
1875}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001876#endif /* MBEDTLS_USE_PSA_CRYPTO */
1877
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001878#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001879int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1880 const unsigned char *dhm_P, size_t P_len,
1881 const unsigned char *dhm_G, size_t G_len )
1882{
Janos Follath865b3eb2019-12-16 11:46:15 +00001883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001884
Glenn Strausscee11292021-12-20 01:43:17 -05001885 mbedtls_mpi_free( &conf->dhm_P );
1886 mbedtls_mpi_free( &conf->dhm_G );
1887
Hanno Beckera90658f2017-10-04 15:29:08 +01001888 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1889 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1890 {
1891 mbedtls_mpi_free( &conf->dhm_P );
1892 mbedtls_mpi_free( &conf->dhm_G );
1893 return( ret );
1894 }
1895
1896 return( 0 );
1897}
Paul Bakker5121ce52009-01-03 21:22:43 +00001898
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001899int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001900{
Janos Follath865b3eb2019-12-16 11:46:15 +00001901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001902
Glenn Strausscee11292021-12-20 01:43:17 -05001903 mbedtls_mpi_free( &conf->dhm_P );
1904 mbedtls_mpi_free( &conf->dhm_G );
1905
Gilles Peskinee5702482021-06-11 21:59:08 +02001906 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1907 &conf->dhm_P ) ) != 0 ||
1908 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1909 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001910 {
1911 mbedtls_mpi_free( &conf->dhm_P );
1912 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001913 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001914 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001915
1916 return( 0 );
1917}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001918#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001919
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001920#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1921/*
1922 * Set the minimum length for Diffie-Hellman parameters
1923 */
1924void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1925 unsigned int bitlen )
1926{
1927 conf->dhm_min_bitlen = bitlen;
1928}
1929#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1930
Gilles Peskineeccd8882020-03-10 12:19:08 +01001931#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001932#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001933/*
1934 * Set allowed/preferred hashes for handshake signatures
1935 */
1936void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1937 const int *hashes )
1938{
1939 conf->sig_hashes = hashes;
1940}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001941#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001942
Jerry Yuf017ee42022-01-12 15:49:48 +08001943/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001944void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1945 const uint16_t* sig_algs )
1946{
Jerry Yuf017ee42022-01-12 15:49:48 +08001947#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1948 conf->sig_hashes = NULL;
1949#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1950 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001951}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001952#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001953
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001954#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001955#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001956/*
1957 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001958 *
1959 * mbedtls_ssl_setup() takes the provided list
1960 * and translates it to a list of IANA TLS group identifiers,
1961 * stored in ssl->handshake->group_list.
1962 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001963 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001964void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001965 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001966{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001967 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01001968 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001969}
Brett Warrene0edc842021-08-17 09:53:13 +01001970#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01001971#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001972
Brett Warrene0edc842021-08-17 09:53:13 +01001973/*
1974 * Set the allowed groups
1975 */
1976void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
1977 const uint16_t *group_list )
1978{
1979#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1980 conf->curve_list = NULL;
1981#endif
1982 conf->group_list = group_list;
1983}
1984
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001985#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00001987{
Hanno Becker947194e2017-04-07 13:25:49 +01001988 /* Initialize to suppress unnecessary compiler warning */
1989 size_t hostname_len = 0;
1990
1991 /* Check if new hostname is valid before
1992 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01001993 if( hostname != NULL )
1994 {
1995 hostname_len = strlen( hostname );
1996
1997 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
1998 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1999 }
2000
2001 /* Now it's clear that we will overwrite the old hostname,
2002 * so we can free it safely */
2003
2004 if( ssl->hostname != NULL )
2005 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002006 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002007 mbedtls_free( ssl->hostname );
2008 }
2009
2010 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002011
Paul Bakker5121ce52009-01-03 21:22:43 +00002012 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002013 {
2014 ssl->hostname = NULL;
2015 }
2016 else
2017 {
2018 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002019 if( ssl->hostname == NULL )
2020 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002021
Hanno Becker947194e2017-04-07 13:25:49 +01002022 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002023
Hanno Becker947194e2017-04-07 13:25:49 +01002024 ssl->hostname[hostname_len] = '\0';
2025 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002026
2027 return( 0 );
2028}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002029#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002030
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002031#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002032void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002034 const unsigned char *, size_t),
2035 void *p_sni )
2036{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002037 conf->f_sni = f_sni;
2038 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002039}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002043int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002044{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002045 size_t cur_len, tot_len;
2046 const char **p;
2047
2048 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002049 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2050 * MUST NOT be truncated."
2051 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002052 */
2053 tot_len = 0;
2054 for( p = protos; *p != NULL; p++ )
2055 {
2056 cur_len = strlen( *p );
2057 tot_len += cur_len;
2058
Ronald Cron8216dd32020-04-23 16:41:44 +02002059 if( ( cur_len == 0 ) ||
2060 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2061 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002063 }
2064
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002065 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002066
2067 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002068}
2069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002071{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002072 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002073}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002075
Johan Pascalb62bb512015-12-03 21:56:45 +01002076#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002077void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2078 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002079{
2080 conf->dtls_srtp_mki_support = support_mki_value;
2081}
2082
Ron Eldoref72faf2018-07-12 11:54:20 +03002083int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2084 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002085 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002086{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002087 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002088 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002089 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002090 }
Ron Eldor591f1622018-01-22 12:30:04 +02002091
2092 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002093 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002094 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002095 }
Ron Eldor591f1622018-01-22 12:30:04 +02002096
2097 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2098 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002099 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002100}
2101
Ron Eldoref72faf2018-07-12 11:54:20 +03002102int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002103 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002104{
Johan Pascal253d0262020-09-22 13:04:45 +02002105 const mbedtls_ssl_srtp_profile *p;
2106 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002107
Johan Pascal253d0262020-09-22 13:04:45 +02002108 /* check the profiles list: all entry must be valid,
2109 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002110 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2111 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2112 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002113 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002114 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002115 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002116 list_size++;
2117 }
2118 else
2119 {
2120 /* unsupported value, stop parsing and set the size to an error value */
2121 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002122 }
2123 }
2124
Johan Pascal5ef72d22020-10-28 17:05:47 +01002125 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002126 {
Johan Pascal253d0262020-09-22 13:04:45 +02002127 conf->dtls_srtp_profile_list = NULL;
2128 conf->dtls_srtp_profile_list_len = 0;
2129 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2130 }
2131
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002132 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002133 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002134
2135 return( 0 );
2136}
2137
Johan Pascal5ef72d22020-10-28 17:05:47 +01002138void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2139 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002140{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002141 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2142 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002143 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002144 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002145 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002146 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002147 else
2148 {
2149 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002150 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2151 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002152 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002153}
Johan Pascalb62bb512015-12-03 21:56:45 +01002154#endif /* MBEDTLS_SSL_DTLS_SRTP */
2155
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002156void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002157{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002158 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002159}
2160
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002161void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002162{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002163 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002164}
2165
Janos Follath088ce432017-04-10 12:42:31 +01002166#if defined(MBEDTLS_SSL_SRV_C)
2167void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2168 char cert_req_ca_list )
2169{
2170 conf->cert_req_ca_list = cert_req_ca_list;
2171}
2172#endif
2173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002175void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002176{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002177 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002178}
2179#endif
2180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002182void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002183{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002184 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002185}
2186#endif
2187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002189int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002190{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002192 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002193 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002195 }
2196
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002197 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002198
2199 return( 0 );
2200}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002202
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002203void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002204{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002205 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002206}
2207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002209void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002211 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002212}
2213
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002214void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002216 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002217}
2218
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002219void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002220 const unsigned char period[8] )
2221{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002222 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002223}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002227#if defined(MBEDTLS_SSL_CLI_C)
2228void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002229{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002230 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002231}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002232#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002233
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002234#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002235void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2236 mbedtls_ssl_ticket_write_t *f_ticket_write,
2237 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2238 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002239{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002240 conf->f_ticket_write = f_ticket_write;
2241 conf->f_ticket_parse = f_ticket_parse;
2242 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002243}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002244#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002246
Hanno Becker7e6c1782021-06-08 09:24:55 +01002247void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2248 mbedtls_ssl_export_keys_t *f_export_keys,
2249 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002250{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002251 ssl->f_export_keys = f_export_keys;
2252 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002253}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002254
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002255#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002256void mbedtls_ssl_conf_async_private_cb(
2257 mbedtls_ssl_config *conf,
2258 mbedtls_ssl_async_sign_t *f_async_sign,
2259 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2260 mbedtls_ssl_async_resume_t *f_async_resume,
2261 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002262 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002263{
2264 conf->f_async_sign_start = f_async_sign;
2265 conf->f_async_decrypt_start = f_async_decrypt;
2266 conf->f_async_resume = f_async_resume;
2267 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002268 conf->p_async_config_data = async_config_data;
2269}
2270
Gilles Peskine8f97af72018-04-26 11:46:10 +02002271void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2272{
2273 return( conf->p_async_config_data );
2274}
2275
Gilles Peskine1febfef2018-04-30 11:54:39 +02002276void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002277{
2278 if( ssl->handshake == NULL )
2279 return( NULL );
2280 else
2281 return( ssl->handshake->user_async_ctx );
2282}
2283
Gilles Peskine1febfef2018-04-30 11:54:39 +02002284void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002285 void *ctx )
2286{
2287 if( ssl->handshake != NULL )
2288 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002289}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002290#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002291
Paul Bakker5121ce52009-01-03 21:22:43 +00002292/*
2293 * SSL get accessors
2294 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002295uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002296{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002297 if( ssl->session != NULL )
2298 return( ssl->session->verify_result );
2299
2300 if( ssl->session_negotiate != NULL )
2301 return( ssl->session_negotiate->verify_result );
2302
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002303 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002304}
2305
Glenn Strauss8f526902022-01-13 00:04:49 -05002306int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2307{
2308 if( ssl == NULL || ssl->session == NULL )
2309 return( 0 );
2310
2311 return( ssl->session->ciphersuite );
2312}
2313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002315{
Paul Bakker926c8e42013-03-06 10:23:34 +01002316 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002317 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002320}
2321
Gilles Peskinee1a0c252022-01-13 01:08:03 +01002322mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(
2323 const mbedtls_ssl_context *ssl )
2324{
2325 /* For major_ver, only 3 is supported, so skip checking it. */
2326 switch( ssl->minor_ver )
2327 {
2328 case MBEDTLS_SSL_MINOR_VERSION_3:
Glenn Straussdff84622022-03-14 11:12:57 -04002329 return( MBEDTLS_SSL_VERSION_TLS1_2 );
Gilles Peskinee1a0c252022-01-13 01:08:03 +01002330 case MBEDTLS_SSL_MINOR_VERSION_4:
Glenn Straussdff84622022-03-14 11:12:57 -04002331 return( MBEDTLS_SSL_VERSION_TLS1_3 );
Gilles Peskinee1a0c252022-01-13 01:08:03 +01002332 default:
2333 return( MBEDTLS_SSL_VERSION_UNKNOWN );
2334 }
2335}
2336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002338{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002340 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002341 {
2342 switch( ssl->minor_ver )
2343 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 case MBEDTLS_SSL_MINOR_VERSION_3:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002345 return( "DTLSv1.2" );
2346
2347 default:
2348 return( "unknown (DTLS)" );
2349 }
2350 }
2351#endif
2352
Paul Bakker43ca69c2011-01-15 17:35:19 +00002353 switch( ssl->minor_ver )
2354 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 case MBEDTLS_SSL_MINOR_VERSION_3:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002356 return( "TLSv1.2" );
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002357 case MBEDTLS_SSL_MINOR_VERSION_4:
2358 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002359 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002360 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002361 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002362}
2363
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002364#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002365size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2366{
David Horstmann95d516f2021-05-04 18:36:56 +01002367 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002368 size_t read_mfl;
2369
2370 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2371 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2372 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2373 {
2374 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2375 }
2376
2377 /* Check if a smaller max length was negotiated */
2378 if( ssl->session_out != NULL )
2379 {
2380 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2381 if( read_mfl < max_len )
2382 {
2383 max_len = read_mfl;
2384 }
2385 }
2386
2387 // During a handshake, use the value being negotiated
2388 if( ssl->session_negotiate != NULL )
2389 {
2390 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2391 if( read_mfl < max_len )
2392 {
2393 max_len = read_mfl;
2394 }
2395 }
2396
2397 return( max_len );
2398}
2399
2400size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002401{
2402 size_t max_len;
2403
2404 /*
2405 * Assume mfl_code is correct since it was checked when set
2406 */
Angus Grattond8213d02016-05-25 20:56:48 +10002407 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002408
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002409 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002410 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002411 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002412 {
Angus Grattond8213d02016-05-25 20:56:48 +10002413 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002414 }
2415
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002416 /* During a handshake, use the value being negotiated */
2417 if( ssl->session_negotiate != NULL &&
2418 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2419 {
2420 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2421 }
2422
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002423 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002424}
2425#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2426
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002428size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002429{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002430 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2431 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2432 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2433 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2434 return ( 0 );
2435
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002436 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2437 return( ssl->mtu );
2438
2439 if( ssl->mtu == 0 )
2440 return( ssl->handshake->mtu );
2441
2442 return( ssl->mtu < ssl->handshake->mtu ?
2443 ssl->mtu : ssl->handshake->mtu );
2444}
2445#endif /* MBEDTLS_SSL_PROTO_DTLS */
2446
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002447int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2448{
2449 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2450
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002451#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2452 !defined(MBEDTLS_SSL_PROTO_DTLS)
2453 (void) ssl;
2454#endif
2455
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002456#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002457 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002458
2459 if( max_len > mfl )
2460 max_len = mfl;
2461#endif
2462
2463#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002464 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002465 {
Hanno Becker89490712020-02-05 10:50:12 +00002466 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002467 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2468 const size_t overhead = (size_t) ret;
2469
2470 if( ret < 0 )
2471 return( ret );
2472
2473 if( mtu <= overhead )
2474 {
2475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2476 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2477 }
2478
2479 if( max_len > mtu - overhead )
2480 max_len = mtu - overhead;
2481 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002482#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002483
Hanno Becker0defedb2018-08-10 12:35:02 +01002484#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2485 !defined(MBEDTLS_SSL_PROTO_DTLS)
2486 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002487#endif
2488
2489 return( (int) max_len );
2490}
2491
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002492int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2493{
2494 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2495
2496#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2497 (void) ssl;
2498#endif
2499
2500#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2501 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2502
2503 if( max_len > mfl )
2504 max_len = mfl;
2505#endif
2506
2507 return( (int) max_len );
2508}
2509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510#if defined(MBEDTLS_X509_CRT_PARSE_C)
2511const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002512{
2513 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002514 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002515
Hanno Beckere6824572019-02-07 13:18:46 +00002516#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002517 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002518#else
2519 return( NULL );
2520#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002521}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002525int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2526 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002527{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002528 int ret;
2529
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002530 if( ssl == NULL ||
2531 dst == NULL ||
2532 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002533 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002534 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002536 }
2537
Hanno Beckere810bbc2021-05-14 16:01:05 +01002538 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2539 * idempotent: Each session can only be exported once.
2540 *
2541 * (This is in preparation for TLS 1.3 support where we will
2542 * need the ability to export multiple sessions (aka tickets),
2543 * which will be achieved by calling mbedtls_ssl_get_session()
2544 * multiple times until it fails.)
2545 *
2546 * Check whether we have already exported the current session,
2547 * and fail if so.
2548 */
2549 if( ssl->session->exported == 1 )
2550 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2551
2552 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2553 if( ret != 0 )
2554 return( ret );
2555
2556 /* Remember that we've exported the session. */
2557 ssl->session->exported = 1;
2558 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002559}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002561
Paul Bakker5121ce52009-01-03 21:22:43 +00002562/*
Hanno Beckera835da52019-05-16 12:39:07 +01002563 * Define ticket header determining Mbed TLS version
2564 * and structure of the ticket.
2565 */
2566
Hanno Becker94ef3b32019-05-16 12:50:45 +01002567/*
Hanno Becker50b59662019-05-28 14:30:45 +01002568 * Define bitflag determining compile-time settings influencing
2569 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002570 */
2571
Hanno Becker50b59662019-05-28 14:30:45 +01002572#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002573#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002574#else
Hanno Becker3e088662019-05-29 11:10:18 +01002575#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002576#endif /* MBEDTLS_HAVE_TIME */
2577
2578#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002579#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002580#else
Hanno Becker3e088662019-05-29 11:10:18 +01002581#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002582#endif /* MBEDTLS_X509_CRT_PARSE_C */
2583
2584#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002585#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002586#else
Hanno Becker3e088662019-05-29 11:10:18 +01002587#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002588#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2589
2590#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002591#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002592#else
Hanno Becker3e088662019-05-29 11:10:18 +01002593#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002594#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2595
Hanno Becker94ef3b32019-05-16 12:50:45 +01002596#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002597#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002598#else
Hanno Becker3e088662019-05-29 11:10:18 +01002599#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002600#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2601
Hanno Becker94ef3b32019-05-16 12:50:45 +01002602#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2603#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2604#else
2605#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2606#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2607
Hanno Becker3e088662019-05-29 11:10:18 +01002608#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2609#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2610#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2611#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002612#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2613#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002614
Hanno Becker50b59662019-05-28 14:30:45 +01002615#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002616 ( (uint16_t) ( \
2617 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2618 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2619 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2620 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002621 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002622 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002623
Hanno Beckerf8787072019-05-16 12:41:07 +01002624static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002625 MBEDTLS_VERSION_MAJOR,
2626 MBEDTLS_VERSION_MINOR,
2627 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002628 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2629 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002630};
Hanno Beckera835da52019-05-16 12:39:07 +01002631
2632/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002633 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002634 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002635 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002636 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002637 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002638 * opaque mbedtls_version[3]; // library version: major, minor, patch
2639 * opaque session_format[2]; // library-version specific 16-bit field
2640 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002641 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002642 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002643 * Note: When updating the format, remember to keep
2644 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002645 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002646 * // In this version, `session_format` determines
2647 * // the setting of those compile-time
2648 * // configuration options which influence
2649 * // the structure of mbedtls_ssl_session.
2650 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002651 * uint8_t minor_ver; // Protocol minor version. Possible values:
2652 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002653 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002654 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002655 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002656 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002657 * serialized_session_tls12 data;
2658 *
2659 * };
2660 *
2661 * } serialized_session;
2662 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002663 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002664
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002665static int ssl_session_save( const mbedtls_ssl_session *session,
2666 unsigned char omit_header,
2667 unsigned char *buf,
2668 size_t buf_len,
2669 size_t *olen )
2670{
2671 unsigned char *p = buf;
2672 size_t used = 0;
2673
2674 if( !omit_header )
2675 {
2676 /*
2677 * Add Mbed TLS version identifier
2678 */
2679
2680 used += sizeof( ssl_serialized_session_header );
2681
2682 if( used <= buf_len )
2683 {
2684 memcpy( p, ssl_serialized_session_header,
2685 sizeof( ssl_serialized_session_header ) );
2686 p += sizeof( ssl_serialized_session_header );
2687 }
2688 }
2689
2690 /*
2691 * TLS version identifier
2692 */
2693 used += 1;
2694 if( used <= buf_len )
2695 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002696 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002697 }
2698
2699 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002700 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002701 {
2702#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002703 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002704 {
2705 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2706 used += ssl_session_save_tls12( session, p, remaining_len );
2707 break;
2708 }
2709#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2710
2711 default:
2712 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2713 }
2714
2715 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002716 if( used > buf_len )
2717 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002718
2719 return( 0 );
2720}
2721
2722/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002723 * Public wrapper for ssl_session_save()
2724 */
2725int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2726 unsigned char *buf,
2727 size_t buf_len,
2728 size_t *olen )
2729{
2730 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2731}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002732
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002733/*
2734 * Deserialize session, see mbedtls_ssl_session_save() for format.
2735 *
2736 * This internal version is wrapped by a public function that cleans up in
2737 * case of error, and has an extra option omit_header.
2738 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002739static int ssl_session_load( mbedtls_ssl_session *session,
2740 unsigned char omit_header,
2741 const unsigned char *buf,
2742 size_t len )
2743{
2744 const unsigned char *p = buf;
2745 const unsigned char * const end = buf + len;
2746
2747 if( !omit_header )
2748 {
2749 /*
2750 * Check Mbed TLS version identifier
2751 */
2752
2753 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2754 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2755
2756 if( memcmp( p, ssl_serialized_session_header,
2757 sizeof( ssl_serialized_session_header ) ) != 0 )
2758 {
2759 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2760 }
2761 p += sizeof( ssl_serialized_session_header );
2762 }
2763
2764 /*
2765 * TLS version identifier
2766 */
2767 if( 1 > (size_t)( end - p ) )
2768 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002769 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002770
2771 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002772 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002773 {
2774#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002775 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002776 {
2777 size_t remaining_len = ( end - p );
2778 return( ssl_session_load_tls12( session, p, remaining_len ) );
2779 }
2780#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2781
2782 default:
2783 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2784 }
2785}
2786
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002787/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002788 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002789 */
2790int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2791 const unsigned char *buf,
2792 size_t len )
2793{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002794 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002795
2796 if( ret != 0 )
2797 mbedtls_ssl_session_free( session );
2798
2799 return( ret );
2800}
2801
2802/*
Paul Bakker1961b702013-01-25 14:49:24 +01002803 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002804 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002805static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2806{
2807 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2808
Ronald Cron66dbf912022-02-02 15:33:46 +01002809 /*
2810 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002811 * that were written into the output buffer by the previous handshake step,
2812 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002813 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2814 * We proceed to the next handshake step only when all data from the
2815 * previous one have been sent to the peer, thus we make sure that this is
2816 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2817 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2818 * we have to wait before to go ahead.
2819 * In the case of TLS 1.3, handshake step handlers do not send data to the
2820 * peer. Data are only sent here and through
2821 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2822 * alert occured.
2823 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002824 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2825 return( ret );
2826
2827#if defined(MBEDTLS_SSL_PROTO_DTLS)
2828 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2829 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2830 {
2831 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2832 return( ret );
2833 }
2834#endif /* MBEDTLS_SSL_PROTO_DTLS */
2835
2836 return( ret );
2837}
2838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002840{
Hanno Becker41934dd2021-08-07 19:13:43 +01002841 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002842
Hanno Becker41934dd2021-08-07 19:13:43 +01002843 if( ssl == NULL ||
2844 ssl->conf == NULL ||
2845 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002846 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002847 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002848 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002849 }
2850
2851 ret = ssl_prepare_handshake_step( ssl );
2852 if( ret != 0 )
2853 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002854
Jerry Yue7047812021-09-13 19:26:39 +08002855 ret = mbedtls_ssl_handle_pending_alert( ssl );
2856 if( ret != 0 )
2857 goto cleanup;
2858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002860 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002861 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2863 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002864
Ronald Cron9f0fba32022-02-10 16:45:15 +01002865 switch( ssl->state )
2866 {
2867 case MBEDTLS_SSL_HELLO_REQUEST:
2868 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2869 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002870
Ronald Cron9f0fba32022-02-10 16:45:15 +01002871 case MBEDTLS_SSL_CLIENT_HELLO:
2872 ret = mbedtls_ssl_write_client_hello( ssl );
2873 break;
2874
2875 default:
2876#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
2877 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2878 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2879 else
2880 ret = mbedtls_ssl_handshake_client_step( ssl );
2881#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2882 ret = mbedtls_ssl_handshake_client_step( ssl );
2883#else
2884 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2885#endif
2886 }
Jerry Yub9930e72021-08-06 17:11:51 +08002887 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002888#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002890 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002891 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002892#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002893 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002894 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002895#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002896
2897#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2898 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2899 ret = mbedtls_ssl_handshake_server_step( ssl );
2900#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2901 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002902#endif
2903
Jerry Yue7047812021-09-13 19:26:39 +08002904 if( ret != 0 )
2905 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002906 /* handshake_step return error. And it is same
2907 * with alert_reason.
2908 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002909 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002910 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002911 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002912 goto cleanup;
2913 }
2914 }
2915
2916cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002917 return( ret );
2918}
2919
2920/*
2921 * Perform the SSL handshake
2922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002924{
2925 int ret = 0;
2926
Hanno Beckera817ea42020-10-20 15:20:23 +01002927 /* Sanity checks */
2928
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002929 if( ssl == NULL || ssl->conf == NULL )
2930 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2931
Hanno Beckera817ea42020-10-20 15:20:23 +01002932#if defined(MBEDTLS_SSL_PROTO_DTLS)
2933 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2934 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2935 {
2936 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2937 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2938 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2939 }
2940#endif /* MBEDTLS_SSL_PROTO_DTLS */
2941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002943
Hanno Beckera817ea42020-10-20 15:20:23 +01002944 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00002945 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01002946 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002948
2949 if( ret != 0 )
2950 break;
2951 }
2952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002954
2955 return( ret );
2956}
2957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958#if defined(MBEDTLS_SSL_RENEGOTIATION)
2959#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002960/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002961 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002962 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002964{
Janos Follath865b3eb2019-12-16 11:46:15 +00002965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002968
2969 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2971 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002972
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002973 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002974 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002975 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002976 return( ret );
2977 }
2978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002980
2981 return( 0 );
2982}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002984
2985/*
2986 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 * - any side: calling mbedtls_ssl_renegotiate(),
2988 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2989 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002990 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002991 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002993 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002994int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002995{
Janos Follath865b3eb2019-12-16 11:46:15 +00002996 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002999
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003000 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3001 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003002
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003003 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3004 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003006 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003008 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003009 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003010 ssl->handshake->out_msg_seq = 1;
3011 else
3012 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003013 }
3014#endif
3015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3017 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003020 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003022 return( ret );
3023 }
3024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003026
3027 return( 0 );
3028}
3029
3030/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003031 * Renegotiate current connection on client,
3032 * or request renegotiation on server
3033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003035{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003037
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003038 if( ssl == NULL || ssl->conf == NULL )
3039 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003042 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003043 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003044 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003045 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003049
3050 /* Did we already try/start sending HelloRequest? */
3051 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003053
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003054 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003055 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003058#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003059 /*
3060 * On client, either start the renegotiation process or,
3061 * if already in progress, continue the handshake
3062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003064 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003065 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003067
Hanno Becker40cdaa12020-02-05 10:48:27 +00003068 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003069 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003070 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003071 return( ret );
3072 }
3073 }
3074 else
3075 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003079 return( ret );
3080 }
3081 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003083
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003084 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003085}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003087
Gilles Peskine9b562d52018-04-25 20:32:43 +02003088void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003089{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003090 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3091
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003092 if( handshake == NULL )
3093 return;
3094
Brett Warrene0edc842021-08-17 09:53:13 +01003095#if defined(MBEDTLS_ECP_C)
3096#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3097 if ( ssl->handshake->group_list_heap_allocated )
3098 mbedtls_free( (void*) handshake->group_list );
3099 handshake->group_list = NULL;
3100#endif /* MBEDTLS_DEPRECATED_REMOVED */
3101#endif /* MBEDTLS_ECP_C */
3102
Jerry Yuf017ee42022-01-12 15:49:48 +08003103#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3104#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3105 if ( ssl->handshake->sig_algs_heap_allocated )
3106 mbedtls_free( (void*) handshake->sig_algs );
3107 handshake->sig_algs = NULL;
3108#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003109#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3110 if( ssl->handshake->certificate_request_context )
3111 {
3112 mbedtls_free( (void*) handshake->certificate_request_context );
3113 }
3114#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003115#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3116
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003117#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3118 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3119 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003120 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003121 handshake->async_in_progress = 0;
3122 }
3123#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3124
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003125#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003126#if defined(MBEDTLS_USE_PSA_CRYPTO)
3127 psa_hash_abort( &handshake->fin_sha256_psa );
3128#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003129 mbedtls_sha256_free( &handshake->fin_sha256 );
3130#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003131#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003132#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003133#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003134 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003135#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003136 mbedtls_sha512_free( &handshake->fin_sha512 );
3137#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003138#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#if defined(MBEDTLS_DHM_C)
3141 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003142#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#if defined(MBEDTLS_ECDH_C)
3144 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003145#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003146#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003147 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003148#if defined(MBEDTLS_SSL_CLI_C)
3149 mbedtls_free( handshake->ecjpake_cache );
3150 handshake->ecjpake_cache = NULL;
3151 handshake->ecjpake_cache_len = 0;
3152#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003153#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003154
Janos Follath4ae5c292016-02-10 11:27:43 +00003155#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3156 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003157 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003159#endif
3160
Gilles Peskineeccd8882020-03-10 12:19:08 +01003161#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003162 if( handshake->psk != NULL )
3163 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003164 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003165 mbedtls_free( handshake->psk );
3166 }
3167#endif
3168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3170 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003171 /*
3172 * Free only the linked list wrapper, not the keys themselves
3173 * since the belong to the SNI callback
3174 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003175 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003177
Gilles Peskineeccd8882020-03-10 12:19:08 +01003178#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003179 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003180 if( handshake->ecrs_peer_cert != NULL )
3181 {
3182 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3183 mbedtls_free( handshake->ecrs_peer_cert );
3184 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003185#endif
3186
Hanno Becker75173122019-02-06 16:18:31 +00003187#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3188 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3189 mbedtls_pk_free( &handshake->peer_pubkey );
3190#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3191
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003192#if defined(MBEDTLS_SSL_CLI_C) && \
3193 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3194 mbedtls_free( handshake->cookie );
3195#endif /* MBEDTLS_SSL_CLI_C &&
3196 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003197
3198#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003199 mbedtls_ssl_flight_free( handshake->flight );
3200 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003201#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003202
Ronald Cronf12b81d2022-03-15 10:42:41 +01003203#if defined(MBEDTLS_ECDH_C) && \
3204 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003205 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003206 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003207#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3208
Ronald Cron6f135e12021-12-08 16:57:54 +01003209#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003210 mbedtls_ssl_transform_free( handshake->transform_handshake );
3211 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003212 mbedtls_free( handshake->transform_earlydata );
3213 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003214#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003215
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003216
3217#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3218 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3219 * processes datagrams and the fact that a datagram is allowed to have
3220 * several records in it, it is possible that the I/O buffers are not
3221 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003222 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3223 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003224#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003225
Jerry Yuba9c7272021-10-30 11:54:10 +08003226 /* mbedtls_platform_zeroize MUST be last one in this function */
3227 mbedtls_platform_zeroize( handshake,
3228 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003229}
3230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003232{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003233 if( session == NULL )
3234 return;
3235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003237 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003238#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003239
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003240#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003242#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003243
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003244 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003245}
3246
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003247#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003248
3249#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3250#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3251#else
3252#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3253#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3254
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003255#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003256
3257#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3258#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3259#else
3260#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3261#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3262
3263#if defined(MBEDTLS_SSL_ALPN)
3264#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3265#else
3266#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3267#endif /* MBEDTLS_SSL_ALPN */
3268
3269#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3270#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3271#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3272#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3273
3274#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3275 ( (uint32_t) ( \
3276 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3277 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3278 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3279 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3280 0u ) )
3281
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003282static unsigned char ssl_serialized_context_header[] = {
3283 MBEDTLS_VERSION_MAJOR,
3284 MBEDTLS_VERSION_MINOR,
3285 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003286 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3287 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3288 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3289 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3290 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003291};
3292
Paul Bakker5121ce52009-01-03 21:22:43 +00003293/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003294 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003295 *
3296 * The format of the serialized data is:
3297 * (in the presentation language of TLS, RFC 8446 section 3)
3298 *
3299 * // header
3300 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003301 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003302 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003303 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003304 * Note: When updating the format, remember to keep these
3305 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003306 *
3307 * // session sub-structure
3308 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3309 * // transform sub-structure
3310 * uint8 random[64]; // ServerHello.random+ClientHello.random
3311 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3312 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3313 * // fields from ssl_context
3314 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3315 * uint64 in_window_top; // DTLS: last validated record seq_num
3316 * uint64 in_window; // DTLS: bitmask for replay protection
3317 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3318 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3319 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3320 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3321 *
3322 * Note that many fields of the ssl_context or sub-structures are not
3323 * serialized, as they fall in one of the following categories:
3324 *
3325 * 1. forced value (eg in_left must be 0)
3326 * 2. pointer to dynamically-allocated memory (eg session, transform)
3327 * 3. value can be re-derived from other data (eg session keys from MS)
3328 * 4. value was temporary (eg content of input buffer)
3329 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003330 */
3331int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3332 unsigned char *buf,
3333 size_t buf_len,
3334 size_t *olen )
3335{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003336 unsigned char *p = buf;
3337 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003338 size_t session_len;
3339 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003340
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003341 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003342 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3343 * this function's documentation.
3344 *
3345 * These are due to assumptions/limitations in the implementation. Some of
3346 * them are likely to stay (no handshake in progress) some might go away
3347 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003348 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003349 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003350 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003351 {
3352 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003353 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003354 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003355 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003356 {
3357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003358 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003359 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003360 /* Double-check that sub-structures are indeed ready */
3361 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003362 {
3363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003364 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003365 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003366 /* There must be no pending incoming or outgoing data */
3367 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003368 {
3369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003370 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003371 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003372 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003373 {
3374 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003375 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003376 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003377 /* Protocol must be DLTS, not TLS */
3378 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003379 {
3380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003381 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003382 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003383 /* Version must be 1.2 */
3384 if( ssl->major_ver != MBEDTLS_SSL_MAJOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003385 {
3386 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003387 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003388 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003389 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003390 {
3391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003392 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003393 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003394 /* We must be using an AEAD ciphersuite */
3395 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003396 {
3397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003398 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003399 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003400 /* Renegotiation must not be enabled */
3401#if defined(MBEDTLS_SSL_RENEGOTIATION)
3402 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003403 {
3404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003405 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003406 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003407#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003408
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003409 /*
3410 * Version and format identifier
3411 */
3412 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003413
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003414 if( used <= buf_len )
3415 {
3416 memcpy( p, ssl_serialized_context_header,
3417 sizeof( ssl_serialized_context_header ) );
3418 p += sizeof( ssl_serialized_context_header );
3419 }
3420
3421 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003422 * Session (length + data)
3423 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003424 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003425 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3426 return( ret );
3427
3428 used += 4 + session_len;
3429 if( used <= buf_len )
3430 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003431 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3432 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003433
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003434 ret = ssl_session_save( ssl->session, 1,
3435 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003436 if( ret != 0 )
3437 return( ret );
3438
3439 p += session_len;
3440 }
3441
3442 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003443 * Transform
3444 */
3445 used += sizeof( ssl->transform->randbytes );
3446 if( used <= buf_len )
3447 {
3448 memcpy( p, ssl->transform->randbytes,
3449 sizeof( ssl->transform->randbytes ) );
3450 p += sizeof( ssl->transform->randbytes );
3451 }
3452
3453#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3454 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3455 if( used <= buf_len )
3456 {
3457 *p++ = ssl->transform->in_cid_len;
3458 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3459 p += ssl->transform->in_cid_len;
3460
3461 *p++ = ssl->transform->out_cid_len;
3462 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3463 p += ssl->transform->out_cid_len;
3464 }
3465#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3466
3467 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003468 * Saved fields from top-level ssl_context structure
3469 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003470 used += 4;
3471 if( used <= buf_len )
3472 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003473 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3474 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003475 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003476
3477#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3478 used += 16;
3479 if( used <= buf_len )
3480 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003481 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3482 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003483
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003484 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3485 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003486 }
3487#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3488
3489#if defined(MBEDTLS_SSL_PROTO_DTLS)
3490 used += 1;
3491 if( used <= buf_len )
3492 {
3493 *p++ = ssl->disable_datagram_packing;
3494 }
3495#endif /* MBEDTLS_SSL_PROTO_DTLS */
3496
Jerry Yuae0b2e22021-10-08 15:21:19 +08003497 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003498 if( used <= buf_len )
3499 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003500 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3501 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003502 }
3503
3504#if defined(MBEDTLS_SSL_PROTO_DTLS)
3505 used += 2;
3506 if( used <= buf_len )
3507 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003508 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3509 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003510 }
3511#endif /* MBEDTLS_SSL_PROTO_DTLS */
3512
3513#if defined(MBEDTLS_SSL_ALPN)
3514 {
3515 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003516 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003517 : 0;
3518
3519 used += 1 + alpn_len;
3520 if( used <= buf_len )
3521 {
3522 *p++ = alpn_len;
3523
3524 if( ssl->alpn_chosen != NULL )
3525 {
3526 memcpy( p, ssl->alpn_chosen, alpn_len );
3527 p += alpn_len;
3528 }
3529 }
3530 }
3531#endif /* MBEDTLS_SSL_ALPN */
3532
3533 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003534 * Done
3535 */
3536 *olen = used;
3537
3538 if( used > buf_len )
3539 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003540
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003541 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3542
Hanno Becker43aefe22020-02-05 10:44:56 +00003543 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003544}
3545
3546/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003547 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003548 *
3549 * This internal version is wrapped by a public function that cleans up in
3550 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003551 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003552static int ssl_context_load( mbedtls_ssl_context *ssl,
3553 const unsigned char *buf,
3554 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003555{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003556 const unsigned char *p = buf;
3557 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003558 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003559 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003560
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003561 /*
3562 * The context should have been freshly setup or reset.
3563 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003564 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003565 * renegotiating, or if the user mistakenly loaded a session first.)
3566 */
3567 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3568 ssl->session != NULL )
3569 {
3570 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3571 }
3572
3573 /*
3574 * We can't check that the config matches the initial one, but we can at
3575 * least check it matches the requirements for serializing.
3576 */
3577 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003578 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3579 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003580#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003581 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003582#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003583 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003584 {
3585 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3586 }
3587
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003588 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3589
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003590 /*
3591 * Check version identifier
3592 */
3593 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3594 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3595
3596 if( memcmp( p, ssl_serialized_context_header,
3597 sizeof( ssl_serialized_context_header ) ) != 0 )
3598 {
3599 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3600 }
3601 p += sizeof( ssl_serialized_context_header );
3602
3603 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003604 * Session
3605 */
3606 if( (size_t)( end - p ) < 4 )
3607 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3608
3609 session_len = ( (size_t) p[0] << 24 ) |
3610 ( (size_t) p[1] << 16 ) |
3611 ( (size_t) p[2] << 8 ) |
3612 ( (size_t) p[3] );
3613 p += 4;
3614
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003615 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003616 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003617 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003618 ssl->session_in = ssl->session;
3619 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003620 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003621
3622 if( (size_t)( end - p ) < session_len )
3623 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3624
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003625 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003626 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003627 {
3628 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003629 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003630 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003631
3632 p += session_len;
3633
3634 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003635 * Transform
3636 */
3637
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003638 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003639 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003640 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003641 ssl->transform_in = ssl->transform;
3642 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003643 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003644
3645 /* Read random bytes and populate structure */
3646 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3647 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003648#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003649 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003650 ssl->session->ciphersuite,
3651 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003652#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3653 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003654 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003655#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3656 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003657 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3658 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003659 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003660 ssl->conf->endpoint,
3661 ssl );
3662 if( ret != 0 )
3663 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003664#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003665 p += sizeof( ssl->transform->randbytes );
3666
3667#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3668 /* Read connection IDs and store them */
3669 if( (size_t)( end - p ) < 1 )
3670 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3671
3672 ssl->transform->in_cid_len = *p++;
3673
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003674 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003675 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3676
3677 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3678 p += ssl->transform->in_cid_len;
3679
3680 ssl->transform->out_cid_len = *p++;
3681
3682 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3683 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3684
3685 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3686 p += ssl->transform->out_cid_len;
3687#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3688
3689 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003690 * Saved fields from top-level ssl_context structure
3691 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003692 if( (size_t)( end - p ) < 4 )
3693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3694
3695 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3696 ( (uint32_t) p[1] << 16 ) |
3697 ( (uint32_t) p[2] << 8 ) |
3698 ( (uint32_t) p[3] );
3699 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003700
3701#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3702 if( (size_t)( end - p ) < 16 )
3703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3704
3705 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3706 ( (uint64_t) p[1] << 48 ) |
3707 ( (uint64_t) p[2] << 40 ) |
3708 ( (uint64_t) p[3] << 32 ) |
3709 ( (uint64_t) p[4] << 24 ) |
3710 ( (uint64_t) p[5] << 16 ) |
3711 ( (uint64_t) p[6] << 8 ) |
3712 ( (uint64_t) p[7] );
3713 p += 8;
3714
3715 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3716 ( (uint64_t) p[1] << 48 ) |
3717 ( (uint64_t) p[2] << 40 ) |
3718 ( (uint64_t) p[3] << 32 ) |
3719 ( (uint64_t) p[4] << 24 ) |
3720 ( (uint64_t) p[5] << 16 ) |
3721 ( (uint64_t) p[6] << 8 ) |
3722 ( (uint64_t) p[7] );
3723 p += 8;
3724#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3725
3726#if defined(MBEDTLS_SSL_PROTO_DTLS)
3727 if( (size_t)( end - p ) < 1 )
3728 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3729
3730 ssl->disable_datagram_packing = *p++;
3731#endif /* MBEDTLS_SSL_PROTO_DTLS */
3732
Jerry Yud9a94fe2021-09-28 18:58:59 +08003733 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003735 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3736 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003737
3738#if defined(MBEDTLS_SSL_PROTO_DTLS)
3739 if( (size_t)( end - p ) < 2 )
3740 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3741
3742 ssl->mtu = ( p[0] << 8 ) | p[1];
3743 p += 2;
3744#endif /* MBEDTLS_SSL_PROTO_DTLS */
3745
3746#if defined(MBEDTLS_SSL_ALPN)
3747 {
3748 uint8_t alpn_len;
3749 const char **cur;
3750
3751 if( (size_t)( end - p ) < 1 )
3752 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3753
3754 alpn_len = *p++;
3755
3756 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3757 {
3758 /* alpn_chosen should point to an item in the configured list */
3759 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3760 {
3761 if( strlen( *cur ) == alpn_len &&
3762 memcmp( p, cur, alpn_len ) == 0 )
3763 {
3764 ssl->alpn_chosen = *cur;
3765 break;
3766 }
3767 }
3768 }
3769
3770 /* can only happen on conf mismatch */
3771 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3773
3774 p += alpn_len;
3775 }
3776#endif /* MBEDTLS_SSL_ALPN */
3777
3778 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003779 * Forced fields from top-level ssl_context structure
3780 *
3781 * Most of them already set to the correct value by mbedtls_ssl_init() and
3782 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3783 */
3784 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
3785
3786 ssl->major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
3787 ssl->minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
3788
Hanno Becker361b10d2019-08-30 10:42:49 +01003789 /* Adjust pointers for header fields of outgoing records to
3790 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003791 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003792
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003793#if defined(MBEDTLS_SSL_PROTO_DTLS)
3794 ssl->in_epoch = 1;
3795#endif
3796
3797 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3798 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003799 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3800 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003801 if( ssl->handshake != NULL )
3802 {
3803 mbedtls_ssl_handshake_free( ssl );
3804 mbedtls_free( ssl->handshake );
3805 ssl->handshake = NULL;
3806 }
3807
3808 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003809 * Done - should have consumed entire buffer
3810 */
3811 if( p != end )
3812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003813
3814 return( 0 );
3815}
3816
3817/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003818 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003819 */
3820int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3821 const unsigned char *buf,
3822 size_t len )
3823{
3824 int ret = ssl_context_load( context, buf, len );
3825
3826 if( ret != 0 )
3827 mbedtls_ssl_free( context );
3828
3829 return( ret );
3830}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003831#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003832
3833/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003834 * Free an SSL context
3835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003837{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003838 if( ssl == NULL )
3839 return;
3840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003841 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003842
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003843 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003844 {
sander-visserb8aa2072020-05-06 22:05:13 +02003845#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3846 size_t out_buf_len = ssl->out_buf_len;
3847#else
3848 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3849#endif
3850
Darryl Greenb33cc762019-11-28 14:29:44 +00003851 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003852 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003853 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003854 }
3855
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003856 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003857 {
sander-visserb8aa2072020-05-06 22:05:13 +02003858#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3859 size_t in_buf_len = ssl->in_buf_len;
3860#else
3861 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3862#endif
3863
Darryl Greenb33cc762019-11-28 14:29:44 +00003864 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003865 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003866 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003867 }
3868
Paul Bakker48916f92012-09-16 19:57:18 +00003869 if( ssl->transform )
3870 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003871 mbedtls_ssl_transform_free( ssl->transform );
3872 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003873 }
3874
3875 if( ssl->handshake )
3876 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003877 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3879 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003881 mbedtls_free( ssl->handshake );
3882 mbedtls_free( ssl->transform_negotiate );
3883 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003884 }
3885
Ronald Cron6f135e12021-12-08 16:57:54 +01003886#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003887 mbedtls_ssl_transform_free( ssl->transform_application );
3888 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003889#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003890
Paul Bakkerc0463502013-02-14 11:19:38 +01003891 if( ssl->session )
3892 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003893 mbedtls_ssl_session_free( ssl->session );
3894 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003895 }
3896
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003897#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003898 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003899 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003900 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003901 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003902 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003903#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003904
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003905#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003906 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003907#endif
3908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003910
Paul Bakker86f04f42013-02-14 11:20:09 +01003911 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003912 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003913}
3914
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003915/*
3916 * Initialze mbedtls_ssl_config
3917 */
3918void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3919{
3920 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3921}
3922
Gilles Peskineeccd8882020-03-10 12:19:08 +01003923#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003924#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003925/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003926 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3927 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003928 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3929 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003930static int ssl_preset_default_hashes[] = {
3931#if defined(MBEDTLS_SHA512_C)
3932 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003933#endif
3934#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003935 MBEDTLS_MD_SHA384,
3936#endif
3937#if defined(MBEDTLS_SHA256_C)
3938 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003939#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003940 MBEDTLS_MD_NONE
3941};
Jerry Yuf017ee42022-01-12 15:49:48 +08003942#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3943#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003944
Gilles Peskineae270bf2021-06-02 00:05:29 +02003945/* The selection should be the same as mbedtls_x509_crt_profile_default in
3946 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003947 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003948 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003949 * about this list.
3950 */
Brett Warrene0edc842021-08-17 09:53:13 +01003951static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003952#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003953 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003954#endif
3955#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003956 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003957#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003958#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003959 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003960#endif
3961#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003962 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003963#endif
3964#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003965 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003966#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003967#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003968 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003969#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003970#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003971 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003972#endif
3973#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003974 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003975#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003976 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003977};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003978
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003979static int ssl_preset_suiteb_ciphersuites[] = {
3980 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3981 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3982 0
3983};
3984
Gilles Peskineeccd8882020-03-10 12:19:08 +01003985#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003986#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003987static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003988#if defined(MBEDTLS_SHA256_C)
3989 MBEDTLS_MD_SHA256,
3990#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003991#if defined(MBEDTLS_SHA384_C)
3992 MBEDTLS_MD_SHA384,
3993#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003994 MBEDTLS_MD_NONE
3995};
Jerry Yuf017ee42022-01-12 15:49:48 +08003996#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003997
Jerry Yu909df7b2022-01-22 11:56:27 +08003998/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003999 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004000 * rules SHOULD be upheld.
4001 * - No duplicate entries.
4002 * - But if there is a good reason, do not change the order of the algorithms.
4003 * - ssl_tls12_present* is for TLS 1.2 use only.
4004 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004005 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004006static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004007
Jerry Yued5e9f42022-01-26 11:21:34 +08004008#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4009 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4010 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4011#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4012 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004013
Jerry Yu909df7b2022-01-22 11:56:27 +08004014#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4015 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4016 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4017#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4018 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4019
Jerry Yued5e9f42022-01-26 11:21:34 +08004020#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4021 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4022 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4023#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4024 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004025
Jerry Yu909df7b2022-01-22 11:56:27 +08004026#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4027 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4028#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4029
Ronald Cron8540cf62022-03-16 08:01:09 +01004030#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4031 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4032#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4033
4034#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4035 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4036#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4037
Jerry Yu53037892022-01-25 11:02:06 +08004038#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4039 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4040#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4041
Jerry Yu909df7b2022-01-22 11:56:27 +08004042 MBEDTLS_TLS1_3_SIG_NONE
4043};
4044
4045/* NOTICE: see above */
4046#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4047static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004048#if defined(MBEDTLS_SHA512_C)
4049 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4050#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004051#if defined(MBEDTLS_SHA384_C)
4052 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4053#endif
4054#if defined(MBEDTLS_SHA256_C)
4055 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4056#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004057 MBEDTLS_TLS1_3_SIG_NONE
4058};
4059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4060/* NOTICE: see above */
4061static uint16_t ssl_preset_suiteb_sig_algs[] = {
4062
Jerry Yu909df7b2022-01-22 11:56:27 +08004063#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4064 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4065 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4066#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4067 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4068
Jerry Yu53037892022-01-25 11:02:06 +08004069#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4070 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4071 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4072#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4073 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004074
4075#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4076 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4077#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004078
Jerry Yu53037892022-01-25 11:02:06 +08004079#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4080 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4081#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4082
Jerry Yu713013f2022-01-17 18:16:35 +08004083 MBEDTLS_TLS1_3_SIG_NONE
4084};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004085
Jerry Yu909df7b2022-01-22 11:56:27 +08004086/* NOTICE: see above */
4087#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4088static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004089#if defined(MBEDTLS_SHA256_C)
4090 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4091#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004092#if defined(MBEDTLS_SHA384_C)
4093 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4094#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004095 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004096};
Jerry Yu909df7b2022-01-22 11:56:27 +08004097#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4098
Jerry Yu1a8b4812022-01-20 17:56:50 +08004099#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004100
Brett Warrene0edc842021-08-17 09:53:13 +01004101static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004102#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004103 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004104#endif
4105#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004106 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004107#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004108 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004109};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004110
Jerry Yu1a8b4812022-01-20 17:56:50 +08004111#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004112/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004113 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004114static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004115{
4116 size_t i, j;
4117 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004118
Jerry Yuf377d642022-01-25 10:43:59 +08004119 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004120 {
Jerry Yuf377d642022-01-25 10:43:59 +08004121 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004122 {
Jerry Yuf377d642022-01-25 10:43:59 +08004123 if( sig_algs[i] != sig_algs[j] )
4124 continue;
4125 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4126 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4127 sig_algs[i], j, i );
4128 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004129 }
4130 }
4131 return( ret );
4132}
4133
4134#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4135
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004136/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004137 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004138 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004139int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004140 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004141{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004142#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004144#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004145
Jerry Yu1a8b4812022-01-20 17:56:50 +08004146#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004147 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004148 {
4149 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4150 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4151 }
4152
Jerry Yuf377d642022-01-25 10:43:59 +08004153 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004154 {
4155 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4156 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4157 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004158
4159#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004160 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004161 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004162 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004163 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4164 }
4165
Jerry Yuf377d642022-01-25 10:43:59 +08004166 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004167 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004168 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004169 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4170 }
4171#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004172#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4173
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004174 /* Use the functions here so that they are covered in tests,
4175 * but otherwise access member directly for efficiency */
4176 mbedtls_ssl_conf_endpoint( conf, endpoint );
4177 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004178
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004179 /*
4180 * Things that are common to all presets
4181 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004182#if defined(MBEDTLS_SSL_CLI_C)
4183 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4184 {
4185 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4186#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4187 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4188#endif
4189 }
4190#endif
4191
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004192#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4193 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4194#endif
4195
4196#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4197 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4198#endif
4199
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004200#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004201 conf->f_cookie_write = ssl_cookie_write_dummy;
4202 conf->f_cookie_check = ssl_cookie_check_dummy;
4203#endif
4204
4205#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4206 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4207#endif
4208
Janos Follath088ce432017-04-10 12:42:31 +01004209#if defined(MBEDTLS_SSL_SRV_C)
4210 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004211 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004212#endif
4213
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004214#if defined(MBEDTLS_SSL_PROTO_DTLS)
4215 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4216 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4217#endif
4218
4219#if defined(MBEDTLS_SSL_RENEGOTIATION)
4220 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004221 memset( conf->renego_period, 0x00, 2 );
4222 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004223#endif
4224
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004225#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004226 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4227 {
4228 const unsigned char dhm_p[] =
4229 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4230 const unsigned char dhm_g[] =
4231 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004232
Hanno Beckere2defad2021-07-24 05:59:17 +01004233 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4234 dhm_p, sizeof( dhm_p ),
4235 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4236 {
4237 return( ret );
4238 }
4239 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004240#endif
4241
Ronald Cron6f135e12021-12-08 16:57:54 +01004242#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004243 /*
4244 * Allow all TLS 1.3 key exchange modes by default.
4245 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004246 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004247#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004248
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004249 if( ( endpoint == MBEDTLS_SSL_IS_SERVER ) ||
4250 ( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) )
4251 {
4252#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4253 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4254 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4255#else
4256 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4257#endif
4258 }
4259 else
4260 {
4261#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4262 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4263 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4264#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4265 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4266 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4267#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4268 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4269 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4270#else
4271 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4272#endif
4273 }
4274
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004275 /*
4276 * Preset-specific defaults
4277 */
4278 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004279 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004280 /*
4281 * NSA Suite B
4282 */
4283 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004284
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004285 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004286
4287#if defined(MBEDTLS_X509_CRT_PARSE_C)
4288 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004289#endif
4290
Gilles Peskineeccd8882020-03-10 12:19:08 +01004291#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004292#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004293 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004294#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004295#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4296 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4297 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4298 else
4299#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4300 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004301#endif
4302
Brett Warrene0edc842021-08-17 09:53:13 +01004303#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4304 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004305#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004306 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004307 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004308
4309 /*
4310 * Default
4311 */
4312 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004313
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004314 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004315
4316#if defined(MBEDTLS_X509_CRT_PARSE_C)
4317 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4318#endif
4319
Gilles Peskineeccd8882020-03-10 12:19:08 +01004320#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004321#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004322 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004323#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4325 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4326 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4327 else
4328#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4329 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004330#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004331
Brett Warrene0edc842021-08-17 09:53:13 +01004332#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4333 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004334#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004335 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004336
4337#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4338 conf->dhm_min_bitlen = 1024;
4339#endif
4340 }
4341
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004342 return( 0 );
4343}
4344
4345/*
4346 * Free mbedtls_ssl_config
4347 */
4348void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4349{
4350#if defined(MBEDTLS_DHM_C)
4351 mbedtls_mpi_free( &conf->dhm_P );
4352 mbedtls_mpi_free( &conf->dhm_G );
4353#endif
4354
Gilles Peskineeccd8882020-03-10 12:19:08 +01004355#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004356 if( conf->psk != NULL )
4357 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004358 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004359 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004360 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004361 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004362 }
4363
4364 if( conf->psk_identity != NULL )
4365 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004366 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004367 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004368 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004369 conf->psk_identity_len = 0;
4370 }
4371#endif
4372
4373#if defined(MBEDTLS_X509_CRT_PARSE_C)
4374 ssl_key_cert_free( conf->key_cert );
4375#endif
4376
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004377 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004378}
4379
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004380#if defined(MBEDTLS_PK_C) && \
4381 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004382/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004383 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004385unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004386{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387#if defined(MBEDTLS_RSA_C)
4388 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4389 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004390#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004391#if defined(MBEDTLS_ECDSA_C)
4392 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4393 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004394#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004395 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004396}
4397
Hanno Becker7e5437a2017-04-28 17:15:26 +01004398unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4399{
4400 switch( type ) {
4401 case MBEDTLS_PK_RSA:
4402 return( MBEDTLS_SSL_SIG_RSA );
4403 case MBEDTLS_PK_ECDSA:
4404 case MBEDTLS_PK_ECKEY:
4405 return( MBEDTLS_SSL_SIG_ECDSA );
4406 default:
4407 return( MBEDTLS_SSL_SIG_ANON );
4408 }
4409}
4410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004411mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004412{
4413 switch( sig )
4414 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415#if defined(MBEDTLS_RSA_C)
4416 case MBEDTLS_SSL_SIG_RSA:
4417 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004418#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004419#if defined(MBEDTLS_ECDSA_C)
4420 case MBEDTLS_SSL_SIG_ECDSA:
4421 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004422#endif
4423 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004424 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004425 }
4426}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004427#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004428
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004429/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004430 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004432mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004433{
4434 switch( hash )
4435 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004436#if defined(MBEDTLS_MD5_C)
4437 case MBEDTLS_SSL_HASH_MD5:
4438 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004439#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004440#if defined(MBEDTLS_SHA1_C)
4441 case MBEDTLS_SSL_HASH_SHA1:
4442 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004443#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004444#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004445 case MBEDTLS_SSL_HASH_SHA224:
4446 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004447#endif
4448#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004449 case MBEDTLS_SSL_HASH_SHA256:
4450 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004451#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004452#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004453 case MBEDTLS_SSL_HASH_SHA384:
4454 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004455#endif
4456#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004457 case MBEDTLS_SSL_HASH_SHA512:
4458 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004459#endif
4460 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004461 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004462 }
4463}
4464
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004465/*
4466 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4467 */
4468unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4469{
4470 switch( md )
4471 {
4472#if defined(MBEDTLS_MD5_C)
4473 case MBEDTLS_MD_MD5:
4474 return( MBEDTLS_SSL_HASH_MD5 );
4475#endif
4476#if defined(MBEDTLS_SHA1_C)
4477 case MBEDTLS_MD_SHA1:
4478 return( MBEDTLS_SSL_HASH_SHA1 );
4479#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004480#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004481 case MBEDTLS_MD_SHA224:
4482 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004483#endif
4484#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004485 case MBEDTLS_MD_SHA256:
4486 return( MBEDTLS_SSL_HASH_SHA256 );
4487#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004488#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004489 case MBEDTLS_MD_SHA384:
4490 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004491#endif
4492#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004493 case MBEDTLS_MD_SHA512:
4494 return( MBEDTLS_SSL_HASH_SHA512 );
4495#endif
4496 default:
4497 return( MBEDTLS_SSL_HASH_NONE );
4498 }
4499}
4500
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004501/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004502 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004503 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004504 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004505int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004506{
Brett Warrene0edc842021-08-17 09:53:13 +01004507 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004508
Brett Warrene0edc842021-08-17 09:53:13 +01004509 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004510 return( -1 );
4511
Brett Warrene0edc842021-08-17 09:53:13 +01004512 for( ; *group_list != 0; group_list++ )
4513 {
4514 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004515 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004516 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004517
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004518 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004519}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004520
4521#if defined(MBEDTLS_ECP_C)
4522/*
4523 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4524 */
4525int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4526{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004527 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004528 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4529}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004530#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532#if defined(MBEDTLS_X509_CRT_PARSE_C)
4533int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4534 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004535 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004536 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004537{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004538 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004539 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004540 const char *ext_oid;
4541 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004544 {
4545 /* Server part of the key exchange */
4546 switch( ciphersuite->key_exchange )
4547 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004548 case MBEDTLS_KEY_EXCHANGE_RSA:
4549 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004550 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004551 break;
4552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4554 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4555 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4556 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004557 break;
4558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004559 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4560 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004561 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004562 break;
4563
4564 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565 case MBEDTLS_KEY_EXCHANGE_NONE:
4566 case MBEDTLS_KEY_EXCHANGE_PSK:
4567 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4568 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004569 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004570 usage = 0;
4571 }
4572 }
4573 else
4574 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4576 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004577 }
4578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004580 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004581 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004582 ret = -1;
4583 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004585 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004587 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4588 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004589 }
4590 else
4591 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4593 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004594 }
4595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004596 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004597 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004598 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004599 ret = -1;
4600 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004601
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004602 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004603}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004604#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004605
Jerry Yu148165c2021-09-24 23:20:59 +08004606#if defined(MBEDTLS_USE_PSA_CRYPTO)
4607int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4608 const mbedtls_md_type_t md,
4609 unsigned char *dst,
4610 size_t dst_len,
4611 size_t *olen )
4612{
Ronald Cronf6893e12022-01-07 22:09:01 +01004613 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4614 psa_hash_operation_t *hash_operation_to_clone;
4615 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4616
Jerry Yu148165c2021-09-24 23:20:59 +08004617 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004618
4619 switch( md )
4620 {
4621#if defined(MBEDTLS_SHA384_C)
4622 case MBEDTLS_MD_SHA384:
4623 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4624 break;
4625#endif
4626
4627#if defined(MBEDTLS_SHA256_C)
4628 case MBEDTLS_MD_SHA256:
4629 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4630 break;
4631#endif
4632
4633 default:
4634 goto exit;
4635 }
4636
4637 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4638 if( status != PSA_SUCCESS )
4639 goto exit;
4640
4641 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4642 if( status != PSA_SUCCESS )
4643 goto exit;
4644
4645exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004646 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004647}
4648#else /* MBEDTLS_USE_PSA_CRYPTO */
4649
Jerry Yu24c0ec32021-09-09 14:21:07 +08004650#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004651static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4652 unsigned char *dst,
4653 size_t dst_len,
4654 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004655{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004656 int ret;
4657 mbedtls_sha512_context sha512;
4658
4659 if( dst_len < 48 )
4660 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4661
4662 mbedtls_sha512_init( &sha512 );
4663 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4664
4665 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4666 {
4667 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4668 goto exit;
4669 }
4670
4671 *olen = 48;
4672
4673exit:
4674
4675 mbedtls_sha512_free( &sha512 );
4676 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004677}
4678#endif /* MBEDTLS_SHA384_C */
4679
4680#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004681static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4682 unsigned char *dst,
4683 size_t dst_len,
4684 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004685{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004686 int ret;
4687 mbedtls_sha256_context sha256;
4688
4689 if( dst_len < 32 )
4690 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4691
4692 mbedtls_sha256_init( &sha256 );
4693 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004694
Jerry Yu24c0ec32021-09-09 14:21:07 +08004695 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4696 {
4697 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4698 goto exit;
4699 }
4700
4701 *olen = 32;
4702
4703exit:
4704
4705 mbedtls_sha256_free( &sha256 );
4706 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004707}
4708#endif /* MBEDTLS_SHA256_C */
4709
Jerry Yu000f9762021-09-14 11:12:51 +08004710int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4711 const mbedtls_md_type_t md,
4712 unsigned char *dst,
4713 size_t dst_len,
4714 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004715{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004716 switch( md )
4717 {
4718
Jerry Yu24c0ec32021-09-09 14:21:07 +08004719#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004720 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004721 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004722#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004723
Jerry Yu24c0ec32021-09-09 14:21:07 +08004724#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004725 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004726 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004727#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004728
4729 default:
4730 break;
4731 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004732 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004733}
XiaokangQian647719a2021-12-07 09:16:29 +00004734
Jerry Yu148165c2021-09-24 23:20:59 +08004735#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004736
Jerry Yudc7bd172022-02-17 13:44:15 +08004737#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4738
4739#if defined(MBEDTLS_USE_PSA_CRYPTO)
4740
4741static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4742 mbedtls_svc_key_id_t key,
4743 psa_algorithm_t alg,
4744 const unsigned char* seed, size_t seed_length,
4745 const unsigned char* label, size_t label_length,
4746 size_t capacity )
4747{
4748 psa_status_t status;
4749
4750 status = psa_key_derivation_setup( derivation, alg );
4751 if( status != PSA_SUCCESS )
4752 return( status );
4753
4754 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4755 {
4756 status = psa_key_derivation_input_bytes( derivation,
4757 PSA_KEY_DERIVATION_INPUT_SEED,
4758 seed, seed_length );
4759 if( status != PSA_SUCCESS )
4760 return( status );
4761
4762 if( mbedtls_svc_key_id_is_null( key ) )
4763 {
4764 status = psa_key_derivation_input_bytes(
4765 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4766 NULL, 0 );
4767 }
4768 else
4769 {
4770 status = psa_key_derivation_input_key(
4771 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4772 }
4773 if( status != PSA_SUCCESS )
4774 return( status );
4775
4776 status = psa_key_derivation_input_bytes( derivation,
4777 PSA_KEY_DERIVATION_INPUT_LABEL,
4778 label, label_length );
4779 if( status != PSA_SUCCESS )
4780 return( status );
4781 }
4782 else
4783 {
4784 return( PSA_ERROR_NOT_SUPPORTED );
4785 }
4786
4787 status = psa_key_derivation_set_capacity( derivation, capacity );
4788 if( status != PSA_SUCCESS )
4789 return( status );
4790
4791 return( PSA_SUCCESS );
4792}
4793
4794static int tls_prf_generic( mbedtls_md_type_t md_type,
4795 const unsigned char *secret, size_t slen,
4796 const char *label,
4797 const unsigned char *random, size_t rlen,
4798 unsigned char *dstbuf, size_t dlen )
4799{
4800 psa_status_t status;
4801 psa_algorithm_t alg;
4802 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4803 psa_key_derivation_operation_t derivation =
4804 PSA_KEY_DERIVATION_OPERATION_INIT;
4805
4806 if( md_type == MBEDTLS_MD_SHA384 )
4807 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4808 else
4809 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4810
4811 /* Normally a "secret" should be long enough to be impossible to
4812 * find by brute force, and in particular should not be empty. But
4813 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4814 * and for this use case it makes sense to have a 0-length "secret".
4815 * Since the key API doesn't allow importing a key of length 0,
4816 * keep master_key=0, which setup_psa_key_derivation() understands
4817 * to mean a 0-length "secret" input. */
4818 if( slen != 0 )
4819 {
4820 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4821 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4822 psa_set_key_algorithm( &key_attributes, alg );
4823 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4824
4825 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4826 if( status != PSA_SUCCESS )
4827 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4828 }
4829
4830 status = setup_psa_key_derivation( &derivation,
4831 master_key, alg,
4832 random, rlen,
4833 (unsigned char const *) label,
4834 (size_t) strlen( label ),
4835 dlen );
4836 if( status != PSA_SUCCESS )
4837 {
4838 psa_key_derivation_abort( &derivation );
4839 psa_destroy_key( master_key );
4840 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4841 }
4842
4843 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4844 if( status != PSA_SUCCESS )
4845 {
4846 psa_key_derivation_abort( &derivation );
4847 psa_destroy_key( master_key );
4848 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4849 }
4850
4851 status = psa_key_derivation_abort( &derivation );
4852 if( status != PSA_SUCCESS )
4853 {
4854 psa_destroy_key( master_key );
4855 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4856 }
4857
4858 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4859 status = psa_destroy_key( master_key );
4860 if( status != PSA_SUCCESS )
4861 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4862
4863 return( 0 );
4864}
4865
4866#else /* MBEDTLS_USE_PSA_CRYPTO */
4867
4868static int tls_prf_generic( mbedtls_md_type_t md_type,
4869 const unsigned char *secret, size_t slen,
4870 const char *label,
4871 const unsigned char *random, size_t rlen,
4872 unsigned char *dstbuf, size_t dlen )
4873{
4874 size_t nb;
4875 size_t i, j, k, md_len;
4876 unsigned char *tmp;
4877 size_t tmp_len = 0;
4878 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
4879 const mbedtls_md_info_t *md_info;
4880 mbedtls_md_context_t md_ctx;
4881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4882
4883 mbedtls_md_init( &md_ctx );
4884
4885 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
4886 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4887
4888 md_len = mbedtls_md_get_size( md_info );
4889
4890 tmp_len = md_len + strlen( label ) + rlen;
4891 tmp = mbedtls_calloc( 1, tmp_len );
4892 if( tmp == NULL )
4893 {
4894 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4895 goto exit;
4896 }
4897
4898 nb = strlen( label );
4899 memcpy( tmp + md_len, label, nb );
4900 memcpy( tmp + md_len + nb, random, rlen );
4901 nb += rlen;
4902
4903 /*
4904 * Compute P_<hash>(secret, label + random)[0..dlen]
4905 */
4906 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
4907 goto exit;
4908
4909 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
4910 if( ret != 0 )
4911 goto exit;
4912 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
4913 if( ret != 0 )
4914 goto exit;
4915 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4916 if( ret != 0 )
4917 goto exit;
4918
4919 for( i = 0; i < dlen; i += md_len )
4920 {
4921 ret = mbedtls_md_hmac_reset ( &md_ctx );
4922 if( ret != 0 )
4923 goto exit;
4924 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
4925 if( ret != 0 )
4926 goto exit;
4927 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
4928 if( ret != 0 )
4929 goto exit;
4930
4931 ret = mbedtls_md_hmac_reset ( &md_ctx );
4932 if( ret != 0 )
4933 goto exit;
4934 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
4935 if( ret != 0 )
4936 goto exit;
4937 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4938 if( ret != 0 )
4939 goto exit;
4940
4941 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
4942
4943 for( j = 0; j < k; j++ )
4944 dstbuf[i + j] = h_i[j];
4945 }
4946
4947exit:
4948 mbedtls_md_free( &md_ctx );
4949
4950 mbedtls_platform_zeroize( tmp, tmp_len );
4951 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
4952
4953 mbedtls_free( tmp );
4954
4955 return( ret );
4956}
4957#endif /* MBEDTLS_USE_PSA_CRYPTO */
4958
4959#if defined(MBEDTLS_SHA256_C)
4960static int tls_prf_sha256( const unsigned char *secret, size_t slen,
4961 const char *label,
4962 const unsigned char *random, size_t rlen,
4963 unsigned char *dstbuf, size_t dlen )
4964{
4965 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
4966 label, random, rlen, dstbuf, dlen ) );
4967}
4968#endif /* MBEDTLS_SHA256_C */
4969
4970#if defined(MBEDTLS_SHA384_C)
4971static int tls_prf_sha384( const unsigned char *secret, size_t slen,
4972 const char *label,
4973 const unsigned char *random, size_t rlen,
4974 unsigned char *dstbuf, size_t dlen )
4975{
4976 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
4977 label, random, rlen, dstbuf, dlen ) );
4978}
4979#endif /* MBEDTLS_SHA384_C */
4980
Jerry Yuf009d862022-02-17 14:01:37 +08004981/*
4982 * Set appropriate PRF function and other SSL / TLS1.2 functions
4983 *
4984 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08004985 * - hash associated with the ciphersuite (only used by TLS 1.2)
4986 *
4987 * Outputs:
4988 * - the tls_prf, calc_verify and calc_finished members of handshake structure
4989 */
4990static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08004991 mbedtls_md_type_t hash )
4992{
Jerry Yuf009d862022-02-17 14:01:37 +08004993#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01004994 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08004995 {
4996 handshake->tls_prf = tls_prf_sha384;
4997 handshake->calc_verify = ssl_calc_verify_tls_sha384;
4998 handshake->calc_finished = ssl_calc_finished_tls_sha384;
4999 }
5000 else
5001#endif
5002#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005003 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005004 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005005 handshake->tls_prf = tls_prf_sha256;
5006 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5007 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5008 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005009#else
Jerry Yuf009d862022-02-17 14:01:37 +08005010 {
Jerry Yuf009d862022-02-17 14:01:37 +08005011 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005012 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005013 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5014 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005015#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005016
5017 return( 0 );
5018}
Jerry Yud6ab2352022-02-17 14:03:43 +08005019
5020#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
5021 defined(MBEDTLS_USE_PSA_CRYPTO)
5022static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
5023{
5024 if( ssl->conf->f_psk != NULL )
5025 {
5026 /* If we've used a callback to select the PSK,
5027 * the static configuration is irrelevant. */
5028 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
5029 return( 1 );
5030
5031 return( 0 );
5032 }
5033
5034 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5035 return( 1 );
5036
5037 return( 0 );
5038}
5039#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5040 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5041
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005042/*
5043 * Compute master secret if needed
5044 *
5045 * Parameters:
5046 * [in/out] handshake
5047 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5048 * (PSA-PSK) ciphersuite_info, psk_opaque
5049 * [out] premaster (cleared)
5050 * [out] master
5051 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5052 * debug: conf->f_dbg, conf->p_dbg
5053 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005054 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005055 */
5056static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5057 unsigned char *master,
5058 const mbedtls_ssl_context *ssl )
5059{
5060 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5061
5062 /* cf. RFC 5246, Section 8.1:
5063 * "The master secret is always exactly 48 bytes in length." */
5064 size_t const master_secret_len = 48;
5065
5066#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5067 unsigned char session_hash[48];
5068#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5069
5070 /* The label for the KDF used for key expansion.
5071 * This is either "master secret" or "extended master secret"
5072 * depending on whether the Extended Master Secret extension
5073 * is used. */
5074 char const *lbl = "master secret";
5075
5076 /* The salt for the KDF used for key expansion.
5077 * - If the Extended Master Secret extension is not used,
5078 * this is ClientHello.Random + ServerHello.Random
5079 * (see Sect. 8.1 in RFC 5246).
5080 * - If the Extended Master Secret extension is used,
5081 * this is the transcript of the handshake so far.
5082 * (see Sect. 4 in RFC 7627). */
5083 unsigned char const *salt = handshake->randbytes;
5084 size_t salt_len = 64;
5085
5086#if !defined(MBEDTLS_DEBUG_C) && \
5087 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5088 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5089 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5090 ssl = NULL; /* make sure we don't use it except for those cases */
5091 (void) ssl;
5092#endif
5093
5094 if( handshake->resume != 0 )
5095 {
5096 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5097 return( 0 );
5098 }
5099
5100#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5101 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5102 {
5103 lbl = "extended master secret";
5104 salt = session_hash;
5105 handshake->calc_verify( ssl, session_hash, &salt_len );
5106
5107 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5108 session_hash, salt_len );
5109 }
5110#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5111
5112#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5113 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5114 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005115 ssl_use_opaque_psk( ssl ) == 1 )
5116 {
5117 /* Perform PSK-to-MS expansion in a single step. */
5118 psa_status_t status;
5119 psa_algorithm_t alg;
5120 mbedtls_svc_key_id_t psk;
5121 psa_key_derivation_operation_t derivation =
5122 PSA_KEY_DERIVATION_OPERATION_INIT;
5123 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5124
5125 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5126
5127 psk = mbedtls_ssl_get_opaque_psk( ssl );
5128
5129 if( hash_alg == MBEDTLS_MD_SHA384 )
5130 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5131 else
5132 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5133
5134 status = setup_psa_key_derivation( &derivation, psk, alg,
5135 salt, salt_len,
5136 (unsigned char const *) lbl,
5137 (size_t) strlen( lbl ),
5138 master_secret_len );
5139 if( status != PSA_SUCCESS )
5140 {
5141 psa_key_derivation_abort( &derivation );
5142 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5143 }
5144
5145 status = psa_key_derivation_output_bytes( &derivation,
5146 master,
5147 master_secret_len );
5148 if( status != PSA_SUCCESS )
5149 {
5150 psa_key_derivation_abort( &derivation );
5151 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5152 }
5153
5154 status = psa_key_derivation_abort( &derivation );
5155 if( status != PSA_SUCCESS )
5156 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5157 }
5158 else
5159#endif
5160 {
5161 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5162 lbl, salt, salt_len,
5163 master,
5164 master_secret_len );
5165 if( ret != 0 )
5166 {
5167 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5168 return( ret );
5169 }
5170
5171 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5172 handshake->premaster,
5173 handshake->pmslen );
5174
5175 mbedtls_platform_zeroize( handshake->premaster,
5176 sizeof(handshake->premaster) );
5177 }
5178
5179 return( 0 );
5180}
5181
Jerry Yud62f87e2022-02-17 14:09:02 +08005182int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5183{
5184 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5185 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5186 ssl->handshake->ciphersuite_info;
5187
5188 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5189
5190 /* Set PRF, calc_verify and calc_finished function pointers */
5191 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005192 ciphersuite_info->mac );
5193 if( ret != 0 )
5194 {
5195 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5196 return( ret );
5197 }
5198
5199 /* Compute master secret if needed */
5200 ret = ssl_compute_master( ssl->handshake,
5201 ssl->session_negotiate->master,
5202 ssl );
5203 if( ret != 0 )
5204 {
5205 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5206 return( ret );
5207 }
5208
5209 /* Swap the client and server random values:
5210 * - MS derivation wanted client+server (RFC 5246 8.1)
5211 * - key derivation wants server+client (RFC 5246 6.3) */
5212 {
5213 unsigned char tmp[64];
5214 memcpy( tmp, ssl->handshake->randbytes, 64 );
5215 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5216 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5217 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5218 }
5219
5220 /* Populate transform structure */
5221 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5222 ssl->session_negotiate->ciphersuite,
5223 ssl->session_negotiate->master,
5224#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5225 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5226 ssl->session_negotiate->encrypt_then_mac,
5227#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5228 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5229 ssl->handshake->tls_prf,
5230 ssl->handshake->randbytes,
Glenn Strauss07c64162022-03-14 12:34:51 -04005231 ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4
5232 ? MBEDTLS_SSL_VERSION_TLS1_3
5233 : MBEDTLS_SSL_VERSION_TLS1_2,
Jerry Yud62f87e2022-02-17 14:09:02 +08005234 ssl->conf->endpoint,
5235 ssl );
5236 if( ret != 0 )
5237 {
5238 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5239 return( ret );
5240 }
5241
5242 /* We no longer need Server/ClientHello.random values */
5243 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5244 sizeof( ssl->handshake->randbytes ) );
5245
5246 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5247
5248 return( 0 );
5249}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005250
Ronald Cron4dcbca92022-03-07 10:21:40 +01005251int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5252{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005253 switch( md )
5254 {
5255#if defined(MBEDTLS_SHA384_C)
5256 case MBEDTLS_SSL_HASH_SHA384:
5257 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5258 break;
5259#endif
5260#if defined(MBEDTLS_SHA256_C)
5261 case MBEDTLS_SSL_HASH_SHA256:
5262 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5263 break;
5264#endif
5265 default:
5266 return( -1 );
5267 }
5268
Ronald Cronc2f13a02022-03-07 10:25:24 +01005269 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005270}
5271
Jerry Yu8392e0d2022-02-17 14:10:24 +08005272#if defined(MBEDTLS_SHA256_C)
5273void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5274 unsigned char *hash,
5275 size_t *hlen )
5276{
5277#if defined(MBEDTLS_USE_PSA_CRYPTO)
5278 size_t hash_size;
5279 psa_status_t status;
5280 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5281
5282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5283 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5284 if( status != PSA_SUCCESS )
5285 {
5286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5287 return;
5288 }
5289
5290 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5291 if( status != PSA_SUCCESS )
5292 {
5293 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5294 return;
5295 }
5296
5297 *hlen = 32;
5298 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5300#else
5301 mbedtls_sha256_context sha256;
5302
5303 mbedtls_sha256_init( &sha256 );
5304
5305 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5306
5307 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5308 mbedtls_sha256_finish( &sha256, hash );
5309
5310 *hlen = 32;
5311
5312 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5313 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5314
5315 mbedtls_sha256_free( &sha256 );
5316#endif /* MBEDTLS_USE_PSA_CRYPTO */
5317 return;
5318}
5319#endif /* MBEDTLS_SHA256_C */
5320
Jerry Yuc1cb3842022-02-17 14:13:48 +08005321#if defined(MBEDTLS_SHA384_C)
5322void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5323 unsigned char *hash,
5324 size_t *hlen )
5325{
5326#if defined(MBEDTLS_USE_PSA_CRYPTO)
5327 size_t hash_size;
5328 psa_status_t status;
5329 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5330
5331 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5332 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5333 if( status != PSA_SUCCESS )
5334 {
5335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5336 return;
5337 }
5338
5339 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5340 if( status != PSA_SUCCESS )
5341 {
5342 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5343 return;
5344 }
5345
5346 *hlen = 48;
5347 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5348 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5349#else
5350 mbedtls_sha512_context sha512;
5351
5352 mbedtls_sha512_init( &sha512 );
5353
5354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5355
5356 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5357 mbedtls_sha512_finish( &sha512, hash );
5358
5359 *hlen = 48;
5360
5361 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5363
5364 mbedtls_sha512_free( &sha512 );
5365#endif /* MBEDTLS_USE_PSA_CRYPTO */
5366 return;
5367}
5368#endif /* MBEDTLS_SHA384_C */
5369
Jerry Yuce3dca42022-02-17 14:16:37 +08005370#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5371int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5372{
5373 unsigned char *p = ssl->handshake->premaster;
5374 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5375 const unsigned char *psk = NULL;
5376 size_t psk_len = 0;
5377
5378 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5379 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5380 {
5381 /*
5382 * This should never happen because the existence of a PSK is always
5383 * checked before calling this function
5384 */
5385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5386 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5387 }
5388
5389 /*
5390 * PMS = struct {
5391 * opaque other_secret<0..2^16-1>;
5392 * opaque psk<0..2^16-1>;
5393 * };
5394 * with "other_secret" depending on the particular key exchange
5395 */
5396#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5397 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5398 {
5399 if( end - p < 2 )
5400 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5401
5402 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5403 p += 2;
5404
5405 if( end < p || (size_t)( end - p ) < psk_len )
5406 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5407
5408 memset( p, 0, psk_len );
5409 p += psk_len;
5410 }
5411 else
5412#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5413#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5414 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5415 {
5416 /*
5417 * other_secret already set by the ClientKeyExchange message,
5418 * and is 48 bytes long
5419 */
5420 if( end - p < 2 )
5421 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5422
5423 *p++ = 0;
5424 *p++ = 48;
5425 p += 48;
5426 }
5427 else
5428#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5429#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5430 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5431 {
5432 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5433 size_t len;
5434
5435 /* Write length only when we know the actual value */
5436 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5437 p + 2, end - ( p + 2 ), &len,
5438 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5439 {
5440 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5441 return( ret );
5442 }
5443 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5444 p += 2 + len;
5445
5446 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5447 }
5448 else
5449#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5450#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5451 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5452 {
5453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5454 size_t zlen;
5455
5456 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5457 p + 2, end - ( p + 2 ),
5458 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5459 {
5460 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5461 return( ret );
5462 }
5463
5464 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5465 p += 2 + zlen;
5466
5467 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5468 MBEDTLS_DEBUG_ECDH_Z );
5469 }
5470 else
5471#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5472 {
5473 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5474 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5475 }
5476
5477 /* opaque psk<0..2^16-1>; */
5478 if( end - p < 2 )
5479 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5480
5481 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5482 p += 2;
5483
5484 if( end < p || (size_t)( end - p ) < psk_len )
5485 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5486
5487 memcpy( p, psk, psk_len );
5488 p += psk_len;
5489
5490 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5491
5492 return( 0 );
5493}
5494#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005495
5496#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5497static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5498
5499#if defined(MBEDTLS_SSL_PROTO_DTLS)
5500int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5501{
5502 /* If renegotiation is not enforced, retransmit until we would reach max
5503 * timeout if we were using the usual handshake doubling scheme */
5504 if( ssl->conf->renego_max_records < 0 )
5505 {
5506 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5507 unsigned char doublings = 1;
5508
5509 while( ratio != 0 )
5510 {
5511 ++doublings;
5512 ratio >>= 1;
5513 }
5514
5515 if( ++ssl->renego_records_seen > doublings )
5516 {
5517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5518 return( 0 );
5519 }
5520 }
5521
5522 return( ssl_write_hello_request( ssl ) );
5523}
5524#endif
5525#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005526
Jerry Yud9526692022-02-17 14:23:47 +08005527/*
5528 * Handshake functions
5529 */
5530#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5531/* No certificate support -> dummy functions */
5532int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5533{
5534 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5535 ssl->handshake->ciphersuite_info;
5536
5537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5538
5539 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5540 {
5541 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5542 ssl->state++;
5543 return( 0 );
5544 }
5545
5546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5547 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5548}
5549
5550int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5551{
5552 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5553 ssl->handshake->ciphersuite_info;
5554
5555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5556
5557 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5558 {
5559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5560 ssl->state++;
5561 return( 0 );
5562 }
5563
5564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5566}
5567
5568#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5569/* Some certificate support -> implement write and parse */
5570
5571int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5572{
5573 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5574 size_t i, n;
5575 const mbedtls_x509_crt *crt;
5576 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5577 ssl->handshake->ciphersuite_info;
5578
5579 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5580
5581 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5582 {
5583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5584 ssl->state++;
5585 return( 0 );
5586 }
5587
5588#if defined(MBEDTLS_SSL_CLI_C)
5589 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5590 {
5591 if( ssl->handshake->client_auth == 0 )
5592 {
5593 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5594 ssl->state++;
5595 return( 0 );
5596 }
5597 }
5598#endif /* MBEDTLS_SSL_CLI_C */
5599#if defined(MBEDTLS_SSL_SRV_C)
5600 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5601 {
5602 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5603 {
5604 /* Should never happen because we shouldn't have picked the
5605 * ciphersuite if we don't have a certificate. */
5606 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5607 }
5608 }
5609#endif
5610
5611 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5612
5613 /*
5614 * 0 . 0 handshake type
5615 * 1 . 3 handshake length
5616 * 4 . 6 length of all certs
5617 * 7 . 9 length of cert. 1
5618 * 10 . n-1 peer certificate
5619 * n . n+2 length of cert. 2
5620 * n+3 . ... upper level cert, etc.
5621 */
5622 i = 7;
5623 crt = mbedtls_ssl_own_cert( ssl );
5624
5625 while( crt != NULL )
5626 {
5627 n = crt->raw.len;
5628 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5629 {
5630 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5631 " > %" MBEDTLS_PRINTF_SIZET,
5632 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5633 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5634 }
5635
5636 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5637 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5638 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5639
5640 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5641 i += n; crt = crt->next;
5642 }
5643
5644 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5645 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5646 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5647
5648 ssl->out_msglen = i;
5649 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5650 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5651
5652 ssl->state++;
5653
5654 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5655 {
5656 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5657 return( ret );
5658 }
5659
5660 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5661
5662 return( ret );
5663}
5664
5665#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5666
5667#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5668static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5669 unsigned char *crt_buf,
5670 size_t crt_buf_len )
5671{
5672 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5673
5674 if( peer_crt == NULL )
5675 return( -1 );
5676
5677 if( peer_crt->raw.len != crt_buf_len )
5678 return( -1 );
5679
5680 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5681}
5682#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5683static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5684 unsigned char *crt_buf,
5685 size_t crt_buf_len )
5686{
5687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5688 unsigned char const * const peer_cert_digest =
5689 ssl->session->peer_cert_digest;
5690 mbedtls_md_type_t const peer_cert_digest_type =
5691 ssl->session->peer_cert_digest_type;
5692 mbedtls_md_info_t const * const digest_info =
5693 mbedtls_md_info_from_type( peer_cert_digest_type );
5694 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5695 size_t digest_len;
5696
5697 if( peer_cert_digest == NULL || digest_info == NULL )
5698 return( -1 );
5699
5700 digest_len = mbedtls_md_get_size( digest_info );
5701 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5702 return( -1 );
5703
5704 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5705 if( ret != 0 )
5706 return( -1 );
5707
5708 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5709}
5710#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5711#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5712
5713/*
5714 * Once the certificate message is read, parse it into a cert chain and
5715 * perform basic checks, but leave actual verification to the caller
5716 */
5717static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5718 mbedtls_x509_crt *chain )
5719{
5720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5721#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5722 int crt_cnt=0;
5723#endif
5724 size_t i, n;
5725 uint8_t alert;
5726
5727 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5728 {
5729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5730 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5731 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5732 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5733 }
5734
5735 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5736 {
5737 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5738 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5739 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5740 }
5741
5742 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5743 {
5744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5745 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5746 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5747 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5748 }
5749
5750 i = mbedtls_ssl_hs_hdr_len( ssl );
5751
5752 /*
5753 * Same message structure as in mbedtls_ssl_write_certificate()
5754 */
5755 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5756
5757 if( ssl->in_msg[i] != 0 ||
5758 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5759 {
5760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5761 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5762 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5763 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5764 }
5765
5766 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5767 i += 3;
5768
5769 /* Iterate through and parse the CRTs in the provided chain. */
5770 while( i < ssl->in_hslen )
5771 {
5772 /* Check that there's room for the next CRT's length fields. */
5773 if ( i + 3 > ssl->in_hslen ) {
5774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5775 mbedtls_ssl_send_alert_message( ssl,
5776 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5777 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5778 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5779 }
5780 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5781 * anything beyond 2**16 ~ 64K. */
5782 if( ssl->in_msg[i] != 0 )
5783 {
5784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5785 mbedtls_ssl_send_alert_message( ssl,
5786 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5787 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5788 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5789 }
5790
5791 /* Read length of the next CRT in the chain. */
5792 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5793 | (unsigned int) ssl->in_msg[i + 2];
5794 i += 3;
5795
5796 if( n < 128 || i + n > ssl->in_hslen )
5797 {
5798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5799 mbedtls_ssl_send_alert_message( ssl,
5800 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5801 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5802 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5803 }
5804
5805 /* Check if we're handling the first CRT in the chain. */
5806#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5807 if( crt_cnt++ == 0 &&
5808 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5809 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5810 {
5811 /* During client-side renegotiation, check that the server's
5812 * end-CRTs hasn't changed compared to the initial handshake,
5813 * mitigating the triple handshake attack. On success, reuse
5814 * the original end-CRT instead of parsing it again. */
5815 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5816 if( ssl_check_peer_crt_unchanged( ssl,
5817 &ssl->in_msg[i],
5818 n ) != 0 )
5819 {
5820 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5821 mbedtls_ssl_send_alert_message( ssl,
5822 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5823 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5824 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5825 }
5826
5827 /* Now we can safely free the original chain. */
5828 ssl_clear_peer_cert( ssl->session );
5829 }
5830#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5831
5832 /* Parse the next certificate in the chain. */
5833#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5834 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5835#else
5836 /* If we don't need to store the CRT chain permanently, parse
5837 * it in-place from the input buffer instead of making a copy. */
5838 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5839#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5840 switch( ret )
5841 {
5842 case 0: /*ok*/
5843 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5844 /* Ignore certificate with an unknown algorithm: maybe a
5845 prior certificate was already trusted. */
5846 break;
5847
5848 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5849 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5850 goto crt_parse_der_failed;
5851
5852 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5853 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5854 goto crt_parse_der_failed;
5855
5856 default:
5857 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5858 crt_parse_der_failed:
5859 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5860 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5861 return( ret );
5862 }
5863
5864 i += n;
5865 }
5866
5867 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
5868 return( 0 );
5869}
5870
5871#if defined(MBEDTLS_SSL_SRV_C)
5872static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
5873{
5874 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5875 return( -1 );
5876
5877 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
5878 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
5879 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
5880 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
5881 {
5882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
5883 return( 0 );
5884 }
5885 return( -1 );
5886}
5887#endif /* MBEDTLS_SSL_SRV_C */
5888
5889/* Check if a certificate message is expected.
5890 * Return either
5891 * - SSL_CERTIFICATE_EXPECTED, or
5892 * - SSL_CERTIFICATE_SKIP
5893 * indicating whether a Certificate message is expected or not.
5894 */
5895#define SSL_CERTIFICATE_EXPECTED 0
5896#define SSL_CERTIFICATE_SKIP 1
5897static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
5898 int authmode )
5899{
5900 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5901 ssl->handshake->ciphersuite_info;
5902
5903 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5904 return( SSL_CERTIFICATE_SKIP );
5905
5906#if defined(MBEDTLS_SSL_SRV_C)
5907 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5908 {
5909 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5910 return( SSL_CERTIFICATE_SKIP );
5911
5912 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5913 {
5914 ssl->session_negotiate->verify_result =
5915 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
5916 return( SSL_CERTIFICATE_SKIP );
5917 }
5918 }
5919#else
5920 ((void) authmode);
5921#endif /* MBEDTLS_SSL_SRV_C */
5922
5923 return( SSL_CERTIFICATE_EXPECTED );
5924}
5925
5926static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
5927 int authmode,
5928 mbedtls_x509_crt *chain,
5929 void *rs_ctx )
5930{
5931 int ret = 0;
5932 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5933 ssl->handshake->ciphersuite_info;
5934 int have_ca_chain = 0;
5935
5936 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
5937 void *p_vrfy;
5938
5939 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5940 return( 0 );
5941
5942 if( ssl->f_vrfy != NULL )
5943 {
5944 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
5945 f_vrfy = ssl->f_vrfy;
5946 p_vrfy = ssl->p_vrfy;
5947 }
5948 else
5949 {
5950 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
5951 f_vrfy = ssl->conf->f_vrfy;
5952 p_vrfy = ssl->conf->p_vrfy;
5953 }
5954
5955 /*
5956 * Main check: verify certificate
5957 */
5958#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
5959 if( ssl->conf->f_ca_cb != NULL )
5960 {
5961 ((void) rs_ctx);
5962 have_ca_chain = 1;
5963
5964 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
5965 ret = mbedtls_x509_crt_verify_with_ca_cb(
5966 chain,
5967 ssl->conf->f_ca_cb,
5968 ssl->conf->p_ca_cb,
5969 ssl->conf->cert_profile,
5970 ssl->hostname,
5971 &ssl->session_negotiate->verify_result,
5972 f_vrfy, p_vrfy );
5973 }
5974 else
5975#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
5976 {
5977 mbedtls_x509_crt *ca_chain;
5978 mbedtls_x509_crl *ca_crl;
5979
5980#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
5981 if( ssl->handshake->sni_ca_chain != NULL )
5982 {
5983 ca_chain = ssl->handshake->sni_ca_chain;
5984 ca_crl = ssl->handshake->sni_ca_crl;
5985 }
5986 else
5987#endif
5988 {
5989 ca_chain = ssl->conf->ca_chain;
5990 ca_crl = ssl->conf->ca_crl;
5991 }
5992
5993 if( ca_chain != NULL )
5994 have_ca_chain = 1;
5995
5996 ret = mbedtls_x509_crt_verify_restartable(
5997 chain,
5998 ca_chain, ca_crl,
5999 ssl->conf->cert_profile,
6000 ssl->hostname,
6001 &ssl->session_negotiate->verify_result,
6002 f_vrfy, p_vrfy, rs_ctx );
6003 }
6004
6005 if( ret != 0 )
6006 {
6007 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6008 }
6009
6010#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6011 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6012 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6013#endif
6014
6015 /*
6016 * Secondary checks: always done, but change 'ret' only if it was 0
6017 */
6018
6019#if defined(MBEDTLS_ECP_C)
6020 {
6021 const mbedtls_pk_context *pk = &chain->pk;
6022
6023 /* If certificate uses an EC key, make sure the curve is OK */
6024 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6025 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6026 {
6027 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6028
6029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6030 if( ret == 0 )
6031 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6032 }
6033 }
6034#endif /* MBEDTLS_ECP_C */
6035
6036 if( mbedtls_ssl_check_cert_usage( chain,
6037 ciphersuite_info,
6038 ! ssl->conf->endpoint,
6039 &ssl->session_negotiate->verify_result ) != 0 )
6040 {
6041 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6042 if( ret == 0 )
6043 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6044 }
6045
6046 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6047 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6048 * with details encoded in the verification flags. All other kinds
6049 * of error codes, including those from the user provided f_vrfy
6050 * functions, are treated as fatal and lead to a failure of
6051 * ssl_parse_certificate even if verification was optional. */
6052 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6053 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6054 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6055 {
6056 ret = 0;
6057 }
6058
6059 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6060 {
6061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6062 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6063 }
6064
6065 if( ret != 0 )
6066 {
6067 uint8_t alert;
6068
6069 /* The certificate may have been rejected for several reasons.
6070 Pick one and send the corresponding alert. Which alert to send
6071 may be a subject of debate in some cases. */
6072 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6073 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6074 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6075 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6076 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6077 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6078 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6079 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6080 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6081 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6082 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6083 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6084 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6085 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6086 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6087 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6088 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6089 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6090 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6091 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6092 else
6093 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6094 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6095 alert );
6096 }
6097
6098#if defined(MBEDTLS_DEBUG_C)
6099 if( ssl->session_negotiate->verify_result != 0 )
6100 {
6101 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6102 (unsigned int) ssl->session_negotiate->verify_result ) );
6103 }
6104 else
6105 {
6106 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6107 }
6108#endif /* MBEDTLS_DEBUG_C */
6109
6110 return( ret );
6111}
6112
6113#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6114static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6115 unsigned char *start, size_t len )
6116{
6117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6118 /* Remember digest of the peer's end-CRT. */
6119 ssl->session_negotiate->peer_cert_digest =
6120 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6121 if( ssl->session_negotiate->peer_cert_digest == NULL )
6122 {
6123 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6124 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6125 mbedtls_ssl_send_alert_message( ssl,
6126 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6127 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6128
6129 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6130 }
6131
6132 ret = mbedtls_md( mbedtls_md_info_from_type(
6133 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6134 start, len,
6135 ssl->session_negotiate->peer_cert_digest );
6136
6137 ssl->session_negotiate->peer_cert_digest_type =
6138 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6139 ssl->session_negotiate->peer_cert_digest_len =
6140 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6141
6142 return( ret );
6143}
6144
6145static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6146 unsigned char *start, size_t len )
6147{
6148 unsigned char *end = start + len;
6149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6150
6151 /* Make a copy of the peer's raw public key. */
6152 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6153 ret = mbedtls_pk_parse_subpubkey( &start, end,
6154 &ssl->handshake->peer_pubkey );
6155 if( ret != 0 )
6156 {
6157 /* We should have parsed the public key before. */
6158 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6159 }
6160
6161 return( 0 );
6162}
6163#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6164
6165int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6166{
6167 int ret = 0;
6168 int crt_expected;
6169#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6170 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6171 ? ssl->handshake->sni_authmode
6172 : ssl->conf->authmode;
6173#else
6174 const int authmode = ssl->conf->authmode;
6175#endif
6176 void *rs_ctx = NULL;
6177 mbedtls_x509_crt *chain = NULL;
6178
6179 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6180
6181 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6182 if( crt_expected == SSL_CERTIFICATE_SKIP )
6183 {
6184 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6185 goto exit;
6186 }
6187
6188#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6189 if( ssl->handshake->ecrs_enabled &&
6190 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6191 {
6192 chain = ssl->handshake->ecrs_peer_cert;
6193 ssl->handshake->ecrs_peer_cert = NULL;
6194 goto crt_verify;
6195 }
6196#endif
6197
6198 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6199 {
6200 /* mbedtls_ssl_read_record may have sent an alert already. We
6201 let it decide whether to alert. */
6202 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6203 goto exit;
6204 }
6205
6206#if defined(MBEDTLS_SSL_SRV_C)
6207 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6208 {
6209 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6210
6211 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6212 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6213
6214 goto exit;
6215 }
6216#endif /* MBEDTLS_SSL_SRV_C */
6217
6218 /* Clear existing peer CRT structure in case we tried to
6219 * reuse a session but it failed, and allocate a new one. */
6220 ssl_clear_peer_cert( ssl->session_negotiate );
6221
6222 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6223 if( chain == NULL )
6224 {
6225 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6226 sizeof( mbedtls_x509_crt ) ) );
6227 mbedtls_ssl_send_alert_message( ssl,
6228 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6229 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6230
6231 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6232 goto exit;
6233 }
6234 mbedtls_x509_crt_init( chain );
6235
6236 ret = ssl_parse_certificate_chain( ssl, chain );
6237 if( ret != 0 )
6238 goto exit;
6239
6240#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6241 if( ssl->handshake->ecrs_enabled)
6242 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6243
6244crt_verify:
6245 if( ssl->handshake->ecrs_enabled)
6246 rs_ctx = &ssl->handshake->ecrs_ctx;
6247#endif
6248
6249 ret = ssl_parse_certificate_verify( ssl, authmode,
6250 chain, rs_ctx );
6251 if( ret != 0 )
6252 goto exit;
6253
6254#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6255 {
6256 unsigned char *crt_start, *pk_start;
6257 size_t crt_len, pk_len;
6258
6259 /* We parse the CRT chain without copying, so
6260 * these pointers point into the input buffer,
6261 * and are hence still valid after freeing the
6262 * CRT chain. */
6263
6264 crt_start = chain->raw.p;
6265 crt_len = chain->raw.len;
6266
6267 pk_start = chain->pk_raw.p;
6268 pk_len = chain->pk_raw.len;
6269
6270 /* Free the CRT structures before computing
6271 * digest and copying the peer's public key. */
6272 mbedtls_x509_crt_free( chain );
6273 mbedtls_free( chain );
6274 chain = NULL;
6275
6276 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6277 if( ret != 0 )
6278 goto exit;
6279
6280 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6281 if( ret != 0 )
6282 goto exit;
6283 }
6284#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6285 /* Pass ownership to session structure. */
6286 ssl->session_negotiate->peer_cert = chain;
6287 chain = NULL;
6288#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6289
6290 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6291
6292exit:
6293
6294 if( ret == 0 )
6295 ssl->state++;
6296
6297#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6298 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6299 {
6300 ssl->handshake->ecrs_peer_cert = chain;
6301 chain = NULL;
6302 }
6303#endif
6304
6305 if( chain != NULL )
6306 {
6307 mbedtls_x509_crt_free( chain );
6308 mbedtls_free( chain );
6309 }
6310
6311 return( ret );
6312}
6313#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6314
Jerry Yu615bd6f2022-02-17 14:25:15 +08006315#if defined(MBEDTLS_SHA256_C)
6316static void ssl_calc_finished_tls_sha256(
6317 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6318{
6319 int len = 12;
6320 const char *sender;
6321 unsigned char padbuf[32];
6322#if defined(MBEDTLS_USE_PSA_CRYPTO)
6323 size_t hash_size;
6324 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6325 psa_status_t status;
6326#else
6327 mbedtls_sha256_context sha256;
6328#endif
6329
6330 mbedtls_ssl_session *session = ssl->session_negotiate;
6331 if( !session )
6332 session = ssl->session;
6333
6334 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6335 ? "client finished"
6336 : "server finished";
6337
6338#if defined(MBEDTLS_USE_PSA_CRYPTO)
6339 sha256_psa = psa_hash_operation_init();
6340
6341 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6342
6343 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6344 if( status != PSA_SUCCESS )
6345 {
6346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6347 return;
6348 }
6349
6350 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6351 if( status != PSA_SUCCESS )
6352 {
6353 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6354 return;
6355 }
6356 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6357#else
6358
6359 mbedtls_sha256_init( &sha256 );
6360
6361 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6362
6363 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6364
6365 /*
6366 * TLSv1.2:
6367 * hash = PRF( master, finished_label,
6368 * Hash( handshake ) )[0.11]
6369 */
6370
6371#if !defined(MBEDTLS_SHA256_ALT)
6372 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6373 sha256.state, sizeof( sha256.state ) );
6374#endif
6375
6376 mbedtls_sha256_finish( &sha256, padbuf );
6377 mbedtls_sha256_free( &sha256 );
6378#endif /* MBEDTLS_USE_PSA_CRYPTO */
6379
6380 ssl->handshake->tls_prf( session->master, 48, sender,
6381 padbuf, 32, buf, len );
6382
6383 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6384
6385 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6386
6387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6388}
6389#endif /* MBEDTLS_SHA256_C */
6390
Jerry Yub7ba49e2022-02-17 14:25:53 +08006391
6392#if defined(MBEDTLS_SHA384_C)
6393
6394static void ssl_calc_finished_tls_sha384(
6395 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6396{
6397 int len = 12;
6398 const char *sender;
6399 unsigned char padbuf[48];
6400#if defined(MBEDTLS_USE_PSA_CRYPTO)
6401 size_t hash_size;
6402 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6403 psa_status_t status;
6404#else
6405 mbedtls_sha512_context sha512;
6406#endif
6407
6408 mbedtls_ssl_session *session = ssl->session_negotiate;
6409 if( !session )
6410 session = ssl->session;
6411
6412 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6413 ? "client finished"
6414 : "server finished";
6415
6416#if defined(MBEDTLS_USE_PSA_CRYPTO)
6417 sha384_psa = psa_hash_operation_init();
6418
6419 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6420
6421 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6422 if( status != PSA_SUCCESS )
6423 {
6424 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6425 return;
6426 }
6427
6428 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6429 if( status != PSA_SUCCESS )
6430 {
6431 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6432 return;
6433 }
6434 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6435#else
6436 mbedtls_sha512_init( &sha512 );
6437
6438 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6439
6440 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6441
6442 /*
6443 * TLSv1.2:
6444 * hash = PRF( master, finished_label,
6445 * Hash( handshake ) )[0.11]
6446 */
6447
6448#if !defined(MBEDTLS_SHA512_ALT)
6449 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6450 sha512.state, sizeof( sha512.state ) );
6451#endif
6452 mbedtls_sha512_finish( &sha512, padbuf );
6453
6454 mbedtls_sha512_free( &sha512 );
6455#endif
6456
6457 ssl->handshake->tls_prf( session->master, 48, sender,
6458 padbuf, 48, buf, len );
6459
6460 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6461
6462 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6463
6464 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6465}
6466#endif /* MBEDTLS_SHA384_C */
6467
Jerry Yuaef00152022-02-17 14:27:31 +08006468void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6469{
6470 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6471
6472 /*
6473 * Free our handshake params
6474 */
6475 mbedtls_ssl_handshake_free( ssl );
6476 mbedtls_free( ssl->handshake );
6477 ssl->handshake = NULL;
6478
6479 /*
6480 * Free the previous transform and swith in the current one
6481 */
6482 if( ssl->transform )
6483 {
6484 mbedtls_ssl_transform_free( ssl->transform );
6485 mbedtls_free( ssl->transform );
6486 }
6487 ssl->transform = ssl->transform_negotiate;
6488 ssl->transform_negotiate = NULL;
6489
6490 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6491}
6492
Jerry Yu2a9fff52022-02-17 14:28:51 +08006493void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6494{
6495 int resume = ssl->handshake->resume;
6496
6497 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6498
6499#if defined(MBEDTLS_SSL_RENEGOTIATION)
6500 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6501 {
6502 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6503 ssl->renego_records_seen = 0;
6504 }
6505#endif
6506
6507 /*
6508 * Free the previous session and switch in the current one
6509 */
6510 if( ssl->session )
6511 {
6512#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6513 /* RFC 7366 3.1: keep the EtM state */
6514 ssl->session_negotiate->encrypt_then_mac =
6515 ssl->session->encrypt_then_mac;
6516#endif
6517
6518 mbedtls_ssl_session_free( ssl->session );
6519 mbedtls_free( ssl->session );
6520 }
6521 ssl->session = ssl->session_negotiate;
6522 ssl->session_negotiate = NULL;
6523
6524 /*
6525 * Add cache entry
6526 */
6527 if( ssl->conf->f_set_cache != NULL &&
6528 ssl->session->id_len != 0 &&
6529 resume == 0 )
6530 {
6531 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6532 ssl->session->id,
6533 ssl->session->id_len,
6534 ssl->session ) != 0 )
6535 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6536 }
6537
6538#if defined(MBEDTLS_SSL_PROTO_DTLS)
6539 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6540 ssl->handshake->flight != NULL )
6541 {
6542 /* Cancel handshake timer */
6543 mbedtls_ssl_set_timer( ssl, 0 );
6544
6545 /* Keep last flight around in case we need to resend it:
6546 * we need the handshake and transform structures for that */
6547 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6548 }
6549 else
6550#endif
6551 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6552
6553 ssl->state++;
6554
6555 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6556}
6557
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006558int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6559{
6560 int ret, hash_len;
6561
6562 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6563
6564 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6565
6566 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6567
6568 /*
6569 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6570 * may define some other value. Currently (early 2016), no defined
6571 * ciphersuite does this (and this is unlikely to change as activity has
6572 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6573 */
6574 hash_len = 12;
6575
6576#if defined(MBEDTLS_SSL_RENEGOTIATION)
6577 ssl->verify_data_len = hash_len;
6578 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6579#endif
6580
6581 ssl->out_msglen = 4 + hash_len;
6582 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6583 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6584
6585 /*
6586 * In case of session resuming, invert the client and server
6587 * ChangeCipherSpec messages order.
6588 */
6589 if( ssl->handshake->resume != 0 )
6590 {
6591#if defined(MBEDTLS_SSL_CLI_C)
6592 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6593 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6594#endif
6595#if defined(MBEDTLS_SSL_SRV_C)
6596 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6597 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6598#endif
6599 }
6600 else
6601 ssl->state++;
6602
6603 /*
6604 * Switch to our negotiated transform and session parameters for outbound
6605 * data.
6606 */
6607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6608
6609#if defined(MBEDTLS_SSL_PROTO_DTLS)
6610 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6611 {
6612 unsigned char i;
6613
6614 /* Remember current epoch settings for resending */
6615 ssl->handshake->alt_transform_out = ssl->transform_out;
6616 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6617 sizeof( ssl->handshake->alt_out_ctr ) );
6618
6619 /* Set sequence_number to zero */
6620 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6621
6622
6623 /* Increment epoch */
6624 for( i = 2; i > 0; i-- )
6625 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6626 break;
6627
6628 /* The loop goes to its end iff the counter is wrapping */
6629 if( i == 0 )
6630 {
6631 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6632 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6633 }
6634 }
6635 else
6636#endif /* MBEDTLS_SSL_PROTO_DTLS */
6637 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6638
6639 ssl->transform_out = ssl->transform_negotiate;
6640 ssl->session_out = ssl->session_negotiate;
6641
6642#if defined(MBEDTLS_SSL_PROTO_DTLS)
6643 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6644 mbedtls_ssl_send_flight_completed( ssl );
6645#endif
6646
6647 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6648 {
6649 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6650 return( ret );
6651 }
6652
6653#if defined(MBEDTLS_SSL_PROTO_DTLS)
6654 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6655 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6656 {
6657 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6658 return( ret );
6659 }
6660#endif
6661
6662 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6663
6664 return( 0 );
6665}
6666
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006667#define SSL_MAX_HASH_LEN 12
6668
6669int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6670{
6671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6672 unsigned int hash_len = 12;
6673 unsigned char buf[SSL_MAX_HASH_LEN];
6674
6675 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6676
6677 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6678
6679 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6680 {
6681 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6682 goto exit;
6683 }
6684
6685 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6686 {
6687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6688 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6689 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6690 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6691 goto exit;
6692 }
6693
6694 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6695 {
6696 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6697 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6698 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6699 goto exit;
6700 }
6701
6702 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6703 {
6704 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6705 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6706 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6707 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6708 goto exit;
6709 }
6710
6711 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6712 buf, hash_len ) != 0 )
6713 {
6714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6715 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6716 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6717 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6718 goto exit;
6719 }
6720
6721#if defined(MBEDTLS_SSL_RENEGOTIATION)
6722 ssl->verify_data_len = hash_len;
6723 memcpy( ssl->peer_verify_data, buf, hash_len );
6724#endif
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_CLIENT_CHANGE_CIPHER_SPEC;
6731#endif
6732#if defined(MBEDTLS_SSL_SRV_C)
6733 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6734 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6735#endif
6736 }
6737 else
6738 ssl->state++;
6739
6740#if defined(MBEDTLS_SSL_PROTO_DTLS)
6741 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6742 mbedtls_ssl_recv_flight_completed( ssl );
6743#endif
6744
6745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6746
6747exit:
6748 mbedtls_platform_zeroize( buf, hash_len );
6749 return( ret );
6750}
6751
Jerry Yu392112c2022-02-17 14:34:10 +08006752#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6753/*
6754 * Helper to get TLS 1.2 PRF from ciphersuite
6755 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6756 */
6757static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6758{
6759#if defined(MBEDTLS_SHA384_C)
6760 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6761 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6762
6763 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6764 return( tls_prf_sha384 );
6765#else
6766 (void) ciphersuite_id;
6767#endif
6768 return( tls_prf_sha256 );
6769}
6770#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006771
6772static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6773{
6774 ((void) tls_prf);
6775#if defined(MBEDTLS_SHA384_C)
6776 if( tls_prf == tls_prf_sha384 )
6777 {
6778 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6779 }
6780 else
6781#endif
6782#if defined(MBEDTLS_SHA256_C)
6783 if( tls_prf == tls_prf_sha256 )
6784 {
6785 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6786 }
6787 else
6788#endif
6789 return( MBEDTLS_SSL_TLS_PRF_NONE );
6790}
6791
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006792/*
6793 * Populate a transform structure with session keys and all the other
6794 * necessary information.
6795 *
6796 * Parameters:
6797 * - [in/out]: transform: structure to populate
6798 * [in] must be just initialised with mbedtls_ssl_transform_init()
6799 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6800 * - [in] ciphersuite
6801 * - [in] master
6802 * - [in] encrypt_then_mac
6803 * - [in] compression
6804 * - [in] tls_prf: pointer to PRF to use for key derivation
6805 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006806 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006807 * - [in] endpoint: client or server
6808 * - [in] ssl: used for:
6809 * - ssl->conf->{f,p}_export_keys
6810 * [in] optionally used for:
6811 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6812 */
6813static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6814 int ciphersuite,
6815 const unsigned char master[48],
6816#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6817 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6818 int encrypt_then_mac,
6819#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6820 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6821 ssl_tls_prf_t tls_prf,
6822 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006823 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006824 unsigned endpoint,
6825 const mbedtls_ssl_context *ssl )
6826{
6827 int ret = 0;
6828 unsigned char keyblk[256];
6829 unsigned char *key1;
6830 unsigned char *key2;
6831 unsigned char *mac_enc;
6832 unsigned char *mac_dec;
6833 size_t mac_key_len = 0;
6834 size_t iv_copy_len;
6835 size_t keylen;
6836 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
6837 const mbedtls_cipher_info_t *cipher_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006838#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006839 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006840#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006841
6842#if defined(MBEDTLS_USE_PSA_CRYPTO)
6843 psa_key_type_t key_type;
6844 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6845 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006846 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006847 size_t key_bits;
6848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6849#endif
6850
6851#if !defined(MBEDTLS_DEBUG_C) && \
6852 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6853 if( ssl->f_export_keys == NULL )
6854 {
6855 ssl = NULL; /* make sure we don't use it except for these cases */
6856 (void) ssl;
6857 }
6858#endif
6859
6860 /*
6861 * Some data just needs copying into the structure
6862 */
6863#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
6864 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6865 transform->encrypt_then_mac = encrypt_then_mac;
6866#endif
Glenn Strauss07c64162022-03-14 12:34:51 -04006867 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006868
6869#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6870 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
6871#endif
6872
6873#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04006874 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006875 {
6876 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
6877 * generation separate. This should never happen. */
6878 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6879 }
6880#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6881
6882 /*
6883 * Get various info structures
6884 */
6885 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
6886 if( ciphersuite_info == NULL )
6887 {
6888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
6889 ciphersuite ) );
6890 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6891 }
6892
6893 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
6894 if( cipher_info == NULL )
6895 {
6896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
6897 ciphersuite_info->cipher ) );
6898 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6899 }
6900
Neil Armstronge4512952022-03-08 09:08:22 +01006901#if defined(MBEDTLS_USE_PSA_CRYPTO)
6902 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
6903 if( mac_alg == 0 )
6904 {
6905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
6906 (unsigned) ciphersuite_info->mac ) );
6907 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6908 }
6909#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006910 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
6911 if( md_info == NULL )
6912 {
6913 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
6914 (unsigned) ciphersuite_info->mac ) );
6915 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6916 }
Neil Armstronge4512952022-03-08 09:08:22 +01006917#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006918
6919#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6920 /* Copy own and peer's CID if the use of the CID
6921 * extension has been negotiated. */
6922 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
6923 {
6924 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
6925
6926 transform->in_cid_len = ssl->own_cid_len;
6927 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
6928 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
6929 transform->in_cid_len );
6930
6931 transform->out_cid_len = ssl->handshake->peer_cid_len;
6932 memcpy( transform->out_cid, ssl->handshake->peer_cid,
6933 ssl->handshake->peer_cid_len );
6934 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
6935 transform->out_cid_len );
6936 }
6937#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
6938
6939 /*
6940 * Compute key block using the PRF
6941 */
6942 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
6943 if( ret != 0 )
6944 {
6945 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6946 return( ret );
6947 }
6948
6949 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
6950 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
6951 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
6952 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
6953 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
6954
6955 /*
6956 * Determine the appropriate key, IV and MAC length.
6957 */
6958
6959 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
6960
6961#if defined(MBEDTLS_GCM_C) || \
6962 defined(MBEDTLS_CCM_C) || \
6963 defined(MBEDTLS_CHACHAPOLY_C)
6964 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
6965 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
6966 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6967 {
6968 size_t explicit_ivlen;
6969
6970 transform->maclen = 0;
6971 mac_key_len = 0;
6972 transform->taglen =
6973 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
6974
6975 /* All modes haves 96-bit IVs, but the length of the static parts vary
6976 * with mode and version:
6977 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
6978 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
6979 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
6980 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
6981 * sequence number).
6982 */
6983 transform->ivlen = 12;
6984 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6985 transform->fixed_ivlen = 12;
6986 else
6987 transform->fixed_ivlen = 4;
6988
6989 /* Minimum length of encrypted record */
6990 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
6991 transform->minlen = explicit_ivlen + transform->taglen;
6992 }
6993 else
6994#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
6995#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6996 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
6997 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
6998 {
Neil Armstronge4512952022-03-08 09:08:22 +01006999#if defined(MBEDTLS_USE_PSA_CRYPTO)
7000 /* Get MAC length */
7001 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7002#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007003 /* Initialize HMAC contexts */
7004 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7005 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7006 {
7007 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7008 goto end;
7009 }
7010
7011 /* Get MAC length */
7012 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007013#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007014 transform->maclen = mac_key_len;
7015
7016 /* IV length */
7017 transform->ivlen = cipher_info->iv_size;
7018
7019 /* Minimum length */
7020 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
7021 transform->minlen = transform->maclen;
7022 else
7023 {
7024 /*
7025 * GenericBlockCipher:
7026 * 1. if EtM is in use: one block plus MAC
7027 * otherwise: * first multiple of blocklen greater than maclen
7028 * 2. IV
7029 */
7030#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7031 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
7032 {
7033 transform->minlen = transform->maclen
7034 + cipher_info->block_size;
7035 }
7036 else
7037#endif
7038 {
7039 transform->minlen = transform->maclen
7040 + cipher_info->block_size
7041 - transform->maclen % cipher_info->block_size;
7042 }
7043
Glenn Strauss07c64162022-03-14 12:34:51 -04007044 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007045 {
7046 transform->minlen += transform->ivlen;
7047 }
7048 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007049 {
7050 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7051 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7052 goto end;
7053 }
7054 }
7055 }
7056 else
7057#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7058 {
7059 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7060 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7061 }
7062
7063 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7064 (unsigned) keylen,
7065 (unsigned) transform->minlen,
7066 (unsigned) transform->ivlen,
7067 (unsigned) transform->maclen ) );
7068
7069 /*
7070 * Finally setup the cipher contexts, IVs and MAC secrets.
7071 */
7072#if defined(MBEDTLS_SSL_CLI_C)
7073 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7074 {
7075 key1 = keyblk + mac_key_len * 2;
7076 key2 = keyblk + mac_key_len * 2 + keylen;
7077
7078 mac_enc = keyblk;
7079 mac_dec = keyblk + mac_key_len;
7080
7081 /*
7082 * This is not used in TLS v1.1.
7083 */
7084 iv_copy_len = ( transform->fixed_ivlen ) ?
7085 transform->fixed_ivlen : transform->ivlen;
7086 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7087 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7088 iv_copy_len );
7089 }
7090 else
7091#endif /* MBEDTLS_SSL_CLI_C */
7092#if defined(MBEDTLS_SSL_SRV_C)
7093 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7094 {
7095 key1 = keyblk + mac_key_len * 2 + keylen;
7096 key2 = keyblk + mac_key_len * 2;
7097
7098 mac_enc = keyblk + mac_key_len;
7099 mac_dec = keyblk;
7100
7101 /*
7102 * This is not used in TLS v1.1.
7103 */
7104 iv_copy_len = ( transform->fixed_ivlen ) ?
7105 transform->fixed_ivlen : transform->ivlen;
7106 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7107 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7108 iv_copy_len );
7109 }
7110 else
7111#endif /* MBEDTLS_SSL_SRV_C */
7112 {
7113 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7114 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7115 goto end;
7116 }
7117
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007118 if( ssl != NULL && ssl->f_export_keys != NULL )
7119 {
7120 ssl->f_export_keys( ssl->p_export_keys,
7121 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7122 master, 48,
7123 randbytes + 32,
7124 randbytes,
7125 tls_prf_get_type( tls_prf ) );
7126 }
7127
7128#if defined(MBEDTLS_USE_PSA_CRYPTO)
7129 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7130 transform->taglen,
7131 &alg,
7132 &key_type,
7133 &key_bits ) ) != PSA_SUCCESS )
7134 {
7135 ret = psa_ssl_status_to_mbedtls( status );
7136 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7137 goto end;
7138 }
7139
7140 transform->psa_alg = alg;
7141
7142 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7143 {
7144 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7145 psa_set_key_algorithm( &attributes, alg );
7146 psa_set_key_type( &attributes, key_type );
7147
7148 if( ( status = psa_import_key( &attributes,
7149 key1,
7150 PSA_BITS_TO_BYTES( key_bits ),
7151 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7152 {
7153 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7154 ret = psa_ssl_status_to_mbedtls( status );
7155 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7156 goto end;
7157 }
7158
7159 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7160
7161 if( ( status = psa_import_key( &attributes,
7162 key2,
7163 PSA_BITS_TO_BYTES( key_bits ),
7164 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7165 {
7166 ret = psa_ssl_status_to_mbedtls( status );
7167 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7168 goto end;
7169 }
7170 }
7171#else
7172 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7173 cipher_info ) ) != 0 )
7174 {
7175 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7176 goto end;
7177 }
7178
7179 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7180 cipher_info ) ) != 0 )
7181 {
7182 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7183 goto end;
7184 }
7185
7186 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7187 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7188 MBEDTLS_ENCRYPT ) ) != 0 )
7189 {
7190 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7191 goto end;
7192 }
7193
7194 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7195 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7196 MBEDTLS_DECRYPT ) ) != 0 )
7197 {
7198 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7199 goto end;
7200 }
7201
7202#if defined(MBEDTLS_CIPHER_MODE_CBC)
7203 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7204 {
7205 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7206 MBEDTLS_PADDING_NONE ) ) != 0 )
7207 {
7208 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7209 goto end;
7210 }
7211
7212 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7213 MBEDTLS_PADDING_NONE ) ) != 0 )
7214 {
7215 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7216 goto end;
7217 }
7218 }
7219#endif /* MBEDTLS_CIPHER_MODE_CBC */
7220#endif /* MBEDTLS_USE_PSA_CRYPTO */
7221
Neil Armstrong29c0c042022-03-17 17:47:28 +01007222#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7223 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7224 For AEAD-based ciphersuites, there is nothing to do here. */
7225 if( mac_key_len != 0 )
7226 {
7227#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007228 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007229
7230 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007231 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007232 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7233
7234 if( ( status = psa_import_key( &attributes,
7235 mac_enc, mac_key_len,
7236 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7237 {
7238 ret = psa_ssl_status_to_mbedtls( status );
7239 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7240 goto end;
7241 }
7242
Ronald Cronfb39f152022-03-25 14:36:28 +01007243 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7244 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7245 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007246 /* mbedtls_ct_hmac() requires the key to be exportable */
7247 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7248 PSA_KEY_USAGE_VERIFY_HASH );
7249 else
7250 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7251
7252 if( ( status = psa_import_key( &attributes,
7253 mac_dec, mac_key_len,
7254 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7255 {
7256 ret = psa_ssl_status_to_mbedtls( status );
7257 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7258 goto end;
7259 }
7260#else
7261 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7262 if( ret != 0 )
7263 goto end;
7264 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7265 if( ret != 0 )
7266 goto end;
7267#endif /* MBEDTLS_USE_PSA_CRYPTO */
7268 }
7269#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7270
7271 ((void) mac_dec);
7272 ((void) mac_enc);
7273
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007274end:
7275 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7276 return( ret );
7277}
7278
Jerry Yuee40f9d2022-02-17 14:55:16 +08007279#if defined(MBEDTLS_USE_PSA_CRYPTO)
7280int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7281 unsigned char *hash, size_t *hashlen,
7282 unsigned char *data, size_t data_len,
7283 mbedtls_md_type_t md_alg )
7284{
7285 psa_status_t status;
7286 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7287 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7288
7289 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7290
7291 if( ( status = psa_hash_setup( &hash_operation,
7292 hash_alg ) ) != PSA_SUCCESS )
7293 {
7294 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7295 goto exit;
7296 }
7297
7298 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7299 64 ) ) != PSA_SUCCESS )
7300 {
7301 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7302 goto exit;
7303 }
7304
7305 if( ( status = psa_hash_update( &hash_operation,
7306 data, data_len ) ) != PSA_SUCCESS )
7307 {
7308 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7309 goto exit;
7310 }
7311
7312 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7313 hashlen ) ) != PSA_SUCCESS )
7314 {
7315 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7316 goto exit;
7317 }
7318
7319exit:
7320 if( status != PSA_SUCCESS )
7321 {
7322 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7323 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7324 switch( status )
7325 {
7326 case PSA_ERROR_NOT_SUPPORTED:
7327 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7328 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7329 case PSA_ERROR_BUFFER_TOO_SMALL:
7330 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7331 case PSA_ERROR_INSUFFICIENT_MEMORY:
7332 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7333 default:
7334 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7335 }
7336 }
7337 return( 0 );
7338}
7339
7340#else
7341
7342int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7343 unsigned char *hash, size_t *hashlen,
7344 unsigned char *data, size_t data_len,
7345 mbedtls_md_type_t md_alg )
7346{
7347 int ret = 0;
7348 mbedtls_md_context_t ctx;
7349 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7350 *hashlen = mbedtls_md_get_size( md_info );
7351
7352 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7353
7354 mbedtls_md_init( &ctx );
7355
7356 /*
7357 * digitally-signed struct {
7358 * opaque client_random[32];
7359 * opaque server_random[32];
7360 * ServerDHParams params;
7361 * };
7362 */
7363 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7364 {
7365 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7366 goto exit;
7367 }
7368 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7369 {
7370 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7371 goto exit;
7372 }
7373 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7374 {
7375 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7376 goto exit;
7377 }
7378 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7379 {
7380 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7381 goto exit;
7382 }
7383 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7384 {
7385 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7386 goto exit;
7387 }
7388
7389exit:
7390 mbedtls_md_free( &ctx );
7391
7392 if( ret != 0 )
7393 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7394 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7395
7396 return( ret );
7397}
7398#endif /* MBEDTLS_USE_PSA_CRYPTO */
7399
Jerry Yud9d91da2022-02-17 14:57:06 +08007400#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7401
7402/* Find an entry in a signature-hash set matching a given hash algorithm. */
7403mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7404 mbedtls_pk_type_t sig_alg )
7405{
7406 switch( sig_alg )
7407 {
7408 case MBEDTLS_PK_RSA:
7409 return( set->rsa );
7410 case MBEDTLS_PK_ECDSA:
7411 return( set->ecdsa );
7412 default:
7413 return( MBEDTLS_MD_NONE );
7414 }
7415}
7416
7417/* Add a signature-hash-pair to a signature-hash set */
7418void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7419 mbedtls_pk_type_t sig_alg,
7420 mbedtls_md_type_t md_alg )
7421{
7422 switch( sig_alg )
7423 {
7424 case MBEDTLS_PK_RSA:
7425 if( set->rsa == MBEDTLS_MD_NONE )
7426 set->rsa = md_alg;
7427 break;
7428
7429 case MBEDTLS_PK_ECDSA:
7430 if( set->ecdsa == MBEDTLS_MD_NONE )
7431 set->ecdsa = md_alg;
7432 break;
7433
7434 default:
7435 break;
7436 }
7437}
7438
7439/* Allow exactly one hash algorithm for each signature. */
7440void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7441 mbedtls_md_type_t md_alg )
7442{
7443 set->rsa = md_alg;
7444 set->ecdsa = md_alg;
7445}
7446
7447#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7448
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007449/* Serialization of TLS 1.2 sessions:
7450 *
7451 * struct {
7452 * uint64 start_time;
7453 * uint8 ciphersuite[2]; // defined by the standard
7454 * uint8 compression; // 0 or 1
7455 * uint8 session_id_len; // at most 32
7456 * opaque session_id[32];
7457 * opaque master[48]; // fixed length in the standard
7458 * uint32 verify_result;
7459 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7460 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7461 * uint32 ticket_lifetime;
7462 * uint8 mfl_code; // up to 255 according to standard
7463 * uint8 encrypt_then_mac; // 0 or 1
7464 * } serialized_session_tls12;
7465 *
7466 */
7467static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7468 unsigned char *buf,
7469 size_t buf_len )
7470{
7471 unsigned char *p = buf;
7472 size_t used = 0;
7473
7474#if defined(MBEDTLS_HAVE_TIME)
7475 uint64_t start;
7476#endif
7477#if defined(MBEDTLS_X509_CRT_PARSE_C)
7478#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7479 size_t cert_len;
7480#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7481#endif /* MBEDTLS_X509_CRT_PARSE_C */
7482
7483 /*
7484 * Time
7485 */
7486#if defined(MBEDTLS_HAVE_TIME)
7487 used += 8;
7488
7489 if( used <= buf_len )
7490 {
7491 start = (uint64_t) session->start;
7492
7493 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7494 p += 8;
7495 }
7496#endif /* MBEDTLS_HAVE_TIME */
7497
7498 /*
7499 * Basic mandatory fields
7500 */
7501 used += 2 /* ciphersuite */
7502 + 1 /* compression */
7503 + 1 /* id_len */
7504 + sizeof( session->id )
7505 + sizeof( session->master )
7506 + 4; /* verify_result */
7507
7508 if( used <= buf_len )
7509 {
7510 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7511 p += 2;
7512
7513 *p++ = MBEDTLS_BYTE_0( session->compression );
7514
7515 *p++ = MBEDTLS_BYTE_0( session->id_len );
7516 memcpy( p, session->id, 32 );
7517 p += 32;
7518
7519 memcpy( p, session->master, 48 );
7520 p += 48;
7521
7522 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7523 p += 4;
7524 }
7525
7526 /*
7527 * Peer's end-entity certificate
7528 */
7529#if defined(MBEDTLS_X509_CRT_PARSE_C)
7530#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7531 if( session->peer_cert == NULL )
7532 cert_len = 0;
7533 else
7534 cert_len = session->peer_cert->raw.len;
7535
7536 used += 3 + cert_len;
7537
7538 if( used <= buf_len )
7539 {
7540 *p++ = MBEDTLS_BYTE_2( cert_len );
7541 *p++ = MBEDTLS_BYTE_1( cert_len );
7542 *p++ = MBEDTLS_BYTE_0( cert_len );
7543
7544 if( session->peer_cert != NULL )
7545 {
7546 memcpy( p, session->peer_cert->raw.p, cert_len );
7547 p += cert_len;
7548 }
7549 }
7550#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7551 if( session->peer_cert_digest != NULL )
7552 {
7553 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7554 if( used <= buf_len )
7555 {
7556 *p++ = (unsigned char) session->peer_cert_digest_type;
7557 *p++ = (unsigned char) session->peer_cert_digest_len;
7558 memcpy( p, session->peer_cert_digest,
7559 session->peer_cert_digest_len );
7560 p += session->peer_cert_digest_len;
7561 }
7562 }
7563 else
7564 {
7565 used += 2;
7566 if( used <= buf_len )
7567 {
7568 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7569 *p++ = 0;
7570 }
7571 }
7572#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7573#endif /* MBEDTLS_X509_CRT_PARSE_C */
7574
7575 /*
7576 * Session ticket if any, plus associated data
7577 */
7578#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7579 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7580
7581 if( used <= buf_len )
7582 {
7583 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7584 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7585 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7586
7587 if( session->ticket != NULL )
7588 {
7589 memcpy( p, session->ticket, session->ticket_len );
7590 p += session->ticket_len;
7591 }
7592
7593 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7594 p += 4;
7595 }
7596#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7597
7598 /*
7599 * Misc extension-related info
7600 */
7601#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7602 used += 1;
7603
7604 if( used <= buf_len )
7605 *p++ = session->mfl_code;
7606#endif
7607
7608#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7609 used += 1;
7610
7611 if( used <= buf_len )
7612 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7613#endif
7614
7615 return( used );
7616}
7617
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007618static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7619 const unsigned char *buf,
7620 size_t len )
7621{
7622#if defined(MBEDTLS_HAVE_TIME)
7623 uint64_t start;
7624#endif
7625#if defined(MBEDTLS_X509_CRT_PARSE_C)
7626#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7627 size_t cert_len;
7628#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7629#endif /* MBEDTLS_X509_CRT_PARSE_C */
7630
7631 const unsigned char *p = buf;
7632 const unsigned char * const end = buf + len;
7633
7634 /*
7635 * Time
7636 */
7637#if defined(MBEDTLS_HAVE_TIME)
7638 if( 8 > (size_t)( end - p ) )
7639 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7640
7641 start = ( (uint64_t) p[0] << 56 ) |
7642 ( (uint64_t) p[1] << 48 ) |
7643 ( (uint64_t) p[2] << 40 ) |
7644 ( (uint64_t) p[3] << 32 ) |
7645 ( (uint64_t) p[4] << 24 ) |
7646 ( (uint64_t) p[5] << 16 ) |
7647 ( (uint64_t) p[6] << 8 ) |
7648 ( (uint64_t) p[7] );
7649 p += 8;
7650
7651 session->start = (time_t) start;
7652#endif /* MBEDTLS_HAVE_TIME */
7653
7654 /*
7655 * Basic mandatory fields
7656 */
7657 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7658 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7659
7660 session->ciphersuite = ( p[0] << 8 ) | p[1];
7661 p += 2;
7662
7663 session->compression = *p++;
7664
7665 session->id_len = *p++;
7666 memcpy( session->id, p, 32 );
7667 p += 32;
7668
7669 memcpy( session->master, p, 48 );
7670 p += 48;
7671
7672 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7673 ( (uint32_t) p[1] << 16 ) |
7674 ( (uint32_t) p[2] << 8 ) |
7675 ( (uint32_t) p[3] );
7676 p += 4;
7677
7678 /* Immediately clear invalid pointer values that have been read, in case
7679 * we exit early before we replaced them with valid ones. */
7680#if defined(MBEDTLS_X509_CRT_PARSE_C)
7681#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7682 session->peer_cert = NULL;
7683#else
7684 session->peer_cert_digest = NULL;
7685#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7686#endif /* MBEDTLS_X509_CRT_PARSE_C */
7687#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7688 session->ticket = NULL;
7689#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7690
7691 /*
7692 * Peer certificate
7693 */
7694#if defined(MBEDTLS_X509_CRT_PARSE_C)
7695#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7696 /* Deserialize CRT from the end of the ticket. */
7697 if( 3 > (size_t)( end - p ) )
7698 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7699
7700 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7701 p += 3;
7702
7703 if( cert_len != 0 )
7704 {
7705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7706
7707 if( cert_len > (size_t)( end - p ) )
7708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7709
7710 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7711
7712 if( session->peer_cert == NULL )
7713 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7714
7715 mbedtls_x509_crt_init( session->peer_cert );
7716
7717 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7718 p, cert_len ) ) != 0 )
7719 {
7720 mbedtls_x509_crt_free( session->peer_cert );
7721 mbedtls_free( session->peer_cert );
7722 session->peer_cert = NULL;
7723 return( ret );
7724 }
7725
7726 p += cert_len;
7727 }
7728#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7729 /* Deserialize CRT digest from the end of the ticket. */
7730 if( 2 > (size_t)( end - p ) )
7731 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7732
7733 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7734 session->peer_cert_digest_len = (size_t) *p++;
7735
7736 if( session->peer_cert_digest_len != 0 )
7737 {
7738 const mbedtls_md_info_t *md_info =
7739 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7740 if( md_info == NULL )
7741 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7742 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7743 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7744
7745 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7746 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7747
7748 session->peer_cert_digest =
7749 mbedtls_calloc( 1, session->peer_cert_digest_len );
7750 if( session->peer_cert_digest == NULL )
7751 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7752
7753 memcpy( session->peer_cert_digest, p,
7754 session->peer_cert_digest_len );
7755 p += session->peer_cert_digest_len;
7756 }
7757#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7758#endif /* MBEDTLS_X509_CRT_PARSE_C */
7759
7760 /*
7761 * Session ticket and associated data
7762 */
7763#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7764 if( 3 > (size_t)( end - p ) )
7765 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7766
7767 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7768 p += 3;
7769
7770 if( session->ticket_len != 0 )
7771 {
7772 if( session->ticket_len > (size_t)( end - p ) )
7773 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7774
7775 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7776 if( session->ticket == NULL )
7777 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7778
7779 memcpy( session->ticket, p, session->ticket_len );
7780 p += session->ticket_len;
7781 }
7782
7783 if( 4 > (size_t)( end - p ) )
7784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7785
7786 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7787 ( (uint32_t) p[1] << 16 ) |
7788 ( (uint32_t) p[2] << 8 ) |
7789 ( (uint32_t) p[3] );
7790 p += 4;
7791#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7792
7793 /*
7794 * Misc extension-related info
7795 */
7796#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7797 if( 1 > (size_t)( end - p ) )
7798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7799
7800 session->mfl_code = *p++;
7801#endif
7802
7803#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7804 if( 1 > (size_t)( end - p ) )
7805 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7806
7807 session->encrypt_then_mac = *p++;
7808#endif
7809
7810 /* Done, should have consumed entire buffer */
7811 if( p != end )
7812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7813
7814 return( 0 );
7815}
Jerry Yudc7bd172022-02-17 13:44:15 +08007816#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007818#endif /* MBEDTLS_SSL_TLS_C */