blob: f2a3e1a3f5c60cca902b268707f9efc282d47c4e [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800387 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200388#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800389 ssl_tls_prf_t tls_prf,
390 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400391 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800392 unsigned endpoint,
393 const mbedtls_ssl_context *ssl );
394
395#if defined(MBEDTLS_SHA256_C)
396static int tls_prf_sha256( const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen );
400static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
401static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
402
403#endif /* MBEDTLS_SHA256_C */
404
405#if defined(MBEDTLS_SHA384_C)
406static int tls_prf_sha384( const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen );
410
411static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
412static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
413#endif /* MBEDTLS_SHA384_C */
414
415static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
416 unsigned char *buf,
417 size_t buf_len );
418static int ssl_session_load_tls12( mbedtls_ssl_session *session,
419 const unsigned char *buf,
420 size_t len );
421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
422
Jerry Yu53d23e22022-02-09 16:25:09 +0800423static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
424
Jerry Yudb8c48a2022-01-27 14:54:54 +0800425#if defined(MBEDTLS_SHA256_C)
426static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800427#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800428
429#if defined(MBEDTLS_SHA384_C)
430static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800431#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000432
Ron Eldor51d3ab52019-05-12 14:54:30 +0300433int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
434 const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen )
438{
439 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
440
441 switch( prf )
442 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300443#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200444#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300445 case MBEDTLS_SSL_TLS_PRF_SHA384:
446 tls_prf = tls_prf_sha384;
447 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200448#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300449#if defined(MBEDTLS_SHA256_C)
450 case MBEDTLS_SSL_TLS_PRF_SHA256:
451 tls_prf = tls_prf_sha256;
452 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300453#endif /* MBEDTLS_SHA256_C */
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300455 default:
456 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
457 }
458
459 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
460}
461
Jerry Yuc73c6182022-02-08 20:29:25 +0800462#if defined(MBEDTLS_X509_CRT_PARSE_C)
463static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
464{
465#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
466 if( session->peer_cert != NULL )
467 {
468 mbedtls_x509_crt_free( session->peer_cert );
469 mbedtls_free( session->peer_cert );
470 session->peer_cert = NULL;
471 }
472#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
473 if( session->peer_cert_digest != NULL )
474 {
475 /* Zeroization is not necessary. */
476 mbedtls_free( session->peer_cert_digest );
477 session->peer_cert_digest = NULL;
478 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
479 session->peer_cert_digest_len = 0;
480 }
481#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
482}
483#endif /* MBEDTLS_X509_CRT_PARSE_C */
484
485void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
487{
488 ((void) ciphersuite_info);
489
490#if defined(MBEDTLS_SHA384_C)
491 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
492 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
493 else
494#endif
495#if defined(MBEDTLS_SHA256_C)
496 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
497 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
498 else
499#endif
500 {
501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
502 return;
503 }
504}
505
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100506static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
507 unsigned hs_type,
508 size_t total_hs_len )
509{
510 unsigned char hs_hdr[4];
511
512 /* Build HS header for checksum update. */
513 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
514 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
515 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
516 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
517
518 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
519}
520
521void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
522 unsigned hs_type,
523 unsigned char const *msg,
524 size_t msg_len )
525{
526 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
527 ssl->handshake->update_checksum( ssl, msg, msg_len );
528}
529
Jerry Yuc73c6182022-02-08 20:29:25 +0800530void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
531{
532 ((void) ssl);
533#if defined(MBEDTLS_SHA256_C)
534#if defined(MBEDTLS_USE_PSA_CRYPTO)
535 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
536 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
537#else
538 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
539#endif
540#endif
541#if defined(MBEDTLS_SHA384_C)
542#if defined(MBEDTLS_USE_PSA_CRYPTO)
543 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
544 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
545#else
546 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
547#endif
548#endif
549}
550
551static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
552 const unsigned char *buf, size_t len )
553{
554#if defined(MBEDTLS_SHA256_C)
555#if defined(MBEDTLS_USE_PSA_CRYPTO)
556 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
557#else
558 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
559#endif
560#endif
561#if defined(MBEDTLS_SHA384_C)
562#if defined(MBEDTLS_USE_PSA_CRYPTO)
563 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
564#else
565 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
566#endif
567#endif
568}
569
570#if defined(MBEDTLS_SHA256_C)
571static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
572 const unsigned char *buf, size_t len )
573{
574#if defined(MBEDTLS_USE_PSA_CRYPTO)
575 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
576#else
577 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
578#endif
579}
580#endif
581
582#if defined(MBEDTLS_SHA384_C)
583static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
584 const unsigned char *buf, size_t len )
585{
586#if defined(MBEDTLS_USE_PSA_CRYPTO)
587 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
588#else
589 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
590#endif
591}
592#endif
593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200595{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500599#if defined(MBEDTLS_USE_PSA_CRYPTO)
600 handshake->fin_sha256_psa = psa_hash_operation_init();
601 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
602#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200604 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200605#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500606#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200607#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500609 handshake->fin_sha384_psa = psa_hash_operation_init();
610 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500611#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200613 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200614#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500615#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616
617 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100618
619#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100620 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100621 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
622#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#if defined(MBEDTLS_DHM_C)
625 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200626#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200627#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200629#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200630#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200632#if defined(MBEDTLS_SSL_CLI_C)
633 handshake->ecjpake_cache = NULL;
634 handshake->ecjpake_cache_len = 0;
635#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200636#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200637
Gilles Peskineeccd8882020-03-10 12:19:08 +0100638#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200639 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200640#endif
641
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200642#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
643 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
644#endif
Hanno Becker75173122019-02-06 16:18:31 +0000645
646#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
647 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
648 mbedtls_pk_init( &handshake->peer_pubkey );
649#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200650}
651
Hanno Beckera18d1322018-01-03 14:27:32 +0000652void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200653{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200655
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
658 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100659#else
660 mbedtls_cipher_init( &transform->cipher_ctx_enc );
661 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100662#endif
663
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100665#if defined(MBEDTLS_USE_PSA_CRYPTO)
666 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
667 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100668#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 mbedtls_md_init( &transform->md_ctx_enc );
670 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000671#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100672#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200673}
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200676{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678}
679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000681{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200682 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000683 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200685 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200688 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689
690 /*
691 * Either the pointers are now NULL or cleared properly and can be freed.
692 * Now allocate missing structures.
693 */
694 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200695 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200696 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 }
Paul Bakker48916f92012-09-16 19:57:18 +0000698
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200699 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200700 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200701 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 }
Paul Bakker48916f92012-09-16 19:57:18 +0000703
Paul Bakker82788fb2014-10-20 13:59:19 +0200704 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200705 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200706 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500708#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
709 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400710
Andrzej Kurek4a063792020-10-21 15:08:44 +0200711 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
712 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500713#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000714
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000716 if( ssl->handshake == NULL ||
717 ssl->transform_negotiate == NULL ||
718 ssl->session_negotiate == NULL )
719 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200720 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 mbedtls_free( ssl->handshake );
723 mbedtls_free( ssl->transform_negotiate );
724 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725
726 ssl->handshake = NULL;
727 ssl->transform_negotiate = NULL;
728 ssl->session_negotiate = NULL;
729
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200730 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000731 }
732
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200733 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200734 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000735 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200736 ssl_handshake_params_init( ssl->handshake );
737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200739 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
740 {
741 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200742
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200743 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
744 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
745 else
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200747
Hanno Becker0f57a652020-02-05 10:37:26 +0000748 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200749 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200750#endif
751
Brett Warrene0edc842021-08-17 09:53:13 +0100752/*
753 * curve_list is translated to IANA TLS group identifiers here because
754 * mbedtls_ssl_conf_curves returns void and so can't return
755 * any error codes.
756 */
757#if defined(MBEDTLS_ECP_C)
758#if !defined(MBEDTLS_DEPRECATED_REMOVED)
759 /* Heap allocate and translate curve_list from internal to IANA group ids */
760 if ( ssl->conf->curve_list != NULL )
761 {
762 size_t length;
763 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
764
765 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
766 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
767
768 /* Leave room for zero termination */
769 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
770 if ( group_list == NULL )
771 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
772
773 for( size_t i = 0; i < length; i++ )
774 {
775 const mbedtls_ecp_curve_info *info =
776 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
777 if ( info == NULL )
778 {
779 mbedtls_free( group_list );
780 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
781 }
782 group_list[i] = info->tls_id;
783 }
784
785 group_list[length] = 0;
786
787 ssl->handshake->group_list = group_list;
788 ssl->handshake->group_list_heap_allocated = 1;
789 }
790 else
791 {
792 ssl->handshake->group_list = ssl->conf->group_list;
793 ssl->handshake->group_list_heap_allocated = 0;
794 }
795#endif /* MBEDTLS_DEPRECATED_REMOVED */
796#endif /* MBEDTLS_ECP_C */
797
Jerry Yuf017ee42022-01-12 15:49:48 +0800798#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
799#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800800#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800801 /* Heap allocate and translate sig_hashes from internal hash identifiers to
802 signature algorithms IANA identifiers. */
803 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800804 ssl->conf->sig_hashes != NULL )
805 {
806 const int *md;
807 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800808 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800809 uint16_t *p;
810
Jerry Yub476a442022-01-21 18:14:45 +0800811#if defined(static_assert)
812 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
813 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
814 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800815#endif
816
Jerry Yuf017ee42022-01-12 15:49:48 +0800817 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
818 {
819 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
820 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800821#if defined(MBEDTLS_ECDSA_C)
822 sig_algs_len += sizeof( uint16_t );
823#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800824
Jerry Yub476a442022-01-21 18:14:45 +0800825#if defined(MBEDTLS_RSA_C)
826 sig_algs_len += sizeof( uint16_t );
827#endif
828 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
829 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 }
831
Jerry Yub476a442022-01-21 18:14:45 +0800832 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800833 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
834
Jerry Yub476a442022-01-21 18:14:45 +0800835 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
836 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800837 if( ssl->handshake->sig_algs == NULL )
838 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
839
840 p = (uint16_t *)ssl->handshake->sig_algs;
841 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
842 {
843 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
844 if( hash == MBEDTLS_SSL_HASH_NONE )
845 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800846#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800847 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
848 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800849#endif
850#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800851 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
852 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800853#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800854 }
855 *p = MBEDTLS_TLS1_3_SIG_NONE;
856 ssl->handshake->sig_algs_heap_allocated = 1;
857 }
858 else
Jerry Yua69269a2022-01-17 21:06:01 +0800859#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800860 {
861 ssl->handshake->sig_algs = ssl->conf->sig_algs;
862 ssl->handshake->sig_algs_heap_allocated = 0;
863 }
864#endif /* MBEDTLS_DEPRECATED_REMOVED */
865#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000866 return( 0 );
867}
868
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200869#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200870/* Dummy cookie callbacks for defaults */
871static int ssl_cookie_write_dummy( void *ctx,
872 unsigned char **p, unsigned char *end,
873 const unsigned char *cli_id, size_t cli_id_len )
874{
875 ((void) ctx);
876 ((void) p);
877 ((void) end);
878 ((void) cli_id);
879 ((void) cli_id_len);
880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200882}
883
884static int ssl_cookie_check_dummy( void *ctx,
885 const unsigned char *cookie, size_t cookie_len,
886 const unsigned char *cli_id, size_t cli_id_len )
887{
888 ((void) ctx);
889 ((void) cookie);
890 ((void) cookie_len);
891 ((void) cli_id);
892 ((void) cli_id_len);
893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200896#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897
Paul Bakker5121ce52009-01-03 21:22:43 +0000898/*
899 * Initialize an SSL context
900 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200901void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
902{
903 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
904}
905
Jerry Yu60835a82021-08-04 10:13:52 +0800906static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
907{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100908 const mbedtls_ssl_config *conf = ssl->conf;
909
Ronald Cron6f135e12021-12-08 16:57:54 +0100910#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100911 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
912 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000913 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
914 {
915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
916 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
917 }
918
Jerry Yu60835a82021-08-04 10:13:52 +0800919 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
920 return( 0 );
921 }
922#endif
923
924#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100925 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800926 {
927 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
928 return( 0 );
929 }
930#endif
931
Ronald Cron6f135e12021-12-08 16:57:54 +0100932#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100933 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800934 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000935 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
936 {
937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
938 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
939 }
940
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000941 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
947
Ronald Crone1d3f062022-02-10 14:50:54 +0100948 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
949 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800950 }
951#endif
952
953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
954 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
955}
956
957static int ssl_conf_check(const mbedtls_ssl_context *ssl)
958{
959 int ret;
960 ret = ssl_conf_version_check( ssl );
961 if( ret != 0 )
962 return( ret );
963
964 /* Space for further checks */
965
966 return( 0 );
967}
968
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200969/*
970 * Setup an SSL context
971 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100972
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200973int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200974 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000975{
Janos Follath865b3eb2019-12-16 11:46:15 +0000976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000977 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
978 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000979
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200980 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000981
Jerry Yu60835a82021-08-04 10:13:52 +0800982 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
983 return( ret );
984
Paul Bakker62f2dee2012-09-28 07:31:51 +0000985 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100986 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000987 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200988
989 /* Set to NULL in case of an error condition */
990 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200991
Darryl Greenb33cc762019-11-28 14:29:44 +0000992#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
993 ssl->in_buf_len = in_buf_len;
994#endif
995 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000996 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000997 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200999 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001000 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001001 }
1002
Darryl Greenb33cc762019-11-28 14:29:44 +00001003#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1004 ssl->out_buf_len = out_buf_len;
1005#endif
1006 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001007 if( ssl->out_buf == NULL )
1008 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001010 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001011 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001012 }
1013
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001014 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001015
Johan Pascalb62bb512015-12-03 21:56:45 +01001016#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001017 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001018#endif
1019
Paul Bakker48916f92012-09-16 19:57:18 +00001020 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001021 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001022
1023 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001024
1025error:
1026 mbedtls_free( ssl->in_buf );
1027 mbedtls_free( ssl->out_buf );
1028
1029 ssl->conf = NULL;
1030
Darryl Greenb33cc762019-11-28 14:29:44 +00001031#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1032 ssl->in_buf_len = 0;
1033 ssl->out_buf_len = 0;
1034#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001035 ssl->in_buf = NULL;
1036 ssl->out_buf = NULL;
1037
1038 ssl->in_hdr = NULL;
1039 ssl->in_ctr = NULL;
1040 ssl->in_len = NULL;
1041 ssl->in_iv = NULL;
1042 ssl->in_msg = NULL;
1043
1044 ssl->out_hdr = NULL;
1045 ssl->out_ctr = NULL;
1046 ssl->out_len = NULL;
1047 ssl->out_iv = NULL;
1048 ssl->out_msg = NULL;
1049
k-stachowiak9f7798e2018-07-31 16:52:32 +02001050 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001051}
1052
1053/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001054 * Reset an initialized and used SSL context for re-use while retaining
1055 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001056 *
1057 * If partial is non-zero, keep data in the input buffer and client ID.
1058 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001059 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001060void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1061 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001062{
Darryl Greenb33cc762019-11-28 14:29:44 +00001063#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1064 size_t in_buf_len = ssl->in_buf_len;
1065 size_t out_buf_len = ssl->out_buf_len;
1066#else
1067 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1068 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1069#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001070
Hanno Beckerb0302c42021-08-03 09:39:42 +01001071#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1072 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001073#endif
1074
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001075 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001076 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001077
Hanno Beckerb0302c42021-08-03 09:39:42 +01001078 mbedtls_ssl_reset_in_out_pointers( ssl );
1079
1080 /* Reset incoming message parsing */
1081 ssl->in_offt = NULL;
1082 ssl->nb_zero = 0;
1083 ssl->in_msgtype = 0;
1084 ssl->in_msglen = 0;
1085 ssl->in_hslen = 0;
1086 ssl->keep_current_message = 0;
1087 ssl->transform_in = NULL;
1088
1089#if defined(MBEDTLS_SSL_PROTO_DTLS)
1090 ssl->next_record_offset = 0;
1091 ssl->in_epoch = 0;
1092#endif
1093
1094 /* Keep current datagram if partial == 1 */
1095 if( partial == 0 )
1096 {
1097 ssl->in_left = 0;
1098 memset( ssl->in_buf, 0, in_buf_len );
1099 }
1100
1101 /* Reset outgoing message writing */
1102 ssl->out_msgtype = 0;
1103 ssl->out_msglen = 0;
1104 ssl->out_left = 0;
1105 memset( ssl->out_buf, 0, out_buf_len );
1106 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1107 ssl->transform_out = NULL;
1108
1109#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1110 mbedtls_ssl_dtls_replay_reset( ssl );
1111#endif
1112
XiaokangQian2b01dc32022-01-21 02:53:13 +00001113#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001114 if( ssl->transform )
1115 {
1116 mbedtls_ssl_transform_free( ssl->transform );
1117 mbedtls_free( ssl->transform );
1118 ssl->transform = NULL;
1119 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001120#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1121
XiaokangQian2b01dc32022-01-21 02:53:13 +00001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1123 mbedtls_ssl_transform_free( ssl->transform_application );
1124 mbedtls_free( ssl->transform_application );
1125 ssl->transform_application = NULL;
1126
1127 if( ssl->handshake != NULL )
1128 {
1129 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1130 mbedtls_free( ssl->handshake->transform_earlydata );
1131 ssl->handshake->transform_earlydata = NULL;
1132
1133 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1134 mbedtls_free( ssl->handshake->transform_handshake );
1135 ssl->handshake->transform_handshake = NULL;
1136 }
1137
XiaokangQian2b01dc32022-01-21 02:53:13 +00001138#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001139}
1140
1141int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1142{
1143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1144
1145 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1146
XiaokangQian78b1fa72022-01-19 06:56:30 +00001147 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001148
1149 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150#if defined(MBEDTLS_SSL_RENEGOTIATION)
1151 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001152 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001153
1154 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1156 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001157#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001159
Hanno Beckerb0302c42021-08-03 09:39:42 +01001160 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001161 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001162 if( ssl->session )
1163 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 mbedtls_ssl_session_free( ssl->session );
1165 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001166 ssl->session = NULL;
1167 }
1168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001170 ssl->alpn_chosen = NULL;
1171#endif
1172
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001173#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001174#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001175 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001176#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001177 {
1178 mbedtls_free( ssl->cli_id );
1179 ssl->cli_id = NULL;
1180 ssl->cli_id_len = 0;
1181 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001182#endif
1183
Paul Bakker48916f92012-09-16 19:57:18 +00001184 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1185 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001186
1187 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001188}
1189
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001190/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001191 * Reset an initialized and used SSL context for re-use while retaining
1192 * all application-set variables, function pointers and data.
1193 */
1194int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1195{
Hanno Becker43aefe22020-02-05 10:44:56 +00001196 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001197}
1198
1199/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001200 * SSL set accessors
1201 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001202void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001203{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001204 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001205}
1206
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001207void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001209 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001210}
1211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001212#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001213void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001215 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001216}
1217#endif
1218
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001219void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001220{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001221 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001222}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001225
Hanno Becker1841b0a2018-08-24 11:13:57 +01001226void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1227 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001228{
1229 ssl->disable_datagram_packing = !allow_packing;
1230}
1231
1232void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1233 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->hs_timeout_min = min;
1236 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001237}
1238#endif
1239
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001240void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001243}
1244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001246void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001247 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001248 void *p_vrfy )
1249{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001250 conf->f_vrfy = f_vrfy;
1251 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001252}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001254
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001255void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001256 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001257 void *p_rng )
1258{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001259 conf->f_rng = f_rng;
1260 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001261}
1262
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001263void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001264 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001265 void *p_dbg )
1266{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001267 conf->f_dbg = f_dbg;
1268 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001269}
1270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001272 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001273 mbedtls_ssl_send_t *f_send,
1274 mbedtls_ssl_recv_t *f_recv,
1275 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001276{
1277 ssl->p_bio = p_bio;
1278 ssl->f_send = f_send;
1279 ssl->f_recv = f_recv;
1280 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001281}
1282
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001283#if defined(MBEDTLS_SSL_PROTO_DTLS)
1284void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1285{
1286 ssl->mtu = mtu;
1287}
1288#endif
1289
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001290void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001291{
1292 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001293}
1294
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001295void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1296 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001297 mbedtls_ssl_set_timer_t *f_set_timer,
1298 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001299{
1300 ssl->p_timer = p_timer;
1301 ssl->f_set_timer = f_set_timer;
1302 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001303
1304 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001305 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001306}
1307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001309void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001310 void *p_cache,
1311 mbedtls_ssl_cache_get_t *f_get_cache,
1312 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001313{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001314 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001315 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001316 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001317}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#if defined(MBEDTLS_SSL_CLI_C)
1321int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001322{
Janos Follath865b3eb2019-12-16 11:46:15 +00001323 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001324
1325 if( ssl == NULL ||
1326 session == NULL ||
1327 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001328 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001331 }
1332
Hanno Beckere810bbc2021-05-14 16:01:05 +01001333 if( ssl->handshake->resume == 1 )
1334 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1335
Hanno Becker52055ae2019-02-06 14:30:46 +00001336 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1337 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001338 return( ret );
1339
Paul Bakker0a597072012-09-25 21:55:46 +00001340 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001341
1342 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001343}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001345
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001346void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1347 const int *ciphersuites )
1348{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001349 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001350}
1351
Ronald Cron6f135e12021-12-08 16:57:54 +01001352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001353void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001354 const int kex_modes )
1355{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001356 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001357}
Ronald Cron6f135e12021-12-08 16:57:54 +01001358#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001361void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001362 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001363{
1364 conf->cert_profile = profile;
1365}
1366
Glenn Strauss36872db2022-01-22 05:06:31 -05001367static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1368{
1369 mbedtls_ssl_key_cert *cur = key_cert, *next;
1370
1371 while( cur != NULL )
1372 {
1373 next = cur->next;
1374 mbedtls_free( cur );
1375 cur = next;
1376 }
1377}
1378
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001379/* Append a new keycert entry to a (possibly empty) list */
1380static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1381 mbedtls_x509_crt *cert,
1382 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001383{
niisato8ee24222018-06-25 19:05:48 +09001384 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001385
Glenn Strauss36872db2022-01-22 05:06:31 -05001386 if( cert == NULL )
1387 {
1388 /* Free list if cert is null */
1389 ssl_key_cert_free( *head );
1390 *head = NULL;
1391 return( 0 );
1392 }
1393
niisato8ee24222018-06-25 19:05:48 +09001394 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1395 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001396 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001397
niisato8ee24222018-06-25 19:05:48 +09001398 new_cert->cert = cert;
1399 new_cert->key = key;
1400 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001401
Glenn Strauss36872db2022-01-22 05:06:31 -05001402 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001403 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001404 {
niisato8ee24222018-06-25 19:05:48 +09001405 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001406 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001407 else
1408 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001409 mbedtls_ssl_key_cert *cur = *head;
1410 while( cur->next != NULL )
1411 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001412 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001413 }
1414
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001415 return( 0 );
1416}
1417
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001418int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001419 mbedtls_x509_crt *own_cert,
1420 mbedtls_pk_context *pk_key )
1421{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001422 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001423}
1424
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001425void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001426 mbedtls_x509_crt *ca_chain,
1427 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001428{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001429 conf->ca_chain = ca_chain;
1430 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001431
1432#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1433 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1434 * cannot be used together. */
1435 conf->f_ca_cb = NULL;
1436 conf->p_ca_cb = NULL;
1437#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001438}
Hanno Becker5adaad92019-03-27 16:54:37 +00001439
1440#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1441void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001442 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001443 void *p_ca_cb )
1444{
1445 conf->f_ca_cb = f_ca_cb;
1446 conf->p_ca_cb = p_ca_cb;
1447
1448 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1449 * cannot be used together. */
1450 conf->ca_chain = NULL;
1451 conf->ca_crl = NULL;
1452}
1453#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001455
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001456#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001457const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1458 size_t *name_len )
1459{
1460 *name_len = ssl->handshake->sni_name_len;
1461 return( ssl->handshake->sni_name );
1462}
1463
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001464int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1465 mbedtls_x509_crt *own_cert,
1466 mbedtls_pk_context *pk_key )
1467{
1468 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1469 own_cert, pk_key ) );
1470}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001471
1472void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1473 mbedtls_x509_crt *ca_chain,
1474 mbedtls_x509_crl *ca_crl )
1475{
1476 ssl->handshake->sni_ca_chain = ca_chain;
1477 ssl->handshake->sni_ca_crl = ca_crl;
1478}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001479
1480void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1481 int authmode )
1482{
1483 ssl->handshake->sni_authmode = authmode;
1484}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001485#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1486
Hanno Becker8927c832019-04-03 12:52:50 +01001487#if defined(MBEDTLS_X509_CRT_PARSE_C)
1488void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1489 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1490 void *p_vrfy )
1491{
1492 ssl->f_vrfy = f_vrfy;
1493 ssl->p_vrfy = p_vrfy;
1494}
1495#endif
1496
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001497#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001498/*
1499 * Set EC J-PAKE password for current handshake
1500 */
1501int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1502 const unsigned char *pw,
1503 size_t pw_len )
1504{
1505 mbedtls_ecjpake_role role;
1506
Janos Follath8eb64132016-06-03 15:40:57 +01001507 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001508 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1509
1510 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1511 role = MBEDTLS_ECJPAKE_SERVER;
1512 else
1513 role = MBEDTLS_ECJPAKE_CLIENT;
1514
1515 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1516 role,
1517 MBEDTLS_MD_SHA256,
1518 MBEDTLS_ECP_DP_SECP256R1,
1519 pw, pw_len ) );
1520}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001521#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001522
Gilles Peskineeccd8882020-03-10 12:19:08 +01001523#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001524
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001525static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1526{
1527#if defined(MBEDTLS_USE_PSA_CRYPTO)
1528 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1529 return( 1 );
Neil Armstronge952a302022-05-03 10:22:14 +02001530#else
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001531 if( conf->psk != NULL )
1532 return( 1 );
Neil Armstronge952a302022-05-03 10:22:14 +02001533#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001534
1535 return( 0 );
1536}
1537
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001538static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1539{
1540 /* Remove reference to existing PSK, if any. */
1541#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001542 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001543 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001544 /* The maintenance of the external PSK key slot is the
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545 * user's responsibility. */
Neil Armstrong501c9322022-05-03 09:35:09 +02001546 if( conf->psk_opaque_is_internal )
1547 {
1548 psa_destroy_key( conf->psk_opaque );
1549 conf->psk_opaque_is_internal = 0;
1550 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001551 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001552 }
Neil Armstronge952a302022-05-03 10:22:14 +02001553#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001554 if( conf->psk != NULL )
1555 {
1556 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1557
1558 mbedtls_free( conf->psk );
1559 conf->psk = NULL;
1560 conf->psk_len = 0;
1561 }
Neil Armstronge952a302022-05-03 10:22:14 +02001562#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001563
1564 /* Remove reference to PSK identity, if any. */
1565 if( conf->psk_identity != NULL )
1566 {
1567 mbedtls_free( conf->psk_identity );
1568 conf->psk_identity = NULL;
1569 conf->psk_identity_len = 0;
1570 }
1571}
1572
Hanno Becker7390c712018-11-15 13:33:04 +00001573/* This function assumes that PSK identity in the SSL config is unset.
1574 * It checks that the provided identity is well-formed and attempts
1575 * to make a copy of it in the SSL config.
1576 * On failure, the PSK identity in the config remains unset. */
1577static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1578 unsigned char const *psk_identity,
1579 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001580{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001581 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001582 if( psk_identity == NULL ||
1583 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001584 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001585 {
1586 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1587 }
1588
Hanno Becker7390c712018-11-15 13:33:04 +00001589 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1590 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001591 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001592
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001593 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001594 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001595
1596 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001597}
1598
Hanno Becker7390c712018-11-15 13:33:04 +00001599int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1600 const unsigned char *psk, size_t psk_len,
1601 const unsigned char *psk_identity, size_t psk_identity_len )
1602{
Janos Follath865b3eb2019-12-16 11:46:15 +00001603 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong501c9322022-05-03 09:35:09 +02001604#if defined(MBEDTLS_USE_PSA_CRYPTO)
1605 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1606 psa_status_t status;
1607 mbedtls_svc_key_id_t key;
1608#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001609
1610 /* We currently only support one PSK, raw or opaque. */
1611 if( ssl_conf_psk_is_configured( conf ) )
1612 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001613
1614 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001615 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001616 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001617 if( psk_len == 0 )
1618 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1619 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1620 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1621
Neil Armstrong501c9322022-05-03 09:35:09 +02001622#if defined(MBEDTLS_USE_PSA_CRYPTO)
1623 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1624 psa_set_key_algorithm( &key_attributes,
1625 PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256) );
1626 psa_set_key_enrollment_algorithm( &key_attributes,
1627 PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384) );
1628 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1629
1630 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1631 if( status != PSA_SUCCESS )
1632 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1633
1634 /* Allow calling psa_destroy_key() on config psk remove/free */
1635 conf->psk_opaque_is_internal = 1;
1636 ret = mbedtls_ssl_conf_psk_opaque( conf, key,
1637 psk_identity, psk_identity_len );
1638#else
Hanno Becker7390c712018-11-15 13:33:04 +00001639 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1640 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1641 conf->psk_len = psk_len;
1642 memcpy( conf->psk, psk, conf->psk_len );
1643
1644 /* Check and set PSK Identity */
1645 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1646 if( ret != 0 )
1647 ssl_conf_remove_psk( conf );
Neil Armstrong501c9322022-05-03 09:35:09 +02001648#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker7390c712018-11-15 13:33:04 +00001649
1650 return( ret );
1651}
1652
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001653static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1654{
1655#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001656 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001657 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001658 /* The maintenance of the external PSK key slot is the
1659 * user's responsibility. */
1660 if( ssl->handshake->psk_opaque_is_internal )
1661 {
1662 psa_destroy_key( ssl->handshake->psk_opaque );
1663 ssl->handshake->psk_opaque_is_internal = 0;
1664 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001665 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001666 }
Neil Armstronge952a302022-05-03 10:22:14 +02001667#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001668 if( ssl->handshake->psk != NULL )
1669 {
1670 mbedtls_platform_zeroize( ssl->handshake->psk,
1671 ssl->handshake->psk_len );
1672 mbedtls_free( ssl->handshake->psk );
1673 ssl->handshake->psk_len = 0;
1674 }
Neil Armstronge952a302022-05-03 10:22:14 +02001675#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001676}
1677
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001678int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1679 const unsigned char *psk, size_t psk_len )
1680{
Neil Armstrong501c9322022-05-03 09:35:09 +02001681#if defined(MBEDTLS_USE_PSA_CRYPTO)
1682 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1683 psa_status_t status;
1684 psa_algorithm_t alg;
1685 mbedtls_svc_key_id_t key;
1686#endif /* MBEDTLS_USE_PSA_CRYPTO */
1687
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001688 if( psk == NULL || ssl->handshake == NULL )
1689 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1690
1691 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1692 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1693
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001694 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001695
Neil Armstrong501c9322022-05-03 09:35:09 +02001696#if defined(MBEDTLS_USE_PSA_CRYPTO)
1697 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1698 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1699 else
1700 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1701
1702 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1703 psa_set_key_algorithm( &key_attributes, alg );
1704 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1705
1706 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1707 if( status != PSA_SUCCESS )
1708 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1709
1710 /* Allow calling psa_destroy_key() on psk remove */
1711 ssl->handshake->psk_opaque_is_internal = 1;
1712 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1713#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001714 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001715 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001716
1717 ssl->handshake->psk_len = psk_len;
1718 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1719
1720 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001721#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001722}
1723
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001724#if defined(MBEDTLS_USE_PSA_CRYPTO)
1725int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001726 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001727 const unsigned char *psk_identity,
1728 size_t psk_identity_len )
1729{
Janos Follath865b3eb2019-12-16 11:46:15 +00001730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001731
1732 /* We currently only support one PSK, raw or opaque. */
1733 if( ssl_conf_psk_is_configured( conf ) )
1734 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001735
Hanno Becker7390c712018-11-15 13:33:04 +00001736 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001737 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001738 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001739 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001740
1741 /* Check and set PSK Identity */
1742 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1743 psk_identity_len );
1744 if( ret != 0 )
1745 ssl_conf_remove_psk( conf );
1746
1747 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001748}
1749
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001750int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1751 mbedtls_svc_key_id_t psk )
1752{
1753 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1754 ( ssl->handshake == NULL ) )
1755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1756
1757 ssl_remove_psk( ssl );
1758 ssl->handshake->psk_opaque = psk;
1759 return( 0 );
1760}
1761#endif /* MBEDTLS_USE_PSA_CRYPTO */
1762
1763void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1764 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1765 size_t),
1766 void *p_psk )
1767{
1768 conf->f_psk = f_psk;
1769 conf->p_psk = p_psk;
1770}
1771#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1772
1773#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001774static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1775 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001776{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001777#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001778 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001779 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001780#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001781 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001782 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001783 return( MBEDTLS_SSL_MODE_STREAM );
1784}
1785
1786#else /* MBEDTLS_USE_PSA_CRYPTO */
1787
1788static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1789 mbedtls_cipher_mode_t mode )
1790{
1791#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1792 if( mode == MBEDTLS_MODE_CBC )
1793 return( MBEDTLS_SSL_MODE_CBC );
1794#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1795
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001796#if defined(MBEDTLS_GCM_C) || \
1797 defined(MBEDTLS_CCM_C) || \
1798 defined(MBEDTLS_CHACHAPOLY_C)
1799 if( mode == MBEDTLS_MODE_GCM ||
1800 mode == MBEDTLS_MODE_CCM ||
1801 mode == MBEDTLS_MODE_CHACHAPOLY )
1802 return( MBEDTLS_SSL_MODE_AEAD );
1803#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001804
1805 return( MBEDTLS_SSL_MODE_STREAM );
1806}
Gilles Peskine301711e2022-04-26 16:57:05 +02001807#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001808
Gilles Peskinee108d982022-04-26 16:50:40 +02001809static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1810 mbedtls_ssl_mode_t base_mode,
1811 int encrypt_then_mac )
1812{
1813#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1814 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1815 base_mode == MBEDTLS_SSL_MODE_CBC )
1816 {
1817 return( MBEDTLS_SSL_MODE_CBC_ETM );
1818 }
1819#else
1820 (void) encrypt_then_mac;
1821#endif
1822 return( base_mode );
1823}
1824
Neil Armstrongab555e02022-04-04 11:07:59 +02001825mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001826 const mbedtls_ssl_transform *transform )
1827{
Gilles Peskinee108d982022-04-26 16:50:40 +02001828 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001830 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001831#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001832 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1833#endif
1834 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001835
Gilles Peskinee108d982022-04-26 16:50:40 +02001836 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001837#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001838 encrypt_then_mac = transform->encrypt_then_mac;
1839#endif
1840 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001841}
1842
Neil Armstrongab555e02022-04-04 11:07:59 +02001843mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001844#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001845 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001846#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001847 const mbedtls_ssl_ciphersuite_t *suite )
1848{
Gilles Peskinee108d982022-04-26 16:50:40 +02001849 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1850
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001851#if defined(MBEDTLS_USE_PSA_CRYPTO)
1852 psa_status_t status;
1853 psa_algorithm_t alg;
1854 psa_key_type_t type;
1855 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001856 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1857 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001858 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001859#else
1860 const mbedtls_cipher_info_t *cipher =
1861 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001862 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001863 {
1864 base_mode =
1865 mbedtls_ssl_get_base_mode(
1866 mbedtls_cipher_info_get_mode( cipher ) );
1867 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001868#endif /* MBEDTLS_USE_PSA_CRYPTO */
1869
Gilles Peskinee108d982022-04-26 16:50:40 +02001870#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1871 int encrypt_then_mac = 0;
1872#endif
1873 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001874}
1875
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001876#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001877psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001878 size_t taglen,
1879 psa_algorithm_t *alg,
1880 psa_key_type_t *key_type,
1881 size_t *key_size )
1882{
1883 switch ( mbedtls_cipher_type )
1884 {
1885 case MBEDTLS_CIPHER_AES_128_CBC:
1886 *alg = PSA_ALG_CBC_NO_PADDING;
1887 *key_type = PSA_KEY_TYPE_AES;
1888 *key_size = 128;
1889 break;
1890 case MBEDTLS_CIPHER_AES_128_CCM:
1891 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1892 *key_type = PSA_KEY_TYPE_AES;
1893 *key_size = 128;
1894 break;
1895 case MBEDTLS_CIPHER_AES_128_GCM:
1896 *alg = PSA_ALG_GCM;
1897 *key_type = PSA_KEY_TYPE_AES;
1898 *key_size = 128;
1899 break;
1900 case MBEDTLS_CIPHER_AES_192_CCM:
1901 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1902 *key_type = PSA_KEY_TYPE_AES;
1903 *key_size = 192;
1904 break;
1905 case MBEDTLS_CIPHER_AES_192_GCM:
1906 *alg = PSA_ALG_GCM;
1907 *key_type = PSA_KEY_TYPE_AES;
1908 *key_size = 192;
1909 break;
1910 case MBEDTLS_CIPHER_AES_256_CBC:
1911 *alg = PSA_ALG_CBC_NO_PADDING;
1912 *key_type = PSA_KEY_TYPE_AES;
1913 *key_size = 256;
1914 break;
1915 case MBEDTLS_CIPHER_AES_256_CCM:
1916 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1917 *key_type = PSA_KEY_TYPE_AES;
1918 *key_size = 256;
1919 break;
1920 case MBEDTLS_CIPHER_AES_256_GCM:
1921 *alg = PSA_ALG_GCM;
1922 *key_type = PSA_KEY_TYPE_AES;
1923 *key_size = 256;
1924 break;
1925 case MBEDTLS_CIPHER_ARIA_128_CBC:
1926 *alg = PSA_ALG_CBC_NO_PADDING;
1927 *key_type = PSA_KEY_TYPE_ARIA;
1928 *key_size = 128;
1929 break;
1930 case MBEDTLS_CIPHER_ARIA_128_CCM:
1931 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1932 *key_type = PSA_KEY_TYPE_ARIA;
1933 *key_size = 128;
1934 break;
1935 case MBEDTLS_CIPHER_ARIA_128_GCM:
1936 *alg = PSA_ALG_GCM;
1937 *key_type = PSA_KEY_TYPE_ARIA;
1938 *key_size = 128;
1939 break;
1940 case MBEDTLS_CIPHER_ARIA_192_CCM:
1941 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1942 *key_type = PSA_KEY_TYPE_ARIA;
1943 *key_size = 192;
1944 break;
1945 case MBEDTLS_CIPHER_ARIA_192_GCM:
1946 *alg = PSA_ALG_GCM;
1947 *key_type = PSA_KEY_TYPE_ARIA;
1948 *key_size = 192;
1949 break;
1950 case MBEDTLS_CIPHER_ARIA_256_CBC:
1951 *alg = PSA_ALG_CBC_NO_PADDING;
1952 *key_type = PSA_KEY_TYPE_ARIA;
1953 *key_size = 256;
1954 break;
1955 case MBEDTLS_CIPHER_ARIA_256_CCM:
1956 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1957 *key_type = PSA_KEY_TYPE_ARIA;
1958 *key_size = 256;
1959 break;
1960 case MBEDTLS_CIPHER_ARIA_256_GCM:
1961 *alg = PSA_ALG_GCM;
1962 *key_type = PSA_KEY_TYPE_ARIA;
1963 *key_size = 256;
1964 break;
1965 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1966 *alg = PSA_ALG_CBC_NO_PADDING;
1967 *key_type = PSA_KEY_TYPE_CAMELLIA;
1968 *key_size = 128;
1969 break;
1970 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1971 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1972 *key_type = PSA_KEY_TYPE_CAMELLIA;
1973 *key_size = 128;
1974 break;
1975 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1976 *alg = PSA_ALG_GCM;
1977 *key_type = PSA_KEY_TYPE_CAMELLIA;
1978 *key_size = 128;
1979 break;
1980 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1981 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1982 *key_type = PSA_KEY_TYPE_CAMELLIA;
1983 *key_size = 192;
1984 break;
1985 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1986 *alg = PSA_ALG_GCM;
1987 *key_type = PSA_KEY_TYPE_CAMELLIA;
1988 *key_size = 192;
1989 break;
1990 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1991 *alg = PSA_ALG_CBC_NO_PADDING;
1992 *key_type = PSA_KEY_TYPE_CAMELLIA;
1993 *key_size = 256;
1994 break;
1995 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1996 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1997 *key_type = PSA_KEY_TYPE_CAMELLIA;
1998 *key_size = 256;
1999 break;
2000 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2001 *alg = PSA_ALG_GCM;
2002 *key_type = PSA_KEY_TYPE_CAMELLIA;
2003 *key_size = 256;
2004 break;
2005 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2006 *alg = PSA_ALG_CHACHA20_POLY1305;
2007 *key_type = PSA_KEY_TYPE_CHACHA20;
2008 *key_size = 256;
2009 break;
2010 case MBEDTLS_CIPHER_NULL:
2011 *alg = MBEDTLS_SSL_NULL_CIPHER;
2012 *key_type = 0;
2013 *key_size = 0;
2014 break;
2015 default:
2016 return PSA_ERROR_NOT_SUPPORTED;
2017 }
2018
2019 return PSA_SUCCESS;
2020}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002021#endif /* MBEDTLS_USE_PSA_CRYPTO */
2022
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002023#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002024int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2025 const unsigned char *dhm_P, size_t P_len,
2026 const unsigned char *dhm_G, size_t G_len )
2027{
Janos Follath865b3eb2019-12-16 11:46:15 +00002028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002029
Glenn Strausscee11292021-12-20 01:43:17 -05002030 mbedtls_mpi_free( &conf->dhm_P );
2031 mbedtls_mpi_free( &conf->dhm_G );
2032
Hanno Beckera90658f2017-10-04 15:29:08 +01002033 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2034 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2035 {
2036 mbedtls_mpi_free( &conf->dhm_P );
2037 mbedtls_mpi_free( &conf->dhm_G );
2038 return( ret );
2039 }
2040
2041 return( 0 );
2042}
Paul Bakker5121ce52009-01-03 21:22:43 +00002043
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002044int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002045{
Janos Follath865b3eb2019-12-16 11:46:15 +00002046 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002047
Glenn Strausscee11292021-12-20 01:43:17 -05002048 mbedtls_mpi_free( &conf->dhm_P );
2049 mbedtls_mpi_free( &conf->dhm_G );
2050
Gilles Peskinee5702482021-06-11 21:59:08 +02002051 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2052 &conf->dhm_P ) ) != 0 ||
2053 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2054 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002055 {
2056 mbedtls_mpi_free( &conf->dhm_P );
2057 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002058 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002059 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002060
2061 return( 0 );
2062}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002063#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002064
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002065#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2066/*
2067 * Set the minimum length for Diffie-Hellman parameters
2068 */
2069void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2070 unsigned int bitlen )
2071{
2072 conf->dhm_min_bitlen = bitlen;
2073}
2074#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2075
Gilles Peskineeccd8882020-03-10 12:19:08 +01002076#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002077#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002078/*
2079 * Set allowed/preferred hashes for handshake signatures
2080 */
2081void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2082 const int *hashes )
2083{
2084 conf->sig_hashes = hashes;
2085}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002086#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002087
Jerry Yuf017ee42022-01-12 15:49:48 +08002088/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002089void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2090 const uint16_t* sig_algs )
2091{
Jerry Yuf017ee42022-01-12 15:49:48 +08002092#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2093 conf->sig_hashes = NULL;
2094#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2095 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002096}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002097#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002098
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002099#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002100#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002101/*
2102 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002103 *
2104 * mbedtls_ssl_setup() takes the provided list
2105 * and translates it to a list of IANA TLS group identifiers,
2106 * stored in ssl->handshake->group_list.
2107 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002108 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002109void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002110 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002111{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002112 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002113 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002114}
Brett Warrene0edc842021-08-17 09:53:13 +01002115#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002116#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002117
Brett Warrene0edc842021-08-17 09:53:13 +01002118/*
2119 * Set the allowed groups
2120 */
2121void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2122 const uint16_t *group_list )
2123{
2124#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2125 conf->curve_list = NULL;
2126#endif
2127 conf->group_list = group_list;
2128}
2129
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002130#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002132{
Hanno Becker947194e2017-04-07 13:25:49 +01002133 /* Initialize to suppress unnecessary compiler warning */
2134 size_t hostname_len = 0;
2135
2136 /* Check if new hostname is valid before
2137 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002138 if( hostname != NULL )
2139 {
2140 hostname_len = strlen( hostname );
2141
2142 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2143 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2144 }
2145
2146 /* Now it's clear that we will overwrite the old hostname,
2147 * so we can free it safely */
2148
2149 if( ssl->hostname != NULL )
2150 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002151 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002152 mbedtls_free( ssl->hostname );
2153 }
2154
2155 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002156
Paul Bakker5121ce52009-01-03 21:22:43 +00002157 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002158 {
2159 ssl->hostname = NULL;
2160 }
2161 else
2162 {
2163 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002164 if( ssl->hostname == NULL )
2165 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002166
Hanno Becker947194e2017-04-07 13:25:49 +01002167 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002168
Hanno Becker947194e2017-04-07 13:25:49 +01002169 ssl->hostname[hostname_len] = '\0';
2170 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002171
2172 return( 0 );
2173}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002174#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002175
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002176#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002177void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002179 const unsigned char *, size_t),
2180 void *p_sni )
2181{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002182 conf->f_sni = f_sni;
2183 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002184}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002188int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002189{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002190 size_t cur_len, tot_len;
2191 const char **p;
2192
2193 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002194 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2195 * MUST NOT be truncated."
2196 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002197 */
2198 tot_len = 0;
2199 for( p = protos; *p != NULL; p++ )
2200 {
2201 cur_len = strlen( *p );
2202 tot_len += cur_len;
2203
Ronald Cron8216dd32020-04-23 16:41:44 +02002204 if( ( cur_len == 0 ) ||
2205 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2206 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002207 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002208 }
2209
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002210 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002211
2212 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002213}
2214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002216{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002217 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002218}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002220
Johan Pascalb62bb512015-12-03 21:56:45 +01002221#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002222void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2223 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002224{
2225 conf->dtls_srtp_mki_support = support_mki_value;
2226}
2227
Ron Eldoref72faf2018-07-12 11:54:20 +03002228int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2229 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002230 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002231{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002232 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002233 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002234 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002235 }
Ron Eldor591f1622018-01-22 12:30:04 +02002236
2237 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002238 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002239 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002240 }
Ron Eldor591f1622018-01-22 12:30:04 +02002241
2242 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2243 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002244 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002245}
2246
Ron Eldoref72faf2018-07-12 11:54:20 +03002247int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002248 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002249{
Johan Pascal253d0262020-09-22 13:04:45 +02002250 const mbedtls_ssl_srtp_profile *p;
2251 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002252
Johan Pascal253d0262020-09-22 13:04:45 +02002253 /* check the profiles list: all entry must be valid,
2254 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002255 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2256 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2257 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002258 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002259 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002260 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002261 list_size++;
2262 }
2263 else
2264 {
2265 /* unsupported value, stop parsing and set the size to an error value */
2266 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002267 }
2268 }
2269
Johan Pascal5ef72d22020-10-28 17:05:47 +01002270 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002271 {
Johan Pascal253d0262020-09-22 13:04:45 +02002272 conf->dtls_srtp_profile_list = NULL;
2273 conf->dtls_srtp_profile_list_len = 0;
2274 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2275 }
2276
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002277 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002278 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002279
2280 return( 0 );
2281}
2282
Johan Pascal5ef72d22020-10-28 17:05:47 +01002283void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2284 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002285{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002286 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2287 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002288 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002289 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002290 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002291 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002292 else
2293 {
2294 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002295 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2296 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002297 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002298}
Johan Pascalb62bb512015-12-03 21:56:45 +01002299#endif /* MBEDTLS_SSL_DTLS_SRTP */
2300
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002301void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002302{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002303 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002304}
2305
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002306void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002307{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002308 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002309}
2310
Janos Follath088ce432017-04-10 12:42:31 +01002311#if defined(MBEDTLS_SSL_SRV_C)
2312void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2313 char cert_req_ca_list )
2314{
2315 conf->cert_req_ca_list = cert_req_ca_list;
2316}
2317#endif
2318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002320void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002321{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002322 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002323}
2324#endif
2325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002327void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002328{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002329 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002330}
2331#endif
2332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002333#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002334int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002335{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002337 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002340 }
2341
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002342 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002343
2344 return( 0 );
2345}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002347
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002348void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002349{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002350 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002351}
2352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002354void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002355{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002356 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002357}
2358
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002359void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002360{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002361 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002362}
2363
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002364void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002365 const unsigned char period[8] )
2366{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002367 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002368}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002372#if defined(MBEDTLS_SSL_CLI_C)
2373void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002374{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002375 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002376}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002377#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002378
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002379#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002380void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2381 mbedtls_ssl_ticket_write_t *f_ticket_write,
2382 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2383 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002384{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002385 conf->f_ticket_write = f_ticket_write;
2386 conf->f_ticket_parse = f_ticket_parse;
2387 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002388}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002389#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002391
Hanno Becker7e6c1782021-06-08 09:24:55 +01002392void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2393 mbedtls_ssl_export_keys_t *f_export_keys,
2394 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002395{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002396 ssl->f_export_keys = f_export_keys;
2397 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002398}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002399
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002400#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002401void mbedtls_ssl_conf_async_private_cb(
2402 mbedtls_ssl_config *conf,
2403 mbedtls_ssl_async_sign_t *f_async_sign,
2404 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2405 mbedtls_ssl_async_resume_t *f_async_resume,
2406 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002407 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002408{
2409 conf->f_async_sign_start = f_async_sign;
2410 conf->f_async_decrypt_start = f_async_decrypt;
2411 conf->f_async_resume = f_async_resume;
2412 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002413 conf->p_async_config_data = async_config_data;
2414}
2415
Gilles Peskine8f97af72018-04-26 11:46:10 +02002416void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2417{
2418 return( conf->p_async_config_data );
2419}
2420
Gilles Peskine1febfef2018-04-30 11:54:39 +02002421void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002422{
2423 if( ssl->handshake == NULL )
2424 return( NULL );
2425 else
2426 return( ssl->handshake->user_async_ctx );
2427}
2428
Gilles Peskine1febfef2018-04-30 11:54:39 +02002429void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002430 void *ctx )
2431{
2432 if( ssl->handshake != NULL )
2433 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002434}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002435#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002436
Paul Bakker5121ce52009-01-03 21:22:43 +00002437/*
2438 * SSL get accessors
2439 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002440uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002441{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002442 if( ssl->session != NULL )
2443 return( ssl->session->verify_result );
2444
2445 if( ssl->session_negotiate != NULL )
2446 return( ssl->session_negotiate->verify_result );
2447
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002448 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002449}
2450
Glenn Strauss8f526902022-01-13 00:04:49 -05002451int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2452{
2453 if( ssl == NULL || ssl->session == NULL )
2454 return( 0 );
2455
2456 return( ssl->session->ciphersuite );
2457}
2458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002460{
Paul Bakker926c8e42013-03-06 10:23:34 +01002461 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002462 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002465}
2466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002468{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002470 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002471 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002472 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002473 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002474 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002475 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002476 default:
2477 return( "unknown (DTLS)" );
2478 }
2479 }
2480#endif
2481
Glenn Strauss60bfe602022-03-14 19:04:24 -04002482 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002483 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002484 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002485 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002486 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002487 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002488 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002489 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002490 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002491}
2492
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002493#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002494size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2495{
David Horstmann95d516f2021-05-04 18:36:56 +01002496 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002497 size_t read_mfl;
2498
2499 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2500 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2501 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2502 {
2503 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2504 }
2505
2506 /* Check if a smaller max length was negotiated */
2507 if( ssl->session_out != NULL )
2508 {
2509 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2510 if( read_mfl < max_len )
2511 {
2512 max_len = read_mfl;
2513 }
2514 }
2515
2516 // During a handshake, use the value being negotiated
2517 if( ssl->session_negotiate != NULL )
2518 {
2519 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2520 if( read_mfl < max_len )
2521 {
2522 max_len = read_mfl;
2523 }
2524 }
2525
2526 return( max_len );
2527}
2528
2529size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002530{
2531 size_t max_len;
2532
2533 /*
2534 * Assume mfl_code is correct since it was checked when set
2535 */
Angus Grattond8213d02016-05-25 20:56:48 +10002536 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002537
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002538 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002539 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002540 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002541 {
Angus Grattond8213d02016-05-25 20:56:48 +10002542 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002543 }
2544
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002545 /* During a handshake, use the value being negotiated */
2546 if( ssl->session_negotiate != NULL &&
2547 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2548 {
2549 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2550 }
2551
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002552 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002553}
2554#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2555
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002556#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002557size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002558{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002559 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2560 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2561 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2562 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2563 return ( 0 );
2564
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002565 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2566 return( ssl->mtu );
2567
2568 if( ssl->mtu == 0 )
2569 return( ssl->handshake->mtu );
2570
2571 return( ssl->mtu < ssl->handshake->mtu ?
2572 ssl->mtu : ssl->handshake->mtu );
2573}
2574#endif /* MBEDTLS_SSL_PROTO_DTLS */
2575
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002576int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2577{
2578 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2579
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002580#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2581 !defined(MBEDTLS_SSL_PROTO_DTLS)
2582 (void) ssl;
2583#endif
2584
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002585#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002586 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002587
2588 if( max_len > mfl )
2589 max_len = mfl;
2590#endif
2591
2592#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002593 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002594 {
Hanno Becker89490712020-02-05 10:50:12 +00002595 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002596 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2597 const size_t overhead = (size_t) ret;
2598
2599 if( ret < 0 )
2600 return( ret );
2601
2602 if( mtu <= overhead )
2603 {
2604 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2605 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2606 }
2607
2608 if( max_len > mtu - overhead )
2609 max_len = mtu - overhead;
2610 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002611#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002612
Hanno Becker0defedb2018-08-10 12:35:02 +01002613#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2614 !defined(MBEDTLS_SSL_PROTO_DTLS)
2615 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002616#endif
2617
2618 return( (int) max_len );
2619}
2620
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002621int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2622{
2623 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2624
2625#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2626 (void) ssl;
2627#endif
2628
2629#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2630 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2631
2632 if( max_len > mfl )
2633 max_len = mfl;
2634#endif
2635
2636 return( (int) max_len );
2637}
2638
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639#if defined(MBEDTLS_X509_CRT_PARSE_C)
2640const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002641{
2642 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002643 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002644
Hanno Beckere6824572019-02-07 13:18:46 +00002645#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002646 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002647#else
2648 return( NULL );
2649#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002650}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002654int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2655 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002656{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002657 int ret;
2658
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002659 if( ssl == NULL ||
2660 dst == NULL ||
2661 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002662 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002663 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002665 }
2666
Hanno Beckere810bbc2021-05-14 16:01:05 +01002667 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2668 * idempotent: Each session can only be exported once.
2669 *
2670 * (This is in preparation for TLS 1.3 support where we will
2671 * need the ability to export multiple sessions (aka tickets),
2672 * which will be achieved by calling mbedtls_ssl_get_session()
2673 * multiple times until it fails.)
2674 *
2675 * Check whether we have already exported the current session,
2676 * and fail if so.
2677 */
2678 if( ssl->session->exported == 1 )
2679 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2680
2681 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2682 if( ret != 0 )
2683 return( ret );
2684
2685 /* Remember that we've exported the session. */
2686 ssl->session->exported = 1;
2687 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002688}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002690
Paul Bakker5121ce52009-01-03 21:22:43 +00002691/*
Hanno Beckera835da52019-05-16 12:39:07 +01002692 * Define ticket header determining Mbed TLS version
2693 * and structure of the ticket.
2694 */
2695
Hanno Becker94ef3b32019-05-16 12:50:45 +01002696/*
Hanno Becker50b59662019-05-28 14:30:45 +01002697 * Define bitflag determining compile-time settings influencing
2698 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002699 */
2700
Hanno Becker50b59662019-05-28 14:30:45 +01002701#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002702#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002703#else
Hanno Becker3e088662019-05-29 11:10:18 +01002704#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002705#endif /* MBEDTLS_HAVE_TIME */
2706
2707#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002708#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002709#else
Hanno Becker3e088662019-05-29 11:10:18 +01002710#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002711#endif /* MBEDTLS_X509_CRT_PARSE_C */
2712
2713#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002714#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002715#else
Hanno Becker3e088662019-05-29 11:10:18 +01002716#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002717#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2718
2719#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002720#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002721#else
Hanno Becker3e088662019-05-29 11:10:18 +01002722#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002723#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2724
Hanno Becker94ef3b32019-05-16 12:50:45 +01002725#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002726#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002727#else
Hanno Becker3e088662019-05-29 11:10:18 +01002728#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002729#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2730
Hanno Becker94ef3b32019-05-16 12:50:45 +01002731#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2732#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2733#else
2734#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2735#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2736
Hanno Becker3e088662019-05-29 11:10:18 +01002737#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2738#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2739#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2740#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002741#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2742#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002743
Hanno Becker50b59662019-05-28 14:30:45 +01002744#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002745 ( (uint16_t) ( \
2746 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2747 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2748 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2749 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002750 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002751 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002752
Hanno Beckerf8787072019-05-16 12:41:07 +01002753static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002754 MBEDTLS_VERSION_MAJOR,
2755 MBEDTLS_VERSION_MINOR,
2756 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002757 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2758 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002759};
Hanno Beckera835da52019-05-16 12:39:07 +01002760
2761/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002762 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002763 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002764 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002765 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002766 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002767 * opaque mbedtls_version[3]; // library version: major, minor, patch
2768 * opaque session_format[2]; // library-version specific 16-bit field
2769 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002770 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002771 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002772 * Note: When updating the format, remember to keep
2773 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002774 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002775 * // In this version, `session_format` determines
2776 * // the setting of those compile-time
2777 * // configuration options which influence
2778 * // the structure of mbedtls_ssl_session.
2779 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002780 * uint8_t minor_ver; // Protocol minor version. Possible values:
2781 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002782 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002783 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002784 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002785 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002786 * serialized_session_tls12 data;
2787 *
2788 * };
2789 *
2790 * } serialized_session;
2791 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002792 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002793
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002794static int ssl_session_save( const mbedtls_ssl_session *session,
2795 unsigned char omit_header,
2796 unsigned char *buf,
2797 size_t buf_len,
2798 size_t *olen )
2799{
2800 unsigned char *p = buf;
2801 size_t used = 0;
2802
2803 if( !omit_header )
2804 {
2805 /*
2806 * Add Mbed TLS version identifier
2807 */
2808
2809 used += sizeof( ssl_serialized_session_header );
2810
2811 if( used <= buf_len )
2812 {
2813 memcpy( p, ssl_serialized_session_header,
2814 sizeof( ssl_serialized_session_header ) );
2815 p += sizeof( ssl_serialized_session_header );
2816 }
2817 }
2818
2819 /*
2820 * TLS version identifier
2821 */
2822 used += 1;
2823 if( used <= buf_len )
2824 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002825 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002826 }
2827
2828 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002829 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002830 {
2831#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002832 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002833 {
2834 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2835 used += ssl_session_save_tls12( session, p, remaining_len );
2836 break;
2837 }
2838#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2839
2840 default:
2841 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2842 }
2843
2844 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002845 if( used > buf_len )
2846 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002847
2848 return( 0 );
2849}
2850
2851/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002852 * Public wrapper for ssl_session_save()
2853 */
2854int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2855 unsigned char *buf,
2856 size_t buf_len,
2857 size_t *olen )
2858{
2859 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2860}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002861
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002862/*
2863 * Deserialize session, see mbedtls_ssl_session_save() for format.
2864 *
2865 * This internal version is wrapped by a public function that cleans up in
2866 * case of error, and has an extra option omit_header.
2867 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002868static int ssl_session_load( mbedtls_ssl_session *session,
2869 unsigned char omit_header,
2870 const unsigned char *buf,
2871 size_t len )
2872{
2873 const unsigned char *p = buf;
2874 const unsigned char * const end = buf + len;
2875
2876 if( !omit_header )
2877 {
2878 /*
2879 * Check Mbed TLS version identifier
2880 */
2881
2882 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2883 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2884
2885 if( memcmp( p, ssl_serialized_session_header,
2886 sizeof( ssl_serialized_session_header ) ) != 0 )
2887 {
2888 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2889 }
2890 p += sizeof( ssl_serialized_session_header );
2891 }
2892
2893 /*
2894 * TLS version identifier
2895 */
2896 if( 1 > (size_t)( end - p ) )
2897 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002898 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002899
2900 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002901 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002902 {
2903#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002904 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002905 {
2906 size_t remaining_len = ( end - p );
2907 return( ssl_session_load_tls12( session, p, remaining_len ) );
2908 }
2909#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2910
2911 default:
2912 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2913 }
2914}
2915
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002916/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002917 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002918 */
2919int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2920 const unsigned char *buf,
2921 size_t len )
2922{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002923 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002924
2925 if( ret != 0 )
2926 mbedtls_ssl_session_free( session );
2927
2928 return( ret );
2929}
2930
2931/*
Paul Bakker1961b702013-01-25 14:49:24 +01002932 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002933 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002934static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2935{
2936 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2937
Ronald Cron66dbf912022-02-02 15:33:46 +01002938 /*
2939 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002940 * that were written into the output buffer by the previous handshake step,
2941 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002942 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2943 * We proceed to the next handshake step only when all data from the
2944 * previous one have been sent to the peer, thus we make sure that this is
2945 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2946 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2947 * we have to wait before to go ahead.
2948 * In the case of TLS 1.3, handshake step handlers do not send data to the
2949 * peer. Data are only sent here and through
2950 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2951 * alert occured.
2952 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002953 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2954 return( ret );
2955
2956#if defined(MBEDTLS_SSL_PROTO_DTLS)
2957 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2958 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2959 {
2960 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2961 return( ret );
2962 }
2963#endif /* MBEDTLS_SSL_PROTO_DTLS */
2964
2965 return( ret );
2966}
2967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002969{
Hanno Becker41934dd2021-08-07 19:13:43 +01002970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002971
Hanno Becker41934dd2021-08-07 19:13:43 +01002972 if( ssl == NULL ||
2973 ssl->conf == NULL ||
2974 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002975 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002976 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002977 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002978 }
2979
2980 ret = ssl_prepare_handshake_step( ssl );
2981 if( ret != 0 )
2982 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002983
Jerry Yue7047812021-09-13 19:26:39 +08002984 ret = mbedtls_ssl_handle_pending_alert( ssl );
2985 if( ret != 0 )
2986 goto cleanup;
2987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002989 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002990 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002991 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2992 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002993
Ronald Cron9f0fba32022-02-10 16:45:15 +01002994 switch( ssl->state )
2995 {
2996 case MBEDTLS_SSL_HELLO_REQUEST:
2997 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2998 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002999
Ronald Cron9f0fba32022-02-10 16:45:15 +01003000 case MBEDTLS_SSL_CLIENT_HELLO:
3001 ret = mbedtls_ssl_write_client_hello( ssl );
3002 break;
3003
3004 default:
3005#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003006 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003007 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3008 else
3009 ret = mbedtls_ssl_handshake_client_step( ssl );
3010#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3011 ret = mbedtls_ssl_handshake_client_step( ssl );
3012#else
3013 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3014#endif
3015 }
Jerry Yub9930e72021-08-06 17:11:51 +08003016 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003017#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003019 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003020 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003021#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003022 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003023 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003024#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003025
3026#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3027 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3028 ret = mbedtls_ssl_handshake_server_step( ssl );
3029#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3030 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003031#endif
3032
Jerry Yue7047812021-09-13 19:26:39 +08003033 if( ret != 0 )
3034 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003035 /* handshake_step return error. And it is same
3036 * with alert_reason.
3037 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003038 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003039 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003040 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003041 goto cleanup;
3042 }
3043 }
3044
3045cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003046 return( ret );
3047}
3048
3049/*
3050 * Perform the SSL handshake
3051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003053{
3054 int ret = 0;
3055
Hanno Beckera817ea42020-10-20 15:20:23 +01003056 /* Sanity checks */
3057
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003058 if( ssl == NULL || ssl->conf == NULL )
3059 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3060
Hanno Beckera817ea42020-10-20 15:20:23 +01003061#if defined(MBEDTLS_SSL_PROTO_DTLS)
3062 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3063 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3064 {
3065 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3066 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3067 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3068 }
3069#endif /* MBEDTLS_SSL_PROTO_DTLS */
3070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003072
Hanno Beckera817ea42020-10-20 15:20:23 +01003073 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003074 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003075 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003077
3078 if( ret != 0 )
3079 break;
3080 }
3081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003083
3084 return( ret );
3085}
3086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087#if defined(MBEDTLS_SSL_RENEGOTIATION)
3088#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003089/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003090 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003091 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003093{
Janos Follath865b3eb2019-12-16 11:46:15 +00003094 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003097
3098 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3100 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003101
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003102 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003103 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003104 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003105 return( ret );
3106 }
3107
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003109
3110 return( 0 );
3111}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003113
3114/*
3115 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 * - any side: calling mbedtls_ssl_renegotiate(),
3117 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3118 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003119 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003120 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003122 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003123int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003124{
Janos Follath865b3eb2019-12-16 11:46:15 +00003125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003128
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003129 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3130 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003131
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003132 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3133 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003135 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003137 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003138 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003139 ssl->handshake->out_msg_seq = 1;
3140 else
3141 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003142 }
3143#endif
3144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3146 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003149 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003151 return( ret );
3152 }
3153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003155
3156 return( 0 );
3157}
3158
3159/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003160 * Renegotiate current connection on client,
3161 * or request renegotiation on server
3162 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003164{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003166
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003167 if( ssl == NULL || ssl->conf == NULL )
3168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003171 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003172 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003173 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003174 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003178
3179 /* Did we already try/start sending HelloRequest? */
3180 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003182
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003183 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003184 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003188 /*
3189 * On client, either start the renegotiation process or,
3190 * if already in progress, continue the handshake
3191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003193 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003194 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003196
Hanno Becker40cdaa12020-02-05 10:48:27 +00003197 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003198 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003199 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003200 return( ret );
3201 }
3202 }
3203 else
3204 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003206 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003208 return( ret );
3209 }
3210 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003212
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003213 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003214}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003216
Gilles Peskine9b562d52018-04-25 20:32:43 +02003217void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003218{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003219 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3220
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003221 if( handshake == NULL )
3222 return;
3223
Brett Warrene0edc842021-08-17 09:53:13 +01003224#if defined(MBEDTLS_ECP_C)
3225#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3226 if ( ssl->handshake->group_list_heap_allocated )
3227 mbedtls_free( (void*) handshake->group_list );
3228 handshake->group_list = NULL;
3229#endif /* MBEDTLS_DEPRECATED_REMOVED */
3230#endif /* MBEDTLS_ECP_C */
3231
Jerry Yuf017ee42022-01-12 15:49:48 +08003232#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3233#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3234 if ( ssl->handshake->sig_algs_heap_allocated )
3235 mbedtls_free( (void*) handshake->sig_algs );
3236 handshake->sig_algs = NULL;
3237#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003238#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3239 if( ssl->handshake->certificate_request_context )
3240 {
3241 mbedtls_free( (void*) handshake->certificate_request_context );
3242 }
3243#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003244#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3245
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003246#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3247 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3248 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003249 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003250 handshake->async_in_progress = 0;
3251 }
3252#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3253
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003254#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003255#if defined(MBEDTLS_USE_PSA_CRYPTO)
3256 psa_hash_abort( &handshake->fin_sha256_psa );
3257#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003258 mbedtls_sha256_free( &handshake->fin_sha256 );
3259#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003260#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003261#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003262#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003263 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003264#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003265 mbedtls_sha512_free( &handshake->fin_sha512 );
3266#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003267#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269#if defined(MBEDTLS_DHM_C)
3270 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003271#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003272#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003274#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003275#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003276 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003277#if defined(MBEDTLS_SSL_CLI_C)
3278 mbedtls_free( handshake->ecjpake_cache );
3279 handshake->ecjpake_cache = NULL;
3280 handshake->ecjpake_cache_len = 0;
3281#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003282#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003283
Janos Follath4ae5c292016-02-10 11:27:43 +00003284#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3285 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003286 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003288#endif
3289
Gilles Peskineeccd8882020-03-10 12:19:08 +01003290#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003291#if defined(MBEDTLS_USE_PSA_CRYPTO)
3292 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3293 {
3294 /* The maintenance of the external PSK key slot is the
3295 * user's responsibility. */
3296 if( ssl->handshake->psk_opaque_is_internal )
3297 {
3298 psa_destroy_key( ssl->handshake->psk_opaque );
3299 ssl->handshake->psk_opaque_is_internal = 0;
3300 }
3301 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3302 }
Neil Armstronge952a302022-05-03 10:22:14 +02003303#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003304 if( handshake->psk != NULL )
3305 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003306 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003307 mbedtls_free( handshake->psk );
3308 }
Neil Armstronge952a302022-05-03 10:22:14 +02003309#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003310#endif
3311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3313 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003314 /*
3315 * Free only the linked list wrapper, not the keys themselves
3316 * since the belong to the SNI callback
3317 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003318 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003320
Gilles Peskineeccd8882020-03-10 12:19:08 +01003321#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003322 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003323 if( handshake->ecrs_peer_cert != NULL )
3324 {
3325 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3326 mbedtls_free( handshake->ecrs_peer_cert );
3327 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003328#endif
3329
Hanno Becker75173122019-02-06 16:18:31 +00003330#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3331 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3332 mbedtls_pk_free( &handshake->peer_pubkey );
3333#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3334
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003335#if defined(MBEDTLS_SSL_CLI_C) && \
3336 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3337 mbedtls_free( handshake->cookie );
3338#endif /* MBEDTLS_SSL_CLI_C &&
3339 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003340
3341#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003342 mbedtls_ssl_flight_free( handshake->flight );
3343 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003344#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003345
Ronald Cronf12b81d2022-03-15 10:42:41 +01003346#if defined(MBEDTLS_ECDH_C) && \
3347 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003348 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003349 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003350#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3351
Ronald Cron6f135e12021-12-08 16:57:54 +01003352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003353 mbedtls_ssl_transform_free( handshake->transform_handshake );
3354 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003355 mbedtls_free( handshake->transform_earlydata );
3356 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003357#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003358
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003359
3360#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3361 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3362 * processes datagrams and the fact that a datagram is allowed to have
3363 * several records in it, it is possible that the I/O buffers are not
3364 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003365 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3366 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003367#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003368
Jerry Yuba9c7272021-10-30 11:54:10 +08003369 /* mbedtls_platform_zeroize MUST be last one in this function */
3370 mbedtls_platform_zeroize( handshake,
3371 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003372}
3373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003375{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003376 if( session == NULL )
3377 return;
3378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003380 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003381#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003382
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003383#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003385#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003386
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003387 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003388}
3389
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003390#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003391
3392#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3393#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3394#else
3395#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3396#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3397
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003398#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003399
3400#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3401#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3402#else
3403#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3404#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3405
3406#if defined(MBEDTLS_SSL_ALPN)
3407#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3408#else
3409#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3410#endif /* MBEDTLS_SSL_ALPN */
3411
3412#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3413#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3414#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3415#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3416
3417#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3418 ( (uint32_t) ( \
3419 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3420 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3421 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3422 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3423 0u ) )
3424
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003425static unsigned char ssl_serialized_context_header[] = {
3426 MBEDTLS_VERSION_MAJOR,
3427 MBEDTLS_VERSION_MINOR,
3428 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003429 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3430 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3431 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3432 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3433 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003434};
3435
Paul Bakker5121ce52009-01-03 21:22:43 +00003436/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003437 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003438 *
3439 * The format of the serialized data is:
3440 * (in the presentation language of TLS, RFC 8446 section 3)
3441 *
3442 * // header
3443 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003444 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003445 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003446 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003447 * Note: When updating the format, remember to keep these
3448 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003449 *
3450 * // session sub-structure
3451 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3452 * // transform sub-structure
3453 * uint8 random[64]; // ServerHello.random+ClientHello.random
3454 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3455 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3456 * // fields from ssl_context
3457 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3458 * uint64 in_window_top; // DTLS: last validated record seq_num
3459 * uint64 in_window; // DTLS: bitmask for replay protection
3460 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3461 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3462 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3463 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3464 *
3465 * Note that many fields of the ssl_context or sub-structures are not
3466 * serialized, as they fall in one of the following categories:
3467 *
3468 * 1. forced value (eg in_left must be 0)
3469 * 2. pointer to dynamically-allocated memory (eg session, transform)
3470 * 3. value can be re-derived from other data (eg session keys from MS)
3471 * 4. value was temporary (eg content of input buffer)
3472 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003473 */
3474int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3475 unsigned char *buf,
3476 size_t buf_len,
3477 size_t *olen )
3478{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003479 unsigned char *p = buf;
3480 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003481 size_t session_len;
3482 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003483
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003484 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003485 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3486 * this function's documentation.
3487 *
3488 * These are due to assumptions/limitations in the implementation. Some of
3489 * them are likely to stay (no handshake in progress) some might go away
3490 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003491 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003492 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003493 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003494 {
3495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003496 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003497 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003498 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003499 {
3500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003501 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003502 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003503 /* Double-check that sub-structures are indeed ready */
3504 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003505 {
3506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003507 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003508 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003509 /* There must be no pending incoming or outgoing data */
3510 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003511 {
3512 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003513 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003514 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003515 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003516 {
3517 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003518 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003519 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003520 /* Protocol must be DLTS, not TLS */
3521 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003522 {
3523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003524 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003525 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003526 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003527 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003528 {
3529 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003530 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003531 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003532 /* We must be using an AEAD ciphersuite */
3533 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003534 {
3535 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003536 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003537 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003538 /* Renegotiation must not be enabled */
3539#if defined(MBEDTLS_SSL_RENEGOTIATION)
3540 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003541 {
3542 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003543 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003544 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003545#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003546
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003547 /*
3548 * Version and format identifier
3549 */
3550 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003551
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003552 if( used <= buf_len )
3553 {
3554 memcpy( p, ssl_serialized_context_header,
3555 sizeof( ssl_serialized_context_header ) );
3556 p += sizeof( ssl_serialized_context_header );
3557 }
3558
3559 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003560 * Session (length + data)
3561 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003562 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003563 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3564 return( ret );
3565
3566 used += 4 + session_len;
3567 if( used <= buf_len )
3568 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003569 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3570 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003571
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003572 ret = ssl_session_save( ssl->session, 1,
3573 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003574 if( ret != 0 )
3575 return( ret );
3576
3577 p += session_len;
3578 }
3579
3580 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003581 * Transform
3582 */
3583 used += sizeof( ssl->transform->randbytes );
3584 if( used <= buf_len )
3585 {
3586 memcpy( p, ssl->transform->randbytes,
3587 sizeof( ssl->transform->randbytes ) );
3588 p += sizeof( ssl->transform->randbytes );
3589 }
3590
3591#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3592 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3593 if( used <= buf_len )
3594 {
3595 *p++ = ssl->transform->in_cid_len;
3596 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3597 p += ssl->transform->in_cid_len;
3598
3599 *p++ = ssl->transform->out_cid_len;
3600 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3601 p += ssl->transform->out_cid_len;
3602 }
3603#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3604
3605 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003606 * Saved fields from top-level ssl_context structure
3607 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003608 used += 4;
3609 if( used <= buf_len )
3610 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003611 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3612 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003613 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003614
3615#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3616 used += 16;
3617 if( used <= buf_len )
3618 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003619 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3620 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003621
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003622 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3623 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003624 }
3625#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3626
3627#if defined(MBEDTLS_SSL_PROTO_DTLS)
3628 used += 1;
3629 if( used <= buf_len )
3630 {
3631 *p++ = ssl->disable_datagram_packing;
3632 }
3633#endif /* MBEDTLS_SSL_PROTO_DTLS */
3634
Jerry Yuae0b2e22021-10-08 15:21:19 +08003635 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003636 if( used <= buf_len )
3637 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003638 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3639 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003640 }
3641
3642#if defined(MBEDTLS_SSL_PROTO_DTLS)
3643 used += 2;
3644 if( used <= buf_len )
3645 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003646 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3647 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003648 }
3649#endif /* MBEDTLS_SSL_PROTO_DTLS */
3650
3651#if defined(MBEDTLS_SSL_ALPN)
3652 {
3653 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003654 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003655 : 0;
3656
3657 used += 1 + alpn_len;
3658 if( used <= buf_len )
3659 {
3660 *p++ = alpn_len;
3661
3662 if( ssl->alpn_chosen != NULL )
3663 {
3664 memcpy( p, ssl->alpn_chosen, alpn_len );
3665 p += alpn_len;
3666 }
3667 }
3668 }
3669#endif /* MBEDTLS_SSL_ALPN */
3670
3671 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003672 * Done
3673 */
3674 *olen = used;
3675
3676 if( used > buf_len )
3677 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003678
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003679 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3680
Hanno Becker43aefe22020-02-05 10:44:56 +00003681 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003682}
3683
3684/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003685 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003686 *
3687 * This internal version is wrapped by a public function that cleans up in
3688 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003689 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003690static int ssl_context_load( mbedtls_ssl_context *ssl,
3691 const unsigned char *buf,
3692 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003693{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003694 const unsigned char *p = buf;
3695 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003696 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003698
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003699 /*
3700 * The context should have been freshly setup or reset.
3701 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003702 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003703 * renegotiating, or if the user mistakenly loaded a session first.)
3704 */
3705 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3706 ssl->session != NULL )
3707 {
3708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3709 }
3710
3711 /*
3712 * We can't check that the config matches the initial one, but we can at
3713 * least check it matches the requirements for serializing.
3714 */
3715 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003716 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3717 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003718#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003719 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003720#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003721 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003722 {
3723 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3724 }
3725
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003726 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3727
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003728 /*
3729 * Check version identifier
3730 */
3731 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3733
3734 if( memcmp( p, ssl_serialized_context_header,
3735 sizeof( ssl_serialized_context_header ) ) != 0 )
3736 {
3737 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3738 }
3739 p += sizeof( ssl_serialized_context_header );
3740
3741 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003742 * Session
3743 */
3744 if( (size_t)( end - p ) < 4 )
3745 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3746
3747 session_len = ( (size_t) p[0] << 24 ) |
3748 ( (size_t) p[1] << 16 ) |
3749 ( (size_t) p[2] << 8 ) |
3750 ( (size_t) p[3] );
3751 p += 4;
3752
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003753 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003754 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003755 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003756 ssl->session_in = ssl->session;
3757 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003758 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003759
3760 if( (size_t)( end - p ) < session_len )
3761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3762
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003763 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003764 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003765 {
3766 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003767 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003768 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003769
3770 p += session_len;
3771
3772 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003773 * Transform
3774 */
3775
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003776 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003777 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003778 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003779 ssl->transform_in = ssl->transform;
3780 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003781 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003782
3783 /* Read random bytes and populate structure */
3784 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3785 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003786#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003787 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003788 ssl->session->ciphersuite,
3789 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003790#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003791 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003792#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003793 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3794 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003795 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003796 ssl->conf->endpoint,
3797 ssl );
3798 if( ret != 0 )
3799 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003800#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003801 p += sizeof( ssl->transform->randbytes );
3802
3803#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3804 /* Read connection IDs and store them */
3805 if( (size_t)( end - p ) < 1 )
3806 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3807
3808 ssl->transform->in_cid_len = *p++;
3809
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003810 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003811 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3812
3813 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3814 p += ssl->transform->in_cid_len;
3815
3816 ssl->transform->out_cid_len = *p++;
3817
3818 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3819 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3820
3821 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3822 p += ssl->transform->out_cid_len;
3823#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3824
3825 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003826 * Saved fields from top-level ssl_context structure
3827 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003828 if( (size_t)( end - p ) < 4 )
3829 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3830
3831 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3832 ( (uint32_t) p[1] << 16 ) |
3833 ( (uint32_t) p[2] << 8 ) |
3834 ( (uint32_t) p[3] );
3835 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003836
3837#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3838 if( (size_t)( end - p ) < 16 )
3839 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3840
3841 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3842 ( (uint64_t) p[1] << 48 ) |
3843 ( (uint64_t) p[2] << 40 ) |
3844 ( (uint64_t) p[3] << 32 ) |
3845 ( (uint64_t) p[4] << 24 ) |
3846 ( (uint64_t) p[5] << 16 ) |
3847 ( (uint64_t) p[6] << 8 ) |
3848 ( (uint64_t) p[7] );
3849 p += 8;
3850
3851 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3852 ( (uint64_t) p[1] << 48 ) |
3853 ( (uint64_t) p[2] << 40 ) |
3854 ( (uint64_t) p[3] << 32 ) |
3855 ( (uint64_t) p[4] << 24 ) |
3856 ( (uint64_t) p[5] << 16 ) |
3857 ( (uint64_t) p[6] << 8 ) |
3858 ( (uint64_t) p[7] );
3859 p += 8;
3860#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3861
3862#if defined(MBEDTLS_SSL_PROTO_DTLS)
3863 if( (size_t)( end - p ) < 1 )
3864 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3865
3866 ssl->disable_datagram_packing = *p++;
3867#endif /* MBEDTLS_SSL_PROTO_DTLS */
3868
Jerry Yud9a94fe2021-09-28 18:58:59 +08003869 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003870 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003871 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3872 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003873
3874#if defined(MBEDTLS_SSL_PROTO_DTLS)
3875 if( (size_t)( end - p ) < 2 )
3876 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3877
3878 ssl->mtu = ( p[0] << 8 ) | p[1];
3879 p += 2;
3880#endif /* MBEDTLS_SSL_PROTO_DTLS */
3881
3882#if defined(MBEDTLS_SSL_ALPN)
3883 {
3884 uint8_t alpn_len;
3885 const char **cur;
3886
3887 if( (size_t)( end - p ) < 1 )
3888 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3889
3890 alpn_len = *p++;
3891
3892 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3893 {
3894 /* alpn_chosen should point to an item in the configured list */
3895 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3896 {
3897 if( strlen( *cur ) == alpn_len &&
3898 memcmp( p, cur, alpn_len ) == 0 )
3899 {
3900 ssl->alpn_chosen = *cur;
3901 break;
3902 }
3903 }
3904 }
3905
3906 /* can only happen on conf mismatch */
3907 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3908 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3909
3910 p += alpn_len;
3911 }
3912#endif /* MBEDTLS_SSL_ALPN */
3913
3914 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003915 * Forced fields from top-level ssl_context structure
3916 *
3917 * Most of them already set to the correct value by mbedtls_ssl_init() and
3918 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3919 */
3920 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003921 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003922
Hanno Becker361b10d2019-08-30 10:42:49 +01003923 /* Adjust pointers for header fields of outgoing records to
3924 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003925 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003926
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003927#if defined(MBEDTLS_SSL_PROTO_DTLS)
3928 ssl->in_epoch = 1;
3929#endif
3930
3931 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3932 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003933 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3934 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003935 if( ssl->handshake != NULL )
3936 {
3937 mbedtls_ssl_handshake_free( ssl );
3938 mbedtls_free( ssl->handshake );
3939 ssl->handshake = NULL;
3940 }
3941
3942 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003943 * Done - should have consumed entire buffer
3944 */
3945 if( p != end )
3946 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003947
3948 return( 0 );
3949}
3950
3951/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003952 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003953 */
3954int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3955 const unsigned char *buf,
3956 size_t len )
3957{
3958 int ret = ssl_context_load( context, buf, len );
3959
3960 if( ret != 0 )
3961 mbedtls_ssl_free( context );
3962
3963 return( ret );
3964}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003965#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003966
3967/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003968 * Free an SSL context
3969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003970void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003971{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003972 if( ssl == NULL )
3973 return;
3974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003975 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003976
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003977 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003978 {
sander-visserb8aa2072020-05-06 22:05:13 +02003979#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3980 size_t out_buf_len = ssl->out_buf_len;
3981#else
3982 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3983#endif
3984
Darryl Greenb33cc762019-11-28 14:29:44 +00003985 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003986 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003987 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003988 }
3989
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003990 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003991 {
sander-visserb8aa2072020-05-06 22:05:13 +02003992#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3993 size_t in_buf_len = ssl->in_buf_len;
3994#else
3995 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3996#endif
3997
Darryl Greenb33cc762019-11-28 14:29:44 +00003998 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004000 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004001 }
4002
Paul Bakker48916f92012-09-16 19:57:18 +00004003 if( ssl->transform )
4004 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005 mbedtls_ssl_transform_free( ssl->transform );
4006 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004007 }
4008
4009 if( ssl->handshake )
4010 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004011 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004012 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4013 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015 mbedtls_free( ssl->handshake );
4016 mbedtls_free( ssl->transform_negotiate );
4017 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004018 }
4019
Ronald Cron6f135e12021-12-08 16:57:54 +01004020#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004021 mbedtls_ssl_transform_free( ssl->transform_application );
4022 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004023#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004024
Paul Bakkerc0463502013-02-14 11:19:38 +01004025 if( ssl->session )
4026 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004027 mbedtls_ssl_session_free( ssl->session );
4028 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004029 }
4030
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004031#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004032 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004033 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004034 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004035 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004036 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004037#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004038
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004039#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004040 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004041#endif
4042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004044
Paul Bakker86f04f42013-02-14 11:20:09 +01004045 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004046 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004047}
4048
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004049/*
4050 * Initialze mbedtls_ssl_config
4051 */
4052void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4053{
4054 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4055}
4056
Gilles Peskineeccd8882020-03-10 12:19:08 +01004057#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004058#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02004059/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02004060 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
4061 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004062 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
4063 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004064static int ssl_preset_default_hashes[] = {
4065#if defined(MBEDTLS_SHA512_C)
4066 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004067#endif
4068#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004069 MBEDTLS_MD_SHA384,
4070#endif
4071#if defined(MBEDTLS_SHA256_C)
4072 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004073#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004074 MBEDTLS_MD_NONE
4075};
Jerry Yuf017ee42022-01-12 15:49:48 +08004076#endif /* !MBEDTLS_DEPRECATED_REMOVED */
4077#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004078
Gilles Peskineae270bf2021-06-02 00:05:29 +02004079/* The selection should be the same as mbedtls_x509_crt_profile_default in
4080 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004081 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004082 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004083 * about this list.
4084 */
Brett Warrene0edc842021-08-17 09:53:13 +01004085static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004086#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004087 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004088#endif
4089#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004090 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004091#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004092#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004093 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004094#endif
4095#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004096 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004097#endif
4098#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004099 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004100#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004101#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004102 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004103#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004104#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004105 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004106#endif
4107#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004108 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004109#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004110 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004111};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004112
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004113static int ssl_preset_suiteb_ciphersuites[] = {
4114 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4115 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4116 0
4117};
4118
Gilles Peskineeccd8882020-03-10 12:19:08 +01004119#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004120#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004121static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08004122#if defined(MBEDTLS_SHA256_C)
4123 MBEDTLS_MD_SHA256,
4124#endif
Jerry Yu713013f2022-01-17 18:16:35 +08004125#if defined(MBEDTLS_SHA384_C)
4126 MBEDTLS_MD_SHA384,
4127#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004128 MBEDTLS_MD_NONE
4129};
Jerry Yuf017ee42022-01-12 15:49:48 +08004130#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004131
Jerry Yu909df7b2022-01-22 11:56:27 +08004132/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004133 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004134 * rules SHOULD be upheld.
4135 * - No duplicate entries.
4136 * - But if there is a good reason, do not change the order of the algorithms.
4137 * - ssl_tls12_present* is for TLS 1.2 use only.
4138 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004139 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004140static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004141
Jerry Yued5e9f42022-01-26 11:21:34 +08004142#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4143 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4144 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4145#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4146 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004147
Jerry Yu909df7b2022-01-22 11:56:27 +08004148#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4149 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4150 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4151#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4152 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4153
Jerry Yued5e9f42022-01-26 11:21:34 +08004154#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4155 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4156 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4157#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4158 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004159
Jerry Yu909df7b2022-01-22 11:56:27 +08004160#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4161 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4162#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4163
Ronald Cron8540cf62022-03-16 08:01:09 +01004164#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4165 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4166#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4167
4168#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4169 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4170#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4171
Jerry Yu53037892022-01-25 11:02:06 +08004172#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4173 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4174#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4175
Jerry Yu909df7b2022-01-22 11:56:27 +08004176 MBEDTLS_TLS1_3_SIG_NONE
4177};
4178
4179/* NOTICE: see above */
4180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4181static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004182#if defined(MBEDTLS_SHA512_C)
4183 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4184#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004185#if defined(MBEDTLS_SHA384_C)
4186 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4187#endif
4188#if defined(MBEDTLS_SHA256_C)
4189 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4190#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004191 MBEDTLS_TLS1_3_SIG_NONE
4192};
4193#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4194/* NOTICE: see above */
4195static uint16_t ssl_preset_suiteb_sig_algs[] = {
4196
Jerry Yu909df7b2022-01-22 11:56:27 +08004197#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4198 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4199 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4200#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4201 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4202
Jerry Yu53037892022-01-25 11:02:06 +08004203#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4204 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4205 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4206#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4207 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004208
4209#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4210 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4211#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004212
Jerry Yu53037892022-01-25 11:02:06 +08004213#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4214 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4215#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4216
Jerry Yu713013f2022-01-17 18:16:35 +08004217 MBEDTLS_TLS1_3_SIG_NONE
4218};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004219
Jerry Yu909df7b2022-01-22 11:56:27 +08004220/* NOTICE: see above */
4221#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4222static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004223#if defined(MBEDTLS_SHA256_C)
4224 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4225#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004226#if defined(MBEDTLS_SHA384_C)
4227 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4228#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004229 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004230};
Jerry Yu909df7b2022-01-22 11:56:27 +08004231#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4232
Jerry Yu1a8b4812022-01-20 17:56:50 +08004233#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004234
Brett Warrene0edc842021-08-17 09:53:13 +01004235static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004236#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004237 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004238#endif
4239#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004240 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004241#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004242 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004243};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004244
Jerry Yu1a8b4812022-01-20 17:56:50 +08004245#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004246/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004247 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004248static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004249{
4250 size_t i, j;
4251 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004252
Jerry Yuf377d642022-01-25 10:43:59 +08004253 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004254 {
Jerry Yuf377d642022-01-25 10:43:59 +08004255 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004256 {
Jerry Yuf377d642022-01-25 10:43:59 +08004257 if( sig_algs[i] != sig_algs[j] )
4258 continue;
4259 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4260 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4261 sig_algs[i], j, i );
4262 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004263 }
4264 }
4265 return( ret );
4266}
4267
4268#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4269
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004270/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004271 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004272 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004273int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004274 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004275{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004276#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004277 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004278#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004279
Jerry Yu1a8b4812022-01-20 17:56:50 +08004280#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004281 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004282 {
4283 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4284 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4285 }
4286
Jerry Yuf377d642022-01-25 10:43:59 +08004287 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004288 {
4289 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4290 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4291 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004292
4293#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004294 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004295 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004296 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004297 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4298 }
4299
Jerry Yuf377d642022-01-25 10:43:59 +08004300 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004301 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004302 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004303 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4304 }
4305#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004306#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4307
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004308 /* Use the functions here so that they are covered in tests,
4309 * but otherwise access member directly for efficiency */
4310 mbedtls_ssl_conf_endpoint( conf, endpoint );
4311 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004312
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004313 /*
4314 * Things that are common to all presets
4315 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004316#if defined(MBEDTLS_SSL_CLI_C)
4317 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4318 {
4319 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4320#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4321 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4322#endif
4323 }
4324#endif
4325
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004326#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4327 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4328#endif
4329
4330#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4331 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4332#endif
4333
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004334#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004335 conf->f_cookie_write = ssl_cookie_write_dummy;
4336 conf->f_cookie_check = ssl_cookie_check_dummy;
4337#endif
4338
4339#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4340 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4341#endif
4342
Janos Follath088ce432017-04-10 12:42:31 +01004343#if defined(MBEDTLS_SSL_SRV_C)
4344 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004345 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004346#endif
4347
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004348#if defined(MBEDTLS_SSL_PROTO_DTLS)
4349 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4350 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4351#endif
4352
4353#if defined(MBEDTLS_SSL_RENEGOTIATION)
4354 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004355 memset( conf->renego_period, 0x00, 2 );
4356 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004357#endif
4358
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004359#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004360 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4361 {
4362 const unsigned char dhm_p[] =
4363 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4364 const unsigned char dhm_g[] =
4365 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004366
Hanno Beckere2defad2021-07-24 05:59:17 +01004367 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4368 dhm_p, sizeof( dhm_p ),
4369 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4370 {
4371 return( ret );
4372 }
4373 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004374#endif
4375
Ronald Cron6f135e12021-12-08 16:57:54 +01004376#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004377 /*
4378 * Allow all TLS 1.3 key exchange modes by default.
4379 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004380 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004381#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004382
XiaokangQian4d3a6042022-04-21 13:46:17 +00004383 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4384 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004385#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004386 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004387 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004388#else
XiaokangQian060d8672022-04-21 09:24:56 +00004389 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004390#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004391 }
4392 else
4393 {
4394#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4395 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4396 {
4397 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4398 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4399 }
4400 else
4401 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4402 {
4403 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4404 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4405 }
4406#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4407 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4408 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4409#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4410 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4411 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4412#else
4413 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4414#endif
4415 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004416
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004417 /*
4418 * Preset-specific defaults
4419 */
4420 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004421 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004422 /*
4423 * NSA Suite B
4424 */
4425 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004426
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004427 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004428
4429#if defined(MBEDTLS_X509_CRT_PARSE_C)
4430 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004431#endif
4432
Gilles Peskineeccd8882020-03-10 12:19:08 +01004433#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004434#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004435 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004436#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004437#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4438 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4439 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4440 else
4441#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4442 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004443#endif
4444
Brett Warrene0edc842021-08-17 09:53:13 +01004445#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4446 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004447#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004448 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004449 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004450
4451 /*
4452 * Default
4453 */
4454 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004455
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004456 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004457
4458#if defined(MBEDTLS_X509_CRT_PARSE_C)
4459 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4460#endif
4461
Gilles Peskineeccd8882020-03-10 12:19:08 +01004462#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004463#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004464 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004465#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004466#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4467 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4468 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4469 else
4470#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4471 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004472#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004473
Brett Warrene0edc842021-08-17 09:53:13 +01004474#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4475 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004476#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004477 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004478
4479#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4480 conf->dhm_min_bitlen = 1024;
4481#endif
4482 }
4483
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004484 return( 0 );
4485}
4486
4487/*
4488 * Free mbedtls_ssl_config
4489 */
4490void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4491{
4492#if defined(MBEDTLS_DHM_C)
4493 mbedtls_mpi_free( &conf->dhm_P );
4494 mbedtls_mpi_free( &conf->dhm_G );
4495#endif
4496
Gilles Peskineeccd8882020-03-10 12:19:08 +01004497#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004498#if defined(MBEDTLS_USE_PSA_CRYPTO)
4499 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4500 {
4501 if( conf->psk_opaque_is_internal )
4502 {
4503 psa_destroy_key( conf->psk_opaque );
4504 conf->psk_opaque_is_internal = 0;
4505 }
4506 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4507 }
Neil Armstronge952a302022-05-03 10:22:14 +02004508#else
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004509 if( conf->psk != NULL )
4510 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004511 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004512 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004513 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004514 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004515 }
Neil Armstronge952a302022-05-03 10:22:14 +02004516#endif /* MBEDTLS_USE_PSA_CRYPTO */
junyeonLEE316b1622017-12-20 16:29:30 +09004517
4518 if( conf->psk_identity != NULL )
4519 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004520 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004521 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004522 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004523 conf->psk_identity_len = 0;
4524 }
4525#endif
4526
4527#if defined(MBEDTLS_X509_CRT_PARSE_C)
4528 ssl_key_cert_free( conf->key_cert );
4529#endif
4530
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004531 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004532}
4533
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004534#if defined(MBEDTLS_PK_C) && \
4535 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004536/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004539unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004540{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541#if defined(MBEDTLS_RSA_C)
4542 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4543 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004544#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545#if defined(MBEDTLS_ECDSA_C)
4546 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4547 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004548#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004550}
4551
Hanno Becker7e5437a2017-04-28 17:15:26 +01004552unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4553{
4554 switch( type ) {
4555 case MBEDTLS_PK_RSA:
4556 return( MBEDTLS_SSL_SIG_RSA );
4557 case MBEDTLS_PK_ECDSA:
4558 case MBEDTLS_PK_ECKEY:
4559 return( MBEDTLS_SSL_SIG_ECDSA );
4560 default:
4561 return( MBEDTLS_SSL_SIG_ANON );
4562 }
4563}
4564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004566{
4567 switch( sig )
4568 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004569#if defined(MBEDTLS_RSA_C)
4570 case MBEDTLS_SSL_SIG_RSA:
4571 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004572#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004573#if defined(MBEDTLS_ECDSA_C)
4574 case MBEDTLS_SSL_SIG_ECDSA:
4575 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004576#endif
4577 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004579 }
4580}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004581#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004582
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004583/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004584 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004586mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004587{
4588 switch( hash )
4589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004590#if defined(MBEDTLS_MD5_C)
4591 case MBEDTLS_SSL_HASH_MD5:
4592 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004593#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004594#if defined(MBEDTLS_SHA1_C)
4595 case MBEDTLS_SSL_HASH_SHA1:
4596 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004597#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004598#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004599 case MBEDTLS_SSL_HASH_SHA224:
4600 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004601#endif
4602#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004603 case MBEDTLS_SSL_HASH_SHA256:
4604 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004605#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004606#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607 case MBEDTLS_SSL_HASH_SHA384:
4608 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004609#endif
4610#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004611 case MBEDTLS_SSL_HASH_SHA512:
4612 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004613#endif
4614 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004616 }
4617}
4618
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004619/*
4620 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4621 */
4622unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4623{
4624 switch( md )
4625 {
4626#if defined(MBEDTLS_MD5_C)
4627 case MBEDTLS_MD_MD5:
4628 return( MBEDTLS_SSL_HASH_MD5 );
4629#endif
4630#if defined(MBEDTLS_SHA1_C)
4631 case MBEDTLS_MD_SHA1:
4632 return( MBEDTLS_SSL_HASH_SHA1 );
4633#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004634#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004635 case MBEDTLS_MD_SHA224:
4636 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004637#endif
4638#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004639 case MBEDTLS_MD_SHA256:
4640 return( MBEDTLS_SSL_HASH_SHA256 );
4641#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004642#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004643 case MBEDTLS_MD_SHA384:
4644 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004645#endif
4646#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004647 case MBEDTLS_MD_SHA512:
4648 return( MBEDTLS_SSL_HASH_SHA512 );
4649#endif
4650 default:
4651 return( MBEDTLS_SSL_HASH_NONE );
4652 }
4653}
4654
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004655/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004656 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004657 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004658 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004659int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004660{
Brett Warrene0edc842021-08-17 09:53:13 +01004661 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004662
Brett Warrene0edc842021-08-17 09:53:13 +01004663 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004664 return( -1 );
4665
Brett Warrene0edc842021-08-17 09:53:13 +01004666 for( ; *group_list != 0; group_list++ )
4667 {
4668 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004669 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004670 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004671
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004672 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004673}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004674
4675#if defined(MBEDTLS_ECP_C)
4676/*
4677 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4678 */
4679int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4680{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004681 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004682 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4683}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004684#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686#if defined(MBEDTLS_X509_CRT_PARSE_C)
4687int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4688 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004689 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004690 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004691{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004692 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004693 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004694 const char *ext_oid;
4695 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004698 {
4699 /* Server part of the key exchange */
4700 switch( ciphersuite->key_exchange )
4701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004702 case MBEDTLS_KEY_EXCHANGE_RSA:
4703 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004704 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004705 break;
4706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004707 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4708 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4709 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4710 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004711 break;
4712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4714 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004715 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004716 break;
4717
4718 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719 case MBEDTLS_KEY_EXCHANGE_NONE:
4720 case MBEDTLS_KEY_EXCHANGE_PSK:
4721 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4722 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004723 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004724 usage = 0;
4725 }
4726 }
4727 else
4728 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4730 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004731 }
4732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004734 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004735 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004736 ret = -1;
4737 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004740 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4742 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004743 }
4744 else
4745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004746 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4747 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004748 }
4749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004751 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004752 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004753 ret = -1;
4754 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004755
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004756 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004757}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004759
Jerry Yu148165c2021-09-24 23:20:59 +08004760#if defined(MBEDTLS_USE_PSA_CRYPTO)
4761int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4762 const mbedtls_md_type_t md,
4763 unsigned char *dst,
4764 size_t dst_len,
4765 size_t *olen )
4766{
Ronald Cronf6893e12022-01-07 22:09:01 +01004767 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4768 psa_hash_operation_t *hash_operation_to_clone;
4769 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4770
Jerry Yu148165c2021-09-24 23:20:59 +08004771 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004772
4773 switch( md )
4774 {
4775#if defined(MBEDTLS_SHA384_C)
4776 case MBEDTLS_MD_SHA384:
4777 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4778 break;
4779#endif
4780
4781#if defined(MBEDTLS_SHA256_C)
4782 case MBEDTLS_MD_SHA256:
4783 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4784 break;
4785#endif
4786
4787 default:
4788 goto exit;
4789 }
4790
4791 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4792 if( status != PSA_SUCCESS )
4793 goto exit;
4794
4795 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4796 if( status != PSA_SUCCESS )
4797 goto exit;
4798
4799exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004800 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004801}
4802#else /* MBEDTLS_USE_PSA_CRYPTO */
4803
Jerry Yu24c0ec32021-09-09 14:21:07 +08004804#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004805static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4806 unsigned char *dst,
4807 size_t dst_len,
4808 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004809{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004810 int ret;
4811 mbedtls_sha512_context sha512;
4812
4813 if( dst_len < 48 )
4814 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4815
4816 mbedtls_sha512_init( &sha512 );
4817 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4818
4819 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4820 {
4821 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4822 goto exit;
4823 }
4824
4825 *olen = 48;
4826
4827exit:
4828
4829 mbedtls_sha512_free( &sha512 );
4830 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004831}
4832#endif /* MBEDTLS_SHA384_C */
4833
4834#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004835static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4836 unsigned char *dst,
4837 size_t dst_len,
4838 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004839{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004840 int ret;
4841 mbedtls_sha256_context sha256;
4842
4843 if( dst_len < 32 )
4844 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4845
4846 mbedtls_sha256_init( &sha256 );
4847 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004848
Jerry Yu24c0ec32021-09-09 14:21:07 +08004849 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4850 {
4851 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4852 goto exit;
4853 }
4854
4855 *olen = 32;
4856
4857exit:
4858
4859 mbedtls_sha256_free( &sha256 );
4860 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004861}
4862#endif /* MBEDTLS_SHA256_C */
4863
Jerry Yu000f9762021-09-14 11:12:51 +08004864int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4865 const mbedtls_md_type_t md,
4866 unsigned char *dst,
4867 size_t dst_len,
4868 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004869{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004870 switch( md )
4871 {
4872
Jerry Yu24c0ec32021-09-09 14:21:07 +08004873#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004874 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004875 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004876#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004877
Jerry Yu24c0ec32021-09-09 14:21:07 +08004878#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004879 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004880 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004881#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004882
4883 default:
4884 break;
4885 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004886 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004887}
XiaokangQian647719a2021-12-07 09:16:29 +00004888
Jerry Yu148165c2021-09-24 23:20:59 +08004889#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004890
Jerry Yudc7bd172022-02-17 13:44:15 +08004891#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4892
4893#if defined(MBEDTLS_USE_PSA_CRYPTO)
4894
4895static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4896 mbedtls_svc_key_id_t key,
4897 psa_algorithm_t alg,
4898 const unsigned char* seed, size_t seed_length,
4899 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004900 const unsigned char* other_secret,
4901 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004902 size_t capacity )
4903{
4904 psa_status_t status;
4905
4906 status = psa_key_derivation_setup( derivation, alg );
4907 if( status != PSA_SUCCESS )
4908 return( status );
4909
4910 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4911 {
4912 status = psa_key_derivation_input_bytes( derivation,
4913 PSA_KEY_DERIVATION_INPUT_SEED,
4914 seed, seed_length );
4915 if( status != PSA_SUCCESS )
4916 return( status );
4917
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004918 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02004919 {
4920 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004921 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
4922 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02004923 if( status != PSA_SUCCESS )
4924 return( status );
4925 }
4926
Jerry Yudc7bd172022-02-17 13:44:15 +08004927 if( mbedtls_svc_key_id_is_null( key ) )
4928 {
4929 status = psa_key_derivation_input_bytes(
4930 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4931 NULL, 0 );
4932 }
4933 else
4934 {
4935 status = psa_key_derivation_input_key(
4936 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4937 }
4938 if( status != PSA_SUCCESS )
4939 return( status );
4940
4941 status = psa_key_derivation_input_bytes( derivation,
4942 PSA_KEY_DERIVATION_INPUT_LABEL,
4943 label, label_length );
4944 if( status != PSA_SUCCESS )
4945 return( status );
4946 }
4947 else
4948 {
4949 return( PSA_ERROR_NOT_SUPPORTED );
4950 }
4951
4952 status = psa_key_derivation_set_capacity( derivation, capacity );
4953 if( status != PSA_SUCCESS )
4954 return( status );
4955
4956 return( PSA_SUCCESS );
4957}
4958
4959static int tls_prf_generic( mbedtls_md_type_t md_type,
4960 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 psa_status_t status;
4966 psa_algorithm_t alg;
4967 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4968 psa_key_derivation_operation_t derivation =
4969 PSA_KEY_DERIVATION_OPERATION_INIT;
4970
4971 if( md_type == MBEDTLS_MD_SHA384 )
4972 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4973 else
4974 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4975
4976 /* Normally a "secret" should be long enough to be impossible to
4977 * find by brute force, and in particular should not be empty. But
4978 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4979 * and for this use case it makes sense to have a 0-length "secret".
4980 * Since the key API doesn't allow importing a key of length 0,
4981 * keep master_key=0, which setup_psa_key_derivation() understands
4982 * to mean a 0-length "secret" input. */
4983 if( slen != 0 )
4984 {
4985 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4986 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4987 psa_set_key_algorithm( &key_attributes, alg );
4988 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4989
4990 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4991 if( status != PSA_SUCCESS )
4992 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4993 }
4994
4995 status = setup_psa_key_derivation( &derivation,
4996 master_key, alg,
4997 random, rlen,
4998 (unsigned char const *) label,
4999 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005000 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005001 dlen );
5002 if( status != PSA_SUCCESS )
5003 {
5004 psa_key_derivation_abort( &derivation );
5005 psa_destroy_key( master_key );
5006 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5007 }
5008
5009 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5010 if( status != PSA_SUCCESS )
5011 {
5012 psa_key_derivation_abort( &derivation );
5013 psa_destroy_key( master_key );
5014 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5015 }
5016
5017 status = psa_key_derivation_abort( &derivation );
5018 if( status != PSA_SUCCESS )
5019 {
5020 psa_destroy_key( master_key );
5021 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5022 }
5023
5024 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5025 status = psa_destroy_key( master_key );
5026 if( status != PSA_SUCCESS )
5027 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5028
5029 return( 0 );
5030}
5031
5032#else /* MBEDTLS_USE_PSA_CRYPTO */
5033
5034static int tls_prf_generic( mbedtls_md_type_t md_type,
5035 const unsigned char *secret, size_t slen,
5036 const char *label,
5037 const unsigned char *random, size_t rlen,
5038 unsigned char *dstbuf, size_t dlen )
5039{
5040 size_t nb;
5041 size_t i, j, k, md_len;
5042 unsigned char *tmp;
5043 size_t tmp_len = 0;
5044 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5045 const mbedtls_md_info_t *md_info;
5046 mbedtls_md_context_t md_ctx;
5047 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5048
5049 mbedtls_md_init( &md_ctx );
5050
5051 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5052 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5053
5054 md_len = mbedtls_md_get_size( md_info );
5055
5056 tmp_len = md_len + strlen( label ) + rlen;
5057 tmp = mbedtls_calloc( 1, tmp_len );
5058 if( tmp == NULL )
5059 {
5060 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5061 goto exit;
5062 }
5063
5064 nb = strlen( label );
5065 memcpy( tmp + md_len, label, nb );
5066 memcpy( tmp + md_len + nb, random, rlen );
5067 nb += rlen;
5068
5069 /*
5070 * Compute P_<hash>(secret, label + random)[0..dlen]
5071 */
5072 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5073 goto exit;
5074
5075 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5076 if( ret != 0 )
5077 goto exit;
5078 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5079 if( ret != 0 )
5080 goto exit;
5081 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5082 if( ret != 0 )
5083 goto exit;
5084
5085 for( i = 0; i < dlen; i += md_len )
5086 {
5087 ret = mbedtls_md_hmac_reset ( &md_ctx );
5088 if( ret != 0 )
5089 goto exit;
5090 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5091 if( ret != 0 )
5092 goto exit;
5093 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5094 if( ret != 0 )
5095 goto exit;
5096
5097 ret = mbedtls_md_hmac_reset ( &md_ctx );
5098 if( ret != 0 )
5099 goto exit;
5100 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5101 if( ret != 0 )
5102 goto exit;
5103 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5104 if( ret != 0 )
5105 goto exit;
5106
5107 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5108
5109 for( j = 0; j < k; j++ )
5110 dstbuf[i + j] = h_i[j];
5111 }
5112
5113exit:
5114 mbedtls_md_free( &md_ctx );
5115
5116 mbedtls_platform_zeroize( tmp, tmp_len );
5117 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5118
5119 mbedtls_free( tmp );
5120
5121 return( ret );
5122}
5123#endif /* MBEDTLS_USE_PSA_CRYPTO */
5124
5125#if defined(MBEDTLS_SHA256_C)
5126static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5127 const char *label,
5128 const unsigned char *random, size_t rlen,
5129 unsigned char *dstbuf, size_t dlen )
5130{
5131 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5132 label, random, rlen, dstbuf, dlen ) );
5133}
5134#endif /* MBEDTLS_SHA256_C */
5135
5136#if defined(MBEDTLS_SHA384_C)
5137static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5138 const char *label,
5139 const unsigned char *random, size_t rlen,
5140 unsigned char *dstbuf, size_t dlen )
5141{
5142 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5143 label, random, rlen, dstbuf, dlen ) );
5144}
5145#endif /* MBEDTLS_SHA384_C */
5146
Jerry Yuf009d862022-02-17 14:01:37 +08005147/*
5148 * Set appropriate PRF function and other SSL / TLS1.2 functions
5149 *
5150 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005151 * - hash associated with the ciphersuite (only used by TLS 1.2)
5152 *
5153 * Outputs:
5154 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5155 */
5156static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005157 mbedtls_md_type_t hash )
5158{
Jerry Yuf009d862022-02-17 14:01:37 +08005159#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005160 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005161 {
5162 handshake->tls_prf = tls_prf_sha384;
5163 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5164 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5165 }
5166 else
5167#endif
5168#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005169 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005170 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005171 handshake->tls_prf = tls_prf_sha256;
5172 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5173 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5174 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005175#else
Jerry Yuf009d862022-02-17 14:01:37 +08005176 {
Jerry Yuf009d862022-02-17 14:01:37 +08005177 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005178 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005179 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5180 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005181#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005182
5183 return( 0 );
5184}
Jerry Yud6ab2352022-02-17 14:03:43 +08005185
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005186/*
5187 * Compute master secret if needed
5188 *
5189 * Parameters:
5190 * [in/out] handshake
5191 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5192 * (PSA-PSK) ciphersuite_info, psk_opaque
5193 * [out] premaster (cleared)
5194 * [out] master
5195 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5196 * debug: conf->f_dbg, conf->p_dbg
5197 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005198 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005199 */
5200static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5201 unsigned char *master,
5202 const mbedtls_ssl_context *ssl )
5203{
5204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5205
5206 /* cf. RFC 5246, Section 8.1:
5207 * "The master secret is always exactly 48 bytes in length." */
5208 size_t const master_secret_len = 48;
5209
5210#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5211 unsigned char session_hash[48];
5212#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5213
5214 /* The label for the KDF used for key expansion.
5215 * This is either "master secret" or "extended master secret"
5216 * depending on whether the Extended Master Secret extension
5217 * is used. */
5218 char const *lbl = "master secret";
5219
Przemek Stekielae4ed302022-04-05 17:15:55 +02005220 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005221 * - If the Extended Master Secret extension is not used,
5222 * this is ClientHello.Random + ServerHello.Random
5223 * (see Sect. 8.1 in RFC 5246).
5224 * - If the Extended Master Secret extension is used,
5225 * this is the transcript of the handshake so far.
5226 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005227 unsigned char const *seed = handshake->randbytes;
5228 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005229
5230#if !defined(MBEDTLS_DEBUG_C) && \
5231 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5232 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5233 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5234 ssl = NULL; /* make sure we don't use it except for those cases */
5235 (void) ssl;
5236#endif
5237
5238 if( handshake->resume != 0 )
5239 {
5240 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5241 return( 0 );
5242 }
5243
5244#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5245 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5246 {
5247 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005248 seed = session_hash;
5249 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005250
5251 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005252 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005253 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005254#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005255
Przemek Stekiel99114f32022-04-22 11:20:09 +02005256#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005257 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005258 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005259 {
5260 /* Perform PSK-to-MS expansion in a single step. */
5261 psa_status_t status;
5262 psa_algorithm_t alg;
5263 mbedtls_svc_key_id_t psk;
5264 psa_key_derivation_operation_t derivation =
5265 PSA_KEY_DERIVATION_OPERATION_INIT;
5266 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5267
5268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5269
5270 psk = mbedtls_ssl_get_opaque_psk( ssl );
5271
5272 if( hash_alg == MBEDTLS_MD_SHA384 )
5273 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5274 else
5275 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5276
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005277 size_t other_secret_len = 0;
5278 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005279
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005280 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005281 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005282 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005283 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005284 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005285 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005286 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005287 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005288 other_secret_len = 48;
5289 other_secret = handshake->premaster + 2;
5290 break;
5291 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005292 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005293 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5294 other_secret = handshake->premaster + 2;
5295 break;
5296 default:
5297 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005298 }
5299
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005300 status = setup_psa_key_derivation( &derivation, psk, alg,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005301 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005302 (unsigned char const *) lbl,
5303 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005304 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005305 master_secret_len );
5306 if( status != PSA_SUCCESS )
5307 {
5308 psa_key_derivation_abort( &derivation );
5309 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5310 }
5311
5312 status = psa_key_derivation_output_bytes( &derivation,
5313 master,
5314 master_secret_len );
5315 if( status != PSA_SUCCESS )
5316 {
5317 psa_key_derivation_abort( &derivation );
5318 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5319 }
5320
5321 status = psa_key_derivation_abort( &derivation );
5322 if( status != PSA_SUCCESS )
5323 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5324 }
5325 else
5326#endif
5327 {
5328 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005329 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005330 master,
5331 master_secret_len );
5332 if( ret != 0 )
5333 {
5334 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5335 return( ret );
5336 }
5337
5338 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5339 handshake->premaster,
5340 handshake->pmslen );
5341
5342 mbedtls_platform_zeroize( handshake->premaster,
5343 sizeof(handshake->premaster) );
5344 }
5345
5346 return( 0 );
5347}
5348
Jerry Yud62f87e2022-02-17 14:09:02 +08005349int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5350{
5351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5352 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5353 ssl->handshake->ciphersuite_info;
5354
5355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5356
5357 /* Set PRF, calc_verify and calc_finished function pointers */
5358 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005359 ciphersuite_info->mac );
5360 if( ret != 0 )
5361 {
5362 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5363 return( ret );
5364 }
5365
5366 /* Compute master secret if needed */
5367 ret = ssl_compute_master( ssl->handshake,
5368 ssl->session_negotiate->master,
5369 ssl );
5370 if( ret != 0 )
5371 {
5372 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5373 return( ret );
5374 }
5375
5376 /* Swap the client and server random values:
5377 * - MS derivation wanted client+server (RFC 5246 8.1)
5378 * - key derivation wants server+client (RFC 5246 6.3) */
5379 {
5380 unsigned char tmp[64];
5381 memcpy( tmp, ssl->handshake->randbytes, 64 );
5382 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5383 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5384 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5385 }
5386
5387 /* Populate transform structure */
5388 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5389 ssl->session_negotiate->ciphersuite,
5390 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005391#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005392 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005393#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005394 ssl->handshake->tls_prf,
5395 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005396 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005397 ssl->conf->endpoint,
5398 ssl );
5399 if( ret != 0 )
5400 {
5401 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5402 return( ret );
5403 }
5404
5405 /* We no longer need Server/ClientHello.random values */
5406 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5407 sizeof( ssl->handshake->randbytes ) );
5408
5409 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5410
5411 return( 0 );
5412}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005413
Ronald Cron4dcbca92022-03-07 10:21:40 +01005414int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5415{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005416 switch( md )
5417 {
5418#if defined(MBEDTLS_SHA384_C)
5419 case MBEDTLS_SSL_HASH_SHA384:
5420 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5421 break;
5422#endif
5423#if defined(MBEDTLS_SHA256_C)
5424 case MBEDTLS_SSL_HASH_SHA256:
5425 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5426 break;
5427#endif
5428 default:
5429 return( -1 );
5430 }
5431
Ronald Cronc2f13a02022-03-07 10:25:24 +01005432 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005433}
5434
Jerry Yu8392e0d2022-02-17 14:10:24 +08005435#if defined(MBEDTLS_SHA256_C)
5436void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5437 unsigned char *hash,
5438 size_t *hlen )
5439{
5440#if defined(MBEDTLS_USE_PSA_CRYPTO)
5441 size_t hash_size;
5442 psa_status_t status;
5443 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5444
5445 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5446 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5447 if( status != PSA_SUCCESS )
5448 {
5449 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5450 return;
5451 }
5452
5453 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5454 if( status != PSA_SUCCESS )
5455 {
5456 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5457 return;
5458 }
5459
5460 *hlen = 32;
5461 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5462 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5463#else
5464 mbedtls_sha256_context sha256;
5465
5466 mbedtls_sha256_init( &sha256 );
5467
5468 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5469
5470 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5471 mbedtls_sha256_finish( &sha256, hash );
5472
5473 *hlen = 32;
5474
5475 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5477
5478 mbedtls_sha256_free( &sha256 );
5479#endif /* MBEDTLS_USE_PSA_CRYPTO */
5480 return;
5481}
5482#endif /* MBEDTLS_SHA256_C */
5483
Jerry Yuc1cb3842022-02-17 14:13:48 +08005484#if defined(MBEDTLS_SHA384_C)
5485void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5486 unsigned char *hash,
5487 size_t *hlen )
5488{
5489#if defined(MBEDTLS_USE_PSA_CRYPTO)
5490 size_t hash_size;
5491 psa_status_t status;
5492 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5493
5494 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5495 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5496 if( status != PSA_SUCCESS )
5497 {
5498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5499 return;
5500 }
5501
5502 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5503 if( status != PSA_SUCCESS )
5504 {
5505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5506 return;
5507 }
5508
5509 *hlen = 48;
5510 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5511 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5512#else
5513 mbedtls_sha512_context sha512;
5514
5515 mbedtls_sha512_init( &sha512 );
5516
5517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5518
5519 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5520 mbedtls_sha512_finish( &sha512, hash );
5521
5522 *hlen = 48;
5523
5524 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5526
5527 mbedtls_sha512_free( &sha512 );
5528#endif /* MBEDTLS_USE_PSA_CRYPTO */
5529 return;
5530}
5531#endif /* MBEDTLS_SHA384_C */
5532
Neil Armstrong80f6f322022-05-03 17:56:38 +02005533#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5534 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005535int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5536{
5537 unsigned char *p = ssl->handshake->premaster;
5538 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5539 const unsigned char *psk = NULL;
5540 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005541 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005542
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005543 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005544 {
5545 /*
5546 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005547 * checked before calling this function.
5548 *
5549 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005550 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005551 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005552 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5553 {
5554 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5555 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5556 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005557 }
5558
5559 /*
5560 * PMS = struct {
5561 * opaque other_secret<0..2^16-1>;
5562 * opaque psk<0..2^16-1>;
5563 * };
5564 * with "other_secret" depending on the particular key exchange
5565 */
5566#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5567 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5568 {
5569 if( end - p < 2 )
5570 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5571
5572 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5573 p += 2;
5574
5575 if( end < p || (size_t)( end - p ) < psk_len )
5576 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5577
5578 memset( p, 0, psk_len );
5579 p += psk_len;
5580 }
5581 else
5582#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5583#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5584 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5585 {
5586 /*
5587 * other_secret already set by the ClientKeyExchange message,
5588 * and is 48 bytes long
5589 */
5590 if( end - p < 2 )
5591 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5592
5593 *p++ = 0;
5594 *p++ = 48;
5595 p += 48;
5596 }
5597 else
5598#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5599#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5600 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5601 {
5602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5603 size_t len;
5604
5605 /* Write length only when we know the actual value */
5606 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5607 p + 2, end - ( p + 2 ), &len,
5608 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5609 {
5610 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5611 return( ret );
5612 }
5613 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5614 p += 2 + len;
5615
5616 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5617 }
5618 else
5619#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005620#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005621 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5622 {
5623 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5624 size_t zlen;
5625
5626 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5627 p + 2, end - ( p + 2 ),
5628 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5629 {
5630 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5631 return( ret );
5632 }
5633
5634 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5635 p += 2 + zlen;
5636
5637 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5638 MBEDTLS_DEBUG_ECDH_Z );
5639 }
5640 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005641#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005642 {
5643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5644 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5645 }
5646
5647 /* opaque psk<0..2^16-1>; */
5648 if( end - p < 2 )
5649 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5650
5651 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5652 p += 2;
5653
5654 if( end < p || (size_t)( end - p ) < psk_len )
5655 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5656
5657 memcpy( p, psk, psk_len );
5658 p += psk_len;
5659
5660 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5661
5662 return( 0 );
5663}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005664#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005665
5666#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5667static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5668
5669#if defined(MBEDTLS_SSL_PROTO_DTLS)
5670int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5671{
5672 /* If renegotiation is not enforced, retransmit until we would reach max
5673 * timeout if we were using the usual handshake doubling scheme */
5674 if( ssl->conf->renego_max_records < 0 )
5675 {
5676 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5677 unsigned char doublings = 1;
5678
5679 while( ratio != 0 )
5680 {
5681 ++doublings;
5682 ratio >>= 1;
5683 }
5684
5685 if( ++ssl->renego_records_seen > doublings )
5686 {
5687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5688 return( 0 );
5689 }
5690 }
5691
5692 return( ssl_write_hello_request( ssl ) );
5693}
5694#endif
5695#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005696
Jerry Yud9526692022-02-17 14:23:47 +08005697/*
5698 * Handshake functions
5699 */
5700#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5701/* No certificate support -> dummy functions */
5702int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5703{
5704 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5705 ssl->handshake->ciphersuite_info;
5706
5707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5708
5709 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5710 {
5711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5712 ssl->state++;
5713 return( 0 );
5714 }
5715
5716 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5717 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5718}
5719
5720int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5721{
5722 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5723 ssl->handshake->ciphersuite_info;
5724
5725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5726
5727 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5728 {
5729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5730 ssl->state++;
5731 return( 0 );
5732 }
5733
5734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5735 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5736}
5737
5738#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5739/* Some certificate support -> implement write and parse */
5740
5741int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5742{
5743 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5744 size_t i, n;
5745 const mbedtls_x509_crt *crt;
5746 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5747 ssl->handshake->ciphersuite_info;
5748
5749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5750
5751 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5752 {
5753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5754 ssl->state++;
5755 return( 0 );
5756 }
5757
5758#if defined(MBEDTLS_SSL_CLI_C)
5759 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5760 {
5761 if( ssl->handshake->client_auth == 0 )
5762 {
5763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5764 ssl->state++;
5765 return( 0 );
5766 }
5767 }
5768#endif /* MBEDTLS_SSL_CLI_C */
5769#if defined(MBEDTLS_SSL_SRV_C)
5770 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5771 {
5772 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5773 {
5774 /* Should never happen because we shouldn't have picked the
5775 * ciphersuite if we don't have a certificate. */
5776 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5777 }
5778 }
5779#endif
5780
5781 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5782
5783 /*
5784 * 0 . 0 handshake type
5785 * 1 . 3 handshake length
5786 * 4 . 6 length of all certs
5787 * 7 . 9 length of cert. 1
5788 * 10 . n-1 peer certificate
5789 * n . n+2 length of cert. 2
5790 * n+3 . ... upper level cert, etc.
5791 */
5792 i = 7;
5793 crt = mbedtls_ssl_own_cert( ssl );
5794
5795 while( crt != NULL )
5796 {
5797 n = crt->raw.len;
5798 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5799 {
5800 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5801 " > %" MBEDTLS_PRINTF_SIZET,
5802 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5803 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5804 }
5805
5806 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5807 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5808 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5809
5810 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5811 i += n; crt = crt->next;
5812 }
5813
5814 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5815 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5816 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5817
5818 ssl->out_msglen = i;
5819 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5820 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5821
5822 ssl->state++;
5823
5824 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5825 {
5826 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5827 return( ret );
5828 }
5829
5830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5831
5832 return( ret );
5833}
5834
5835#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5836
5837#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5838static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5839 unsigned char *crt_buf,
5840 size_t crt_buf_len )
5841{
5842 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5843
5844 if( peer_crt == NULL )
5845 return( -1 );
5846
5847 if( peer_crt->raw.len != crt_buf_len )
5848 return( -1 );
5849
5850 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5851}
5852#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5853static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5854 unsigned char *crt_buf,
5855 size_t crt_buf_len )
5856{
5857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5858 unsigned char const * const peer_cert_digest =
5859 ssl->session->peer_cert_digest;
5860 mbedtls_md_type_t const peer_cert_digest_type =
5861 ssl->session->peer_cert_digest_type;
5862 mbedtls_md_info_t const * const digest_info =
5863 mbedtls_md_info_from_type( peer_cert_digest_type );
5864 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5865 size_t digest_len;
5866
5867 if( peer_cert_digest == NULL || digest_info == NULL )
5868 return( -1 );
5869
5870 digest_len = mbedtls_md_get_size( digest_info );
5871 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5872 return( -1 );
5873
5874 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5875 if( ret != 0 )
5876 return( -1 );
5877
5878 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5879}
5880#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5881#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5882
5883/*
5884 * Once the certificate message is read, parse it into a cert chain and
5885 * perform basic checks, but leave actual verification to the caller
5886 */
5887static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5888 mbedtls_x509_crt *chain )
5889{
5890 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5891#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5892 int crt_cnt=0;
5893#endif
5894 size_t i, n;
5895 uint8_t alert;
5896
5897 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5898 {
5899 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5900 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5901 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5902 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5903 }
5904
5905 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5906 {
5907 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5908 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5909 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5910 }
5911
5912 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5913 {
5914 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5915 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5916 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5917 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5918 }
5919
5920 i = mbedtls_ssl_hs_hdr_len( ssl );
5921
5922 /*
5923 * Same message structure as in mbedtls_ssl_write_certificate()
5924 */
5925 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5926
5927 if( ssl->in_msg[i] != 0 ||
5928 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5929 {
5930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5931 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5932 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5933 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5934 }
5935
5936 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5937 i += 3;
5938
5939 /* Iterate through and parse the CRTs in the provided chain. */
5940 while( i < ssl->in_hslen )
5941 {
5942 /* Check that there's room for the next CRT's length fields. */
5943 if ( i + 3 > ssl->in_hslen ) {
5944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5945 mbedtls_ssl_send_alert_message( ssl,
5946 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5947 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5948 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5949 }
5950 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5951 * anything beyond 2**16 ~ 64K. */
5952 if( ssl->in_msg[i] != 0 )
5953 {
5954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5955 mbedtls_ssl_send_alert_message( ssl,
5956 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5957 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5958 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5959 }
5960
5961 /* Read length of the next CRT in the chain. */
5962 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5963 | (unsigned int) ssl->in_msg[i + 2];
5964 i += 3;
5965
5966 if( n < 128 || i + n > ssl->in_hslen )
5967 {
5968 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5969 mbedtls_ssl_send_alert_message( ssl,
5970 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5971 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5972 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5973 }
5974
5975 /* Check if we're handling the first CRT in the chain. */
5976#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5977 if( crt_cnt++ == 0 &&
5978 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5979 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5980 {
5981 /* During client-side renegotiation, check that the server's
5982 * end-CRTs hasn't changed compared to the initial handshake,
5983 * mitigating the triple handshake attack. On success, reuse
5984 * the original end-CRT instead of parsing it again. */
5985 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5986 if( ssl_check_peer_crt_unchanged( ssl,
5987 &ssl->in_msg[i],
5988 n ) != 0 )
5989 {
5990 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5991 mbedtls_ssl_send_alert_message( ssl,
5992 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5993 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5994 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5995 }
5996
5997 /* Now we can safely free the original chain. */
5998 ssl_clear_peer_cert( ssl->session );
5999 }
6000#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6001
6002 /* Parse the next certificate in the chain. */
6003#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6004 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6005#else
6006 /* If we don't need to store the CRT chain permanently, parse
6007 * it in-place from the input buffer instead of making a copy. */
6008 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6009#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6010 switch( ret )
6011 {
6012 case 0: /*ok*/
6013 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6014 /* Ignore certificate with an unknown algorithm: maybe a
6015 prior certificate was already trusted. */
6016 break;
6017
6018 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6019 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6020 goto crt_parse_der_failed;
6021
6022 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6023 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6024 goto crt_parse_der_failed;
6025
6026 default:
6027 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6028 crt_parse_der_failed:
6029 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6030 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6031 return( ret );
6032 }
6033
6034 i += n;
6035 }
6036
6037 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6038 return( 0 );
6039}
6040
6041#if defined(MBEDTLS_SSL_SRV_C)
6042static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6043{
6044 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6045 return( -1 );
6046
6047 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6048 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6049 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6050 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6051 {
6052 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
6053 return( 0 );
6054 }
6055 return( -1 );
6056}
6057#endif /* MBEDTLS_SSL_SRV_C */
6058
6059/* Check if a certificate message is expected.
6060 * Return either
6061 * - SSL_CERTIFICATE_EXPECTED, or
6062 * - SSL_CERTIFICATE_SKIP
6063 * indicating whether a Certificate message is expected or not.
6064 */
6065#define SSL_CERTIFICATE_EXPECTED 0
6066#define SSL_CERTIFICATE_SKIP 1
6067static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6068 int authmode )
6069{
6070 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6071 ssl->handshake->ciphersuite_info;
6072
6073 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6074 return( SSL_CERTIFICATE_SKIP );
6075
6076#if defined(MBEDTLS_SSL_SRV_C)
6077 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6078 {
6079 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6080 return( SSL_CERTIFICATE_SKIP );
6081
6082 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6083 {
6084 ssl->session_negotiate->verify_result =
6085 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6086 return( SSL_CERTIFICATE_SKIP );
6087 }
6088 }
6089#else
6090 ((void) authmode);
6091#endif /* MBEDTLS_SSL_SRV_C */
6092
6093 return( SSL_CERTIFICATE_EXPECTED );
6094}
6095
6096static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6097 int authmode,
6098 mbedtls_x509_crt *chain,
6099 void *rs_ctx )
6100{
6101 int ret = 0;
6102 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6103 ssl->handshake->ciphersuite_info;
6104 int have_ca_chain = 0;
6105
6106 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6107 void *p_vrfy;
6108
6109 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6110 return( 0 );
6111
6112 if( ssl->f_vrfy != NULL )
6113 {
6114 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6115 f_vrfy = ssl->f_vrfy;
6116 p_vrfy = ssl->p_vrfy;
6117 }
6118 else
6119 {
6120 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6121 f_vrfy = ssl->conf->f_vrfy;
6122 p_vrfy = ssl->conf->p_vrfy;
6123 }
6124
6125 /*
6126 * Main check: verify certificate
6127 */
6128#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6129 if( ssl->conf->f_ca_cb != NULL )
6130 {
6131 ((void) rs_ctx);
6132 have_ca_chain = 1;
6133
6134 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6135 ret = mbedtls_x509_crt_verify_with_ca_cb(
6136 chain,
6137 ssl->conf->f_ca_cb,
6138 ssl->conf->p_ca_cb,
6139 ssl->conf->cert_profile,
6140 ssl->hostname,
6141 &ssl->session_negotiate->verify_result,
6142 f_vrfy, p_vrfy );
6143 }
6144 else
6145#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6146 {
6147 mbedtls_x509_crt *ca_chain;
6148 mbedtls_x509_crl *ca_crl;
6149
6150#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6151 if( ssl->handshake->sni_ca_chain != NULL )
6152 {
6153 ca_chain = ssl->handshake->sni_ca_chain;
6154 ca_crl = ssl->handshake->sni_ca_crl;
6155 }
6156 else
6157#endif
6158 {
6159 ca_chain = ssl->conf->ca_chain;
6160 ca_crl = ssl->conf->ca_crl;
6161 }
6162
6163 if( ca_chain != NULL )
6164 have_ca_chain = 1;
6165
6166 ret = mbedtls_x509_crt_verify_restartable(
6167 chain,
6168 ca_chain, ca_crl,
6169 ssl->conf->cert_profile,
6170 ssl->hostname,
6171 &ssl->session_negotiate->verify_result,
6172 f_vrfy, p_vrfy, rs_ctx );
6173 }
6174
6175 if( ret != 0 )
6176 {
6177 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6178 }
6179
6180#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6181 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6182 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6183#endif
6184
6185 /*
6186 * Secondary checks: always done, but change 'ret' only if it was 0
6187 */
6188
6189#if defined(MBEDTLS_ECP_C)
6190 {
6191 const mbedtls_pk_context *pk = &chain->pk;
6192
6193 /* If certificate uses an EC key, make sure the curve is OK */
6194 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6195 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6196 {
6197 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6198
6199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6200 if( ret == 0 )
6201 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6202 }
6203 }
6204#endif /* MBEDTLS_ECP_C */
6205
6206 if( mbedtls_ssl_check_cert_usage( chain,
6207 ciphersuite_info,
6208 ! ssl->conf->endpoint,
6209 &ssl->session_negotiate->verify_result ) != 0 )
6210 {
6211 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6212 if( ret == 0 )
6213 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6214 }
6215
6216 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6217 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6218 * with details encoded in the verification flags. All other kinds
6219 * of error codes, including those from the user provided f_vrfy
6220 * functions, are treated as fatal and lead to a failure of
6221 * ssl_parse_certificate even if verification was optional. */
6222 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6223 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6224 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6225 {
6226 ret = 0;
6227 }
6228
6229 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6230 {
6231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6232 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6233 }
6234
6235 if( ret != 0 )
6236 {
6237 uint8_t alert;
6238
6239 /* The certificate may have been rejected for several reasons.
6240 Pick one and send the corresponding alert. Which alert to send
6241 may be a subject of debate in some cases. */
6242 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6243 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6244 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6245 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6246 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6247 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6248 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6249 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6250 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6251 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6252 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6253 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6254 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6255 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6256 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6257 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6258 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6259 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6260 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6261 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6262 else
6263 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6264 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6265 alert );
6266 }
6267
6268#if defined(MBEDTLS_DEBUG_C)
6269 if( ssl->session_negotiate->verify_result != 0 )
6270 {
6271 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6272 (unsigned int) ssl->session_negotiate->verify_result ) );
6273 }
6274 else
6275 {
6276 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6277 }
6278#endif /* MBEDTLS_DEBUG_C */
6279
6280 return( ret );
6281}
6282
6283#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6284static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6285 unsigned char *start, size_t len )
6286{
6287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6288 /* Remember digest of the peer's end-CRT. */
6289 ssl->session_negotiate->peer_cert_digest =
6290 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6291 if( ssl->session_negotiate->peer_cert_digest == NULL )
6292 {
6293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6294 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6295 mbedtls_ssl_send_alert_message( ssl,
6296 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6297 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6298
6299 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6300 }
6301
6302 ret = mbedtls_md( mbedtls_md_info_from_type(
6303 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6304 start, len,
6305 ssl->session_negotiate->peer_cert_digest );
6306
6307 ssl->session_negotiate->peer_cert_digest_type =
6308 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6309 ssl->session_negotiate->peer_cert_digest_len =
6310 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6311
6312 return( ret );
6313}
6314
6315static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6316 unsigned char *start, size_t len )
6317{
6318 unsigned char *end = start + len;
6319 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6320
6321 /* Make a copy of the peer's raw public key. */
6322 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6323 ret = mbedtls_pk_parse_subpubkey( &start, end,
6324 &ssl->handshake->peer_pubkey );
6325 if( ret != 0 )
6326 {
6327 /* We should have parsed the public key before. */
6328 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6329 }
6330
6331 return( 0 );
6332}
6333#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6334
6335int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6336{
6337 int ret = 0;
6338 int crt_expected;
6339#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6340 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6341 ? ssl->handshake->sni_authmode
6342 : ssl->conf->authmode;
6343#else
6344 const int authmode = ssl->conf->authmode;
6345#endif
6346 void *rs_ctx = NULL;
6347 mbedtls_x509_crt *chain = NULL;
6348
6349 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6350
6351 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6352 if( crt_expected == SSL_CERTIFICATE_SKIP )
6353 {
6354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6355 goto exit;
6356 }
6357
6358#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6359 if( ssl->handshake->ecrs_enabled &&
6360 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6361 {
6362 chain = ssl->handshake->ecrs_peer_cert;
6363 ssl->handshake->ecrs_peer_cert = NULL;
6364 goto crt_verify;
6365 }
6366#endif
6367
6368 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6369 {
6370 /* mbedtls_ssl_read_record may have sent an alert already. We
6371 let it decide whether to alert. */
6372 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6373 goto exit;
6374 }
6375
6376#if defined(MBEDTLS_SSL_SRV_C)
6377 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6378 {
6379 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6380
6381 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6382 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6383
6384 goto exit;
6385 }
6386#endif /* MBEDTLS_SSL_SRV_C */
6387
6388 /* Clear existing peer CRT structure in case we tried to
6389 * reuse a session but it failed, and allocate a new one. */
6390 ssl_clear_peer_cert( ssl->session_negotiate );
6391
6392 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6393 if( chain == NULL )
6394 {
6395 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6396 sizeof( mbedtls_x509_crt ) ) );
6397 mbedtls_ssl_send_alert_message( ssl,
6398 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6399 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6400
6401 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6402 goto exit;
6403 }
6404 mbedtls_x509_crt_init( chain );
6405
6406 ret = ssl_parse_certificate_chain( ssl, chain );
6407 if( ret != 0 )
6408 goto exit;
6409
6410#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6411 if( ssl->handshake->ecrs_enabled)
6412 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6413
6414crt_verify:
6415 if( ssl->handshake->ecrs_enabled)
6416 rs_ctx = &ssl->handshake->ecrs_ctx;
6417#endif
6418
6419 ret = ssl_parse_certificate_verify( ssl, authmode,
6420 chain, rs_ctx );
6421 if( ret != 0 )
6422 goto exit;
6423
6424#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6425 {
6426 unsigned char *crt_start, *pk_start;
6427 size_t crt_len, pk_len;
6428
6429 /* We parse the CRT chain without copying, so
6430 * these pointers point into the input buffer,
6431 * and are hence still valid after freeing the
6432 * CRT chain. */
6433
6434 crt_start = chain->raw.p;
6435 crt_len = chain->raw.len;
6436
6437 pk_start = chain->pk_raw.p;
6438 pk_len = chain->pk_raw.len;
6439
6440 /* Free the CRT structures before computing
6441 * digest and copying the peer's public key. */
6442 mbedtls_x509_crt_free( chain );
6443 mbedtls_free( chain );
6444 chain = NULL;
6445
6446 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6447 if( ret != 0 )
6448 goto exit;
6449
6450 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6451 if( ret != 0 )
6452 goto exit;
6453 }
6454#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6455 /* Pass ownership to session structure. */
6456 ssl->session_negotiate->peer_cert = chain;
6457 chain = NULL;
6458#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6459
6460 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6461
6462exit:
6463
6464 if( ret == 0 )
6465 ssl->state++;
6466
6467#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6468 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6469 {
6470 ssl->handshake->ecrs_peer_cert = chain;
6471 chain = NULL;
6472 }
6473#endif
6474
6475 if( chain != NULL )
6476 {
6477 mbedtls_x509_crt_free( chain );
6478 mbedtls_free( chain );
6479 }
6480
6481 return( ret );
6482}
6483#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6484
Jerry Yu615bd6f2022-02-17 14:25:15 +08006485#if defined(MBEDTLS_SHA256_C)
6486static void ssl_calc_finished_tls_sha256(
6487 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6488{
6489 int len = 12;
6490 const char *sender;
6491 unsigned char padbuf[32];
6492#if defined(MBEDTLS_USE_PSA_CRYPTO)
6493 size_t hash_size;
6494 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6495 psa_status_t status;
6496#else
6497 mbedtls_sha256_context sha256;
6498#endif
6499
6500 mbedtls_ssl_session *session = ssl->session_negotiate;
6501 if( !session )
6502 session = ssl->session;
6503
6504 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6505 ? "client finished"
6506 : "server finished";
6507
6508#if defined(MBEDTLS_USE_PSA_CRYPTO)
6509 sha256_psa = psa_hash_operation_init();
6510
6511 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6512
6513 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6514 if( status != PSA_SUCCESS )
6515 {
6516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6517 return;
6518 }
6519
6520 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6521 if( status != PSA_SUCCESS )
6522 {
6523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6524 return;
6525 }
6526 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6527#else
6528
6529 mbedtls_sha256_init( &sha256 );
6530
6531 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6532
6533 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6534
6535 /*
6536 * TLSv1.2:
6537 * hash = PRF( master, finished_label,
6538 * Hash( handshake ) )[0.11]
6539 */
6540
6541#if !defined(MBEDTLS_SHA256_ALT)
6542 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6543 sha256.state, sizeof( sha256.state ) );
6544#endif
6545
6546 mbedtls_sha256_finish( &sha256, padbuf );
6547 mbedtls_sha256_free( &sha256 );
6548#endif /* MBEDTLS_USE_PSA_CRYPTO */
6549
6550 ssl->handshake->tls_prf( session->master, 48, sender,
6551 padbuf, 32, buf, len );
6552
6553 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6554
6555 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6556
6557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6558}
6559#endif /* MBEDTLS_SHA256_C */
6560
Jerry Yub7ba49e2022-02-17 14:25:53 +08006561
6562#if defined(MBEDTLS_SHA384_C)
6563
6564static void ssl_calc_finished_tls_sha384(
6565 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6566{
6567 int len = 12;
6568 const char *sender;
6569 unsigned char padbuf[48];
6570#if defined(MBEDTLS_USE_PSA_CRYPTO)
6571 size_t hash_size;
6572 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6573 psa_status_t status;
6574#else
6575 mbedtls_sha512_context sha512;
6576#endif
6577
6578 mbedtls_ssl_session *session = ssl->session_negotiate;
6579 if( !session )
6580 session = ssl->session;
6581
6582 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6583 ? "client finished"
6584 : "server finished";
6585
6586#if defined(MBEDTLS_USE_PSA_CRYPTO)
6587 sha384_psa = psa_hash_operation_init();
6588
6589 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6590
6591 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6592 if( status != PSA_SUCCESS )
6593 {
6594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6595 return;
6596 }
6597
6598 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6599 if( status != PSA_SUCCESS )
6600 {
6601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6602 return;
6603 }
6604 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6605#else
6606 mbedtls_sha512_init( &sha512 );
6607
6608 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6609
6610 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6611
6612 /*
6613 * TLSv1.2:
6614 * hash = PRF( master, finished_label,
6615 * Hash( handshake ) )[0.11]
6616 */
6617
6618#if !defined(MBEDTLS_SHA512_ALT)
6619 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6620 sha512.state, sizeof( sha512.state ) );
6621#endif
6622 mbedtls_sha512_finish( &sha512, padbuf );
6623
6624 mbedtls_sha512_free( &sha512 );
6625#endif
6626
6627 ssl->handshake->tls_prf( session->master, 48, sender,
6628 padbuf, 48, buf, len );
6629
6630 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6631
6632 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6633
6634 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6635}
6636#endif /* MBEDTLS_SHA384_C */
6637
Jerry Yuaef00152022-02-17 14:27:31 +08006638void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6639{
6640 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6641
6642 /*
6643 * Free our handshake params
6644 */
6645 mbedtls_ssl_handshake_free( ssl );
6646 mbedtls_free( ssl->handshake );
6647 ssl->handshake = NULL;
6648
6649 /*
6650 * Free the previous transform and swith in the current one
6651 */
6652 if( ssl->transform )
6653 {
6654 mbedtls_ssl_transform_free( ssl->transform );
6655 mbedtls_free( ssl->transform );
6656 }
6657 ssl->transform = ssl->transform_negotiate;
6658 ssl->transform_negotiate = NULL;
6659
6660 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6661}
6662
Jerry Yu2a9fff52022-02-17 14:28:51 +08006663void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6664{
6665 int resume = ssl->handshake->resume;
6666
6667 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6668
6669#if defined(MBEDTLS_SSL_RENEGOTIATION)
6670 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6671 {
6672 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6673 ssl->renego_records_seen = 0;
6674 }
6675#endif
6676
6677 /*
6678 * Free the previous session and switch in the current one
6679 */
6680 if( ssl->session )
6681 {
6682#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6683 /* RFC 7366 3.1: keep the EtM state */
6684 ssl->session_negotiate->encrypt_then_mac =
6685 ssl->session->encrypt_then_mac;
6686#endif
6687
6688 mbedtls_ssl_session_free( ssl->session );
6689 mbedtls_free( ssl->session );
6690 }
6691 ssl->session = ssl->session_negotiate;
6692 ssl->session_negotiate = NULL;
6693
6694 /*
6695 * Add cache entry
6696 */
6697 if( ssl->conf->f_set_cache != NULL &&
6698 ssl->session->id_len != 0 &&
6699 resume == 0 )
6700 {
6701 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6702 ssl->session->id,
6703 ssl->session->id_len,
6704 ssl->session ) != 0 )
6705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6706 }
6707
6708#if defined(MBEDTLS_SSL_PROTO_DTLS)
6709 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6710 ssl->handshake->flight != NULL )
6711 {
6712 /* Cancel handshake timer */
6713 mbedtls_ssl_set_timer( ssl, 0 );
6714
6715 /* Keep last flight around in case we need to resend it:
6716 * we need the handshake and transform structures for that */
6717 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6718 }
6719 else
6720#endif
6721 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6722
6723 ssl->state++;
6724
6725 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6726}
6727
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006728int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6729{
6730 int ret, hash_len;
6731
6732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6733
6734 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6735
6736 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6737
6738 /*
6739 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6740 * may define some other value. Currently (early 2016), no defined
6741 * ciphersuite does this (and this is unlikely to change as activity has
6742 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6743 */
6744 hash_len = 12;
6745
6746#if defined(MBEDTLS_SSL_RENEGOTIATION)
6747 ssl->verify_data_len = hash_len;
6748 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6749#endif
6750
6751 ssl->out_msglen = 4 + hash_len;
6752 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6753 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6754
6755 /*
6756 * In case of session resuming, invert the client and server
6757 * ChangeCipherSpec messages order.
6758 */
6759 if( ssl->handshake->resume != 0 )
6760 {
6761#if defined(MBEDTLS_SSL_CLI_C)
6762 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6763 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6764#endif
6765#if defined(MBEDTLS_SSL_SRV_C)
6766 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6767 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6768#endif
6769 }
6770 else
6771 ssl->state++;
6772
6773 /*
6774 * Switch to our negotiated transform and session parameters for outbound
6775 * data.
6776 */
6777 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6778
6779#if defined(MBEDTLS_SSL_PROTO_DTLS)
6780 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6781 {
6782 unsigned char i;
6783
6784 /* Remember current epoch settings for resending */
6785 ssl->handshake->alt_transform_out = ssl->transform_out;
6786 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6787 sizeof( ssl->handshake->alt_out_ctr ) );
6788
6789 /* Set sequence_number to zero */
6790 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6791
6792
6793 /* Increment epoch */
6794 for( i = 2; i > 0; i-- )
6795 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6796 break;
6797
6798 /* The loop goes to its end iff the counter is wrapping */
6799 if( i == 0 )
6800 {
6801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6802 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6803 }
6804 }
6805 else
6806#endif /* MBEDTLS_SSL_PROTO_DTLS */
6807 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6808
6809 ssl->transform_out = ssl->transform_negotiate;
6810 ssl->session_out = ssl->session_negotiate;
6811
6812#if defined(MBEDTLS_SSL_PROTO_DTLS)
6813 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6814 mbedtls_ssl_send_flight_completed( ssl );
6815#endif
6816
6817 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6818 {
6819 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6820 return( ret );
6821 }
6822
6823#if defined(MBEDTLS_SSL_PROTO_DTLS)
6824 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6825 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6826 {
6827 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6828 return( ret );
6829 }
6830#endif
6831
6832 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6833
6834 return( 0 );
6835}
6836
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006837#define SSL_MAX_HASH_LEN 12
6838
6839int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6840{
6841 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6842 unsigned int hash_len = 12;
6843 unsigned char buf[SSL_MAX_HASH_LEN];
6844
6845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6846
6847 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6848
6849 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6850 {
6851 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6852 goto exit;
6853 }
6854
6855 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6856 {
6857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6858 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6859 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6860 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6861 goto exit;
6862 }
6863
6864 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6865 {
6866 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6867 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6868 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6869 goto exit;
6870 }
6871
6872 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6873 {
6874 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6875 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6876 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6877 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6878 goto exit;
6879 }
6880
6881 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6882 buf, hash_len ) != 0 )
6883 {
6884 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6885 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6886 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6887 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6888 goto exit;
6889 }
6890
6891#if defined(MBEDTLS_SSL_RENEGOTIATION)
6892 ssl->verify_data_len = hash_len;
6893 memcpy( ssl->peer_verify_data, buf, hash_len );
6894#endif
6895
6896 if( ssl->handshake->resume != 0 )
6897 {
6898#if defined(MBEDTLS_SSL_CLI_C)
6899 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6900 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6901#endif
6902#if defined(MBEDTLS_SSL_SRV_C)
6903 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6904 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6905#endif
6906 }
6907 else
6908 ssl->state++;
6909
6910#if defined(MBEDTLS_SSL_PROTO_DTLS)
6911 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6912 mbedtls_ssl_recv_flight_completed( ssl );
6913#endif
6914
6915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6916
6917exit:
6918 mbedtls_platform_zeroize( buf, hash_len );
6919 return( ret );
6920}
6921
Jerry Yu392112c2022-02-17 14:34:10 +08006922#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6923/*
6924 * Helper to get TLS 1.2 PRF from ciphersuite
6925 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6926 */
6927static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6928{
6929#if defined(MBEDTLS_SHA384_C)
6930 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6931 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6932
6933 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6934 return( tls_prf_sha384 );
6935#else
6936 (void) ciphersuite_id;
6937#endif
6938 return( tls_prf_sha256 );
6939}
6940#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006941
6942static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6943{
6944 ((void) tls_prf);
6945#if defined(MBEDTLS_SHA384_C)
6946 if( tls_prf == tls_prf_sha384 )
6947 {
6948 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6949 }
6950 else
6951#endif
6952#if defined(MBEDTLS_SHA256_C)
6953 if( tls_prf == tls_prf_sha256 )
6954 {
6955 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6956 }
6957 else
6958#endif
6959 return( MBEDTLS_SSL_TLS_PRF_NONE );
6960}
6961
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006962/*
6963 * Populate a transform structure with session keys and all the other
6964 * necessary information.
6965 *
6966 * Parameters:
6967 * - [in/out]: transform: structure to populate
6968 * [in] must be just initialised with mbedtls_ssl_transform_init()
6969 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6970 * - [in] ciphersuite
6971 * - [in] master
6972 * - [in] encrypt_then_mac
6973 * - [in] compression
6974 * - [in] tls_prf: pointer to PRF to use for key derivation
6975 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006976 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006977 * - [in] endpoint: client or server
6978 * - [in] ssl: used for:
6979 * - ssl->conf->{f,p}_export_keys
6980 * [in] optionally used for:
6981 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6982 */
6983static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6984 int ciphersuite,
6985 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006986#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006987 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006988#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006989 ssl_tls_prf_t tls_prf,
6990 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006991 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006992 unsigned endpoint,
6993 const mbedtls_ssl_context *ssl )
6994{
6995 int ret = 0;
6996 unsigned char keyblk[256];
6997 unsigned char *key1;
6998 unsigned char *key2;
6999 unsigned char *mac_enc;
7000 unsigned char *mac_dec;
7001 size_t mac_key_len = 0;
7002 size_t iv_copy_len;
7003 size_t keylen;
7004 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007005 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007006#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007007 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007008 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007009#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007010
7011#if defined(MBEDTLS_USE_PSA_CRYPTO)
7012 psa_key_type_t key_type;
7013 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7014 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007015 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007016 size_t key_bits;
7017 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7018#endif
7019
7020#if !defined(MBEDTLS_DEBUG_C) && \
7021 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7022 if( ssl->f_export_keys == NULL )
7023 {
7024 ssl = NULL; /* make sure we don't use it except for these cases */
7025 (void) ssl;
7026 }
7027#endif
7028
7029 /*
7030 * Some data just needs copying into the structure
7031 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007033 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007034#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007035 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007036
7037#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7038 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7039#endif
7040
7041#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007042 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007043 {
7044 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7045 * generation separate. This should never happen. */
7046 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7047 }
7048#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7049
7050 /*
7051 * Get various info structures
7052 */
7053 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7054 if( ciphersuite_info == NULL )
7055 {
7056 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7057 ciphersuite ) );
7058 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7059 }
7060
Neil Armstrongab555e02022-04-04 11:07:59 +02007061 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007062#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007063 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007064#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007065 ciphersuite_info );
7066
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007067 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7068 transform->taglen =
7069 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7070
7071#if defined(MBEDTLS_USE_PSA_CRYPTO)
7072 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7073 transform->taglen,
7074 &alg,
7075 &key_type,
7076 &key_bits ) ) != PSA_SUCCESS )
7077 {
7078 ret = psa_ssl_status_to_mbedtls( status );
7079 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7080 goto end;
7081 }
7082#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007083 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7084 if( cipher_info == NULL )
7085 {
7086 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7087 ciphersuite_info->cipher ) );
7088 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7089 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007090#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007091
Neil Armstronge4512952022-03-08 09:08:22 +01007092#if defined(MBEDTLS_USE_PSA_CRYPTO)
7093 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7094 if( mac_alg == 0 )
7095 {
7096 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7097 (unsigned) ciphersuite_info->mac ) );
7098 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7099 }
7100#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007101 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7102 if( md_info == NULL )
7103 {
7104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7105 (unsigned) ciphersuite_info->mac ) );
7106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7107 }
Neil Armstronge4512952022-03-08 09:08:22 +01007108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007109
7110#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7111 /* Copy own and peer's CID if the use of the CID
7112 * extension has been negotiated. */
7113 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7114 {
7115 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7116
7117 transform->in_cid_len = ssl->own_cid_len;
7118 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7119 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7120 transform->in_cid_len );
7121
7122 transform->out_cid_len = ssl->handshake->peer_cid_len;
7123 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7124 ssl->handshake->peer_cid_len );
7125 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7126 transform->out_cid_len );
7127 }
7128#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7129
7130 /*
7131 * Compute key block using the PRF
7132 */
7133 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7134 if( ret != 0 )
7135 {
7136 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7137 return( ret );
7138 }
7139
7140 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7141 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7142 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7143 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7144 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7145
7146 /*
7147 * Determine the appropriate key, IV and MAC length.
7148 */
7149
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007150#if defined(MBEDTLS_USE_PSA_CRYPTO)
7151 keylen = PSA_BITS_TO_BYTES(key_bits);
7152#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007153 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007154#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007155
7156#if defined(MBEDTLS_GCM_C) || \
7157 defined(MBEDTLS_CCM_C) || \
7158 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007159 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007160 {
7161 size_t explicit_ivlen;
7162
7163 transform->maclen = 0;
7164 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007165
7166 /* All modes haves 96-bit IVs, but the length of the static parts vary
7167 * with mode and version:
7168 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7169 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7170 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7171 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7172 * sequence number).
7173 */
7174 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007175#if defined(MBEDTLS_USE_PSA_CRYPTO)
7176 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7177#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007178 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007179#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007180 transform->fixed_ivlen = 12;
7181 else
7182 transform->fixed_ivlen = 4;
7183
7184 /* Minimum length of encrypted record */
7185 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7186 transform->minlen = explicit_ivlen + transform->taglen;
7187 }
7188 else
7189#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7190#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007191 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7192 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7193 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007194 {
Neil Armstronge4512952022-03-08 09:08:22 +01007195#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007196 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007197#else
7198 size_t block_size = cipher_info->block_size;
7199#endif /* MBEDTLS_USE_PSA_CRYPTO */
7200
7201#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007202 /* Get MAC length */
7203 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7204#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007205 /* Initialize HMAC contexts */
7206 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7207 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7208 {
7209 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7210 goto end;
7211 }
7212
7213 /* Get MAC length */
7214 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007215#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007216 transform->maclen = mac_key_len;
7217
7218 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007219#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007220 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007221#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007222 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007223#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007224
7225 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007226 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007227 transform->minlen = transform->maclen;
7228 else
7229 {
7230 /*
7231 * GenericBlockCipher:
7232 * 1. if EtM is in use: one block plus MAC
7233 * otherwise: * first multiple of blocklen greater than maclen
7234 * 2. IV
7235 */
7236#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007237 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007238 {
7239 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007240 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007241 }
7242 else
7243#endif
7244 {
7245 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007246 + block_size
7247 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007248 }
7249
Glenn Strauss07c64162022-03-14 12:34:51 -04007250 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007251 {
7252 transform->minlen += transform->ivlen;
7253 }
7254 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007255 {
7256 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7257 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7258 goto end;
7259 }
7260 }
7261 }
7262 else
7263#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7264 {
7265 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7266 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7267 }
7268
7269 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7270 (unsigned) keylen,
7271 (unsigned) transform->minlen,
7272 (unsigned) transform->ivlen,
7273 (unsigned) transform->maclen ) );
7274
7275 /*
7276 * Finally setup the cipher contexts, IVs and MAC secrets.
7277 */
7278#if defined(MBEDTLS_SSL_CLI_C)
7279 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7280 {
7281 key1 = keyblk + mac_key_len * 2;
7282 key2 = keyblk + mac_key_len * 2 + keylen;
7283
7284 mac_enc = keyblk;
7285 mac_dec = keyblk + mac_key_len;
7286
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007287 iv_copy_len = ( transform->fixed_ivlen ) ?
7288 transform->fixed_ivlen : transform->ivlen;
7289 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7290 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7291 iv_copy_len );
7292 }
7293 else
7294#endif /* MBEDTLS_SSL_CLI_C */
7295#if defined(MBEDTLS_SSL_SRV_C)
7296 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7297 {
7298 key1 = keyblk + mac_key_len * 2 + keylen;
7299 key2 = keyblk + mac_key_len * 2;
7300
7301 mac_enc = keyblk + mac_key_len;
7302 mac_dec = keyblk;
7303
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007304 iv_copy_len = ( transform->fixed_ivlen ) ?
7305 transform->fixed_ivlen : transform->ivlen;
7306 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7307 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7308 iv_copy_len );
7309 }
7310 else
7311#endif /* MBEDTLS_SSL_SRV_C */
7312 {
7313 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7314 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7315 goto end;
7316 }
7317
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007318 if( ssl != NULL && ssl->f_export_keys != NULL )
7319 {
7320 ssl->f_export_keys( ssl->p_export_keys,
7321 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7322 master, 48,
7323 randbytes + 32,
7324 randbytes,
7325 tls_prf_get_type( tls_prf ) );
7326 }
7327
7328#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007329 transform->psa_alg = alg;
7330
7331 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7332 {
7333 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7334 psa_set_key_algorithm( &attributes, alg );
7335 psa_set_key_type( &attributes, key_type );
7336
7337 if( ( status = psa_import_key( &attributes,
7338 key1,
7339 PSA_BITS_TO_BYTES( key_bits ),
7340 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7341 {
7342 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7343 ret = psa_ssl_status_to_mbedtls( status );
7344 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7345 goto end;
7346 }
7347
7348 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7349
7350 if( ( status = psa_import_key( &attributes,
7351 key2,
7352 PSA_BITS_TO_BYTES( key_bits ),
7353 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7354 {
7355 ret = psa_ssl_status_to_mbedtls( status );
7356 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7357 goto end;
7358 }
7359 }
7360#else
7361 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7362 cipher_info ) ) != 0 )
7363 {
7364 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7365 goto end;
7366 }
7367
7368 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7369 cipher_info ) ) != 0 )
7370 {
7371 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7372 goto end;
7373 }
7374
7375 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7376 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7377 MBEDTLS_ENCRYPT ) ) != 0 )
7378 {
7379 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7380 goto end;
7381 }
7382
7383 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7384 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7385 MBEDTLS_DECRYPT ) ) != 0 )
7386 {
7387 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7388 goto end;
7389 }
7390
7391#if defined(MBEDTLS_CIPHER_MODE_CBC)
7392 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7393 {
7394 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7395 MBEDTLS_PADDING_NONE ) ) != 0 )
7396 {
7397 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7398 goto end;
7399 }
7400
7401 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7402 MBEDTLS_PADDING_NONE ) ) != 0 )
7403 {
7404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7405 goto end;
7406 }
7407 }
7408#endif /* MBEDTLS_CIPHER_MODE_CBC */
7409#endif /* MBEDTLS_USE_PSA_CRYPTO */
7410
Neil Armstrong29c0c042022-03-17 17:47:28 +01007411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7412 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7413 For AEAD-based ciphersuites, there is nothing to do here. */
7414 if( mac_key_len != 0 )
7415 {
7416#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007417 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007418
7419 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007420 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007421 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7422
7423 if( ( status = psa_import_key( &attributes,
7424 mac_enc, mac_key_len,
7425 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7426 {
7427 ret = psa_ssl_status_to_mbedtls( status );
7428 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7429 goto end;
7430 }
7431
Ronald Cronfb39f152022-03-25 14:36:28 +01007432 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7433 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7434 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007435 /* mbedtls_ct_hmac() requires the key to be exportable */
7436 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7437 PSA_KEY_USAGE_VERIFY_HASH );
7438 else
7439 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7440
7441 if( ( status = psa_import_key( &attributes,
7442 mac_dec, mac_key_len,
7443 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7444 {
7445 ret = psa_ssl_status_to_mbedtls( status );
7446 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7447 goto end;
7448 }
7449#else
7450 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7451 if( ret != 0 )
7452 goto end;
7453 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7454 if( ret != 0 )
7455 goto end;
7456#endif /* MBEDTLS_USE_PSA_CRYPTO */
7457 }
7458#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7459
7460 ((void) mac_dec);
7461 ((void) mac_enc);
7462
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007463end:
7464 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7465 return( ret );
7466}
7467
Jerry Yuee40f9d2022-02-17 14:55:16 +08007468#if defined(MBEDTLS_USE_PSA_CRYPTO)
7469int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7470 unsigned char *hash, size_t *hashlen,
7471 unsigned char *data, size_t data_len,
7472 mbedtls_md_type_t md_alg )
7473{
7474 psa_status_t status;
7475 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7476 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7477
7478 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7479
7480 if( ( status = psa_hash_setup( &hash_operation,
7481 hash_alg ) ) != PSA_SUCCESS )
7482 {
7483 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7484 goto exit;
7485 }
7486
7487 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7488 64 ) ) != PSA_SUCCESS )
7489 {
7490 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7491 goto exit;
7492 }
7493
7494 if( ( status = psa_hash_update( &hash_operation,
7495 data, data_len ) ) != PSA_SUCCESS )
7496 {
7497 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7498 goto exit;
7499 }
7500
7501 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7502 hashlen ) ) != PSA_SUCCESS )
7503 {
7504 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7505 goto exit;
7506 }
7507
7508exit:
7509 if( status != PSA_SUCCESS )
7510 {
7511 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7512 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7513 switch( status )
7514 {
7515 case PSA_ERROR_NOT_SUPPORTED:
7516 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7517 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7518 case PSA_ERROR_BUFFER_TOO_SMALL:
7519 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7520 case PSA_ERROR_INSUFFICIENT_MEMORY:
7521 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7522 default:
7523 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7524 }
7525 }
7526 return( 0 );
7527}
7528
7529#else
7530
7531int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7532 unsigned char *hash, size_t *hashlen,
7533 unsigned char *data, size_t data_len,
7534 mbedtls_md_type_t md_alg )
7535{
7536 int ret = 0;
7537 mbedtls_md_context_t ctx;
7538 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7539 *hashlen = mbedtls_md_get_size( md_info );
7540
7541 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7542
7543 mbedtls_md_init( &ctx );
7544
7545 /*
7546 * digitally-signed struct {
7547 * opaque client_random[32];
7548 * opaque server_random[32];
7549 * ServerDHParams params;
7550 * };
7551 */
7552 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7553 {
7554 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7555 goto exit;
7556 }
7557 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7558 {
7559 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7560 goto exit;
7561 }
7562 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7563 {
7564 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7565 goto exit;
7566 }
7567 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7568 {
7569 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7570 goto exit;
7571 }
7572 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7573 {
7574 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7575 goto exit;
7576 }
7577
7578exit:
7579 mbedtls_md_free( &ctx );
7580
7581 if( ret != 0 )
7582 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7583 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7584
7585 return( ret );
7586}
7587#endif /* MBEDTLS_USE_PSA_CRYPTO */
7588
Jerry Yud9d91da2022-02-17 14:57:06 +08007589#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7590
7591/* Find an entry in a signature-hash set matching a given hash algorithm. */
7592mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7593 mbedtls_pk_type_t sig_alg )
7594{
7595 switch( sig_alg )
7596 {
7597 case MBEDTLS_PK_RSA:
7598 return( set->rsa );
7599 case MBEDTLS_PK_ECDSA:
7600 return( set->ecdsa );
7601 default:
7602 return( MBEDTLS_MD_NONE );
7603 }
7604}
7605
7606/* Add a signature-hash-pair to a signature-hash set */
7607void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7608 mbedtls_pk_type_t sig_alg,
7609 mbedtls_md_type_t md_alg )
7610{
7611 switch( sig_alg )
7612 {
7613 case MBEDTLS_PK_RSA:
7614 if( set->rsa == MBEDTLS_MD_NONE )
7615 set->rsa = md_alg;
7616 break;
7617
7618 case MBEDTLS_PK_ECDSA:
7619 if( set->ecdsa == MBEDTLS_MD_NONE )
7620 set->ecdsa = md_alg;
7621 break;
7622
7623 default:
7624 break;
7625 }
7626}
7627
7628/* Allow exactly one hash algorithm for each signature. */
7629void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7630 mbedtls_md_type_t md_alg )
7631{
7632 set->rsa = md_alg;
7633 set->ecdsa = md_alg;
7634}
7635
7636#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7637
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007638/* Serialization of TLS 1.2 sessions:
7639 *
7640 * struct {
7641 * uint64 start_time;
7642 * uint8 ciphersuite[2]; // defined by the standard
7643 * uint8 compression; // 0 or 1
7644 * uint8 session_id_len; // at most 32
7645 * opaque session_id[32];
7646 * opaque master[48]; // fixed length in the standard
7647 * uint32 verify_result;
7648 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7649 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7650 * uint32 ticket_lifetime;
7651 * uint8 mfl_code; // up to 255 according to standard
7652 * uint8 encrypt_then_mac; // 0 or 1
7653 * } serialized_session_tls12;
7654 *
7655 */
7656static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7657 unsigned char *buf,
7658 size_t buf_len )
7659{
7660 unsigned char *p = buf;
7661 size_t used = 0;
7662
7663#if defined(MBEDTLS_HAVE_TIME)
7664 uint64_t start;
7665#endif
7666#if defined(MBEDTLS_X509_CRT_PARSE_C)
7667#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7668 size_t cert_len;
7669#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7670#endif /* MBEDTLS_X509_CRT_PARSE_C */
7671
7672 /*
7673 * Time
7674 */
7675#if defined(MBEDTLS_HAVE_TIME)
7676 used += 8;
7677
7678 if( used <= buf_len )
7679 {
7680 start = (uint64_t) session->start;
7681
7682 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7683 p += 8;
7684 }
7685#endif /* MBEDTLS_HAVE_TIME */
7686
7687 /*
7688 * Basic mandatory fields
7689 */
7690 used += 2 /* ciphersuite */
7691 + 1 /* compression */
7692 + 1 /* id_len */
7693 + sizeof( session->id )
7694 + sizeof( session->master )
7695 + 4; /* verify_result */
7696
7697 if( used <= buf_len )
7698 {
7699 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7700 p += 2;
7701
7702 *p++ = MBEDTLS_BYTE_0( session->compression );
7703
7704 *p++ = MBEDTLS_BYTE_0( session->id_len );
7705 memcpy( p, session->id, 32 );
7706 p += 32;
7707
7708 memcpy( p, session->master, 48 );
7709 p += 48;
7710
7711 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7712 p += 4;
7713 }
7714
7715 /*
7716 * Peer's end-entity certificate
7717 */
7718#if defined(MBEDTLS_X509_CRT_PARSE_C)
7719#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7720 if( session->peer_cert == NULL )
7721 cert_len = 0;
7722 else
7723 cert_len = session->peer_cert->raw.len;
7724
7725 used += 3 + cert_len;
7726
7727 if( used <= buf_len )
7728 {
7729 *p++ = MBEDTLS_BYTE_2( cert_len );
7730 *p++ = MBEDTLS_BYTE_1( cert_len );
7731 *p++ = MBEDTLS_BYTE_0( cert_len );
7732
7733 if( session->peer_cert != NULL )
7734 {
7735 memcpy( p, session->peer_cert->raw.p, cert_len );
7736 p += cert_len;
7737 }
7738 }
7739#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7740 if( session->peer_cert_digest != NULL )
7741 {
7742 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7743 if( used <= buf_len )
7744 {
7745 *p++ = (unsigned char) session->peer_cert_digest_type;
7746 *p++ = (unsigned char) session->peer_cert_digest_len;
7747 memcpy( p, session->peer_cert_digest,
7748 session->peer_cert_digest_len );
7749 p += session->peer_cert_digest_len;
7750 }
7751 }
7752 else
7753 {
7754 used += 2;
7755 if( used <= buf_len )
7756 {
7757 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7758 *p++ = 0;
7759 }
7760 }
7761#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7762#endif /* MBEDTLS_X509_CRT_PARSE_C */
7763
7764 /*
7765 * Session ticket if any, plus associated data
7766 */
7767#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7768 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7769
7770 if( used <= buf_len )
7771 {
7772 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7773 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7774 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7775
7776 if( session->ticket != NULL )
7777 {
7778 memcpy( p, session->ticket, session->ticket_len );
7779 p += session->ticket_len;
7780 }
7781
7782 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7783 p += 4;
7784 }
7785#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7786
7787 /*
7788 * Misc extension-related info
7789 */
7790#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7791 used += 1;
7792
7793 if( used <= buf_len )
7794 *p++ = session->mfl_code;
7795#endif
7796
7797#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7798 used += 1;
7799
7800 if( used <= buf_len )
7801 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7802#endif
7803
7804 return( used );
7805}
7806
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007807static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7808 const unsigned char *buf,
7809 size_t len )
7810{
7811#if defined(MBEDTLS_HAVE_TIME)
7812 uint64_t start;
7813#endif
7814#if defined(MBEDTLS_X509_CRT_PARSE_C)
7815#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7816 size_t cert_len;
7817#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7818#endif /* MBEDTLS_X509_CRT_PARSE_C */
7819
7820 const unsigned char *p = buf;
7821 const unsigned char * const end = buf + len;
7822
7823 /*
7824 * Time
7825 */
7826#if defined(MBEDTLS_HAVE_TIME)
7827 if( 8 > (size_t)( end - p ) )
7828 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7829
7830 start = ( (uint64_t) p[0] << 56 ) |
7831 ( (uint64_t) p[1] << 48 ) |
7832 ( (uint64_t) p[2] << 40 ) |
7833 ( (uint64_t) p[3] << 32 ) |
7834 ( (uint64_t) p[4] << 24 ) |
7835 ( (uint64_t) p[5] << 16 ) |
7836 ( (uint64_t) p[6] << 8 ) |
7837 ( (uint64_t) p[7] );
7838 p += 8;
7839
7840 session->start = (time_t) start;
7841#endif /* MBEDTLS_HAVE_TIME */
7842
7843 /*
7844 * Basic mandatory fields
7845 */
7846 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7847 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7848
7849 session->ciphersuite = ( p[0] << 8 ) | p[1];
7850 p += 2;
7851
7852 session->compression = *p++;
7853
7854 session->id_len = *p++;
7855 memcpy( session->id, p, 32 );
7856 p += 32;
7857
7858 memcpy( session->master, p, 48 );
7859 p += 48;
7860
7861 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7862 ( (uint32_t) p[1] << 16 ) |
7863 ( (uint32_t) p[2] << 8 ) |
7864 ( (uint32_t) p[3] );
7865 p += 4;
7866
7867 /* Immediately clear invalid pointer values that have been read, in case
7868 * we exit early before we replaced them with valid ones. */
7869#if defined(MBEDTLS_X509_CRT_PARSE_C)
7870#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7871 session->peer_cert = NULL;
7872#else
7873 session->peer_cert_digest = NULL;
7874#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7875#endif /* MBEDTLS_X509_CRT_PARSE_C */
7876#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7877 session->ticket = NULL;
7878#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7879
7880 /*
7881 * Peer certificate
7882 */
7883#if defined(MBEDTLS_X509_CRT_PARSE_C)
7884#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7885 /* Deserialize CRT from the end of the ticket. */
7886 if( 3 > (size_t)( end - p ) )
7887 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7888
7889 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7890 p += 3;
7891
7892 if( cert_len != 0 )
7893 {
7894 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7895
7896 if( cert_len > (size_t)( end - p ) )
7897 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7898
7899 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7900
7901 if( session->peer_cert == NULL )
7902 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7903
7904 mbedtls_x509_crt_init( session->peer_cert );
7905
7906 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7907 p, cert_len ) ) != 0 )
7908 {
7909 mbedtls_x509_crt_free( session->peer_cert );
7910 mbedtls_free( session->peer_cert );
7911 session->peer_cert = NULL;
7912 return( ret );
7913 }
7914
7915 p += cert_len;
7916 }
7917#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7918 /* Deserialize CRT digest from the end of the ticket. */
7919 if( 2 > (size_t)( end - p ) )
7920 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7921
7922 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7923 session->peer_cert_digest_len = (size_t) *p++;
7924
7925 if( session->peer_cert_digest_len != 0 )
7926 {
7927 const mbedtls_md_info_t *md_info =
7928 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7929 if( md_info == NULL )
7930 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7931 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7932 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7933
7934 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7935 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7936
7937 session->peer_cert_digest =
7938 mbedtls_calloc( 1, session->peer_cert_digest_len );
7939 if( session->peer_cert_digest == NULL )
7940 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7941
7942 memcpy( session->peer_cert_digest, p,
7943 session->peer_cert_digest_len );
7944 p += session->peer_cert_digest_len;
7945 }
7946#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7947#endif /* MBEDTLS_X509_CRT_PARSE_C */
7948
7949 /*
7950 * Session ticket and associated data
7951 */
7952#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7953 if( 3 > (size_t)( end - p ) )
7954 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7955
7956 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7957 p += 3;
7958
7959 if( session->ticket_len != 0 )
7960 {
7961 if( session->ticket_len > (size_t)( end - p ) )
7962 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7963
7964 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7965 if( session->ticket == NULL )
7966 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7967
7968 memcpy( session->ticket, p, session->ticket_len );
7969 p += session->ticket_len;
7970 }
7971
7972 if( 4 > (size_t)( end - p ) )
7973 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7974
7975 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7976 ( (uint32_t) p[1] << 16 ) |
7977 ( (uint32_t) p[2] << 8 ) |
7978 ( (uint32_t) p[3] );
7979 p += 4;
7980#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7981
7982 /*
7983 * Misc extension-related info
7984 */
7985#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7986 if( 1 > (size_t)( end - p ) )
7987 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7988
7989 session->mfl_code = *p++;
7990#endif
7991
7992#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7993 if( 1 > (size_t)( end - p ) )
7994 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7995
7996 session->encrypt_then_mac = *p++;
7997#endif
7998
7999 /* Done, should have consumed entire buffer */
8000 if( p != end )
8001 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8002
8003 return( 0 );
8004}
Jerry Yudc7bd172022-02-17 13:44:15 +08008005#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8006
XiaokangQian75d40ef2022-04-20 11:05:24 +00008007int mbedtls_ssl_validate_ciphersuite(
8008 const mbedtls_ssl_context *ssl,
8009 const mbedtls_ssl_ciphersuite_t *suite_info,
8010 mbedtls_ssl_protocol_version min_tls_version,
8011 mbedtls_ssl_protocol_version max_tls_version )
8012{
8013 (void) ssl;
8014
8015 if( suite_info == NULL )
8016 return( -1 );
8017
8018 if( ( suite_info->min_tls_version > max_tls_version ) ||
8019 ( suite_info->max_tls_version < min_tls_version ) )
8020 {
8021 return( -1 );
8022 }
8023
XiaokangQian060d8672022-04-21 09:24:56 +00008024#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008025#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8026 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8027 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8028 {
8029 return( -1 );
8030 }
8031#endif
8032
8033 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8034#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8035 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8036 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8037 {
8038 return( -1 );
8039 }
8040#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8041#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8042
8043 return( 0 );
8044}
8045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008046#endif /* MBEDTLS_SSL_TLS_C */