blob: 196973857234eef1af4613290d4a104e7dbe40b5 [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#if defined(MBEDTLS_DHM_C)
620 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200621#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200622#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200624#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200625#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200626 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200627#if defined(MBEDTLS_SSL_CLI_C)
628 handshake->ecjpake_cache = NULL;
629 handshake->ecjpake_cache_len = 0;
630#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200632
Gilles Peskineeccd8882020-03-10 12:19:08 +0100633#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200634 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200635#endif
636
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200637#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
638 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
639#endif
Hanno Becker75173122019-02-06 16:18:31 +0000640
641#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
642 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
643 mbedtls_pk_init( &handshake->peer_pubkey );
644#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200645}
646
Hanno Beckera18d1322018-01-03 14:27:32 +0000647void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200648{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200650
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100651#if defined(MBEDTLS_USE_PSA_CRYPTO)
652 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
653 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100654#else
655 mbedtls_cipher_init( &transform->cipher_ctx_enc );
656 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100657#endif
658
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000659#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100660#if defined(MBEDTLS_USE_PSA_CRYPTO)
661 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
662 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100663#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 mbedtls_md_init( &transform->md_ctx_enc );
665 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000666#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100667#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200668}
669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200671{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200673}
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000676{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200677 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000678 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200682 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200683 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684
685 /*
686 * Either the pointers are now NULL or cleared properly and can be freed.
687 * Now allocate missing structures.
688 */
689 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200690 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200691 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200692 }
Paul Bakker48916f92012-09-16 19:57:18 +0000693
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200694 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200695 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200696 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 }
Paul Bakker48916f92012-09-16 19:57:18 +0000698
Paul Bakker82788fb2014-10-20 13:59:19 +0200699 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200700 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200701 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500703#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
704 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400705
Andrzej Kurek4a063792020-10-21 15:08:44 +0200706 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
707 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500708#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000709
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200710 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000711 if( ssl->handshake == NULL ||
712 ssl->transform_negotiate == NULL ||
713 ssl->session_negotiate == NULL )
714 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 mbedtls_free( ssl->handshake );
718 mbedtls_free( ssl->transform_negotiate );
719 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200720
721 ssl->handshake = NULL;
722 ssl->transform_negotiate = NULL;
723 ssl->session_negotiate = NULL;
724
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200725 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000726 }
727
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200728 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000730 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200731 ssl_handshake_params_init( ssl->handshake );
732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200734 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
735 {
736 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200737
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200738 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
739 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
740 else
741 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200742
Hanno Becker0f57a652020-02-05 10:37:26 +0000743 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200744 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200745#endif
746
Brett Warrene0edc842021-08-17 09:53:13 +0100747/*
748 * curve_list is translated to IANA TLS group identifiers here because
749 * mbedtls_ssl_conf_curves returns void and so can't return
750 * any error codes.
751 */
752#if defined(MBEDTLS_ECP_C)
753#if !defined(MBEDTLS_DEPRECATED_REMOVED)
754 /* Heap allocate and translate curve_list from internal to IANA group ids */
755 if ( ssl->conf->curve_list != NULL )
756 {
757 size_t length;
758 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
759
760 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
761 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
762
763 /* Leave room for zero termination */
764 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
765 if ( group_list == NULL )
766 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
767
768 for( size_t i = 0; i < length; i++ )
769 {
770 const mbedtls_ecp_curve_info *info =
771 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
772 if ( info == NULL )
773 {
774 mbedtls_free( group_list );
775 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
776 }
777 group_list[i] = info->tls_id;
778 }
779
780 group_list[length] = 0;
781
782 ssl->handshake->group_list = group_list;
783 ssl->handshake->group_list_heap_allocated = 1;
784 }
785 else
786 {
787 ssl->handshake->group_list = ssl->conf->group_list;
788 ssl->handshake->group_list_heap_allocated = 0;
789 }
790#endif /* MBEDTLS_DEPRECATED_REMOVED */
791#endif /* MBEDTLS_ECP_C */
792
Jerry Yuf017ee42022-01-12 15:49:48 +0800793#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
794#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800796 /* Heap allocate and translate sig_hashes from internal hash identifiers to
797 signature algorithms IANA identifiers. */
798 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800799 ssl->conf->sig_hashes != NULL )
800 {
801 const int *md;
802 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800803 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800804 uint16_t *p;
805
Jerry Yub476a442022-01-21 18:14:45 +0800806#if defined(static_assert)
807 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
808 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
809 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800810#endif
811
Jerry Yuf017ee42022-01-12 15:49:48 +0800812 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
813 {
814 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
815 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800816#if defined(MBEDTLS_ECDSA_C)
817 sig_algs_len += sizeof( uint16_t );
818#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800819
Jerry Yub476a442022-01-21 18:14:45 +0800820#if defined(MBEDTLS_RSA_C)
821 sig_algs_len += sizeof( uint16_t );
822#endif
823 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
824 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800825 }
826
Jerry Yub476a442022-01-21 18:14:45 +0800827 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800828 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
829
Jerry Yub476a442022-01-21 18:14:45 +0800830 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
831 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 if( ssl->handshake->sig_algs == NULL )
833 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
834
835 p = (uint16_t *)ssl->handshake->sig_algs;
836 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
837 {
838 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
839 if( hash == MBEDTLS_SSL_HASH_NONE )
840 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800841#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800842 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
843 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800844#endif
845#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800846 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
847 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200850 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800851 ssl->handshake->sig_algs_heap_allocated = 1;
852 }
853 else
Jerry Yua69269a2022-01-17 21:06:01 +0800854#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800855 {
856 ssl->handshake->sig_algs = ssl->conf->sig_algs;
857 ssl->handshake->sig_algs_heap_allocated = 0;
858 }
859#endif /* MBEDTLS_DEPRECATED_REMOVED */
860#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000861 return( 0 );
862}
863
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200864#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200865/* Dummy cookie callbacks for defaults */
866static int ssl_cookie_write_dummy( void *ctx,
867 unsigned char **p, unsigned char *end,
868 const unsigned char *cli_id, size_t cli_id_len )
869{
870 ((void) ctx);
871 ((void) p);
872 ((void) end);
873 ((void) cli_id);
874 ((void) cli_id_len);
875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200877}
878
879static int ssl_cookie_check_dummy( void *ctx,
880 const unsigned char *cookie, size_t cookie_len,
881 const unsigned char *cli_id, size_t cli_id_len )
882{
883 ((void) ctx);
884 ((void) cookie);
885 ((void) cookie_len);
886 ((void) cli_id);
887 ((void) cli_id_len);
888
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200890}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200891#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200892
Paul Bakker5121ce52009-01-03 21:22:43 +0000893/*
894 * Initialize an SSL context
895 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200896void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
897{
898 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
899}
900
Jerry Yu60835a82021-08-04 10:13:52 +0800901static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
902{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100903 const mbedtls_ssl_config *conf = ssl->conf;
904
Ronald Cron6f135e12021-12-08 16:57:54 +0100905#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100906 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
907 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000908 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
909 {
910 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
911 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
912 }
913
Jerry Yu60835a82021-08-04 10:13:52 +0800914 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
915 return( 0 );
916 }
917#endif
918
919#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100920 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800921 {
922 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
923 return( 0 );
924 }
925#endif
926
Ronald Cron6f135e12021-12-08 16:57:54 +0100927#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100928 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800929 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
931 {
932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
933 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
934 }
935
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000936 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
937 {
938 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
939 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
940 }
941
942
Ronald Crone1d3f062022-02-10 14:50:54 +0100943 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
944 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800945 }
946#endif
947
948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
949 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
950}
951
952static int ssl_conf_check(const mbedtls_ssl_context *ssl)
953{
954 int ret;
955 ret = ssl_conf_version_check( ssl );
956 if( ret != 0 )
957 return( ret );
958
959 /* Space for further checks */
960
961 return( 0 );
962}
963
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200964/*
965 * Setup an SSL context
966 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100967
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200968int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200969 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000970{
Janos Follath865b3eb2019-12-16 11:46:15 +0000971 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000972 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
973 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000974
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200975 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000976
Jerry Yu60835a82021-08-04 10:13:52 +0800977 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
978 return( ret );
979
Paul Bakker62f2dee2012-09-28 07:31:51 +0000980 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100981 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000982 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200983
984 /* Set to NULL in case of an error condition */
985 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200986
Darryl Greenb33cc762019-11-28 14:29:44 +0000987#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
988 ssl->in_buf_len = in_buf_len;
989#endif
990 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000991 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000992 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000993 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200994 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +0200995 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +1000996 }
997
Darryl Greenb33cc762019-11-28 14:29:44 +0000998#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
999 ssl->out_buf_len = out_buf_len;
1000#endif
1001 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001002 if( ssl->out_buf == NULL )
1003 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001005 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001006 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001007 }
1008
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001009 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001010
Johan Pascalb62bb512015-12-03 21:56:45 +01001011#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001012 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001013#endif
1014
Paul Bakker48916f92012-09-16 19:57:18 +00001015 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001016 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001017
1018 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001019
1020error:
1021 mbedtls_free( ssl->in_buf );
1022 mbedtls_free( ssl->out_buf );
1023
1024 ssl->conf = NULL;
1025
Darryl Greenb33cc762019-11-28 14:29:44 +00001026#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1027 ssl->in_buf_len = 0;
1028 ssl->out_buf_len = 0;
1029#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001030 ssl->in_buf = NULL;
1031 ssl->out_buf = NULL;
1032
1033 ssl->in_hdr = NULL;
1034 ssl->in_ctr = NULL;
1035 ssl->in_len = NULL;
1036 ssl->in_iv = NULL;
1037 ssl->in_msg = NULL;
1038
1039 ssl->out_hdr = NULL;
1040 ssl->out_ctr = NULL;
1041 ssl->out_len = NULL;
1042 ssl->out_iv = NULL;
1043 ssl->out_msg = NULL;
1044
k-stachowiak9f7798e2018-07-31 16:52:32 +02001045 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001046}
1047
1048/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001049 * Reset an initialized and used SSL context for re-use while retaining
1050 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001051 *
1052 * If partial is non-zero, keep data in the input buffer and client ID.
1053 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001054 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001055void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1056 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001057{
Darryl Greenb33cc762019-11-28 14:29:44 +00001058#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1059 size_t in_buf_len = ssl->in_buf_len;
1060 size_t out_buf_len = ssl->out_buf_len;
1061#else
1062 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1063 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1064#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001065
Hanno Beckerb0302c42021-08-03 09:39:42 +01001066#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1067 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001068#endif
1069
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001070 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001071 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001072
Hanno Beckerb0302c42021-08-03 09:39:42 +01001073 mbedtls_ssl_reset_in_out_pointers( ssl );
1074
1075 /* Reset incoming message parsing */
1076 ssl->in_offt = NULL;
1077 ssl->nb_zero = 0;
1078 ssl->in_msgtype = 0;
1079 ssl->in_msglen = 0;
1080 ssl->in_hslen = 0;
1081 ssl->keep_current_message = 0;
1082 ssl->transform_in = NULL;
1083
1084#if defined(MBEDTLS_SSL_PROTO_DTLS)
1085 ssl->next_record_offset = 0;
1086 ssl->in_epoch = 0;
1087#endif
1088
1089 /* Keep current datagram if partial == 1 */
1090 if( partial == 0 )
1091 {
1092 ssl->in_left = 0;
1093 memset( ssl->in_buf, 0, in_buf_len );
1094 }
1095
1096 /* Reset outgoing message writing */
1097 ssl->out_msgtype = 0;
1098 ssl->out_msglen = 0;
1099 ssl->out_left = 0;
1100 memset( ssl->out_buf, 0, out_buf_len );
1101 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1102 ssl->transform_out = NULL;
1103
1104#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1105 mbedtls_ssl_dtls_replay_reset( ssl );
1106#endif
1107
XiaokangQian2b01dc32022-01-21 02:53:13 +00001108#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001109 if( ssl->transform )
1110 {
1111 mbedtls_ssl_transform_free( ssl->transform );
1112 mbedtls_free( ssl->transform );
1113 ssl->transform = NULL;
1114 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001115#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1116
XiaokangQian2b01dc32022-01-21 02:53:13 +00001117#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1118 mbedtls_ssl_transform_free( ssl->transform_application );
1119 mbedtls_free( ssl->transform_application );
1120 ssl->transform_application = NULL;
1121
1122 if( ssl->handshake != NULL )
1123 {
1124 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1125 mbedtls_free( ssl->handshake->transform_earlydata );
1126 ssl->handshake->transform_earlydata = NULL;
1127
1128 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1129 mbedtls_free( ssl->handshake->transform_handshake );
1130 ssl->handshake->transform_handshake = NULL;
1131 }
1132
XiaokangQian2b01dc32022-01-21 02:53:13 +00001133#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001134}
1135
1136int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1137{
1138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1139
1140 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1141
XiaokangQian78b1fa72022-01-19 06:56:30 +00001142 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001143
1144 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145#if defined(MBEDTLS_SSL_RENEGOTIATION)
1146 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001147 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001148
1149 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1151 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001152#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001154
Hanno Beckerb0302c42021-08-03 09:39:42 +01001155 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001156 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001157 if( ssl->session )
1158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 mbedtls_ssl_session_free( ssl->session );
1160 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001161 ssl->session = NULL;
1162 }
1163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001165 ssl->alpn_chosen = NULL;
1166#endif
1167
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001168#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001169#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001170 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001171#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001172 {
1173 mbedtls_free( ssl->cli_id );
1174 ssl->cli_id = NULL;
1175 ssl->cli_id_len = 0;
1176 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001177#endif
1178
Paul Bakker48916f92012-09-16 19:57:18 +00001179 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1180 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001181
1182 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001183}
1184
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001185/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001186 * Reset an initialized and used SSL context for re-use while retaining
1187 * all application-set variables, function pointers and data.
1188 */
1189int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1190{
Hanno Becker43aefe22020-02-05 10:44:56 +00001191 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001192}
1193
1194/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001195 * SSL set accessors
1196 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001197void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001198{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001199 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001200}
1201
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001202void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001203{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001204 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001205}
1206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001208void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001209{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001210 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001211}
1212#endif
1213
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001214void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001216 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001217}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001220
Hanno Becker1841b0a2018-08-24 11:13:57 +01001221void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1222 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001223{
1224 ssl->disable_datagram_packing = !allow_packing;
1225}
1226
1227void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1228 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001229{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001230 conf->hs_timeout_min = min;
1231 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001232}
1233#endif
1234
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001235void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001236{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001237 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001238}
1239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001241void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001242 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001243 void *p_vrfy )
1244{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001245 conf->f_vrfy = f_vrfy;
1246 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001247}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001249
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001250void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001251 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001252 void *p_rng )
1253{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001254 conf->f_rng = f_rng;
1255 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001256}
1257
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001258void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001259 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001260 void *p_dbg )
1261{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001262 conf->f_dbg = f_dbg;
1263 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001264}
1265
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001267 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001268 mbedtls_ssl_send_t *f_send,
1269 mbedtls_ssl_recv_t *f_recv,
1270 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001271{
1272 ssl->p_bio = p_bio;
1273 ssl->f_send = f_send;
1274 ssl->f_recv = f_recv;
1275 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001276}
1277
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001278#if defined(MBEDTLS_SSL_PROTO_DTLS)
1279void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1280{
1281 ssl->mtu = mtu;
1282}
1283#endif
1284
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001285void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001286{
1287 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001288}
1289
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001290void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1291 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001292 mbedtls_ssl_set_timer_t *f_set_timer,
1293 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001294{
1295 ssl->p_timer = p_timer;
1296 ssl->f_set_timer = f_set_timer;
1297 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001298
1299 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001300 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001301}
1302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001304void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001305 void *p_cache,
1306 mbedtls_ssl_cache_get_t *f_get_cache,
1307 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001308{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001309 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001310 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001311 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001312}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_CLI_C)
1316int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001317{
Janos Follath865b3eb2019-12-16 11:46:15 +00001318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001319
1320 if( ssl == NULL ||
1321 session == NULL ||
1322 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001323 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001324 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001326 }
1327
Hanno Beckere810bbc2021-05-14 16:01:05 +01001328 if( ssl->handshake->resume == 1 )
1329 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1330
Hanno Becker52055ae2019-02-06 14:30:46 +00001331 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1332 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001333 return( ret );
1334
Paul Bakker0a597072012-09-25 21:55:46 +00001335 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001336
1337 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001338}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001340
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001341void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1342 const int *ciphersuites )
1343{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001344 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001345}
1346
Ronald Cron6f135e12021-12-08 16:57:54 +01001347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001348void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001349 const int kex_modes )
1350{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001351 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001352}
Ronald Cron6f135e12021-12-08 16:57:54 +01001353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001355#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001356void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001357 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001358{
1359 conf->cert_profile = profile;
1360}
1361
Glenn Strauss36872db2022-01-22 05:06:31 -05001362static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1363{
1364 mbedtls_ssl_key_cert *cur = key_cert, *next;
1365
1366 while( cur != NULL )
1367 {
1368 next = cur->next;
1369 mbedtls_free( cur );
1370 cur = next;
1371 }
1372}
1373
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001374/* Append a new keycert entry to a (possibly empty) list */
1375static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1376 mbedtls_x509_crt *cert,
1377 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001378{
niisato8ee24222018-06-25 19:05:48 +09001379 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001380
Glenn Strauss36872db2022-01-22 05:06:31 -05001381 if( cert == NULL )
1382 {
1383 /* Free list if cert is null */
1384 ssl_key_cert_free( *head );
1385 *head = NULL;
1386 return( 0 );
1387 }
1388
niisato8ee24222018-06-25 19:05:48 +09001389 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1390 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001391 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001392
niisato8ee24222018-06-25 19:05:48 +09001393 new_cert->cert = cert;
1394 new_cert->key = key;
1395 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001396
Glenn Strauss36872db2022-01-22 05:06:31 -05001397 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001398 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001399 {
niisato8ee24222018-06-25 19:05:48 +09001400 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001401 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001402 else
1403 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001404 mbedtls_ssl_key_cert *cur = *head;
1405 while( cur->next != NULL )
1406 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001407 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001408 }
1409
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410 return( 0 );
1411}
1412
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001413int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001414 mbedtls_x509_crt *own_cert,
1415 mbedtls_pk_context *pk_key )
1416{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001417 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001418}
1419
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001420void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001421 mbedtls_x509_crt *ca_chain,
1422 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001423{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001424 conf->ca_chain = ca_chain;
1425 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001426
1427#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1428 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1429 * cannot be used together. */
1430 conf->f_ca_cb = NULL;
1431 conf->p_ca_cb = NULL;
1432#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001433}
Hanno Becker5adaad92019-03-27 16:54:37 +00001434
1435#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1436void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001437 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001438 void *p_ca_cb )
1439{
1440 conf->f_ca_cb = f_ca_cb;
1441 conf->p_ca_cb = p_ca_cb;
1442
1443 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1444 * cannot be used together. */
1445 conf->ca_chain = NULL;
1446 conf->ca_crl = NULL;
1447}
1448#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001450
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001451#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001452const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1453 size_t *name_len )
1454{
1455 *name_len = ssl->handshake->sni_name_len;
1456 return( ssl->handshake->sni_name );
1457}
1458
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001459int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1460 mbedtls_x509_crt *own_cert,
1461 mbedtls_pk_context *pk_key )
1462{
1463 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1464 own_cert, pk_key ) );
1465}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001466
1467void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1468 mbedtls_x509_crt *ca_chain,
1469 mbedtls_x509_crl *ca_crl )
1470{
1471 ssl->handshake->sni_ca_chain = ca_chain;
1472 ssl->handshake->sni_ca_crl = ca_crl;
1473}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001474
Glenn Strauss999ef702022-03-11 01:37:23 -05001475#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1476void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1477 const mbedtls_x509_crt *crt)
1478{
1479 ssl->handshake->dn_hints = crt;
1480}
1481#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1482
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001483void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1484 int authmode )
1485{
1486 ssl->handshake->sni_authmode = authmode;
1487}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001488#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1489
Hanno Becker8927c832019-04-03 12:52:50 +01001490#if defined(MBEDTLS_X509_CRT_PARSE_C)
1491void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1492 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1493 void *p_vrfy )
1494{
1495 ssl->f_vrfy = f_vrfy;
1496 ssl->p_vrfy = p_vrfy;
1497}
1498#endif
1499
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001500#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001501/*
1502 * Set EC J-PAKE password for current handshake
1503 */
1504int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1505 const unsigned char *pw,
1506 size_t pw_len )
1507{
1508 mbedtls_ecjpake_role role;
1509
Janos Follath8eb64132016-06-03 15:40:57 +01001510 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001511 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1512
1513 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1514 role = MBEDTLS_ECJPAKE_SERVER;
1515 else
1516 role = MBEDTLS_ECJPAKE_CLIENT;
1517
1518 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1519 role,
1520 MBEDTLS_MD_SHA256,
1521 MBEDTLS_ECP_DP_SECP256R1,
1522 pw, pw_len ) );
1523}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001524#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001525
Gilles Peskineeccd8882020-03-10 12:19:08 +01001526#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001527
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001528static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1529{
1530#if defined(MBEDTLS_USE_PSA_CRYPTO)
1531 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1532 return( 1 );
1533#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001534 if( conf->psk != NULL )
1535 return( 1 );
1536
1537 return( 0 );
1538}
1539
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001540static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1541{
1542 /* Remove reference to existing PSK, if any. */
1543#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001544 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545 {
1546 /* The maintenance of the PSK key slot is the
1547 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001548 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001549 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001550#endif /* MBEDTLS_USE_PSA_CRYPTO */
1551 if( conf->psk != NULL )
1552 {
1553 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1554
1555 mbedtls_free( conf->psk );
1556 conf->psk = NULL;
1557 conf->psk_len = 0;
1558 }
1559
1560 /* Remove reference to PSK identity, if any. */
1561 if( conf->psk_identity != NULL )
1562 {
1563 mbedtls_free( conf->psk_identity );
1564 conf->psk_identity = NULL;
1565 conf->psk_identity_len = 0;
1566 }
1567}
1568
Hanno Becker7390c712018-11-15 13:33:04 +00001569/* This function assumes that PSK identity in the SSL config is unset.
1570 * It checks that the provided identity is well-formed and attempts
1571 * to make a copy of it in the SSL config.
1572 * On failure, the PSK identity in the config remains unset. */
1573static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1574 unsigned char const *psk_identity,
1575 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001576{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001577 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001578 if( psk_identity == NULL ||
1579 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001580 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001581 {
1582 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1583 }
1584
Hanno Becker7390c712018-11-15 13:33:04 +00001585 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1586 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001587 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001588
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001589 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001590 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001591
1592 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001593}
1594
Hanno Becker7390c712018-11-15 13:33:04 +00001595int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1596 const unsigned char *psk, size_t psk_len,
1597 const unsigned char *psk_identity, size_t psk_identity_len )
1598{
Janos Follath865b3eb2019-12-16 11:46:15 +00001599 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001600
1601 /* We currently only support one PSK, raw or opaque. */
1602 if( ssl_conf_psk_is_configured( conf ) )
1603 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001604
1605 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001606 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001607 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001608 if( psk_len == 0 )
1609 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1610 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1611 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1612
Hanno Becker7390c712018-11-15 13:33:04 +00001613 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1614 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1615 conf->psk_len = psk_len;
1616 memcpy( conf->psk, psk, conf->psk_len );
1617
1618 /* Check and set PSK Identity */
1619 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1620 if( ret != 0 )
1621 ssl_conf_remove_psk( conf );
1622
1623 return( ret );
1624}
1625
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001626static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1627{
1628#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001629 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001630 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001631 /* The maintenance of the external PSK key slot is the
1632 * user's responsibility. */
1633 if( ssl->handshake->psk_opaque_is_internal )
1634 {
1635 psa_destroy_key( ssl->handshake->psk_opaque );
1636 ssl->handshake->psk_opaque_is_internal = 0;
1637 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001638 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001639 }
Neil Armstronge952a302022-05-03 10:22:14 +02001640#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001641 if( ssl->handshake->psk != NULL )
1642 {
1643 mbedtls_platform_zeroize( ssl->handshake->psk,
1644 ssl->handshake->psk_len );
1645 mbedtls_free( ssl->handshake->psk );
1646 ssl->handshake->psk_len = 0;
1647 }
Neil Armstronge952a302022-05-03 10:22:14 +02001648#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001649}
1650
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001651int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1652 const unsigned char *psk, size_t psk_len )
1653{
Neil Armstrong501c9322022-05-03 09:35:09 +02001654#if defined(MBEDTLS_USE_PSA_CRYPTO)
1655 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1656 psa_status_t status;
1657 psa_algorithm_t alg;
1658 mbedtls_svc_key_id_t key;
1659#endif /* MBEDTLS_USE_PSA_CRYPTO */
1660
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001661 if( psk == NULL || ssl->handshake == NULL )
1662 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1663
1664 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1665 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1666
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001667 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001668
Neil Armstrong501c9322022-05-03 09:35:09 +02001669#if defined(MBEDTLS_USE_PSA_CRYPTO)
1670 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1671 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1672 else
1673 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1674
1675 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1676 psa_set_key_algorithm( &key_attributes, alg );
1677 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1678
1679 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1680 if( status != PSA_SUCCESS )
1681 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1682
1683 /* Allow calling psa_destroy_key() on psk remove */
1684 ssl->handshake->psk_opaque_is_internal = 1;
1685 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1686#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001687 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001688 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001689
1690 ssl->handshake->psk_len = psk_len;
1691 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1692
1693 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001694#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001695}
1696
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001697#if defined(MBEDTLS_USE_PSA_CRYPTO)
1698int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001699 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001700 const unsigned char *psk_identity,
1701 size_t psk_identity_len )
1702{
Janos Follath865b3eb2019-12-16 11:46:15 +00001703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001704
1705 /* We currently only support one PSK, raw or opaque. */
1706 if( ssl_conf_psk_is_configured( conf ) )
1707 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001708
Hanno Becker7390c712018-11-15 13:33:04 +00001709 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001710 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001711 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001712 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001713
1714 /* Check and set PSK Identity */
1715 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1716 psk_identity_len );
1717 if( ret != 0 )
1718 ssl_conf_remove_psk( conf );
1719
1720 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001721}
1722
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001723int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1724 mbedtls_svc_key_id_t psk )
1725{
1726 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1727 ( ssl->handshake == NULL ) )
1728 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1729
1730 ssl_remove_psk( ssl );
1731 ssl->handshake->psk_opaque = psk;
1732 return( 0 );
1733}
1734#endif /* MBEDTLS_USE_PSA_CRYPTO */
1735
1736void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1737 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1738 size_t),
1739 void *p_psk )
1740{
1741 conf->f_psk = f_psk;
1742 conf->p_psk = p_psk;
1743}
1744#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1745
1746#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001747static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1748 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001749{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001750#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001751 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001752 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001753#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001754 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001755 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001756 return( MBEDTLS_SSL_MODE_STREAM );
1757}
1758
1759#else /* MBEDTLS_USE_PSA_CRYPTO */
1760
1761static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1762 mbedtls_cipher_mode_t mode )
1763{
1764#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1765 if( mode == MBEDTLS_MODE_CBC )
1766 return( MBEDTLS_SSL_MODE_CBC );
1767#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1768
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001769#if defined(MBEDTLS_GCM_C) || \
1770 defined(MBEDTLS_CCM_C) || \
1771 defined(MBEDTLS_CHACHAPOLY_C)
1772 if( mode == MBEDTLS_MODE_GCM ||
1773 mode == MBEDTLS_MODE_CCM ||
1774 mode == MBEDTLS_MODE_CHACHAPOLY )
1775 return( MBEDTLS_SSL_MODE_AEAD );
1776#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001777
1778 return( MBEDTLS_SSL_MODE_STREAM );
1779}
Gilles Peskine301711e2022-04-26 16:57:05 +02001780#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001781
Gilles Peskinee108d982022-04-26 16:50:40 +02001782static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1783 mbedtls_ssl_mode_t base_mode,
1784 int encrypt_then_mac )
1785{
1786#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1787 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1788 base_mode == MBEDTLS_SSL_MODE_CBC )
1789 {
1790 return( MBEDTLS_SSL_MODE_CBC_ETM );
1791 }
1792#else
1793 (void) encrypt_then_mac;
1794#endif
1795 return( base_mode );
1796}
1797
Neil Armstrongab555e02022-04-04 11:07:59 +02001798mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001799 const mbedtls_ssl_transform *transform )
1800{
Gilles Peskinee108d982022-04-26 16:50:40 +02001801 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001802#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001803 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001804#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001805 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1806#endif
1807 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001808
Gilles Peskinee108d982022-04-26 16:50:40 +02001809 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001810#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001811 encrypt_then_mac = transform->encrypt_then_mac;
1812#endif
1813 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001814}
1815
Neil Armstrongab555e02022-04-04 11:07:59 +02001816mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001817#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001818 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001819#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001820 const mbedtls_ssl_ciphersuite_t *suite )
1821{
Gilles Peskinee108d982022-04-26 16:50:40 +02001822 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1823
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001824#if defined(MBEDTLS_USE_PSA_CRYPTO)
1825 psa_status_t status;
1826 psa_algorithm_t alg;
1827 psa_key_type_t type;
1828 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001829 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1830 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001831 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001832#else
1833 const mbedtls_cipher_info_t *cipher =
1834 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001835 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001836 {
1837 base_mode =
1838 mbedtls_ssl_get_base_mode(
1839 mbedtls_cipher_info_get_mode( cipher ) );
1840 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001841#endif /* MBEDTLS_USE_PSA_CRYPTO */
1842
Gilles Peskinee108d982022-04-26 16:50:40 +02001843#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1844 int encrypt_then_mac = 0;
1845#endif
1846 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001847}
1848
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001849#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001850psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001851 size_t taglen,
1852 psa_algorithm_t *alg,
1853 psa_key_type_t *key_type,
1854 size_t *key_size )
1855{
1856 switch ( mbedtls_cipher_type )
1857 {
1858 case MBEDTLS_CIPHER_AES_128_CBC:
1859 *alg = PSA_ALG_CBC_NO_PADDING;
1860 *key_type = PSA_KEY_TYPE_AES;
1861 *key_size = 128;
1862 break;
1863 case MBEDTLS_CIPHER_AES_128_CCM:
1864 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1865 *key_type = PSA_KEY_TYPE_AES;
1866 *key_size = 128;
1867 break;
1868 case MBEDTLS_CIPHER_AES_128_GCM:
1869 *alg = PSA_ALG_GCM;
1870 *key_type = PSA_KEY_TYPE_AES;
1871 *key_size = 128;
1872 break;
1873 case MBEDTLS_CIPHER_AES_192_CCM:
1874 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1875 *key_type = PSA_KEY_TYPE_AES;
1876 *key_size = 192;
1877 break;
1878 case MBEDTLS_CIPHER_AES_192_GCM:
1879 *alg = PSA_ALG_GCM;
1880 *key_type = PSA_KEY_TYPE_AES;
1881 *key_size = 192;
1882 break;
1883 case MBEDTLS_CIPHER_AES_256_CBC:
1884 *alg = PSA_ALG_CBC_NO_PADDING;
1885 *key_type = PSA_KEY_TYPE_AES;
1886 *key_size = 256;
1887 break;
1888 case MBEDTLS_CIPHER_AES_256_CCM:
1889 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1890 *key_type = PSA_KEY_TYPE_AES;
1891 *key_size = 256;
1892 break;
1893 case MBEDTLS_CIPHER_AES_256_GCM:
1894 *alg = PSA_ALG_GCM;
1895 *key_type = PSA_KEY_TYPE_AES;
1896 *key_size = 256;
1897 break;
1898 case MBEDTLS_CIPHER_ARIA_128_CBC:
1899 *alg = PSA_ALG_CBC_NO_PADDING;
1900 *key_type = PSA_KEY_TYPE_ARIA;
1901 *key_size = 128;
1902 break;
1903 case MBEDTLS_CIPHER_ARIA_128_CCM:
1904 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1905 *key_type = PSA_KEY_TYPE_ARIA;
1906 *key_size = 128;
1907 break;
1908 case MBEDTLS_CIPHER_ARIA_128_GCM:
1909 *alg = PSA_ALG_GCM;
1910 *key_type = PSA_KEY_TYPE_ARIA;
1911 *key_size = 128;
1912 break;
1913 case MBEDTLS_CIPHER_ARIA_192_CCM:
1914 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1915 *key_type = PSA_KEY_TYPE_ARIA;
1916 *key_size = 192;
1917 break;
1918 case MBEDTLS_CIPHER_ARIA_192_GCM:
1919 *alg = PSA_ALG_GCM;
1920 *key_type = PSA_KEY_TYPE_ARIA;
1921 *key_size = 192;
1922 break;
1923 case MBEDTLS_CIPHER_ARIA_256_CBC:
1924 *alg = PSA_ALG_CBC_NO_PADDING;
1925 *key_type = PSA_KEY_TYPE_ARIA;
1926 *key_size = 256;
1927 break;
1928 case MBEDTLS_CIPHER_ARIA_256_CCM:
1929 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1930 *key_type = PSA_KEY_TYPE_ARIA;
1931 *key_size = 256;
1932 break;
1933 case MBEDTLS_CIPHER_ARIA_256_GCM:
1934 *alg = PSA_ALG_GCM;
1935 *key_type = PSA_KEY_TYPE_ARIA;
1936 *key_size = 256;
1937 break;
1938 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1939 *alg = PSA_ALG_CBC_NO_PADDING;
1940 *key_type = PSA_KEY_TYPE_CAMELLIA;
1941 *key_size = 128;
1942 break;
1943 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1944 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1945 *key_type = PSA_KEY_TYPE_CAMELLIA;
1946 *key_size = 128;
1947 break;
1948 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1949 *alg = PSA_ALG_GCM;
1950 *key_type = PSA_KEY_TYPE_CAMELLIA;
1951 *key_size = 128;
1952 break;
1953 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1954 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1955 *key_type = PSA_KEY_TYPE_CAMELLIA;
1956 *key_size = 192;
1957 break;
1958 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1959 *alg = PSA_ALG_GCM;
1960 *key_type = PSA_KEY_TYPE_CAMELLIA;
1961 *key_size = 192;
1962 break;
1963 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1964 *alg = PSA_ALG_CBC_NO_PADDING;
1965 *key_type = PSA_KEY_TYPE_CAMELLIA;
1966 *key_size = 256;
1967 break;
1968 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1969 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1970 *key_type = PSA_KEY_TYPE_CAMELLIA;
1971 *key_size = 256;
1972 break;
1973 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1974 *alg = PSA_ALG_GCM;
1975 *key_type = PSA_KEY_TYPE_CAMELLIA;
1976 *key_size = 256;
1977 break;
1978 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1979 *alg = PSA_ALG_CHACHA20_POLY1305;
1980 *key_type = PSA_KEY_TYPE_CHACHA20;
1981 *key_size = 256;
1982 break;
1983 case MBEDTLS_CIPHER_NULL:
1984 *alg = MBEDTLS_SSL_NULL_CIPHER;
1985 *key_type = 0;
1986 *key_size = 0;
1987 break;
1988 default:
1989 return PSA_ERROR_NOT_SUPPORTED;
1990 }
1991
1992 return PSA_SUCCESS;
1993}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001994#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001995
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001996#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001997int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1998 const unsigned char *dhm_P, size_t P_len,
1999 const unsigned char *dhm_G, size_t G_len )
2000{
Janos Follath865b3eb2019-12-16 11:46:15 +00002001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002002
Glenn Strausscee11292021-12-20 01:43:17 -05002003 mbedtls_mpi_free( &conf->dhm_P );
2004 mbedtls_mpi_free( &conf->dhm_G );
2005
Hanno Beckera90658f2017-10-04 15:29:08 +01002006 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2007 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2008 {
2009 mbedtls_mpi_free( &conf->dhm_P );
2010 mbedtls_mpi_free( &conf->dhm_G );
2011 return( ret );
2012 }
2013
2014 return( 0 );
2015}
Paul Bakker5121ce52009-01-03 21:22:43 +00002016
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002017int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002018{
Janos Follath865b3eb2019-12-16 11:46:15 +00002019 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002020
Glenn Strausscee11292021-12-20 01:43:17 -05002021 mbedtls_mpi_free( &conf->dhm_P );
2022 mbedtls_mpi_free( &conf->dhm_G );
2023
Gilles Peskinee5702482021-06-11 21:59:08 +02002024 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2025 &conf->dhm_P ) ) != 0 ||
2026 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2027 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002028 {
2029 mbedtls_mpi_free( &conf->dhm_P );
2030 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002031 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002032 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002033
2034 return( 0 );
2035}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002036#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002037
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002038#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2039/*
2040 * Set the minimum length for Diffie-Hellman parameters
2041 */
2042void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2043 unsigned int bitlen )
2044{
2045 conf->dhm_min_bitlen = bitlen;
2046}
2047#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2048
Gilles Peskineeccd8882020-03-10 12:19:08 +01002049#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002050#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002051/*
2052 * Set allowed/preferred hashes for handshake signatures
2053 */
2054void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2055 const int *hashes )
2056{
2057 conf->sig_hashes = hashes;
2058}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002059#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002060
Jerry Yuf017ee42022-01-12 15:49:48 +08002061/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002062void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2063 const uint16_t* sig_algs )
2064{
Jerry Yuf017ee42022-01-12 15:49:48 +08002065#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2066 conf->sig_hashes = NULL;
2067#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2068 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002069}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002070#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002071
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002072#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002073#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002074/*
2075 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002076 *
2077 * mbedtls_ssl_setup() takes the provided list
2078 * and translates it to a list of IANA TLS group identifiers,
2079 * stored in ssl->handshake->group_list.
2080 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002081 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002082void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002083 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002084{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002085 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002086 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002087}
Brett Warrene0edc842021-08-17 09:53:13 +01002088#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002089#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002090
Brett Warrene0edc842021-08-17 09:53:13 +01002091/*
2092 * Set the allowed groups
2093 */
2094void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2095 const uint16_t *group_list )
2096{
2097#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2098 conf->curve_list = NULL;
2099#endif
2100 conf->group_list = group_list;
2101}
2102
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002103#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002105{
Hanno Becker947194e2017-04-07 13:25:49 +01002106 /* Initialize to suppress unnecessary compiler warning */
2107 size_t hostname_len = 0;
2108
2109 /* Check if new hostname is valid before
2110 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002111 if( hostname != NULL )
2112 {
2113 hostname_len = strlen( hostname );
2114
2115 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2116 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2117 }
2118
2119 /* Now it's clear that we will overwrite the old hostname,
2120 * so we can free it safely */
2121
2122 if( ssl->hostname != NULL )
2123 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002124 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002125 mbedtls_free( ssl->hostname );
2126 }
2127
2128 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002129
Paul Bakker5121ce52009-01-03 21:22:43 +00002130 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002131 {
2132 ssl->hostname = NULL;
2133 }
2134 else
2135 {
2136 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002137 if( ssl->hostname == NULL )
2138 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002139
Hanno Becker947194e2017-04-07 13:25:49 +01002140 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002141
Hanno Becker947194e2017-04-07 13:25:49 +01002142 ssl->hostname[hostname_len] = '\0';
2143 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002144
2145 return( 0 );
2146}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002147#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002148
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002149#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002150void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002152 const unsigned char *, size_t),
2153 void *p_sni )
2154{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002155 conf->f_sni = f_sni;
2156 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002157}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002161int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002162{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002163 size_t cur_len, tot_len;
2164 const char **p;
2165
2166 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002167 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2168 * MUST NOT be truncated."
2169 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002170 */
2171 tot_len = 0;
2172 for( p = protos; *p != NULL; p++ )
2173 {
2174 cur_len = strlen( *p );
2175 tot_len += cur_len;
2176
Ronald Cron8216dd32020-04-23 16:41:44 +02002177 if( ( cur_len == 0 ) ||
2178 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2179 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002181 }
2182
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002183 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002184
2185 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002186}
2187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002189{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002190 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002191}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002192#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002193
Johan Pascalb62bb512015-12-03 21:56:45 +01002194#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002195void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2196 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002197{
2198 conf->dtls_srtp_mki_support = support_mki_value;
2199}
2200
Ron Eldoref72faf2018-07-12 11:54:20 +03002201int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2202 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002203 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002204{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002205 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002206 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002207 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002208 }
Ron Eldor591f1622018-01-22 12:30:04 +02002209
2210 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002211 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002212 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002213 }
Ron Eldor591f1622018-01-22 12:30:04 +02002214
2215 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2216 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002217 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002218}
2219
Ron Eldoref72faf2018-07-12 11:54:20 +03002220int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002221 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002222{
Johan Pascal253d0262020-09-22 13:04:45 +02002223 const mbedtls_ssl_srtp_profile *p;
2224 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002225
Johan Pascal253d0262020-09-22 13:04:45 +02002226 /* check the profiles list: all entry must be valid,
2227 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002228 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2229 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2230 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002231 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002232 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002233 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002234 list_size++;
2235 }
2236 else
2237 {
2238 /* unsupported value, stop parsing and set the size to an error value */
2239 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002240 }
2241 }
2242
Johan Pascal5ef72d22020-10-28 17:05:47 +01002243 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002244 {
Johan Pascal253d0262020-09-22 13:04:45 +02002245 conf->dtls_srtp_profile_list = NULL;
2246 conf->dtls_srtp_profile_list_len = 0;
2247 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2248 }
2249
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002250 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002251 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002252
2253 return( 0 );
2254}
2255
Johan Pascal5ef72d22020-10-28 17:05:47 +01002256void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2257 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002258{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002259 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2260 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002261 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002262 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002263 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002264 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002265 else
2266 {
2267 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002268 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2269 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002270 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002271}
Johan Pascalb62bb512015-12-03 21:56:45 +01002272#endif /* MBEDTLS_SSL_DTLS_SRTP */
2273
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002274void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002275{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002276 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002277}
2278
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002279void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002280{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002281 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002282}
2283
Janos Follath088ce432017-04-10 12:42:31 +01002284#if defined(MBEDTLS_SSL_SRV_C)
2285void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2286 char cert_req_ca_list )
2287{
2288 conf->cert_req_ca_list = cert_req_ca_list;
2289}
2290#endif
2291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002293void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002294{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002295 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002296}
2297#endif
2298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002300void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002301{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002302 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002303}
2304#endif
2305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002307int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002308{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002310 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002311 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002313 }
2314
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002315 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002316
2317 return( 0 );
2318}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002320
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002321void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002322{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002323 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002324}
2325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002327void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002328{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002329 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002330}
2331
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002332void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002333{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002334 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002335}
2336
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002337void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002338 const unsigned char period[8] )
2339{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002340 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002341}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002345#if defined(MBEDTLS_SSL_CLI_C)
2346void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002347{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002348 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002349}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002350#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002351
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002352#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002353void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2354 mbedtls_ssl_ticket_write_t *f_ticket_write,
2355 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2356 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002357{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002358 conf->f_ticket_write = f_ticket_write;
2359 conf->f_ticket_parse = f_ticket_parse;
2360 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002361}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002362#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002364
Hanno Becker7e6c1782021-06-08 09:24:55 +01002365void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2366 mbedtls_ssl_export_keys_t *f_export_keys,
2367 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002368{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002369 ssl->f_export_keys = f_export_keys;
2370 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002371}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002372
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002373#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002374void mbedtls_ssl_conf_async_private_cb(
2375 mbedtls_ssl_config *conf,
2376 mbedtls_ssl_async_sign_t *f_async_sign,
2377 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2378 mbedtls_ssl_async_resume_t *f_async_resume,
2379 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002380 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002381{
2382 conf->f_async_sign_start = f_async_sign;
2383 conf->f_async_decrypt_start = f_async_decrypt;
2384 conf->f_async_resume = f_async_resume;
2385 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002386 conf->p_async_config_data = async_config_data;
2387}
2388
Gilles Peskine8f97af72018-04-26 11:46:10 +02002389void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2390{
2391 return( conf->p_async_config_data );
2392}
2393
Gilles Peskine1febfef2018-04-30 11:54:39 +02002394void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002395{
2396 if( ssl->handshake == NULL )
2397 return( NULL );
2398 else
2399 return( ssl->handshake->user_async_ctx );
2400}
2401
Gilles Peskine1febfef2018-04-30 11:54:39 +02002402void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002403 void *ctx )
2404{
2405 if( ssl->handshake != NULL )
2406 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002407}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002408#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002409
Paul Bakker5121ce52009-01-03 21:22:43 +00002410/*
2411 * SSL get accessors
2412 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002413uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002414{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002415 if( ssl->session != NULL )
2416 return( ssl->session->verify_result );
2417
2418 if( ssl->session_negotiate != NULL )
2419 return( ssl->session_negotiate->verify_result );
2420
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002421 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002422}
2423
Glenn Strauss8f526902022-01-13 00:04:49 -05002424int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2425{
2426 if( ssl == NULL || ssl->session == NULL )
2427 return( 0 );
2428
2429 return( ssl->session->ciphersuite );
2430}
2431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002433{
Paul Bakker926c8e42013-03-06 10:23:34 +01002434 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002435 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002438}
2439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002441{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002443 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002444 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002445 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002446 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002447 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002448 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002449 default:
2450 return( "unknown (DTLS)" );
2451 }
2452 }
2453#endif
2454
Glenn Strauss60bfe602022-03-14 19:04:24 -04002455 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002456 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002457 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002458 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002459 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002460 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002461 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002462 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002463 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002464}
2465
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002466#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002467size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2468{
David Horstmann95d516f2021-05-04 18:36:56 +01002469 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002470 size_t read_mfl;
2471
2472 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2473 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2474 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2475 {
2476 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2477 }
2478
2479 /* Check if a smaller max length was negotiated */
2480 if( ssl->session_out != NULL )
2481 {
2482 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2483 if( read_mfl < max_len )
2484 {
2485 max_len = read_mfl;
2486 }
2487 }
2488
2489 // During a handshake, use the value being negotiated
2490 if( ssl->session_negotiate != NULL )
2491 {
2492 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2493 if( read_mfl < max_len )
2494 {
2495 max_len = read_mfl;
2496 }
2497 }
2498
2499 return( max_len );
2500}
2501
2502size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002503{
2504 size_t max_len;
2505
2506 /*
2507 * Assume mfl_code is correct since it was checked when set
2508 */
Angus Grattond8213d02016-05-25 20:56:48 +10002509 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002510
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002511 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002512 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002513 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002514 {
Angus Grattond8213d02016-05-25 20:56:48 +10002515 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002516 }
2517
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002518 /* During a handshake, use the value being negotiated */
2519 if( ssl->session_negotiate != NULL &&
2520 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2521 {
2522 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2523 }
2524
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002525 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002526}
2527#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2528
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002529#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002530size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002531{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002532 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2533 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2534 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2535 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2536 return ( 0 );
2537
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002538 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2539 return( ssl->mtu );
2540
2541 if( ssl->mtu == 0 )
2542 return( ssl->handshake->mtu );
2543
2544 return( ssl->mtu < ssl->handshake->mtu ?
2545 ssl->mtu : ssl->handshake->mtu );
2546}
2547#endif /* MBEDTLS_SSL_PROTO_DTLS */
2548
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002549int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2550{
2551 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2552
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002553#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2554 !defined(MBEDTLS_SSL_PROTO_DTLS)
2555 (void) ssl;
2556#endif
2557
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002558#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002559 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002560
2561 if( max_len > mfl )
2562 max_len = mfl;
2563#endif
2564
2565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002566 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002567 {
Hanno Becker89490712020-02-05 10:50:12 +00002568 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002569 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2570 const size_t overhead = (size_t) ret;
2571
2572 if( ret < 0 )
2573 return( ret );
2574
2575 if( mtu <= overhead )
2576 {
2577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2578 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2579 }
2580
2581 if( max_len > mtu - overhead )
2582 max_len = mtu - overhead;
2583 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002584#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002585
Hanno Becker0defedb2018-08-10 12:35:02 +01002586#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2587 !defined(MBEDTLS_SSL_PROTO_DTLS)
2588 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002589#endif
2590
2591 return( (int) max_len );
2592}
2593
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002594int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2595{
2596 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2597
2598#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2599 (void) ssl;
2600#endif
2601
2602#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2603 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2604
2605 if( max_len > mfl )
2606 max_len = mfl;
2607#endif
2608
2609 return( (int) max_len );
2610}
2611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612#if defined(MBEDTLS_X509_CRT_PARSE_C)
2613const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002614{
2615 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002616 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002617
Hanno Beckere6824572019-02-07 13:18:46 +00002618#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002619 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002620#else
2621 return( NULL );
2622#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002623}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002627int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2628 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002629{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002630 int ret;
2631
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002632 if( ssl == NULL ||
2633 dst == NULL ||
2634 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002635 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002638 }
2639
Hanno Beckere810bbc2021-05-14 16:01:05 +01002640 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2641 * idempotent: Each session can only be exported once.
2642 *
2643 * (This is in preparation for TLS 1.3 support where we will
2644 * need the ability to export multiple sessions (aka tickets),
2645 * which will be achieved by calling mbedtls_ssl_get_session()
2646 * multiple times until it fails.)
2647 *
2648 * Check whether we have already exported the current session,
2649 * and fail if so.
2650 */
2651 if( ssl->session->exported == 1 )
2652 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2653
2654 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2655 if( ret != 0 )
2656 return( ret );
2657
2658 /* Remember that we've exported the session. */
2659 ssl->session->exported = 1;
2660 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002663
Paul Bakker5121ce52009-01-03 21:22:43 +00002664/*
Hanno Beckera835da52019-05-16 12:39:07 +01002665 * Define ticket header determining Mbed TLS version
2666 * and structure of the ticket.
2667 */
2668
Hanno Becker94ef3b32019-05-16 12:50:45 +01002669/*
Hanno Becker50b59662019-05-28 14:30:45 +01002670 * Define bitflag determining compile-time settings influencing
2671 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002672 */
2673
Hanno Becker50b59662019-05-28 14:30:45 +01002674#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002675#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002676#else
Hanno Becker3e088662019-05-29 11:10:18 +01002677#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002678#endif /* MBEDTLS_HAVE_TIME */
2679
2680#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002681#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002682#else
Hanno Becker3e088662019-05-29 11:10:18 +01002683#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002684#endif /* MBEDTLS_X509_CRT_PARSE_C */
2685
2686#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002687#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002688#else
Hanno Becker3e088662019-05-29 11:10:18 +01002689#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002690#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2691
2692#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002693#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002694#else
Hanno Becker3e088662019-05-29 11:10:18 +01002695#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002696#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2697
Hanno Becker94ef3b32019-05-16 12:50:45 +01002698#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002699#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002700#else
Hanno Becker3e088662019-05-29 11:10:18 +01002701#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002702#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2703
Hanno Becker94ef3b32019-05-16 12:50:45 +01002704#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2705#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2706#else
2707#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2708#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2709
Hanno Becker3e088662019-05-29 11:10:18 +01002710#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2711#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2712#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2713#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002714#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2715#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002716
Hanno Becker50b59662019-05-28 14:30:45 +01002717#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002718 ( (uint16_t) ( \
2719 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2720 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2721 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2722 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002723 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002724 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002725
Hanno Beckerf8787072019-05-16 12:41:07 +01002726static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002727 MBEDTLS_VERSION_MAJOR,
2728 MBEDTLS_VERSION_MINOR,
2729 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002730 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2731 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002732};
Hanno Beckera835da52019-05-16 12:39:07 +01002733
2734/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002735 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002736 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002737 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002738 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002739 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002740 * opaque mbedtls_version[3]; // library version: major, minor, patch
2741 * opaque session_format[2]; // library-version specific 16-bit field
2742 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002743 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002744 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002745 * Note: When updating the format, remember to keep
2746 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002747 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002748 * // In this version, `session_format` determines
2749 * // the setting of those compile-time
2750 * // configuration options which influence
2751 * // the structure of mbedtls_ssl_session.
2752 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002753 * uint8_t minor_ver; // Protocol minor version. Possible values:
2754 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002755 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002756 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002757 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002758 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002759 * serialized_session_tls12 data;
2760 *
2761 * };
2762 *
2763 * } serialized_session;
2764 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002765 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002766
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002767static int ssl_session_save( const mbedtls_ssl_session *session,
2768 unsigned char omit_header,
2769 unsigned char *buf,
2770 size_t buf_len,
2771 size_t *olen )
2772{
2773 unsigned char *p = buf;
2774 size_t used = 0;
2775
2776 if( !omit_header )
2777 {
2778 /*
2779 * Add Mbed TLS version identifier
2780 */
2781
2782 used += sizeof( ssl_serialized_session_header );
2783
2784 if( used <= buf_len )
2785 {
2786 memcpy( p, ssl_serialized_session_header,
2787 sizeof( ssl_serialized_session_header ) );
2788 p += sizeof( ssl_serialized_session_header );
2789 }
2790 }
2791
2792 /*
2793 * TLS version identifier
2794 */
2795 used += 1;
2796 if( used <= buf_len )
2797 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002798 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002799 }
2800
2801 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002802 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002803 {
2804#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002805 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002806 {
2807 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2808 used += ssl_session_save_tls12( session, p, remaining_len );
2809 break;
2810 }
2811#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2812
2813 default:
2814 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2815 }
2816
2817 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002818 if( used > buf_len )
2819 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002820
2821 return( 0 );
2822}
2823
2824/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002825 * Public wrapper for ssl_session_save()
2826 */
2827int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2828 unsigned char *buf,
2829 size_t buf_len,
2830 size_t *olen )
2831{
2832 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2833}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002834
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002835/*
2836 * Deserialize session, see mbedtls_ssl_session_save() for format.
2837 *
2838 * This internal version is wrapped by a public function that cleans up in
2839 * case of error, and has an extra option omit_header.
2840 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002841static int ssl_session_load( mbedtls_ssl_session *session,
2842 unsigned char omit_header,
2843 const unsigned char *buf,
2844 size_t len )
2845{
2846 const unsigned char *p = buf;
2847 const unsigned char * const end = buf + len;
2848
2849 if( !omit_header )
2850 {
2851 /*
2852 * Check Mbed TLS version identifier
2853 */
2854
2855 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2856 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2857
2858 if( memcmp( p, ssl_serialized_session_header,
2859 sizeof( ssl_serialized_session_header ) ) != 0 )
2860 {
2861 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2862 }
2863 p += sizeof( ssl_serialized_session_header );
2864 }
2865
2866 /*
2867 * TLS version identifier
2868 */
2869 if( 1 > (size_t)( end - p ) )
2870 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002871 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002872
2873 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002874 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002875 {
2876#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002877 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002878 {
2879 size_t remaining_len = ( end - p );
2880 return( ssl_session_load_tls12( session, p, remaining_len ) );
2881 }
2882#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2883
2884 default:
2885 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2886 }
2887}
2888
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002889/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002890 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002891 */
2892int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2893 const unsigned char *buf,
2894 size_t len )
2895{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002896 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002897
2898 if( ret != 0 )
2899 mbedtls_ssl_session_free( session );
2900
2901 return( ret );
2902}
2903
2904/*
Paul Bakker1961b702013-01-25 14:49:24 +01002905 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002906 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002907static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2908{
2909 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2910
Ronald Cron66dbf912022-02-02 15:33:46 +01002911 /*
2912 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002913 * that were written into the output buffer by the previous handshake step,
2914 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002915 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2916 * We proceed to the next handshake step only when all data from the
2917 * previous one have been sent to the peer, thus we make sure that this is
2918 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2919 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2920 * we have to wait before to go ahead.
2921 * In the case of TLS 1.3, handshake step handlers do not send data to the
2922 * peer. Data are only sent here and through
2923 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002924 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002925 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002926 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2927 return( ret );
2928
2929#if defined(MBEDTLS_SSL_PROTO_DTLS)
2930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2931 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2932 {
2933 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2934 return( ret );
2935 }
2936#endif /* MBEDTLS_SSL_PROTO_DTLS */
2937
2938 return( ret );
2939}
2940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002942{
Hanno Becker41934dd2021-08-07 19:13:43 +01002943 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002944
Hanno Becker41934dd2021-08-07 19:13:43 +01002945 if( ssl == NULL ||
2946 ssl->conf == NULL ||
2947 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002948 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002949 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002951 }
2952
2953 ret = ssl_prepare_handshake_step( ssl );
2954 if( ret != 0 )
2955 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002956
Jerry Yue7047812021-09-13 19:26:39 +08002957 ret = mbedtls_ssl_handle_pending_alert( ssl );
2958 if( ret != 0 )
2959 goto cleanup;
2960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002962 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002963 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2965 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002966
Ronald Cron9f0fba32022-02-10 16:45:15 +01002967 switch( ssl->state )
2968 {
2969 case MBEDTLS_SSL_HELLO_REQUEST:
2970 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2971 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002972
Ronald Cron9f0fba32022-02-10 16:45:15 +01002973 case MBEDTLS_SSL_CLIENT_HELLO:
2974 ret = mbedtls_ssl_write_client_hello( ssl );
2975 break;
2976
2977 default:
2978#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002979 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002980 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2981 else
2982 ret = mbedtls_ssl_handshake_client_step( ssl );
2983#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2984 ret = mbedtls_ssl_handshake_client_step( ssl );
2985#else
2986 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2987#endif
2988 }
Jerry Yub9930e72021-08-06 17:11:51 +08002989 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002990#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002992 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002993 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002994#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002995 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002996 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002997#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002998
2999#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3000 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3001 ret = mbedtls_ssl_handshake_server_step( ssl );
3002#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3003 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003004#endif
3005
Jerry Yue7047812021-09-13 19:26:39 +08003006 if( ret != 0 )
3007 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003008 /* handshake_step return error. And it is same
3009 * with alert_reason.
3010 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003011 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003012 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003013 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003014 goto cleanup;
3015 }
3016 }
3017
3018cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003019 return( ret );
3020}
3021
3022/*
3023 * Perform the SSL handshake
3024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003026{
3027 int ret = 0;
3028
Hanno Beckera817ea42020-10-20 15:20:23 +01003029 /* Sanity checks */
3030
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003031 if( ssl == NULL || ssl->conf == NULL )
3032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3033
Hanno Beckera817ea42020-10-20 15:20:23 +01003034#if defined(MBEDTLS_SSL_PROTO_DTLS)
3035 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3036 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3037 {
3038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3039 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3040 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3041 }
3042#endif /* MBEDTLS_SSL_PROTO_DTLS */
3043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003045
Hanno Beckera817ea42020-10-20 15:20:23 +01003046 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003047 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003048 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003050
3051 if( ret != 0 )
3052 break;
3053 }
3054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003056
3057 return( ret );
3058}
3059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060#if defined(MBEDTLS_SSL_RENEGOTIATION)
3061#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003062/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003063 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003066{
Janos Follath865b3eb2019-12-16 11:46:15 +00003067 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003070
3071 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3073 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003074
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003075 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003076 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003077 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003078 return( ret );
3079 }
3080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003082
3083 return( 0 );
3084}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003086
3087/*
3088 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 * - any side: calling mbedtls_ssl_renegotiate(),
3090 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3091 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003092 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003093 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003095 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003096int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003097{
Janos Follath865b3eb2019-12-16 11:46:15 +00003098 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003099
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003101
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003102 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3103 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003104
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003105 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3106 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003108 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003110 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003111 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003112 ssl->handshake->out_msg_seq = 1;
3113 else
3114 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003115 }
3116#endif
3117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3119 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003122 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003124 return( ret );
3125 }
3126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003128
3129 return( 0 );
3130}
3131
3132/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003133 * Renegotiate current connection on client,
3134 * or request renegotiation on server
3135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003137{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003139
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003140 if( ssl == NULL || ssl->conf == NULL )
3141 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003144 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003145 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003146 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003147 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003151
3152 /* Did we already try/start sending HelloRequest? */
3153 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003155
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003156 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003157 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003161 /*
3162 * On client, either start the renegotiation process or,
3163 * if already in progress, continue the handshake
3164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003166 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003167 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003169
Hanno Becker40cdaa12020-02-05 10:48:27 +00003170 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003171 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003172 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003173 return( ret );
3174 }
3175 }
3176 else
3177 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003180 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003181 return( ret );
3182 }
3183 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003185
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003186 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003187}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003189
Gilles Peskine9b562d52018-04-25 20:32:43 +02003190void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003191{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003192 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3193
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003194 if( handshake == NULL )
3195 return;
3196
Brett Warrene0edc842021-08-17 09:53:13 +01003197#if defined(MBEDTLS_ECP_C)
3198#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3199 if ( ssl->handshake->group_list_heap_allocated )
3200 mbedtls_free( (void*) handshake->group_list );
3201 handshake->group_list = NULL;
3202#endif /* MBEDTLS_DEPRECATED_REMOVED */
3203#endif /* MBEDTLS_ECP_C */
3204
Jerry Yuf017ee42022-01-12 15:49:48 +08003205#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3206#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3207 if ( ssl->handshake->sig_algs_heap_allocated )
3208 mbedtls_free( (void*) handshake->sig_algs );
3209 handshake->sig_algs = NULL;
3210#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003211#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3212 if( ssl->handshake->certificate_request_context )
3213 {
3214 mbedtls_free( (void*) handshake->certificate_request_context );
3215 }
3216#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003217#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3218
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003219#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3220 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3221 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003222 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003223 handshake->async_in_progress = 0;
3224 }
3225#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3226
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003227#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003228#if defined(MBEDTLS_USE_PSA_CRYPTO)
3229 psa_hash_abort( &handshake->fin_sha256_psa );
3230#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003231 mbedtls_sha256_free( &handshake->fin_sha256 );
3232#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003233#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003234#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003235#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003236 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003237#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003238 mbedtls_sha512_free( &handshake->fin_sha512 );
3239#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003240#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242#if defined(MBEDTLS_DHM_C)
3243 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003244#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003245#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003247#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003248#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003249 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003250#if defined(MBEDTLS_SSL_CLI_C)
3251 mbedtls_free( handshake->ecjpake_cache );
3252 handshake->ecjpake_cache = NULL;
3253 handshake->ecjpake_cache_len = 0;
3254#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003255#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003256
Janos Follath4ae5c292016-02-10 11:27:43 +00003257#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3258 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003259 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003261#endif
3262
Gilles Peskineeccd8882020-03-10 12:19:08 +01003263#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003264#if defined(MBEDTLS_USE_PSA_CRYPTO)
3265 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3266 {
3267 /* The maintenance of the external PSK key slot is the
3268 * user's responsibility. */
3269 if( ssl->handshake->psk_opaque_is_internal )
3270 {
3271 psa_destroy_key( ssl->handshake->psk_opaque );
3272 ssl->handshake->psk_opaque_is_internal = 0;
3273 }
3274 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3275 }
Neil Armstronge952a302022-05-03 10:22:14 +02003276#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003277 if( handshake->psk != NULL )
3278 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003279 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003280 mbedtls_free( handshake->psk );
3281 }
Neil Armstronge952a302022-05-03 10:22:14 +02003282#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003283#endif
3284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3286 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003287 /*
3288 * Free only the linked list wrapper, not the keys themselves
3289 * since the belong to the SNI callback
3290 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003291 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003292#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003293
Gilles Peskineeccd8882020-03-10 12:19:08 +01003294#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003295 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003296 if( handshake->ecrs_peer_cert != NULL )
3297 {
3298 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3299 mbedtls_free( handshake->ecrs_peer_cert );
3300 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003301#endif
3302
Hanno Becker75173122019-02-06 16:18:31 +00003303#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3304 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3305 mbedtls_pk_free( &handshake->peer_pubkey );
3306#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3307
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003308#if defined(MBEDTLS_SSL_CLI_C) && \
3309 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3310 mbedtls_free( handshake->cookie );
3311#endif /* MBEDTLS_SSL_CLI_C &&
3312 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003313
3314#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003315 mbedtls_ssl_flight_free( handshake->flight );
3316 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003317#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003318
Ronald Cronf12b81d2022-03-15 10:42:41 +01003319#if defined(MBEDTLS_ECDH_C) && \
3320 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003321 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003322 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003323#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3324
Ronald Cron6f135e12021-12-08 16:57:54 +01003325#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003326 mbedtls_ssl_transform_free( handshake->transform_handshake );
3327 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003328 mbedtls_free( handshake->transform_earlydata );
3329 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003330#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003331
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003332
3333#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3334 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3335 * processes datagrams and the fact that a datagram is allowed to have
3336 * several records in it, it is possible that the I/O buffers are not
3337 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003338 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3339 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003340#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003341
Jerry Yuba9c7272021-10-30 11:54:10 +08003342 /* mbedtls_platform_zeroize MUST be last one in this function */
3343 mbedtls_platform_zeroize( handshake,
3344 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003345}
3346
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003348{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003349 if( session == NULL )
3350 return;
3351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003353 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003354#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003355
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003356#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003358#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003359
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003360 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003361}
3362
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003363#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003364
3365#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3366#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3367#else
3368#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3369#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3370
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003371#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003372
3373#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3374#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3375#else
3376#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3377#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3378
3379#if defined(MBEDTLS_SSL_ALPN)
3380#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3381#else
3382#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3383#endif /* MBEDTLS_SSL_ALPN */
3384
3385#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3386#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3387#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3388#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3389
3390#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3391 ( (uint32_t) ( \
3392 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3393 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3394 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3395 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3396 0u ) )
3397
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003398static unsigned char ssl_serialized_context_header[] = {
3399 MBEDTLS_VERSION_MAJOR,
3400 MBEDTLS_VERSION_MINOR,
3401 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003402 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3403 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3404 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3405 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3406 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003407};
3408
Paul Bakker5121ce52009-01-03 21:22:43 +00003409/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003410 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003411 *
3412 * The format of the serialized data is:
3413 * (in the presentation language of TLS, RFC 8446 section 3)
3414 *
3415 * // header
3416 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003417 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003418 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003419 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003420 * Note: When updating the format, remember to keep these
3421 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003422 *
3423 * // session sub-structure
3424 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3425 * // transform sub-structure
3426 * uint8 random[64]; // ServerHello.random+ClientHello.random
3427 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3428 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3429 * // fields from ssl_context
3430 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3431 * uint64 in_window_top; // DTLS: last validated record seq_num
3432 * uint64 in_window; // DTLS: bitmask for replay protection
3433 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3434 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3435 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3436 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3437 *
3438 * Note that many fields of the ssl_context or sub-structures are not
3439 * serialized, as they fall in one of the following categories:
3440 *
3441 * 1. forced value (eg in_left must be 0)
3442 * 2. pointer to dynamically-allocated memory (eg session, transform)
3443 * 3. value can be re-derived from other data (eg session keys from MS)
3444 * 4. value was temporary (eg content of input buffer)
3445 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003446 */
3447int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3448 unsigned char *buf,
3449 size_t buf_len,
3450 size_t *olen )
3451{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003452 unsigned char *p = buf;
3453 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003454 size_t session_len;
3455 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003456
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003457 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003458 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3459 * this function's documentation.
3460 *
3461 * These are due to assumptions/limitations in the implementation. Some of
3462 * them are likely to stay (no handshake in progress) some might go away
3463 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003464 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003465 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003466 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003467 {
3468 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003469 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003470 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003471 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003472 {
3473 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003474 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003475 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003476 /* Double-check that sub-structures are indeed ready */
3477 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003478 {
3479 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003480 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003481 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003482 /* There must be no pending incoming or outgoing data */
3483 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003484 {
3485 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003486 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003487 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003488 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003489 {
3490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003491 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003492 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003493 /* Protocol must be DLTS, not TLS */
3494 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003495 {
3496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003498 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003499 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003500 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003501 {
3502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003503 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003504 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003505 /* We must be using an AEAD ciphersuite */
3506 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003507 {
3508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003509 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003510 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003511 /* Renegotiation must not be enabled */
3512#if defined(MBEDTLS_SSL_RENEGOTIATION)
3513 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003514 {
3515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003516 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003517 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003518#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003519
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003520 /*
3521 * Version and format identifier
3522 */
3523 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003524
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003525 if( used <= buf_len )
3526 {
3527 memcpy( p, ssl_serialized_context_header,
3528 sizeof( ssl_serialized_context_header ) );
3529 p += sizeof( ssl_serialized_context_header );
3530 }
3531
3532 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003533 * Session (length + data)
3534 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003535 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003536 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3537 return( ret );
3538
3539 used += 4 + session_len;
3540 if( used <= buf_len )
3541 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003542 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3543 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003544
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003545 ret = ssl_session_save( ssl->session, 1,
3546 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003547 if( ret != 0 )
3548 return( ret );
3549
3550 p += session_len;
3551 }
3552
3553 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003554 * Transform
3555 */
3556 used += sizeof( ssl->transform->randbytes );
3557 if( used <= buf_len )
3558 {
3559 memcpy( p, ssl->transform->randbytes,
3560 sizeof( ssl->transform->randbytes ) );
3561 p += sizeof( ssl->transform->randbytes );
3562 }
3563
3564#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3565 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3566 if( used <= buf_len )
3567 {
3568 *p++ = ssl->transform->in_cid_len;
3569 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3570 p += ssl->transform->in_cid_len;
3571
3572 *p++ = ssl->transform->out_cid_len;
3573 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3574 p += ssl->transform->out_cid_len;
3575 }
3576#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3577
3578 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003579 * Saved fields from top-level ssl_context structure
3580 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003581 used += 4;
3582 if( used <= buf_len )
3583 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003584 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3585 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003586 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003587
3588#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3589 used += 16;
3590 if( used <= buf_len )
3591 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003592 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3593 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003594
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003595 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3596 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003597 }
3598#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3599
3600#if defined(MBEDTLS_SSL_PROTO_DTLS)
3601 used += 1;
3602 if( used <= buf_len )
3603 {
3604 *p++ = ssl->disable_datagram_packing;
3605 }
3606#endif /* MBEDTLS_SSL_PROTO_DTLS */
3607
Jerry Yuae0b2e22021-10-08 15:21:19 +08003608 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003609 if( used <= buf_len )
3610 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003611 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3612 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003613 }
3614
3615#if defined(MBEDTLS_SSL_PROTO_DTLS)
3616 used += 2;
3617 if( used <= buf_len )
3618 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003619 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3620 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003621 }
3622#endif /* MBEDTLS_SSL_PROTO_DTLS */
3623
3624#if defined(MBEDTLS_SSL_ALPN)
3625 {
3626 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003627 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003628 : 0;
3629
3630 used += 1 + alpn_len;
3631 if( used <= buf_len )
3632 {
3633 *p++ = alpn_len;
3634
3635 if( ssl->alpn_chosen != NULL )
3636 {
3637 memcpy( p, ssl->alpn_chosen, alpn_len );
3638 p += alpn_len;
3639 }
3640 }
3641 }
3642#endif /* MBEDTLS_SSL_ALPN */
3643
3644 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003645 * Done
3646 */
3647 *olen = used;
3648
3649 if( used > buf_len )
3650 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003651
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003652 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3653
Hanno Becker43aefe22020-02-05 10:44:56 +00003654 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003655}
3656
3657/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003658 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003659 *
3660 * This internal version is wrapped by a public function that cleans up in
3661 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003662 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003663static int ssl_context_load( mbedtls_ssl_context *ssl,
3664 const unsigned char *buf,
3665 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003666{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003667 const unsigned char *p = buf;
3668 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003669 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003671
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003672 /*
3673 * The context should have been freshly setup or reset.
3674 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003675 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003676 * renegotiating, or if the user mistakenly loaded a session first.)
3677 */
3678 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3679 ssl->session != NULL )
3680 {
3681 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3682 }
3683
3684 /*
3685 * We can't check that the config matches the initial one, but we can at
3686 * least check it matches the requirements for serializing.
3687 */
3688 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003689 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3690 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003691#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003692 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003693#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003694 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003695 {
3696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3697 }
3698
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003699 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3700
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003701 /*
3702 * Check version identifier
3703 */
3704 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3706
3707 if( memcmp( p, ssl_serialized_context_header,
3708 sizeof( ssl_serialized_context_header ) ) != 0 )
3709 {
3710 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3711 }
3712 p += sizeof( ssl_serialized_context_header );
3713
3714 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003715 * Session
3716 */
3717 if( (size_t)( end - p ) < 4 )
3718 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3719
3720 session_len = ( (size_t) p[0] << 24 ) |
3721 ( (size_t) p[1] << 16 ) |
3722 ( (size_t) p[2] << 8 ) |
3723 ( (size_t) p[3] );
3724 p += 4;
3725
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003726 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003727 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003728 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729 ssl->session_in = ssl->session;
3730 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003731 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003732
3733 if( (size_t)( end - p ) < session_len )
3734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3735
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003736 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003737 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003738 {
3739 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003740 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003741 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003742
3743 p += session_len;
3744
3745 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003746 * Transform
3747 */
3748
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003749 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003750 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003751 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003752 ssl->transform_in = ssl->transform;
3753 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003754 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003755
3756 /* Read random bytes and populate structure */
3757 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3758 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003759#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003760 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003761 ssl->session->ciphersuite,
3762 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003763#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003764 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003765#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003766 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3767 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003768 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003769 ssl->conf->endpoint,
3770 ssl );
3771 if( ret != 0 )
3772 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003773#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003774 p += sizeof( ssl->transform->randbytes );
3775
3776#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3777 /* Read connection IDs and store them */
3778 if( (size_t)( end - p ) < 1 )
3779 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3780
3781 ssl->transform->in_cid_len = *p++;
3782
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003783 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3785
3786 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3787 p += ssl->transform->in_cid_len;
3788
3789 ssl->transform->out_cid_len = *p++;
3790
3791 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3792 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3793
3794 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3795 p += ssl->transform->out_cid_len;
3796#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3797
3798 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003799 * Saved fields from top-level ssl_context structure
3800 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003801 if( (size_t)( end - p ) < 4 )
3802 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3803
3804 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3805 ( (uint32_t) p[1] << 16 ) |
3806 ( (uint32_t) p[2] << 8 ) |
3807 ( (uint32_t) p[3] );
3808 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003809
3810#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3811 if( (size_t)( end - p ) < 16 )
3812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3813
3814 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3815 ( (uint64_t) p[1] << 48 ) |
3816 ( (uint64_t) p[2] << 40 ) |
3817 ( (uint64_t) p[3] << 32 ) |
3818 ( (uint64_t) p[4] << 24 ) |
3819 ( (uint64_t) p[5] << 16 ) |
3820 ( (uint64_t) p[6] << 8 ) |
3821 ( (uint64_t) p[7] );
3822 p += 8;
3823
3824 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3825 ( (uint64_t) p[1] << 48 ) |
3826 ( (uint64_t) p[2] << 40 ) |
3827 ( (uint64_t) p[3] << 32 ) |
3828 ( (uint64_t) p[4] << 24 ) |
3829 ( (uint64_t) p[5] << 16 ) |
3830 ( (uint64_t) p[6] << 8 ) |
3831 ( (uint64_t) p[7] );
3832 p += 8;
3833#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3834
3835#if defined(MBEDTLS_SSL_PROTO_DTLS)
3836 if( (size_t)( end - p ) < 1 )
3837 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3838
3839 ssl->disable_datagram_packing = *p++;
3840#endif /* MBEDTLS_SSL_PROTO_DTLS */
3841
Jerry Yud9a94fe2021-09-28 18:58:59 +08003842 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003843 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003844 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3845 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003846
3847#if defined(MBEDTLS_SSL_PROTO_DTLS)
3848 if( (size_t)( end - p ) < 2 )
3849 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3850
3851 ssl->mtu = ( p[0] << 8 ) | p[1];
3852 p += 2;
3853#endif /* MBEDTLS_SSL_PROTO_DTLS */
3854
3855#if defined(MBEDTLS_SSL_ALPN)
3856 {
3857 uint8_t alpn_len;
3858 const char **cur;
3859
3860 if( (size_t)( end - p ) < 1 )
3861 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3862
3863 alpn_len = *p++;
3864
3865 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3866 {
3867 /* alpn_chosen should point to an item in the configured list */
3868 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3869 {
3870 if( strlen( *cur ) == alpn_len &&
3871 memcmp( p, cur, alpn_len ) == 0 )
3872 {
3873 ssl->alpn_chosen = *cur;
3874 break;
3875 }
3876 }
3877 }
3878
3879 /* can only happen on conf mismatch */
3880 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3881 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3882
3883 p += alpn_len;
3884 }
3885#endif /* MBEDTLS_SSL_ALPN */
3886
3887 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003888 * Forced fields from top-level ssl_context structure
3889 *
3890 * Most of them already set to the correct value by mbedtls_ssl_init() and
3891 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3892 */
3893 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003894 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003895
Hanno Becker361b10d2019-08-30 10:42:49 +01003896 /* Adjust pointers for header fields of outgoing records to
3897 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003898 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003899
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003900#if defined(MBEDTLS_SSL_PROTO_DTLS)
3901 ssl->in_epoch = 1;
3902#endif
3903
3904 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3905 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003906 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3907 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003908 if( ssl->handshake != NULL )
3909 {
3910 mbedtls_ssl_handshake_free( ssl );
3911 mbedtls_free( ssl->handshake );
3912 ssl->handshake = NULL;
3913 }
3914
3915 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003916 * Done - should have consumed entire buffer
3917 */
3918 if( p != end )
3919 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003920
3921 return( 0 );
3922}
3923
3924/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003925 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003926 */
3927int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3928 const unsigned char *buf,
3929 size_t len )
3930{
3931 int ret = ssl_context_load( context, buf, len );
3932
3933 if( ret != 0 )
3934 mbedtls_ssl_free( context );
3935
3936 return( ret );
3937}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003938#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003939
3940/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003941 * Free an SSL context
3942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003944{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003945 if( ssl == NULL )
3946 return;
3947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003949
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003950 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003951 {
sander-visserb8aa2072020-05-06 22:05:13 +02003952#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3953 size_t out_buf_len = ssl->out_buf_len;
3954#else
3955 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3956#endif
3957
Darryl Greenb33cc762019-11-28 14:29:44 +00003958 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003960 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003961 }
3962
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003963 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003964 {
sander-visserb8aa2072020-05-06 22:05:13 +02003965#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3966 size_t in_buf_len = ssl->in_buf_len;
3967#else
3968 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3969#endif
3970
Darryl Greenb33cc762019-11-28 14:29:44 +00003971 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003972 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003973 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003974 }
3975
Paul Bakker48916f92012-09-16 19:57:18 +00003976 if( ssl->transform )
3977 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003978 mbedtls_ssl_transform_free( ssl->transform );
3979 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003980 }
3981
3982 if( ssl->handshake )
3983 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003984 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3986 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003988 mbedtls_free( ssl->handshake );
3989 mbedtls_free( ssl->transform_negotiate );
3990 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003991 }
3992
Ronald Cron6f135e12021-12-08 16:57:54 +01003993#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003994 mbedtls_ssl_transform_free( ssl->transform_application );
3995 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003996#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003997
Paul Bakkerc0463502013-02-14 11:19:38 +01003998 if( ssl->session )
3999 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004000 mbedtls_ssl_session_free( ssl->session );
4001 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004002 }
4003
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004004#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004005 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004006 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004007 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004009 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004010#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004011
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004012#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004014#endif
4015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004017
Paul Bakker86f04f42013-02-14 11:20:09 +01004018 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004019 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004020}
4021
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004022/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004023 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004024 */
4025void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4026{
4027 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4028}
4029
Gilles Peskineeccd8882020-03-10 12:19:08 +01004030#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004031#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02004032/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02004033 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
4034 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004035 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
4036 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004037static int ssl_preset_default_hashes[] = {
4038#if defined(MBEDTLS_SHA512_C)
4039 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004040#endif
4041#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004042 MBEDTLS_MD_SHA384,
4043#endif
4044#if defined(MBEDTLS_SHA256_C)
4045 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004046#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004047 MBEDTLS_MD_NONE
4048};
Jerry Yuf017ee42022-01-12 15:49:48 +08004049#endif /* !MBEDTLS_DEPRECATED_REMOVED */
4050#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004051
Gilles Peskineae270bf2021-06-02 00:05:29 +02004052/* The selection should be the same as mbedtls_x509_crt_profile_default in
4053 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004054 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004055 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004056 * about this list.
4057 */
Brett Warrene0edc842021-08-17 09:53:13 +01004058static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004059#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004060 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004061#endif
4062#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004063 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004064#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004065#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004066 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004067#endif
4068#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004069 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004070#endif
4071#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004072 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004073#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004074#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004075 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004076#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004077#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004078 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004079#endif
4080#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004081 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004082#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004083 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004084};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004085
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004086static int ssl_preset_suiteb_ciphersuites[] = {
4087 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4088 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4089 0
4090};
4091
Gilles Peskineeccd8882020-03-10 12:19:08 +01004092#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004093#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004094static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08004095#if defined(MBEDTLS_SHA256_C)
4096 MBEDTLS_MD_SHA256,
4097#endif
Jerry Yu713013f2022-01-17 18:16:35 +08004098#if defined(MBEDTLS_SHA384_C)
4099 MBEDTLS_MD_SHA384,
4100#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004101 MBEDTLS_MD_NONE
4102};
Jerry Yuf017ee42022-01-12 15:49:48 +08004103#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004104
Jerry Yu909df7b2022-01-22 11:56:27 +08004105/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004106 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004107 * rules SHOULD be upheld.
4108 * - No duplicate entries.
4109 * - But if there is a good reason, do not change the order of the algorithms.
4110 * - ssl_tls12_present* is for TLS 1.2 use only.
4111 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004112 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004113static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004114
Jerry Yued5e9f42022-01-26 11:21:34 +08004115#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4116 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4117 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4118#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4119 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004120
Jerry Yu909df7b2022-01-22 11:56:27 +08004121#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4122 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4123 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4124#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4125 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4126
Jerry Yued5e9f42022-01-26 11:21:34 +08004127#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4128 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4129 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4130#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4131 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004132
Jerry Yu909df7b2022-01-22 11:56:27 +08004133#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4134 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4135#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4136
Ronald Cron8540cf62022-03-16 08:01:09 +01004137#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4138 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4139#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4140
4141#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4142 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4143#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4144
Jerry Yu53037892022-01-25 11:02:06 +08004145#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4146 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4147#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4148
Gabor Mezei15b95a62022-05-09 16:37:58 +02004149 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004150};
4151
4152/* NOTICE: see above */
4153#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4154static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004155#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004156#if defined(MBEDTLS_ECDSA_C)
4157 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004158#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004159#if defined(MBEDTLS_RSA_C)
4160 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4161#endif
4162#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004163#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004164#if defined(MBEDTLS_ECDSA_C)
4165 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004166#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004167#if defined(MBEDTLS_RSA_C)
4168 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4169#endif
4170#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004171#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004172#if defined(MBEDTLS_ECDSA_C)
4173 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004174#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004175#if defined(MBEDTLS_RSA_C)
4176 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4177#endif
4178#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004179 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004180};
4181#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4182/* NOTICE: see above */
4183static uint16_t ssl_preset_suiteb_sig_algs[] = {
4184
Jerry Yu909df7b2022-01-22 11:56:27 +08004185#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4186 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4187 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4188#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4189 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4190
Jerry Yu53037892022-01-25 11:02:06 +08004191#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4192 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4193 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4194#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4195 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004196
4197#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4198 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4199#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004200
Jerry Yu53037892022-01-25 11:02:06 +08004201#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4202 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4203#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4204
Gabor Mezei15b95a62022-05-09 16:37:58 +02004205 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004206};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004207
Jerry Yu909df7b2022-01-22 11:56:27 +08004208/* NOTICE: see above */
4209#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4210static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004211#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004212#if defined(MBEDTLS_ECDSA_C)
4213 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004214#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004215#if defined(MBEDTLS_RSA_C)
4216 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4217#endif
4218#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004219#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004220#if defined(MBEDTLS_ECDSA_C)
4221 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004222#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004223#if defined(MBEDTLS_RSA_C)
4224 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4225#endif
4226#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004227 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004228};
Jerry Yu909df7b2022-01-22 11:56:27 +08004229#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4230
Jerry Yu1a8b4812022-01-20 17:56:50 +08004231#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004232
Brett Warrene0edc842021-08-17 09:53:13 +01004233static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004234#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004235 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004236#endif
4237#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004238 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004239#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004240 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004241};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004242
Jerry Yu1a8b4812022-01-20 17:56:50 +08004243#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004244/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004245 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004246static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004247{
4248 size_t i, j;
4249 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004250
Gabor Mezei15b95a62022-05-09 16:37:58 +02004251 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004252 {
Jerry Yuf377d642022-01-25 10:43:59 +08004253 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004254 {
Jerry Yuf377d642022-01-25 10:43:59 +08004255 if( sig_algs[i] != sig_algs[j] )
4256 continue;
4257 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4258 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4259 sig_algs[i], j, i );
4260 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004261 }
4262 }
4263 return( ret );
4264}
4265
4266#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4267
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004268/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004269 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004270 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004271int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004272 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004273{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004274#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004275 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004276#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004277
Jerry Yu1a8b4812022-01-20 17:56:50 +08004278#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004279 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004280 {
4281 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4282 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4283 }
4284
Jerry Yuf377d642022-01-25 10:43:59 +08004285 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004286 {
4287 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4288 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4289 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004290
4291#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004292 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004293 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004294 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004295 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4296 }
4297
Jerry Yuf377d642022-01-25 10:43:59 +08004298 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004299 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004300 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004301 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4302 }
4303#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004304#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4305
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004306 /* Use the functions here so that they are covered in tests,
4307 * but otherwise access member directly for efficiency */
4308 mbedtls_ssl_conf_endpoint( conf, endpoint );
4309 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004310
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004311 /*
4312 * Things that are common to all presets
4313 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004314#if defined(MBEDTLS_SSL_CLI_C)
4315 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4316 {
4317 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4318#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4319 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4320#endif
4321 }
4322#endif
4323
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004324#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4325 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4326#endif
4327
4328#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4329 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4330#endif
4331
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004332#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004333 conf->f_cookie_write = ssl_cookie_write_dummy;
4334 conf->f_cookie_check = ssl_cookie_check_dummy;
4335#endif
4336
4337#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4338 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4339#endif
4340
Janos Follath088ce432017-04-10 12:42:31 +01004341#if defined(MBEDTLS_SSL_SRV_C)
4342 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004343 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004344#endif
4345
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004346#if defined(MBEDTLS_SSL_PROTO_DTLS)
4347 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4348 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4349#endif
4350
4351#if defined(MBEDTLS_SSL_RENEGOTIATION)
4352 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004353 memset( conf->renego_period, 0x00, 2 );
4354 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004355#endif
4356
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004357#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004358 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4359 {
4360 const unsigned char dhm_p[] =
4361 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4362 const unsigned char dhm_g[] =
4363 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004364
Hanno Beckere2defad2021-07-24 05:59:17 +01004365 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4366 dhm_p, sizeof( dhm_p ),
4367 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4368 {
4369 return( ret );
4370 }
4371 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004372#endif
4373
Ronald Cron6f135e12021-12-08 16:57:54 +01004374#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004375 /*
4376 * Allow all TLS 1.3 key exchange modes by default.
4377 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004378 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004379#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004380
XiaokangQian4d3a6042022-04-21 13:46:17 +00004381 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4382 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004384 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004385 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004386#else
XiaokangQian060d8672022-04-21 09:24:56 +00004387 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004388#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004389 }
4390 else
4391 {
4392#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4393 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4394 {
4395 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4396 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4397 }
4398 else
4399 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4400 {
4401 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4402 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4403 }
4404#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4405 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4406 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4407#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4408 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4409 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4410#else
4411 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4412#endif
4413 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004414
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004415 /*
4416 * Preset-specific defaults
4417 */
4418 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004419 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004420 /*
4421 * NSA Suite B
4422 */
4423 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004424
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004425 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004426
4427#if defined(MBEDTLS_X509_CRT_PARSE_C)
4428 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004429#endif
4430
Gilles Peskineeccd8882020-03-10 12:19:08 +01004431#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004432#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004433 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004434#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004435#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4436 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4437 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4438 else
4439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4440 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004441#endif
4442
Brett Warrene0edc842021-08-17 09:53:13 +01004443#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4444 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004445#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004446 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004447 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004448
4449 /*
4450 * Default
4451 */
4452 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004453
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004454 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004455
4456#if defined(MBEDTLS_X509_CRT_PARSE_C)
4457 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4458#endif
4459
Gilles Peskineeccd8882020-03-10 12:19:08 +01004460#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004461#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004462 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004463#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004464#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4465 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4466 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4467 else
4468#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4469 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004470#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004471
Brett Warrene0edc842021-08-17 09:53:13 +01004472#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4473 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004474#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004475 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004476
4477#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4478 conf->dhm_min_bitlen = 1024;
4479#endif
4480 }
4481
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004482 return( 0 );
4483}
4484
4485/*
4486 * Free mbedtls_ssl_config
4487 */
4488void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4489{
4490#if defined(MBEDTLS_DHM_C)
4491 mbedtls_mpi_free( &conf->dhm_P );
4492 mbedtls_mpi_free( &conf->dhm_G );
4493#endif
4494
Gilles Peskineeccd8882020-03-10 12:19:08 +01004495#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004496#if defined(MBEDTLS_USE_PSA_CRYPTO)
4497 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4498 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004499 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4500 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004501#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004502 if( conf->psk != NULL )
4503 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004504 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004505 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004506 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004507 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004508 }
4509
4510 if( conf->psk_identity != NULL )
4511 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004512 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004513 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004514 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004515 conf->psk_identity_len = 0;
4516 }
4517#endif
4518
4519#if defined(MBEDTLS_X509_CRT_PARSE_C)
4520 ssl_key_cert_free( conf->key_cert );
4521#endif
4522
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004523 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004524}
4525
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004526#if defined(MBEDTLS_PK_C) && \
4527 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004528/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004529 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004532{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_RSA_C)
4534 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4535 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004536#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537#if defined(MBEDTLS_ECDSA_C)
4538 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4539 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004540#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004542}
4543
Hanno Becker7e5437a2017-04-28 17:15:26 +01004544unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4545{
4546 switch( type ) {
4547 case MBEDTLS_PK_RSA:
4548 return( MBEDTLS_SSL_SIG_RSA );
4549 case MBEDTLS_PK_ECDSA:
4550 case MBEDTLS_PK_ECKEY:
4551 return( MBEDTLS_SSL_SIG_ECDSA );
4552 default:
4553 return( MBEDTLS_SSL_SIG_ANON );
4554 }
4555}
4556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004558{
4559 switch( sig )
4560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561#if defined(MBEDTLS_RSA_C)
4562 case MBEDTLS_SSL_SIG_RSA:
4563 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004564#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565#if defined(MBEDTLS_ECDSA_C)
4566 case MBEDTLS_SSL_SIG_ECDSA:
4567 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004568#endif
4569 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004571 }
4572}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004573#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004574
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004575/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004576 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004579{
4580 switch( hash )
4581 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004582#if defined(MBEDTLS_MD5_C)
4583 case MBEDTLS_SSL_HASH_MD5:
4584 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004585#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004586#if defined(MBEDTLS_SHA1_C)
4587 case MBEDTLS_SSL_HASH_SHA1:
4588 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004589#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004590#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 case MBEDTLS_SSL_HASH_SHA224:
4592 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004593#endif
4594#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595 case MBEDTLS_SSL_HASH_SHA256:
4596 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004597#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004598#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004599 case MBEDTLS_SSL_HASH_SHA384:
4600 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004601#endif
4602#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004603 case MBEDTLS_SSL_HASH_SHA512:
4604 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004605#endif
4606 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004608 }
4609}
4610
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004611/*
4612 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4613 */
4614unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4615{
4616 switch( md )
4617 {
4618#if defined(MBEDTLS_MD5_C)
4619 case MBEDTLS_MD_MD5:
4620 return( MBEDTLS_SSL_HASH_MD5 );
4621#endif
4622#if defined(MBEDTLS_SHA1_C)
4623 case MBEDTLS_MD_SHA1:
4624 return( MBEDTLS_SSL_HASH_SHA1 );
4625#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004626#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004627 case MBEDTLS_MD_SHA224:
4628 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004629#endif
4630#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004631 case MBEDTLS_MD_SHA256:
4632 return( MBEDTLS_SSL_HASH_SHA256 );
4633#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004634#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004635 case MBEDTLS_MD_SHA384:
4636 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004637#endif
4638#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004639 case MBEDTLS_MD_SHA512:
4640 return( MBEDTLS_SSL_HASH_SHA512 );
4641#endif
4642 default:
4643 return( MBEDTLS_SSL_HASH_NONE );
4644 }
4645}
4646
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004647/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004648 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004649 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004650 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004651int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004652{
Brett Warrene0edc842021-08-17 09:53:13 +01004653 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004654
Brett Warrene0edc842021-08-17 09:53:13 +01004655 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004656 return( -1 );
4657
Brett Warrene0edc842021-08-17 09:53:13 +01004658 for( ; *group_list != 0; group_list++ )
4659 {
4660 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004661 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004662 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004663
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004664 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004665}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004666
4667#if defined(MBEDTLS_ECP_C)
4668/*
4669 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4670 */
4671int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4672{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004673 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004674 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4675}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004676#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678#if defined(MBEDTLS_X509_CRT_PARSE_C)
4679int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4680 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004681 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004682 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004683{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004684 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004685 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004686 const char *ext_oid;
4687 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004689 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004690 {
4691 /* Server part of the key exchange */
4692 switch( ciphersuite->key_exchange )
4693 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004694 case MBEDTLS_KEY_EXCHANGE_RSA:
4695 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004696 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004697 break;
4698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4700 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4701 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4702 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004703 break;
4704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4706 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004707 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004708 break;
4709
4710 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711 case MBEDTLS_KEY_EXCHANGE_NONE:
4712 case MBEDTLS_KEY_EXCHANGE_PSK:
4713 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4714 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004715 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004716 usage = 0;
4717 }
4718 }
4719 else
4720 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4722 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004723 }
4724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004726 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004727 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004728 ret = -1;
4729 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004732 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4734 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004735 }
4736 else
4737 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004738 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4739 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004740 }
4741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004743 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004744 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004745 ret = -1;
4746 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004747
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004748 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004749}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004751
Jerry Yu148165c2021-09-24 23:20:59 +08004752#if defined(MBEDTLS_USE_PSA_CRYPTO)
4753int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4754 const mbedtls_md_type_t md,
4755 unsigned char *dst,
4756 size_t dst_len,
4757 size_t *olen )
4758{
Ronald Cronf6893e12022-01-07 22:09:01 +01004759 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4760 psa_hash_operation_t *hash_operation_to_clone;
4761 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4762
Jerry Yu148165c2021-09-24 23:20:59 +08004763 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004764
4765 switch( md )
4766 {
4767#if defined(MBEDTLS_SHA384_C)
4768 case MBEDTLS_MD_SHA384:
4769 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4770 break;
4771#endif
4772
4773#if defined(MBEDTLS_SHA256_C)
4774 case MBEDTLS_MD_SHA256:
4775 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4776 break;
4777#endif
4778
4779 default:
4780 goto exit;
4781 }
4782
4783 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4784 if( status != PSA_SUCCESS )
4785 goto exit;
4786
4787 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4788 if( status != PSA_SUCCESS )
4789 goto exit;
4790
4791exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004792 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004793}
4794#else /* MBEDTLS_USE_PSA_CRYPTO */
4795
Jerry Yu24c0ec32021-09-09 14:21:07 +08004796#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004797static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4798 unsigned char *dst,
4799 size_t dst_len,
4800 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004801{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004802 int ret;
4803 mbedtls_sha512_context sha512;
4804
4805 if( dst_len < 48 )
4806 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4807
4808 mbedtls_sha512_init( &sha512 );
4809 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4810
4811 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4812 {
4813 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4814 goto exit;
4815 }
4816
4817 *olen = 48;
4818
4819exit:
4820
4821 mbedtls_sha512_free( &sha512 );
4822 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004823}
4824#endif /* MBEDTLS_SHA384_C */
4825
4826#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004827static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4828 unsigned char *dst,
4829 size_t dst_len,
4830 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004831{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004832 int ret;
4833 mbedtls_sha256_context sha256;
4834
4835 if( dst_len < 32 )
4836 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4837
4838 mbedtls_sha256_init( &sha256 );
4839 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004840
Jerry Yu24c0ec32021-09-09 14:21:07 +08004841 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4842 {
4843 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4844 goto exit;
4845 }
4846
4847 *olen = 32;
4848
4849exit:
4850
4851 mbedtls_sha256_free( &sha256 );
4852 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004853}
4854#endif /* MBEDTLS_SHA256_C */
4855
Jerry Yu000f9762021-09-14 11:12:51 +08004856int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4857 const mbedtls_md_type_t md,
4858 unsigned char *dst,
4859 size_t dst_len,
4860 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004861{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004862 switch( md )
4863 {
4864
Jerry Yu24c0ec32021-09-09 14:21:07 +08004865#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004866 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004867 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004868#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004869
Jerry Yu24c0ec32021-09-09 14:21:07 +08004870#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004871 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004872 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004873#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004874
4875 default:
4876 break;
4877 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004878 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004879}
XiaokangQian647719a2021-12-07 09:16:29 +00004880
Jerry Yu148165c2021-09-24 23:20:59 +08004881#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004882
Gabor Mezei078e8032022-04-27 21:17:56 +02004883#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4884/* mbedtls_ssl_parse_sig_alg_ext()
4885 *
4886 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4887 * value (TLS 1.3 RFC8446):
4888 * enum {
4889 * ....
4890 * ecdsa_secp256r1_sha256( 0x0403 ),
4891 * ecdsa_secp384r1_sha384( 0x0503 ),
4892 * ecdsa_secp521r1_sha512( 0x0603 ),
4893 * ....
4894 * } SignatureScheme;
4895 *
4896 * struct {
4897 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4898 * } SignatureSchemeList;
4899 *
4900 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4901 * value (TLS 1.2 RFC5246):
4902 * enum {
4903 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4904 * sha512(6), (255)
4905 * } HashAlgorithm;
4906 *
4907 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4908 * SignatureAlgorithm;
4909 *
4910 * struct {
4911 * HashAlgorithm hash;
4912 * SignatureAlgorithm signature;
4913 * } SignatureAndHashAlgorithm;
4914 *
4915 * SignatureAndHashAlgorithm
4916 * supported_signature_algorithms<2..2^16-2>;
4917 *
4918 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4919 * generalization of the TLS 1.2 signature algorithm extension.
4920 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4921 * `SignatureScheme` field of TLS 1.3
4922 *
4923 */
4924int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4925 const unsigned char *buf,
4926 const unsigned char *end )
4927{
4928 const unsigned char *p = buf;
4929 size_t supported_sig_algs_len = 0;
4930 const unsigned char *supported_sig_algs_end;
4931 uint16_t sig_alg;
4932 uint32_t common_idx = 0;
4933
4934 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4935 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4936 p += 2;
4937
4938 memset( ssl->handshake->received_sig_algs, 0,
4939 sizeof(ssl->handshake->received_sig_algs) );
4940
4941 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4942 supported_sig_algs_end = p + supported_sig_algs_len;
4943 while( p < supported_sig_algs_end )
4944 {
4945 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4946 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4947 p += 2;
4948
4949 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x",
4950 sig_alg ) );
4951
4952 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) ||
4953 ! mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) )
4954 continue;
4955
4956 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4957 {
4958 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4959 common_idx += 1;
4960 }
4961 }
4962 /* Check that we consumed all the message. */
4963 if( p != end )
4964 {
4965 MBEDTLS_SSL_DEBUG_MSG( 1,
4966 ( "Signature algorithms extension length misaligned" ) );
4967 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4968 MBEDTLS_ERR_SSL_DECODE_ERROR );
4969 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4970 }
4971
4972 if( common_idx == 0 )
4973 {
4974 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
4975 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
4976 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4977 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4978 }
4979
Gabor Mezei15b95a62022-05-09 16:37:58 +02004980 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02004981 return( 0 );
4982}
4983
4984#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4985
Jerry Yudc7bd172022-02-17 13:44:15 +08004986#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4987
4988#if defined(MBEDTLS_USE_PSA_CRYPTO)
4989
4990static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4991 mbedtls_svc_key_id_t key,
4992 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004993 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004994 const unsigned char* seed, size_t seed_length,
4995 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004996 const unsigned char* other_secret,
4997 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004998 size_t capacity )
4999{
5000 psa_status_t status;
5001
5002 status = psa_key_derivation_setup( derivation, alg );
5003 if( status != PSA_SUCCESS )
5004 return( status );
5005
5006 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5007 {
5008 status = psa_key_derivation_input_bytes( derivation,
5009 PSA_KEY_DERIVATION_INPUT_SEED,
5010 seed, seed_length );
5011 if( status != PSA_SUCCESS )
5012 return( status );
5013
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005014 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005015 {
5016 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005017 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5018 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005019 if( status != PSA_SUCCESS )
5020 return( status );
5021 }
5022
Jerry Yudc7bd172022-02-17 13:44:15 +08005023 if( mbedtls_svc_key_id_is_null( key ) )
5024 {
5025 status = psa_key_derivation_input_bytes(
5026 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005027 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005028 }
5029 else
5030 {
5031 status = psa_key_derivation_input_key(
5032 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5033 }
5034 if( status != PSA_SUCCESS )
5035 return( status );
5036
5037 status = psa_key_derivation_input_bytes( derivation,
5038 PSA_KEY_DERIVATION_INPUT_LABEL,
5039 label, label_length );
5040 if( status != PSA_SUCCESS )
5041 return( status );
5042 }
5043 else
5044 {
5045 return( PSA_ERROR_NOT_SUPPORTED );
5046 }
5047
5048 status = psa_key_derivation_set_capacity( derivation, capacity );
5049 if( status != PSA_SUCCESS )
5050 return( status );
5051
5052 return( PSA_SUCCESS );
5053}
5054
5055static int tls_prf_generic( mbedtls_md_type_t md_type,
5056 const unsigned char *secret, size_t slen,
5057 const char *label,
5058 const unsigned char *random, size_t rlen,
5059 unsigned char *dstbuf, size_t dlen )
5060{
5061 psa_status_t status;
5062 psa_algorithm_t alg;
5063 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5064 psa_key_derivation_operation_t derivation =
5065 PSA_KEY_DERIVATION_OPERATION_INIT;
5066
5067 if( md_type == MBEDTLS_MD_SHA384 )
5068 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5069 else
5070 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5071
5072 /* Normally a "secret" should be long enough to be impossible to
5073 * find by brute force, and in particular should not be empty. But
5074 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5075 * and for this use case it makes sense to have a 0-length "secret".
5076 * Since the key API doesn't allow importing a key of length 0,
5077 * keep master_key=0, which setup_psa_key_derivation() understands
5078 * to mean a 0-length "secret" input. */
5079 if( slen != 0 )
5080 {
5081 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5082 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5083 psa_set_key_algorithm( &key_attributes, alg );
5084 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5085
5086 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5087 if( status != PSA_SUCCESS )
5088 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5089 }
5090
5091 status = setup_psa_key_derivation( &derivation,
5092 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005093 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005094 random, rlen,
5095 (unsigned char const *) label,
5096 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005097 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005098 dlen );
5099 if( status != PSA_SUCCESS )
5100 {
5101 psa_key_derivation_abort( &derivation );
5102 psa_destroy_key( master_key );
5103 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5104 }
5105
5106 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5107 if( status != PSA_SUCCESS )
5108 {
5109 psa_key_derivation_abort( &derivation );
5110 psa_destroy_key( master_key );
5111 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5112 }
5113
5114 status = psa_key_derivation_abort( &derivation );
5115 if( status != PSA_SUCCESS )
5116 {
5117 psa_destroy_key( master_key );
5118 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5119 }
5120
5121 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5122 status = psa_destroy_key( master_key );
5123 if( status != PSA_SUCCESS )
5124 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5125
5126 return( 0 );
5127}
5128
5129#else /* MBEDTLS_USE_PSA_CRYPTO */
5130
5131static int tls_prf_generic( mbedtls_md_type_t md_type,
5132 const unsigned char *secret, size_t slen,
5133 const char *label,
5134 const unsigned char *random, size_t rlen,
5135 unsigned char *dstbuf, size_t dlen )
5136{
5137 size_t nb;
5138 size_t i, j, k, md_len;
5139 unsigned char *tmp;
5140 size_t tmp_len = 0;
5141 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5142 const mbedtls_md_info_t *md_info;
5143 mbedtls_md_context_t md_ctx;
5144 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5145
5146 mbedtls_md_init( &md_ctx );
5147
5148 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5149 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5150
5151 md_len = mbedtls_md_get_size( md_info );
5152
5153 tmp_len = md_len + strlen( label ) + rlen;
5154 tmp = mbedtls_calloc( 1, tmp_len );
5155 if( tmp == NULL )
5156 {
5157 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5158 goto exit;
5159 }
5160
5161 nb = strlen( label );
5162 memcpy( tmp + md_len, label, nb );
5163 memcpy( tmp + md_len + nb, random, rlen );
5164 nb += rlen;
5165
5166 /*
5167 * Compute P_<hash>(secret, label + random)[0..dlen]
5168 */
5169 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5170 goto exit;
5171
5172 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5173 if( ret != 0 )
5174 goto exit;
5175 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5176 if( ret != 0 )
5177 goto exit;
5178 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5179 if( ret != 0 )
5180 goto exit;
5181
5182 for( i = 0; i < dlen; i += md_len )
5183 {
5184 ret = mbedtls_md_hmac_reset ( &md_ctx );
5185 if( ret != 0 )
5186 goto exit;
5187 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5188 if( ret != 0 )
5189 goto exit;
5190 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5191 if( ret != 0 )
5192 goto exit;
5193
5194 ret = mbedtls_md_hmac_reset ( &md_ctx );
5195 if( ret != 0 )
5196 goto exit;
5197 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5198 if( ret != 0 )
5199 goto exit;
5200 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5201 if( ret != 0 )
5202 goto exit;
5203
5204 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5205
5206 for( j = 0; j < k; j++ )
5207 dstbuf[i + j] = h_i[j];
5208 }
5209
5210exit:
5211 mbedtls_md_free( &md_ctx );
5212
5213 mbedtls_platform_zeroize( tmp, tmp_len );
5214 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5215
5216 mbedtls_free( tmp );
5217
5218 return( ret );
5219}
5220#endif /* MBEDTLS_USE_PSA_CRYPTO */
5221
5222#if defined(MBEDTLS_SHA256_C)
5223static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5224 const char *label,
5225 const unsigned char *random, size_t rlen,
5226 unsigned char *dstbuf, size_t dlen )
5227{
5228 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5229 label, random, rlen, dstbuf, dlen ) );
5230}
5231#endif /* MBEDTLS_SHA256_C */
5232
5233#if defined(MBEDTLS_SHA384_C)
5234static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5235 const char *label,
5236 const unsigned char *random, size_t rlen,
5237 unsigned char *dstbuf, size_t dlen )
5238{
5239 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5240 label, random, rlen, dstbuf, dlen ) );
5241}
5242#endif /* MBEDTLS_SHA384_C */
5243
Jerry Yuf009d862022-02-17 14:01:37 +08005244/*
5245 * Set appropriate PRF function and other SSL / TLS1.2 functions
5246 *
5247 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005248 * - hash associated with the ciphersuite (only used by TLS 1.2)
5249 *
5250 * Outputs:
5251 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5252 */
5253static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005254 mbedtls_md_type_t hash )
5255{
Jerry Yuf009d862022-02-17 14:01:37 +08005256#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005257 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005258 {
5259 handshake->tls_prf = tls_prf_sha384;
5260 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5261 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5262 }
5263 else
5264#endif
5265#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005266 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005267 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005268 handshake->tls_prf = tls_prf_sha256;
5269 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5270 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5271 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005272#else
Jerry Yuf009d862022-02-17 14:01:37 +08005273 {
Jerry Yuf009d862022-02-17 14:01:37 +08005274 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005275 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005276 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5277 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005278#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005279
5280 return( 0 );
5281}
Jerry Yud6ab2352022-02-17 14:03:43 +08005282
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005283/*
5284 * Compute master secret if needed
5285 *
5286 * Parameters:
5287 * [in/out] handshake
5288 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5289 * (PSA-PSK) ciphersuite_info, psk_opaque
5290 * [out] premaster (cleared)
5291 * [out] master
5292 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5293 * debug: conf->f_dbg, conf->p_dbg
5294 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005295 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005296 */
5297static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5298 unsigned char *master,
5299 const mbedtls_ssl_context *ssl )
5300{
5301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5302
5303 /* cf. RFC 5246, Section 8.1:
5304 * "The master secret is always exactly 48 bytes in length." */
5305 size_t const master_secret_len = 48;
5306
5307#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5308 unsigned char session_hash[48];
5309#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5310
5311 /* The label for the KDF used for key expansion.
5312 * This is either "master secret" or "extended master secret"
5313 * depending on whether the Extended Master Secret extension
5314 * is used. */
5315 char const *lbl = "master secret";
5316
Przemek Stekielae4ed302022-04-05 17:15:55 +02005317 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005318 * - If the Extended Master Secret extension is not used,
5319 * this is ClientHello.Random + ServerHello.Random
5320 * (see Sect. 8.1 in RFC 5246).
5321 * - If the Extended Master Secret extension is used,
5322 * this is the transcript of the handshake so far.
5323 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005324 unsigned char const *seed = handshake->randbytes;
5325 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005326
5327#if !defined(MBEDTLS_DEBUG_C) && \
5328 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5329 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5330 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5331 ssl = NULL; /* make sure we don't use it except for those cases */
5332 (void) ssl;
5333#endif
5334
5335 if( handshake->resume != 0 )
5336 {
5337 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5338 return( 0 );
5339 }
5340
5341#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5342 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5343 {
5344 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005345 seed = session_hash;
5346 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005347
5348 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005349 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005350 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005351#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005352
Przemek Stekiel99114f32022-04-22 11:20:09 +02005353#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005354 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005355 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005356 {
5357 /* Perform PSK-to-MS expansion in a single step. */
5358 psa_status_t status;
5359 psa_algorithm_t alg;
5360 mbedtls_svc_key_id_t psk;
5361 psa_key_derivation_operation_t derivation =
5362 PSA_KEY_DERIVATION_OPERATION_INIT;
5363 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5364
5365 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5366
5367 psk = mbedtls_ssl_get_opaque_psk( ssl );
5368
5369 if( hash_alg == MBEDTLS_MD_SHA384 )
5370 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5371 else
5372 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5373
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005374 size_t other_secret_len = 0;
5375 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005376
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005377 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005378 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005379 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005380 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005381 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005382 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005383 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005384 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005385 other_secret_len = 48;
5386 other_secret = handshake->premaster + 2;
5387 break;
5388 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005389 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005390 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5391 other_secret = handshake->premaster + 2;
5392 break;
5393 default:
5394 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005395 }
5396
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005397 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005398 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005399 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005400 (unsigned char const *) lbl,
5401 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005402 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005403 master_secret_len );
5404 if( status != PSA_SUCCESS )
5405 {
5406 psa_key_derivation_abort( &derivation );
5407 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5408 }
5409
5410 status = psa_key_derivation_output_bytes( &derivation,
5411 master,
5412 master_secret_len );
5413 if( status != PSA_SUCCESS )
5414 {
5415 psa_key_derivation_abort( &derivation );
5416 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5417 }
5418
5419 status = psa_key_derivation_abort( &derivation );
5420 if( status != PSA_SUCCESS )
5421 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5422 }
5423 else
5424#endif
5425 {
5426 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005427 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005428 master,
5429 master_secret_len );
5430 if( ret != 0 )
5431 {
5432 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5433 return( ret );
5434 }
5435
5436 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5437 handshake->premaster,
5438 handshake->pmslen );
5439
5440 mbedtls_platform_zeroize( handshake->premaster,
5441 sizeof(handshake->premaster) );
5442 }
5443
5444 return( 0 );
5445}
5446
Jerry Yud62f87e2022-02-17 14:09:02 +08005447int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5448{
5449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5450 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5451 ssl->handshake->ciphersuite_info;
5452
5453 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5454
5455 /* Set PRF, calc_verify and calc_finished function pointers */
5456 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005457 ciphersuite_info->mac );
5458 if( ret != 0 )
5459 {
5460 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5461 return( ret );
5462 }
5463
5464 /* Compute master secret if needed */
5465 ret = ssl_compute_master( ssl->handshake,
5466 ssl->session_negotiate->master,
5467 ssl );
5468 if( ret != 0 )
5469 {
5470 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5471 return( ret );
5472 }
5473
5474 /* Swap the client and server random values:
5475 * - MS derivation wanted client+server (RFC 5246 8.1)
5476 * - key derivation wants server+client (RFC 5246 6.3) */
5477 {
5478 unsigned char tmp[64];
5479 memcpy( tmp, ssl->handshake->randbytes, 64 );
5480 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5481 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5482 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5483 }
5484
5485 /* Populate transform structure */
5486 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5487 ssl->session_negotiate->ciphersuite,
5488 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005489#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005490 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005491#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005492 ssl->handshake->tls_prf,
5493 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005494 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005495 ssl->conf->endpoint,
5496 ssl );
5497 if( ret != 0 )
5498 {
5499 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5500 return( ret );
5501 }
5502
5503 /* We no longer need Server/ClientHello.random values */
5504 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5505 sizeof( ssl->handshake->randbytes ) );
5506
5507 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5508
5509 return( 0 );
5510}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005511
Ronald Cron4dcbca92022-03-07 10:21:40 +01005512int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5513{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005514 switch( md )
5515 {
5516#if defined(MBEDTLS_SHA384_C)
5517 case MBEDTLS_SSL_HASH_SHA384:
5518 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5519 break;
5520#endif
5521#if defined(MBEDTLS_SHA256_C)
5522 case MBEDTLS_SSL_HASH_SHA256:
5523 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5524 break;
5525#endif
5526 default:
5527 return( -1 );
5528 }
5529
Ronald Cronc2f13a02022-03-07 10:25:24 +01005530 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005531}
5532
Jerry Yu8392e0d2022-02-17 14:10:24 +08005533#if defined(MBEDTLS_SHA256_C)
5534void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5535 unsigned char *hash,
5536 size_t *hlen )
5537{
5538#if defined(MBEDTLS_USE_PSA_CRYPTO)
5539 size_t hash_size;
5540 psa_status_t status;
5541 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5542
5543 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5544 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5545 if( status != PSA_SUCCESS )
5546 {
5547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5548 return;
5549 }
5550
5551 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5552 if( status != PSA_SUCCESS )
5553 {
5554 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5555 return;
5556 }
5557
5558 *hlen = 32;
5559 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5560 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5561#else
5562 mbedtls_sha256_context sha256;
5563
5564 mbedtls_sha256_init( &sha256 );
5565
5566 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5567
5568 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5569 mbedtls_sha256_finish( &sha256, hash );
5570
5571 *hlen = 32;
5572
5573 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5575
5576 mbedtls_sha256_free( &sha256 );
5577#endif /* MBEDTLS_USE_PSA_CRYPTO */
5578 return;
5579}
5580#endif /* MBEDTLS_SHA256_C */
5581
Jerry Yuc1cb3842022-02-17 14:13:48 +08005582#if defined(MBEDTLS_SHA384_C)
5583void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5584 unsigned char *hash,
5585 size_t *hlen )
5586{
5587#if defined(MBEDTLS_USE_PSA_CRYPTO)
5588 size_t hash_size;
5589 psa_status_t status;
5590 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5591
5592 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5593 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5594 if( status != PSA_SUCCESS )
5595 {
5596 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5597 return;
5598 }
5599
5600 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5601 if( status != PSA_SUCCESS )
5602 {
5603 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5604 return;
5605 }
5606
5607 *hlen = 48;
5608 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5609 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5610#else
5611 mbedtls_sha512_context sha512;
5612
5613 mbedtls_sha512_init( &sha512 );
5614
5615 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5616
5617 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5618 mbedtls_sha512_finish( &sha512, hash );
5619
5620 *hlen = 48;
5621
5622 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5623 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5624
5625 mbedtls_sha512_free( &sha512 );
5626#endif /* MBEDTLS_USE_PSA_CRYPTO */
5627 return;
5628}
5629#endif /* MBEDTLS_SHA384_C */
5630
Neil Armstrong80f6f322022-05-03 17:56:38 +02005631#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5632 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005633int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5634{
5635 unsigned char *p = ssl->handshake->premaster;
5636 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5637 const unsigned char *psk = NULL;
5638 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005639 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005640
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005641 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005642 {
5643 /*
5644 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005645 * checked before calling this function.
5646 *
5647 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005648 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005649 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005650 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5651 {
5652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5653 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5654 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005655 }
5656
5657 /*
5658 * PMS = struct {
5659 * opaque other_secret<0..2^16-1>;
5660 * opaque psk<0..2^16-1>;
5661 * };
5662 * with "other_secret" depending on the particular key exchange
5663 */
5664#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5665 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5666 {
5667 if( end - p < 2 )
5668 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5669
5670 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5671 p += 2;
5672
5673 if( end < p || (size_t)( end - p ) < psk_len )
5674 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5675
5676 memset( p, 0, psk_len );
5677 p += psk_len;
5678 }
5679 else
5680#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5681#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5682 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5683 {
5684 /*
5685 * other_secret already set by the ClientKeyExchange message,
5686 * and is 48 bytes long
5687 */
5688 if( end - p < 2 )
5689 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5690
5691 *p++ = 0;
5692 *p++ = 48;
5693 p += 48;
5694 }
5695 else
5696#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5697#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5698 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5699 {
5700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5701 size_t len;
5702
5703 /* Write length only when we know the actual value */
5704 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5705 p + 2, end - ( p + 2 ), &len,
5706 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5707 {
5708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5709 return( ret );
5710 }
5711 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5712 p += 2 + len;
5713
5714 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5715 }
5716 else
5717#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005718#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005719 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5720 {
5721 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5722 size_t zlen;
5723
5724 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5725 p + 2, end - ( p + 2 ),
5726 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5727 {
5728 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5729 return( ret );
5730 }
5731
5732 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5733 p += 2 + zlen;
5734
5735 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5736 MBEDTLS_DEBUG_ECDH_Z );
5737 }
5738 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005739#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005740 {
5741 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5742 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5743 }
5744
5745 /* opaque psk<0..2^16-1>; */
5746 if( end - p < 2 )
5747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5748
5749 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5750 p += 2;
5751
5752 if( end < p || (size_t)( end - p ) < psk_len )
5753 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5754
5755 memcpy( p, psk, psk_len );
5756 p += psk_len;
5757
5758 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5759
5760 return( 0 );
5761}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005762#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005763
5764#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5765static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5766
5767#if defined(MBEDTLS_SSL_PROTO_DTLS)
5768int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5769{
5770 /* If renegotiation is not enforced, retransmit until we would reach max
5771 * timeout if we were using the usual handshake doubling scheme */
5772 if( ssl->conf->renego_max_records < 0 )
5773 {
5774 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5775 unsigned char doublings = 1;
5776
5777 while( ratio != 0 )
5778 {
5779 ++doublings;
5780 ratio >>= 1;
5781 }
5782
5783 if( ++ssl->renego_records_seen > doublings )
5784 {
5785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5786 return( 0 );
5787 }
5788 }
5789
5790 return( ssl_write_hello_request( ssl ) );
5791}
5792#endif
5793#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005794
Jerry Yud9526692022-02-17 14:23:47 +08005795/*
5796 * Handshake functions
5797 */
5798#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5799/* No certificate support -> dummy functions */
5800int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5801{
5802 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5803 ssl->handshake->ciphersuite_info;
5804
5805 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5806
5807 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5808 {
5809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5810 ssl->state++;
5811 return( 0 );
5812 }
5813
5814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5815 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5816}
5817
5818int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5819{
5820 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5821 ssl->handshake->ciphersuite_info;
5822
5823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5824
5825 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5826 {
5827 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5828 ssl->state++;
5829 return( 0 );
5830 }
5831
5832 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5833 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5834}
5835
5836#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5837/* Some certificate support -> implement write and parse */
5838
5839int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5840{
5841 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5842 size_t i, n;
5843 const mbedtls_x509_crt *crt;
5844 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5845 ssl->handshake->ciphersuite_info;
5846
5847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5848
5849 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5850 {
5851 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5852 ssl->state++;
5853 return( 0 );
5854 }
5855
5856#if defined(MBEDTLS_SSL_CLI_C)
5857 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5858 {
5859 if( ssl->handshake->client_auth == 0 )
5860 {
5861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5862 ssl->state++;
5863 return( 0 );
5864 }
5865 }
5866#endif /* MBEDTLS_SSL_CLI_C */
5867#if defined(MBEDTLS_SSL_SRV_C)
5868 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5869 {
5870 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5871 {
5872 /* Should never happen because we shouldn't have picked the
5873 * ciphersuite if we don't have a certificate. */
5874 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5875 }
5876 }
5877#endif
5878
5879 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5880
5881 /*
5882 * 0 . 0 handshake type
5883 * 1 . 3 handshake length
5884 * 4 . 6 length of all certs
5885 * 7 . 9 length of cert. 1
5886 * 10 . n-1 peer certificate
5887 * n . n+2 length of cert. 2
5888 * n+3 . ... upper level cert, etc.
5889 */
5890 i = 7;
5891 crt = mbedtls_ssl_own_cert( ssl );
5892
5893 while( crt != NULL )
5894 {
5895 n = crt->raw.len;
5896 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5897 {
5898 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5899 " > %" MBEDTLS_PRINTF_SIZET,
5900 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5901 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5902 }
5903
5904 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5905 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5906 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5907
5908 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5909 i += n; crt = crt->next;
5910 }
5911
5912 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5913 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5914 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5915
5916 ssl->out_msglen = i;
5917 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5918 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5919
5920 ssl->state++;
5921
5922 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5923 {
5924 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5925 return( ret );
5926 }
5927
5928 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5929
5930 return( ret );
5931}
5932
5933#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5934
5935#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5936static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5937 unsigned char *crt_buf,
5938 size_t crt_buf_len )
5939{
5940 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5941
5942 if( peer_crt == NULL )
5943 return( -1 );
5944
5945 if( peer_crt->raw.len != crt_buf_len )
5946 return( -1 );
5947
5948 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5949}
5950#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5951static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5952 unsigned char *crt_buf,
5953 size_t crt_buf_len )
5954{
5955 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5956 unsigned char const * const peer_cert_digest =
5957 ssl->session->peer_cert_digest;
5958 mbedtls_md_type_t const peer_cert_digest_type =
5959 ssl->session->peer_cert_digest_type;
5960 mbedtls_md_info_t const * const digest_info =
5961 mbedtls_md_info_from_type( peer_cert_digest_type );
5962 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5963 size_t digest_len;
5964
5965 if( peer_cert_digest == NULL || digest_info == NULL )
5966 return( -1 );
5967
5968 digest_len = mbedtls_md_get_size( digest_info );
5969 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5970 return( -1 );
5971
5972 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5973 if( ret != 0 )
5974 return( -1 );
5975
5976 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5977}
5978#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5979#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5980
5981/*
5982 * Once the certificate message is read, parse it into a cert chain and
5983 * perform basic checks, but leave actual verification to the caller
5984 */
5985static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5986 mbedtls_x509_crt *chain )
5987{
5988 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5989#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5990 int crt_cnt=0;
5991#endif
5992 size_t i, n;
5993 uint8_t alert;
5994
5995 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5996 {
5997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5998 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5999 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6000 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6001 }
6002
6003 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6004 {
6005 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6006 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6007 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6008 }
6009
6010 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6011 {
6012 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6013 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6014 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6015 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6016 }
6017
6018 i = mbedtls_ssl_hs_hdr_len( ssl );
6019
6020 /*
6021 * Same message structure as in mbedtls_ssl_write_certificate()
6022 */
6023 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6024
6025 if( ssl->in_msg[i] != 0 ||
6026 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6027 {
6028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6029 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6030 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6031 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6032 }
6033
6034 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6035 i += 3;
6036
6037 /* Iterate through and parse the CRTs in the provided chain. */
6038 while( i < ssl->in_hslen )
6039 {
6040 /* Check that there's room for the next CRT's length fields. */
6041 if ( i + 3 > ssl->in_hslen ) {
6042 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6043 mbedtls_ssl_send_alert_message( ssl,
6044 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6045 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6046 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6047 }
6048 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6049 * anything beyond 2**16 ~ 64K. */
6050 if( ssl->in_msg[i] != 0 )
6051 {
6052 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6053 mbedtls_ssl_send_alert_message( ssl,
6054 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6055 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6056 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6057 }
6058
6059 /* Read length of the next CRT in the chain. */
6060 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6061 | (unsigned int) ssl->in_msg[i + 2];
6062 i += 3;
6063
6064 if( n < 128 || i + n > ssl->in_hslen )
6065 {
6066 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6067 mbedtls_ssl_send_alert_message( ssl,
6068 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6069 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6070 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6071 }
6072
6073 /* Check if we're handling the first CRT in the chain. */
6074#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6075 if( crt_cnt++ == 0 &&
6076 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6077 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6078 {
6079 /* During client-side renegotiation, check that the server's
6080 * end-CRTs hasn't changed compared to the initial handshake,
6081 * mitigating the triple handshake attack. On success, reuse
6082 * the original end-CRT instead of parsing it again. */
6083 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6084 if( ssl_check_peer_crt_unchanged( ssl,
6085 &ssl->in_msg[i],
6086 n ) != 0 )
6087 {
6088 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6089 mbedtls_ssl_send_alert_message( ssl,
6090 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6091 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6092 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6093 }
6094
6095 /* Now we can safely free the original chain. */
6096 ssl_clear_peer_cert( ssl->session );
6097 }
6098#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6099
6100 /* Parse the next certificate in the chain. */
6101#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6102 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6103#else
6104 /* If we don't need to store the CRT chain permanently, parse
6105 * it in-place from the input buffer instead of making a copy. */
6106 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6107#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6108 switch( ret )
6109 {
6110 case 0: /*ok*/
6111 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6112 /* Ignore certificate with an unknown algorithm: maybe a
6113 prior certificate was already trusted. */
6114 break;
6115
6116 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6117 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6118 goto crt_parse_der_failed;
6119
6120 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6121 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6122 goto crt_parse_der_failed;
6123
6124 default:
6125 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6126 crt_parse_der_failed:
6127 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6128 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6129 return( ret );
6130 }
6131
6132 i += n;
6133 }
6134
6135 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6136 return( 0 );
6137}
6138
6139#if defined(MBEDTLS_SSL_SRV_C)
6140static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6141{
6142 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6143 return( -1 );
6144
6145 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6146 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6147 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6148 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6149 {
Ronald Cron19385882022-06-15 16:26:13 +02006150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006151 return( 0 );
6152 }
6153 return( -1 );
6154}
6155#endif /* MBEDTLS_SSL_SRV_C */
6156
6157/* Check if a certificate message is expected.
6158 * Return either
6159 * - SSL_CERTIFICATE_EXPECTED, or
6160 * - SSL_CERTIFICATE_SKIP
6161 * indicating whether a Certificate message is expected or not.
6162 */
6163#define SSL_CERTIFICATE_EXPECTED 0
6164#define SSL_CERTIFICATE_SKIP 1
6165static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6166 int authmode )
6167{
6168 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6169 ssl->handshake->ciphersuite_info;
6170
6171 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6172 return( SSL_CERTIFICATE_SKIP );
6173
6174#if defined(MBEDTLS_SSL_SRV_C)
6175 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6176 {
6177 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6178 return( SSL_CERTIFICATE_SKIP );
6179
6180 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6181 {
6182 ssl->session_negotiate->verify_result =
6183 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6184 return( SSL_CERTIFICATE_SKIP );
6185 }
6186 }
6187#else
6188 ((void) authmode);
6189#endif /* MBEDTLS_SSL_SRV_C */
6190
6191 return( SSL_CERTIFICATE_EXPECTED );
6192}
6193
6194static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6195 int authmode,
6196 mbedtls_x509_crt *chain,
6197 void *rs_ctx )
6198{
6199 int ret = 0;
6200 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6201 ssl->handshake->ciphersuite_info;
6202 int have_ca_chain = 0;
6203
6204 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6205 void *p_vrfy;
6206
6207 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6208 return( 0 );
6209
6210 if( ssl->f_vrfy != NULL )
6211 {
6212 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6213 f_vrfy = ssl->f_vrfy;
6214 p_vrfy = ssl->p_vrfy;
6215 }
6216 else
6217 {
6218 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6219 f_vrfy = ssl->conf->f_vrfy;
6220 p_vrfy = ssl->conf->p_vrfy;
6221 }
6222
6223 /*
6224 * Main check: verify certificate
6225 */
6226#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6227 if( ssl->conf->f_ca_cb != NULL )
6228 {
6229 ((void) rs_ctx);
6230 have_ca_chain = 1;
6231
6232 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6233 ret = mbedtls_x509_crt_verify_with_ca_cb(
6234 chain,
6235 ssl->conf->f_ca_cb,
6236 ssl->conf->p_ca_cb,
6237 ssl->conf->cert_profile,
6238 ssl->hostname,
6239 &ssl->session_negotiate->verify_result,
6240 f_vrfy, p_vrfy );
6241 }
6242 else
6243#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6244 {
6245 mbedtls_x509_crt *ca_chain;
6246 mbedtls_x509_crl *ca_crl;
6247
6248#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6249 if( ssl->handshake->sni_ca_chain != NULL )
6250 {
6251 ca_chain = ssl->handshake->sni_ca_chain;
6252 ca_crl = ssl->handshake->sni_ca_crl;
6253 }
6254 else
6255#endif
6256 {
6257 ca_chain = ssl->conf->ca_chain;
6258 ca_crl = ssl->conf->ca_crl;
6259 }
6260
6261 if( ca_chain != NULL )
6262 have_ca_chain = 1;
6263
6264 ret = mbedtls_x509_crt_verify_restartable(
6265 chain,
6266 ca_chain, ca_crl,
6267 ssl->conf->cert_profile,
6268 ssl->hostname,
6269 &ssl->session_negotiate->verify_result,
6270 f_vrfy, p_vrfy, rs_ctx );
6271 }
6272
6273 if( ret != 0 )
6274 {
6275 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6276 }
6277
6278#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6279 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6280 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6281#endif
6282
6283 /*
6284 * Secondary checks: always done, but change 'ret' only if it was 0
6285 */
6286
6287#if defined(MBEDTLS_ECP_C)
6288 {
6289 const mbedtls_pk_context *pk = &chain->pk;
6290
6291 /* If certificate uses an EC key, make sure the curve is OK */
6292 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6293 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6294 {
6295 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6296
6297 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6298 if( ret == 0 )
6299 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6300 }
6301 }
6302#endif /* MBEDTLS_ECP_C */
6303
6304 if( mbedtls_ssl_check_cert_usage( chain,
6305 ciphersuite_info,
6306 ! ssl->conf->endpoint,
6307 &ssl->session_negotiate->verify_result ) != 0 )
6308 {
6309 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6310 if( ret == 0 )
6311 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6312 }
6313
6314 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6315 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6316 * with details encoded in the verification flags. All other kinds
6317 * of error codes, including those from the user provided f_vrfy
6318 * functions, are treated as fatal and lead to a failure of
6319 * ssl_parse_certificate even if verification was optional. */
6320 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6321 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6322 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6323 {
6324 ret = 0;
6325 }
6326
6327 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6328 {
6329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6330 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6331 }
6332
6333 if( ret != 0 )
6334 {
6335 uint8_t alert;
6336
6337 /* The certificate may have been rejected for several reasons.
6338 Pick one and send the corresponding alert. Which alert to send
6339 may be a subject of debate in some cases. */
6340 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6341 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6342 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6343 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6344 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6345 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6346 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6347 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6348 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6349 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6350 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6351 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6352 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6353 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6354 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6355 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6356 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6357 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6358 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6359 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6360 else
6361 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6362 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6363 alert );
6364 }
6365
6366#if defined(MBEDTLS_DEBUG_C)
6367 if( ssl->session_negotiate->verify_result != 0 )
6368 {
6369 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6370 (unsigned int) ssl->session_negotiate->verify_result ) );
6371 }
6372 else
6373 {
6374 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6375 }
6376#endif /* MBEDTLS_DEBUG_C */
6377
6378 return( ret );
6379}
6380
6381#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6382static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6383 unsigned char *start, size_t len )
6384{
6385 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6386 /* Remember digest of the peer's end-CRT. */
6387 ssl->session_negotiate->peer_cert_digest =
6388 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6389 if( ssl->session_negotiate->peer_cert_digest == NULL )
6390 {
6391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6392 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6393 mbedtls_ssl_send_alert_message( ssl,
6394 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6395 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6396
6397 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6398 }
6399
6400 ret = mbedtls_md( mbedtls_md_info_from_type(
6401 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6402 start, len,
6403 ssl->session_negotiate->peer_cert_digest );
6404
6405 ssl->session_negotiate->peer_cert_digest_type =
6406 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6407 ssl->session_negotiate->peer_cert_digest_len =
6408 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6409
6410 return( ret );
6411}
6412
6413static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6414 unsigned char *start, size_t len )
6415{
6416 unsigned char *end = start + len;
6417 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6418
6419 /* Make a copy of the peer's raw public key. */
6420 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6421 ret = mbedtls_pk_parse_subpubkey( &start, end,
6422 &ssl->handshake->peer_pubkey );
6423 if( ret != 0 )
6424 {
6425 /* We should have parsed the public key before. */
6426 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6427 }
6428
6429 return( 0 );
6430}
6431#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6432
6433int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6434{
6435 int ret = 0;
6436 int crt_expected;
6437#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6438 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6439 ? ssl->handshake->sni_authmode
6440 : ssl->conf->authmode;
6441#else
6442 const int authmode = ssl->conf->authmode;
6443#endif
6444 void *rs_ctx = NULL;
6445 mbedtls_x509_crt *chain = NULL;
6446
6447 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6448
6449 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6450 if( crt_expected == SSL_CERTIFICATE_SKIP )
6451 {
6452 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6453 goto exit;
6454 }
6455
6456#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6457 if( ssl->handshake->ecrs_enabled &&
6458 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6459 {
6460 chain = ssl->handshake->ecrs_peer_cert;
6461 ssl->handshake->ecrs_peer_cert = NULL;
6462 goto crt_verify;
6463 }
6464#endif
6465
6466 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6467 {
6468 /* mbedtls_ssl_read_record may have sent an alert already. We
6469 let it decide whether to alert. */
6470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6471 goto exit;
6472 }
6473
6474#if defined(MBEDTLS_SSL_SRV_C)
6475 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6476 {
6477 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6478
6479 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6480 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6481
6482 goto exit;
6483 }
6484#endif /* MBEDTLS_SSL_SRV_C */
6485
6486 /* Clear existing peer CRT structure in case we tried to
6487 * reuse a session but it failed, and allocate a new one. */
6488 ssl_clear_peer_cert( ssl->session_negotiate );
6489
6490 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6491 if( chain == NULL )
6492 {
6493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6494 sizeof( mbedtls_x509_crt ) ) );
6495 mbedtls_ssl_send_alert_message( ssl,
6496 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6497 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6498
6499 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6500 goto exit;
6501 }
6502 mbedtls_x509_crt_init( chain );
6503
6504 ret = ssl_parse_certificate_chain( ssl, chain );
6505 if( ret != 0 )
6506 goto exit;
6507
6508#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6509 if( ssl->handshake->ecrs_enabled)
6510 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6511
6512crt_verify:
6513 if( ssl->handshake->ecrs_enabled)
6514 rs_ctx = &ssl->handshake->ecrs_ctx;
6515#endif
6516
6517 ret = ssl_parse_certificate_verify( ssl, authmode,
6518 chain, rs_ctx );
6519 if( ret != 0 )
6520 goto exit;
6521
6522#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6523 {
6524 unsigned char *crt_start, *pk_start;
6525 size_t crt_len, pk_len;
6526
6527 /* We parse the CRT chain without copying, so
6528 * these pointers point into the input buffer,
6529 * and are hence still valid after freeing the
6530 * CRT chain. */
6531
6532 crt_start = chain->raw.p;
6533 crt_len = chain->raw.len;
6534
6535 pk_start = chain->pk_raw.p;
6536 pk_len = chain->pk_raw.len;
6537
6538 /* Free the CRT structures before computing
6539 * digest and copying the peer's public key. */
6540 mbedtls_x509_crt_free( chain );
6541 mbedtls_free( chain );
6542 chain = NULL;
6543
6544 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6545 if( ret != 0 )
6546 goto exit;
6547
6548 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6549 if( ret != 0 )
6550 goto exit;
6551 }
6552#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6553 /* Pass ownership to session structure. */
6554 ssl->session_negotiate->peer_cert = chain;
6555 chain = NULL;
6556#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6557
6558 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6559
6560exit:
6561
6562 if( ret == 0 )
6563 ssl->state++;
6564
6565#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6566 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6567 {
6568 ssl->handshake->ecrs_peer_cert = chain;
6569 chain = NULL;
6570 }
6571#endif
6572
6573 if( chain != NULL )
6574 {
6575 mbedtls_x509_crt_free( chain );
6576 mbedtls_free( chain );
6577 }
6578
6579 return( ret );
6580}
6581#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6582
Jerry Yu615bd6f2022-02-17 14:25:15 +08006583#if defined(MBEDTLS_SHA256_C)
6584static void ssl_calc_finished_tls_sha256(
6585 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6586{
6587 int len = 12;
6588 const char *sender;
6589 unsigned char padbuf[32];
6590#if defined(MBEDTLS_USE_PSA_CRYPTO)
6591 size_t hash_size;
6592 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6593 psa_status_t status;
6594#else
6595 mbedtls_sha256_context sha256;
6596#endif
6597
6598 mbedtls_ssl_session *session = ssl->session_negotiate;
6599 if( !session )
6600 session = ssl->session;
6601
6602 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6603 ? "client finished"
6604 : "server finished";
6605
6606#if defined(MBEDTLS_USE_PSA_CRYPTO)
6607 sha256_psa = psa_hash_operation_init();
6608
6609 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6610
6611 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6612 if( status != PSA_SUCCESS )
6613 {
6614 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6615 return;
6616 }
6617
6618 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6619 if( status != PSA_SUCCESS )
6620 {
6621 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6622 return;
6623 }
6624 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6625#else
6626
6627 mbedtls_sha256_init( &sha256 );
6628
6629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6630
6631 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6632
6633 /*
6634 * TLSv1.2:
6635 * hash = PRF( master, finished_label,
6636 * Hash( handshake ) )[0.11]
6637 */
6638
6639#if !defined(MBEDTLS_SHA256_ALT)
6640 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6641 sha256.state, sizeof( sha256.state ) );
6642#endif
6643
6644 mbedtls_sha256_finish( &sha256, padbuf );
6645 mbedtls_sha256_free( &sha256 );
6646#endif /* MBEDTLS_USE_PSA_CRYPTO */
6647
6648 ssl->handshake->tls_prf( session->master, 48, sender,
6649 padbuf, 32, buf, len );
6650
6651 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6652
6653 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6654
6655 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6656}
6657#endif /* MBEDTLS_SHA256_C */
6658
Jerry Yub7ba49e2022-02-17 14:25:53 +08006659
6660#if defined(MBEDTLS_SHA384_C)
6661
6662static void ssl_calc_finished_tls_sha384(
6663 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6664{
6665 int len = 12;
6666 const char *sender;
6667 unsigned char padbuf[48];
6668#if defined(MBEDTLS_USE_PSA_CRYPTO)
6669 size_t hash_size;
6670 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6671 psa_status_t status;
6672#else
6673 mbedtls_sha512_context sha512;
6674#endif
6675
6676 mbedtls_ssl_session *session = ssl->session_negotiate;
6677 if( !session )
6678 session = ssl->session;
6679
6680 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6681 ? "client finished"
6682 : "server finished";
6683
6684#if defined(MBEDTLS_USE_PSA_CRYPTO)
6685 sha384_psa = psa_hash_operation_init();
6686
6687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6688
6689 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6690 if( status != PSA_SUCCESS )
6691 {
6692 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6693 return;
6694 }
6695
6696 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6697 if( status != PSA_SUCCESS )
6698 {
6699 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6700 return;
6701 }
6702 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6703#else
6704 mbedtls_sha512_init( &sha512 );
6705
6706 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6707
6708 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6709
6710 /*
6711 * TLSv1.2:
6712 * hash = PRF( master, finished_label,
6713 * Hash( handshake ) )[0.11]
6714 */
6715
6716#if !defined(MBEDTLS_SHA512_ALT)
6717 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6718 sha512.state, sizeof( sha512.state ) );
6719#endif
6720 mbedtls_sha512_finish( &sha512, padbuf );
6721
6722 mbedtls_sha512_free( &sha512 );
6723#endif
6724
6725 ssl->handshake->tls_prf( session->master, 48, sender,
6726 padbuf, 48, buf, len );
6727
6728 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6729
6730 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6731
6732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6733}
6734#endif /* MBEDTLS_SHA384_C */
6735
Jerry Yuaef00152022-02-17 14:27:31 +08006736void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6737{
6738 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6739
6740 /*
6741 * Free our handshake params
6742 */
6743 mbedtls_ssl_handshake_free( ssl );
6744 mbedtls_free( ssl->handshake );
6745 ssl->handshake = NULL;
6746
6747 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006748 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006749 */
6750 if( ssl->transform )
6751 {
6752 mbedtls_ssl_transform_free( ssl->transform );
6753 mbedtls_free( ssl->transform );
6754 }
6755 ssl->transform = ssl->transform_negotiate;
6756 ssl->transform_negotiate = NULL;
6757
6758 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6759}
6760
Jerry Yu2a9fff52022-02-17 14:28:51 +08006761void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6762{
6763 int resume = ssl->handshake->resume;
6764
6765 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6766
6767#if defined(MBEDTLS_SSL_RENEGOTIATION)
6768 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6769 {
6770 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6771 ssl->renego_records_seen = 0;
6772 }
6773#endif
6774
6775 /*
6776 * Free the previous session and switch in the current one
6777 */
6778 if( ssl->session )
6779 {
6780#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6781 /* RFC 7366 3.1: keep the EtM state */
6782 ssl->session_negotiate->encrypt_then_mac =
6783 ssl->session->encrypt_then_mac;
6784#endif
6785
6786 mbedtls_ssl_session_free( ssl->session );
6787 mbedtls_free( ssl->session );
6788 }
6789 ssl->session = ssl->session_negotiate;
6790 ssl->session_negotiate = NULL;
6791
6792 /*
6793 * Add cache entry
6794 */
6795 if( ssl->conf->f_set_cache != NULL &&
6796 ssl->session->id_len != 0 &&
6797 resume == 0 )
6798 {
6799 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6800 ssl->session->id,
6801 ssl->session->id_len,
6802 ssl->session ) != 0 )
6803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6804 }
6805
6806#if defined(MBEDTLS_SSL_PROTO_DTLS)
6807 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6808 ssl->handshake->flight != NULL )
6809 {
6810 /* Cancel handshake timer */
6811 mbedtls_ssl_set_timer( ssl, 0 );
6812
6813 /* Keep last flight around in case we need to resend it:
6814 * we need the handshake and transform structures for that */
6815 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6816 }
6817 else
6818#endif
6819 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6820
6821 ssl->state++;
6822
6823 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6824}
6825
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006826int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6827{
6828 int ret, hash_len;
6829
6830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6831
6832 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6833
6834 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6835
6836 /*
6837 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6838 * may define some other value. Currently (early 2016), no defined
6839 * ciphersuite does this (and this is unlikely to change as activity has
6840 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6841 */
6842 hash_len = 12;
6843
6844#if defined(MBEDTLS_SSL_RENEGOTIATION)
6845 ssl->verify_data_len = hash_len;
6846 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6847#endif
6848
6849 ssl->out_msglen = 4 + hash_len;
6850 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6851 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6852
6853 /*
6854 * In case of session resuming, invert the client and server
6855 * ChangeCipherSpec messages order.
6856 */
6857 if( ssl->handshake->resume != 0 )
6858 {
6859#if defined(MBEDTLS_SSL_CLI_C)
6860 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6861 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6862#endif
6863#if defined(MBEDTLS_SSL_SRV_C)
6864 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6865 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6866#endif
6867 }
6868 else
6869 ssl->state++;
6870
6871 /*
6872 * Switch to our negotiated transform and session parameters for outbound
6873 * data.
6874 */
6875 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6876
6877#if defined(MBEDTLS_SSL_PROTO_DTLS)
6878 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6879 {
6880 unsigned char i;
6881
6882 /* Remember current epoch settings for resending */
6883 ssl->handshake->alt_transform_out = ssl->transform_out;
6884 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6885 sizeof( ssl->handshake->alt_out_ctr ) );
6886
6887 /* Set sequence_number to zero */
6888 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6889
6890
6891 /* Increment epoch */
6892 for( i = 2; i > 0; i-- )
6893 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6894 break;
6895
6896 /* The loop goes to its end iff the counter is wrapping */
6897 if( i == 0 )
6898 {
6899 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6900 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6901 }
6902 }
6903 else
6904#endif /* MBEDTLS_SSL_PROTO_DTLS */
6905 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6906
6907 ssl->transform_out = ssl->transform_negotiate;
6908 ssl->session_out = ssl->session_negotiate;
6909
6910#if defined(MBEDTLS_SSL_PROTO_DTLS)
6911 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6912 mbedtls_ssl_send_flight_completed( ssl );
6913#endif
6914
6915 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6916 {
6917 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6918 return( ret );
6919 }
6920
6921#if defined(MBEDTLS_SSL_PROTO_DTLS)
6922 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6923 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6924 {
6925 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6926 return( ret );
6927 }
6928#endif
6929
6930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6931
6932 return( 0 );
6933}
6934
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006935#define SSL_MAX_HASH_LEN 12
6936
6937int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6938{
6939 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6940 unsigned int hash_len = 12;
6941 unsigned char buf[SSL_MAX_HASH_LEN];
6942
6943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6944
6945 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6946
6947 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6948 {
6949 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6950 goto exit;
6951 }
6952
6953 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6954 {
6955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6956 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6957 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6958 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6959 goto exit;
6960 }
6961
6962 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6963 {
6964 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6965 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6966 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6967 goto exit;
6968 }
6969
6970 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6971 {
6972 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6973 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6974 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6975 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6976 goto exit;
6977 }
6978
6979 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6980 buf, hash_len ) != 0 )
6981 {
6982 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6983 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6984 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6985 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6986 goto exit;
6987 }
6988
6989#if defined(MBEDTLS_SSL_RENEGOTIATION)
6990 ssl->verify_data_len = hash_len;
6991 memcpy( ssl->peer_verify_data, buf, hash_len );
6992#endif
6993
6994 if( ssl->handshake->resume != 0 )
6995 {
6996#if defined(MBEDTLS_SSL_CLI_C)
6997 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6998 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6999#endif
7000#if defined(MBEDTLS_SSL_SRV_C)
7001 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7002 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7003#endif
7004 }
7005 else
7006 ssl->state++;
7007
7008#if defined(MBEDTLS_SSL_PROTO_DTLS)
7009 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7010 mbedtls_ssl_recv_flight_completed( ssl );
7011#endif
7012
7013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7014
7015exit:
7016 mbedtls_platform_zeroize( buf, hash_len );
7017 return( ret );
7018}
7019
Jerry Yu392112c2022-02-17 14:34:10 +08007020#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7021/*
7022 * Helper to get TLS 1.2 PRF from ciphersuite
7023 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7024 */
7025static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7026{
7027#if defined(MBEDTLS_SHA384_C)
7028 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7029 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7030
7031 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7032 return( tls_prf_sha384 );
7033#else
7034 (void) ciphersuite_id;
7035#endif
7036 return( tls_prf_sha256 );
7037}
7038#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007039
7040static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7041{
7042 ((void) tls_prf);
7043#if defined(MBEDTLS_SHA384_C)
7044 if( tls_prf == tls_prf_sha384 )
7045 {
7046 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7047 }
7048 else
7049#endif
7050#if defined(MBEDTLS_SHA256_C)
7051 if( tls_prf == tls_prf_sha256 )
7052 {
7053 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7054 }
7055 else
7056#endif
7057 return( MBEDTLS_SSL_TLS_PRF_NONE );
7058}
7059
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007060/*
7061 * Populate a transform structure with session keys and all the other
7062 * necessary information.
7063 *
7064 * Parameters:
7065 * - [in/out]: transform: structure to populate
7066 * [in] must be just initialised with mbedtls_ssl_transform_init()
7067 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7068 * - [in] ciphersuite
7069 * - [in] master
7070 * - [in] encrypt_then_mac
7071 * - [in] compression
7072 * - [in] tls_prf: pointer to PRF to use for key derivation
7073 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007074 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007075 * - [in] endpoint: client or server
7076 * - [in] ssl: used for:
7077 * - ssl->conf->{f,p}_export_keys
7078 * [in] optionally used for:
7079 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7080 */
7081static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7082 int ciphersuite,
7083 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007084#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007085 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007086#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007087 ssl_tls_prf_t tls_prf,
7088 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007089 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007090 unsigned endpoint,
7091 const mbedtls_ssl_context *ssl )
7092{
7093 int ret = 0;
7094 unsigned char keyblk[256];
7095 unsigned char *key1;
7096 unsigned char *key2;
7097 unsigned char *mac_enc;
7098 unsigned char *mac_dec;
7099 size_t mac_key_len = 0;
7100 size_t iv_copy_len;
7101 size_t keylen;
7102 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007103 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007104#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007105 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007106 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007107#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007108
7109#if defined(MBEDTLS_USE_PSA_CRYPTO)
7110 psa_key_type_t key_type;
7111 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7112 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007113 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007114 size_t key_bits;
7115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7116#endif
7117
7118#if !defined(MBEDTLS_DEBUG_C) && \
7119 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7120 if( ssl->f_export_keys == NULL )
7121 {
7122 ssl = NULL; /* make sure we don't use it except for these cases */
7123 (void) ssl;
7124 }
7125#endif
7126
7127 /*
7128 * Some data just needs copying into the structure
7129 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007130#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007131 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007132#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007133 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007134
7135#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7136 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7137#endif
7138
7139#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007140 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007141 {
7142 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7143 * generation separate. This should never happen. */
7144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7145 }
7146#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7147
7148 /*
7149 * Get various info structures
7150 */
7151 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7152 if( ciphersuite_info == NULL )
7153 {
7154 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7155 ciphersuite ) );
7156 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7157 }
7158
Neil Armstrongab555e02022-04-04 11:07:59 +02007159 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007160#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007161 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007162#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007163 ciphersuite_info );
7164
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007165 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7166 transform->taglen =
7167 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7168
7169#if defined(MBEDTLS_USE_PSA_CRYPTO)
7170 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7171 transform->taglen,
7172 &alg,
7173 &key_type,
7174 &key_bits ) ) != PSA_SUCCESS )
7175 {
7176 ret = psa_ssl_status_to_mbedtls( status );
7177 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7178 goto end;
7179 }
7180#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007181 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7182 if( cipher_info == NULL )
7183 {
7184 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7185 ciphersuite_info->cipher ) );
7186 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7187 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007188#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007189
Neil Armstronge4512952022-03-08 09:08:22 +01007190#if defined(MBEDTLS_USE_PSA_CRYPTO)
7191 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7192 if( mac_alg == 0 )
7193 {
7194 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7195 (unsigned) ciphersuite_info->mac ) );
7196 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7197 }
7198#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007199 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7200 if( md_info == NULL )
7201 {
7202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7203 (unsigned) ciphersuite_info->mac ) );
7204 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7205 }
Neil Armstronge4512952022-03-08 09:08:22 +01007206#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007207
7208#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7209 /* Copy own and peer's CID if the use of the CID
7210 * extension has been negotiated. */
7211 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7212 {
7213 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7214
7215 transform->in_cid_len = ssl->own_cid_len;
7216 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7217 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7218 transform->in_cid_len );
7219
7220 transform->out_cid_len = ssl->handshake->peer_cid_len;
7221 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7222 ssl->handshake->peer_cid_len );
7223 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7224 transform->out_cid_len );
7225 }
7226#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7227
7228 /*
7229 * Compute key block using the PRF
7230 */
7231 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7232 if( ret != 0 )
7233 {
7234 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7235 return( ret );
7236 }
7237
7238 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7239 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7240 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7241 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7242 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7243
7244 /*
7245 * Determine the appropriate key, IV and MAC length.
7246 */
7247
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007248#if defined(MBEDTLS_USE_PSA_CRYPTO)
7249 keylen = PSA_BITS_TO_BYTES(key_bits);
7250#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007251 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007252#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007253
7254#if defined(MBEDTLS_GCM_C) || \
7255 defined(MBEDTLS_CCM_C) || \
7256 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007257 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007258 {
7259 size_t explicit_ivlen;
7260
7261 transform->maclen = 0;
7262 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007263
7264 /* All modes haves 96-bit IVs, but the length of the static parts vary
7265 * with mode and version:
7266 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7267 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7268 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7269 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7270 * sequence number).
7271 */
7272 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007273#if defined(MBEDTLS_USE_PSA_CRYPTO)
7274 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7275#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007276 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007277#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007278 transform->fixed_ivlen = 12;
7279 else
7280 transform->fixed_ivlen = 4;
7281
7282 /* Minimum length of encrypted record */
7283 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7284 transform->minlen = explicit_ivlen + transform->taglen;
7285 }
7286 else
7287#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7288#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007289 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7290 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7291 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007292 {
Neil Armstronge4512952022-03-08 09:08:22 +01007293#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007294 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007295#else
7296 size_t block_size = cipher_info->block_size;
7297#endif /* MBEDTLS_USE_PSA_CRYPTO */
7298
7299#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007300 /* Get MAC length */
7301 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7302#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007303 /* Initialize HMAC contexts */
7304 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7305 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7306 {
7307 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7308 goto end;
7309 }
7310
7311 /* Get MAC length */
7312 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007313#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007314 transform->maclen = mac_key_len;
7315
7316 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007317#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007318 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007319#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007320 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007321#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007322
7323 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007324 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007325 transform->minlen = transform->maclen;
7326 else
7327 {
7328 /*
7329 * GenericBlockCipher:
7330 * 1. if EtM is in use: one block plus MAC
7331 * otherwise: * first multiple of blocklen greater than maclen
7332 * 2. IV
7333 */
7334#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007335 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007336 {
7337 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007338 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007339 }
7340 else
7341#endif
7342 {
7343 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007344 + block_size
7345 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007346 }
7347
Glenn Strauss07c64162022-03-14 12:34:51 -04007348 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007349 {
7350 transform->minlen += transform->ivlen;
7351 }
7352 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007353 {
7354 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7355 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7356 goto end;
7357 }
7358 }
7359 }
7360 else
7361#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7362 {
7363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7364 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7365 }
7366
7367 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7368 (unsigned) keylen,
7369 (unsigned) transform->minlen,
7370 (unsigned) transform->ivlen,
7371 (unsigned) transform->maclen ) );
7372
7373 /*
7374 * Finally setup the cipher contexts, IVs and MAC secrets.
7375 */
7376#if defined(MBEDTLS_SSL_CLI_C)
7377 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7378 {
7379 key1 = keyblk + mac_key_len * 2;
7380 key2 = keyblk + mac_key_len * 2 + keylen;
7381
7382 mac_enc = keyblk;
7383 mac_dec = keyblk + mac_key_len;
7384
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007385 iv_copy_len = ( transform->fixed_ivlen ) ?
7386 transform->fixed_ivlen : transform->ivlen;
7387 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7388 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7389 iv_copy_len );
7390 }
7391 else
7392#endif /* MBEDTLS_SSL_CLI_C */
7393#if defined(MBEDTLS_SSL_SRV_C)
7394 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7395 {
7396 key1 = keyblk + mac_key_len * 2 + keylen;
7397 key2 = keyblk + mac_key_len * 2;
7398
7399 mac_enc = keyblk + mac_key_len;
7400 mac_dec = keyblk;
7401
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007402 iv_copy_len = ( transform->fixed_ivlen ) ?
7403 transform->fixed_ivlen : transform->ivlen;
7404 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7405 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7406 iv_copy_len );
7407 }
7408 else
7409#endif /* MBEDTLS_SSL_SRV_C */
7410 {
7411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7412 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7413 goto end;
7414 }
7415
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007416 if( ssl != NULL && ssl->f_export_keys != NULL )
7417 {
7418 ssl->f_export_keys( ssl->p_export_keys,
7419 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7420 master, 48,
7421 randbytes + 32,
7422 randbytes,
7423 tls_prf_get_type( tls_prf ) );
7424 }
7425
7426#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007427 transform->psa_alg = alg;
7428
7429 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7430 {
7431 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7432 psa_set_key_algorithm( &attributes, alg );
7433 psa_set_key_type( &attributes, key_type );
7434
7435 if( ( status = psa_import_key( &attributes,
7436 key1,
7437 PSA_BITS_TO_BYTES( key_bits ),
7438 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7439 {
7440 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7441 ret = psa_ssl_status_to_mbedtls( status );
7442 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7443 goto end;
7444 }
7445
7446 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7447
7448 if( ( status = psa_import_key( &attributes,
7449 key2,
7450 PSA_BITS_TO_BYTES( key_bits ),
7451 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7452 {
7453 ret = psa_ssl_status_to_mbedtls( status );
7454 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7455 goto end;
7456 }
7457 }
7458#else
7459 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7460 cipher_info ) ) != 0 )
7461 {
7462 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7463 goto end;
7464 }
7465
7466 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7467 cipher_info ) ) != 0 )
7468 {
7469 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7470 goto end;
7471 }
7472
7473 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7474 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7475 MBEDTLS_ENCRYPT ) ) != 0 )
7476 {
7477 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7478 goto end;
7479 }
7480
7481 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7482 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7483 MBEDTLS_DECRYPT ) ) != 0 )
7484 {
7485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7486 goto end;
7487 }
7488
7489#if defined(MBEDTLS_CIPHER_MODE_CBC)
7490 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7491 {
7492 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7493 MBEDTLS_PADDING_NONE ) ) != 0 )
7494 {
7495 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7496 goto end;
7497 }
7498
7499 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7500 MBEDTLS_PADDING_NONE ) ) != 0 )
7501 {
7502 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7503 goto end;
7504 }
7505 }
7506#endif /* MBEDTLS_CIPHER_MODE_CBC */
7507#endif /* MBEDTLS_USE_PSA_CRYPTO */
7508
Neil Armstrong29c0c042022-03-17 17:47:28 +01007509#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7510 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7511 For AEAD-based ciphersuites, there is nothing to do here. */
7512 if( mac_key_len != 0 )
7513 {
7514#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007515 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007516
7517 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007518 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007519 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7520
7521 if( ( status = psa_import_key( &attributes,
7522 mac_enc, mac_key_len,
7523 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7524 {
7525 ret = psa_ssl_status_to_mbedtls( status );
7526 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7527 goto end;
7528 }
7529
Ronald Cronfb39f152022-03-25 14:36:28 +01007530 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7531 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7532 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007533 /* mbedtls_ct_hmac() requires the key to be exportable */
7534 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7535 PSA_KEY_USAGE_VERIFY_HASH );
7536 else
7537 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7538
7539 if( ( status = psa_import_key( &attributes,
7540 mac_dec, mac_key_len,
7541 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7542 {
7543 ret = psa_ssl_status_to_mbedtls( status );
7544 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7545 goto end;
7546 }
7547#else
7548 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7549 if( ret != 0 )
7550 goto end;
7551 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7552 if( ret != 0 )
7553 goto end;
7554#endif /* MBEDTLS_USE_PSA_CRYPTO */
7555 }
7556#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7557
7558 ((void) mac_dec);
7559 ((void) mac_enc);
7560
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007561end:
7562 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7563 return( ret );
7564}
7565
Jerry Yuee40f9d2022-02-17 14:55:16 +08007566#if defined(MBEDTLS_USE_PSA_CRYPTO)
7567int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7568 unsigned char *hash, size_t *hashlen,
7569 unsigned char *data, size_t data_len,
7570 mbedtls_md_type_t md_alg )
7571{
7572 psa_status_t status;
7573 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7574 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7575
7576 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7577
7578 if( ( status = psa_hash_setup( &hash_operation,
7579 hash_alg ) ) != PSA_SUCCESS )
7580 {
7581 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7582 goto exit;
7583 }
7584
7585 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7586 64 ) ) != PSA_SUCCESS )
7587 {
7588 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7589 goto exit;
7590 }
7591
7592 if( ( status = psa_hash_update( &hash_operation,
7593 data, data_len ) ) != PSA_SUCCESS )
7594 {
7595 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7596 goto exit;
7597 }
7598
7599 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7600 hashlen ) ) != PSA_SUCCESS )
7601 {
7602 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7603 goto exit;
7604 }
7605
7606exit:
7607 if( status != PSA_SUCCESS )
7608 {
7609 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7610 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7611 switch( status )
7612 {
7613 case PSA_ERROR_NOT_SUPPORTED:
7614 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7615 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7616 case PSA_ERROR_BUFFER_TOO_SMALL:
7617 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7618 case PSA_ERROR_INSUFFICIENT_MEMORY:
7619 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7620 default:
7621 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7622 }
7623 }
7624 return( 0 );
7625}
7626
7627#else
7628
7629int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7630 unsigned char *hash, size_t *hashlen,
7631 unsigned char *data, size_t data_len,
7632 mbedtls_md_type_t md_alg )
7633{
7634 int ret = 0;
7635 mbedtls_md_context_t ctx;
7636 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7637 *hashlen = mbedtls_md_get_size( md_info );
7638
7639 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7640
7641 mbedtls_md_init( &ctx );
7642
7643 /*
7644 * digitally-signed struct {
7645 * opaque client_random[32];
7646 * opaque server_random[32];
7647 * ServerDHParams params;
7648 * };
7649 */
7650 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7651 {
7652 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7653 goto exit;
7654 }
7655 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7656 {
7657 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7658 goto exit;
7659 }
7660 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7661 {
7662 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7663 goto exit;
7664 }
7665 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7666 {
7667 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7668 goto exit;
7669 }
7670 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7671 {
7672 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7673 goto exit;
7674 }
7675
7676exit:
7677 mbedtls_md_free( &ctx );
7678
7679 if( ret != 0 )
7680 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7681 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7682
7683 return( ret );
7684}
7685#endif /* MBEDTLS_USE_PSA_CRYPTO */
7686
Jerry Yud9d91da2022-02-17 14:57:06 +08007687#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7688
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007689/* Find the preferred hash for a given signature algorithm. */
7690unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7691 mbedtls_ssl_context *ssl,
7692 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007693{
Gabor Mezei078e8032022-04-27 21:17:56 +02007694 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007695 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007696
7697 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007698 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007699
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007700 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007701 {
Gabor Mezei3631cf62022-05-10 12:59:00 +02007702 if( sig_alg == MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7703 received_sig_algs[i] ) )
Gabor Mezei696956d2022-05-13 16:27:29 +02007704 return( MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7705 received_sig_algs[i] ) );
Jerry Yud9d91da2022-02-17 14:57:06 +08007706 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007707
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007708 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007709}
7710
7711#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7712
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007713/* Serialization of TLS 1.2 sessions:
7714 *
7715 * struct {
7716 * uint64 start_time;
7717 * uint8 ciphersuite[2]; // defined by the standard
7718 * uint8 compression; // 0 or 1
7719 * uint8 session_id_len; // at most 32
7720 * opaque session_id[32];
7721 * opaque master[48]; // fixed length in the standard
7722 * uint32 verify_result;
7723 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7724 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7725 * uint32 ticket_lifetime;
7726 * uint8 mfl_code; // up to 255 according to standard
7727 * uint8 encrypt_then_mac; // 0 or 1
7728 * } serialized_session_tls12;
7729 *
7730 */
7731static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7732 unsigned char *buf,
7733 size_t buf_len )
7734{
7735 unsigned char *p = buf;
7736 size_t used = 0;
7737
7738#if defined(MBEDTLS_HAVE_TIME)
7739 uint64_t start;
7740#endif
7741#if defined(MBEDTLS_X509_CRT_PARSE_C)
7742#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7743 size_t cert_len;
7744#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7745#endif /* MBEDTLS_X509_CRT_PARSE_C */
7746
7747 /*
7748 * Time
7749 */
7750#if defined(MBEDTLS_HAVE_TIME)
7751 used += 8;
7752
7753 if( used <= buf_len )
7754 {
7755 start = (uint64_t) session->start;
7756
7757 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7758 p += 8;
7759 }
7760#endif /* MBEDTLS_HAVE_TIME */
7761
7762 /*
7763 * Basic mandatory fields
7764 */
7765 used += 2 /* ciphersuite */
7766 + 1 /* compression */
7767 + 1 /* id_len */
7768 + sizeof( session->id )
7769 + sizeof( session->master )
7770 + 4; /* verify_result */
7771
7772 if( used <= buf_len )
7773 {
7774 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7775 p += 2;
7776
7777 *p++ = MBEDTLS_BYTE_0( session->compression );
7778
7779 *p++ = MBEDTLS_BYTE_0( session->id_len );
7780 memcpy( p, session->id, 32 );
7781 p += 32;
7782
7783 memcpy( p, session->master, 48 );
7784 p += 48;
7785
7786 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7787 p += 4;
7788 }
7789
7790 /*
7791 * Peer's end-entity certificate
7792 */
7793#if defined(MBEDTLS_X509_CRT_PARSE_C)
7794#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7795 if( session->peer_cert == NULL )
7796 cert_len = 0;
7797 else
7798 cert_len = session->peer_cert->raw.len;
7799
7800 used += 3 + cert_len;
7801
7802 if( used <= buf_len )
7803 {
7804 *p++ = MBEDTLS_BYTE_2( cert_len );
7805 *p++ = MBEDTLS_BYTE_1( cert_len );
7806 *p++ = MBEDTLS_BYTE_0( cert_len );
7807
7808 if( session->peer_cert != NULL )
7809 {
7810 memcpy( p, session->peer_cert->raw.p, cert_len );
7811 p += cert_len;
7812 }
7813 }
7814#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7815 if( session->peer_cert_digest != NULL )
7816 {
7817 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7818 if( used <= buf_len )
7819 {
7820 *p++ = (unsigned char) session->peer_cert_digest_type;
7821 *p++ = (unsigned char) session->peer_cert_digest_len;
7822 memcpy( p, session->peer_cert_digest,
7823 session->peer_cert_digest_len );
7824 p += session->peer_cert_digest_len;
7825 }
7826 }
7827 else
7828 {
7829 used += 2;
7830 if( used <= buf_len )
7831 {
7832 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7833 *p++ = 0;
7834 }
7835 }
7836#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7837#endif /* MBEDTLS_X509_CRT_PARSE_C */
7838
7839 /*
7840 * Session ticket if any, plus associated data
7841 */
7842#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7843 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7844
7845 if( used <= buf_len )
7846 {
7847 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7848 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7849 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7850
7851 if( session->ticket != NULL )
7852 {
7853 memcpy( p, session->ticket, session->ticket_len );
7854 p += session->ticket_len;
7855 }
7856
7857 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7858 p += 4;
7859 }
7860#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7861
7862 /*
7863 * Misc extension-related info
7864 */
7865#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7866 used += 1;
7867
7868 if( used <= buf_len )
7869 *p++ = session->mfl_code;
7870#endif
7871
7872#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7873 used += 1;
7874
7875 if( used <= buf_len )
7876 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7877#endif
7878
7879 return( used );
7880}
7881
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007882static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7883 const unsigned char *buf,
7884 size_t len )
7885{
7886#if defined(MBEDTLS_HAVE_TIME)
7887 uint64_t start;
7888#endif
7889#if defined(MBEDTLS_X509_CRT_PARSE_C)
7890#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7891 size_t cert_len;
7892#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7893#endif /* MBEDTLS_X509_CRT_PARSE_C */
7894
7895 const unsigned char *p = buf;
7896 const unsigned char * const end = buf + len;
7897
7898 /*
7899 * Time
7900 */
7901#if defined(MBEDTLS_HAVE_TIME)
7902 if( 8 > (size_t)( end - p ) )
7903 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7904
7905 start = ( (uint64_t) p[0] << 56 ) |
7906 ( (uint64_t) p[1] << 48 ) |
7907 ( (uint64_t) p[2] << 40 ) |
7908 ( (uint64_t) p[3] << 32 ) |
7909 ( (uint64_t) p[4] << 24 ) |
7910 ( (uint64_t) p[5] << 16 ) |
7911 ( (uint64_t) p[6] << 8 ) |
7912 ( (uint64_t) p[7] );
7913 p += 8;
7914
7915 session->start = (time_t) start;
7916#endif /* MBEDTLS_HAVE_TIME */
7917
7918 /*
7919 * Basic mandatory fields
7920 */
7921 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7922 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7923
7924 session->ciphersuite = ( p[0] << 8 ) | p[1];
7925 p += 2;
7926
7927 session->compression = *p++;
7928
7929 session->id_len = *p++;
7930 memcpy( session->id, p, 32 );
7931 p += 32;
7932
7933 memcpy( session->master, p, 48 );
7934 p += 48;
7935
7936 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7937 ( (uint32_t) p[1] << 16 ) |
7938 ( (uint32_t) p[2] << 8 ) |
7939 ( (uint32_t) p[3] );
7940 p += 4;
7941
7942 /* Immediately clear invalid pointer values that have been read, in case
7943 * we exit early before we replaced them with valid ones. */
7944#if defined(MBEDTLS_X509_CRT_PARSE_C)
7945#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7946 session->peer_cert = NULL;
7947#else
7948 session->peer_cert_digest = NULL;
7949#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7950#endif /* MBEDTLS_X509_CRT_PARSE_C */
7951#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7952 session->ticket = NULL;
7953#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7954
7955 /*
7956 * Peer certificate
7957 */
7958#if defined(MBEDTLS_X509_CRT_PARSE_C)
7959#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7960 /* Deserialize CRT from the end of the ticket. */
7961 if( 3 > (size_t)( end - p ) )
7962 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7963
7964 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7965 p += 3;
7966
7967 if( cert_len != 0 )
7968 {
7969 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7970
7971 if( cert_len > (size_t)( end - p ) )
7972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7973
7974 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7975
7976 if( session->peer_cert == NULL )
7977 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7978
7979 mbedtls_x509_crt_init( session->peer_cert );
7980
7981 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7982 p, cert_len ) ) != 0 )
7983 {
7984 mbedtls_x509_crt_free( session->peer_cert );
7985 mbedtls_free( session->peer_cert );
7986 session->peer_cert = NULL;
7987 return( ret );
7988 }
7989
7990 p += cert_len;
7991 }
7992#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7993 /* Deserialize CRT digest from the end of the ticket. */
7994 if( 2 > (size_t)( end - p ) )
7995 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7996
7997 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7998 session->peer_cert_digest_len = (size_t) *p++;
7999
8000 if( session->peer_cert_digest_len != 0 )
8001 {
8002 const mbedtls_md_info_t *md_info =
8003 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8004 if( md_info == NULL )
8005 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8006 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8007 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8008
8009 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8010 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8011
8012 session->peer_cert_digest =
8013 mbedtls_calloc( 1, session->peer_cert_digest_len );
8014 if( session->peer_cert_digest == NULL )
8015 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8016
8017 memcpy( session->peer_cert_digest, p,
8018 session->peer_cert_digest_len );
8019 p += session->peer_cert_digest_len;
8020 }
8021#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8022#endif /* MBEDTLS_X509_CRT_PARSE_C */
8023
8024 /*
8025 * Session ticket and associated data
8026 */
8027#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8028 if( 3 > (size_t)( end - p ) )
8029 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8030
8031 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8032 p += 3;
8033
8034 if( session->ticket_len != 0 )
8035 {
8036 if( session->ticket_len > (size_t)( end - p ) )
8037 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8038
8039 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8040 if( session->ticket == NULL )
8041 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8042
8043 memcpy( session->ticket, p, session->ticket_len );
8044 p += session->ticket_len;
8045 }
8046
8047 if( 4 > (size_t)( end - p ) )
8048 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8049
8050 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8051 ( (uint32_t) p[1] << 16 ) |
8052 ( (uint32_t) p[2] << 8 ) |
8053 ( (uint32_t) p[3] );
8054 p += 4;
8055#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8056
8057 /*
8058 * Misc extension-related info
8059 */
8060#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8061 if( 1 > (size_t)( end - p ) )
8062 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8063
8064 session->mfl_code = *p++;
8065#endif
8066
8067#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8068 if( 1 > (size_t)( end - p ) )
8069 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8070
8071 session->encrypt_then_mac = *p++;
8072#endif
8073
8074 /* Done, should have consumed entire buffer */
8075 if( p != end )
8076 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8077
8078 return( 0 );
8079}
Jerry Yudc7bd172022-02-17 13:44:15 +08008080#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8081
XiaokangQian75d40ef2022-04-20 11:05:24 +00008082int mbedtls_ssl_validate_ciphersuite(
8083 const mbedtls_ssl_context *ssl,
8084 const mbedtls_ssl_ciphersuite_t *suite_info,
8085 mbedtls_ssl_protocol_version min_tls_version,
8086 mbedtls_ssl_protocol_version max_tls_version )
8087{
8088 (void) ssl;
8089
8090 if( suite_info == NULL )
8091 return( -1 );
8092
8093 if( ( suite_info->min_tls_version > max_tls_version ) ||
8094 ( suite_info->max_tls_version < min_tls_version ) )
8095 {
8096 return( -1 );
8097 }
8098
XiaokangQian060d8672022-04-21 09:24:56 +00008099#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008100#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8101 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8102 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8103 {
8104 return( -1 );
8105 }
8106#endif
8107
8108 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8109#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8110 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8111 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8112 {
8113 return( -1 );
8114 }
8115#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8116#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8117
8118 return( 0 );
8119}
8120
XiaokangQianeaf36512022-04-24 09:07:44 +00008121#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8122/*
8123 * Function for writing a signature algorithm extension.
8124 *
8125 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8126 * value (TLS 1.3 RFC8446):
8127 * enum {
8128 * ....
8129 * ecdsa_secp256r1_sha256( 0x0403 ),
8130 * ecdsa_secp384r1_sha384( 0x0503 ),
8131 * ecdsa_secp521r1_sha512( 0x0603 ),
8132 * ....
8133 * } SignatureScheme;
8134 *
8135 * struct {
8136 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8137 * } SignatureSchemeList;
8138 *
8139 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8140 * value (TLS 1.2 RFC5246):
8141 * enum {
8142 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8143 * sha512(6), (255)
8144 * } HashAlgorithm;
8145 *
8146 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8147 * SignatureAlgorithm;
8148 *
8149 * struct {
8150 * HashAlgorithm hash;
8151 * SignatureAlgorithm signature;
8152 * } SignatureAndHashAlgorithm;
8153 *
8154 * SignatureAndHashAlgorithm
8155 * supported_signature_algorithms<2..2^16-2>;
8156 *
8157 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8158 * generalization of the TLS 1.2 signature algorithm extension.
8159 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8160 * `SignatureScheme` field of TLS 1.3
8161 *
8162 */
8163int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8164 const unsigned char *end, size_t *out_len )
8165{
8166 unsigned char *p = buf;
8167 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8168 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8169
8170 *out_len = 0;
8171
8172 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8173
8174 /* Check if we have space for header and length field:
8175 * - extension_type (2 bytes)
8176 * - extension_data_length (2 bytes)
8177 * - supported_signature_algorithms_length (2 bytes)
8178 */
8179 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8180 p += 6;
8181
8182 /*
8183 * Write supported_signature_algorithms
8184 */
8185 supported_sig_alg = p;
8186 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8187 if( sig_alg == NULL )
8188 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8189
8190 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8191 {
8192 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8193 continue;
8194 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8195 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8196 p += 2;
8197 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x]", *sig_alg ) );
8198 }
8199
8200 /* Length of supported_signature_algorithms */
8201 supported_sig_alg_len = p - supported_sig_alg;
8202 if( supported_sig_alg_len == 0 )
8203 {
8204 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8205 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8206 }
8207
XiaokangQianeaf36512022-04-24 09:07:44 +00008208 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008209 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008210 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8211
XiaokangQianeaf36512022-04-24 09:07:44 +00008212 *out_len = p - buf;
8213
8214#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8215 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8216#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8217 return( 0 );
8218}
8219#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8220
XiaokangQian40a35232022-05-07 09:02:40 +00008221#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008222/*
8223 * mbedtls_ssl_parse_server_name_ext
8224 *
8225 * Structure of server_name extension:
8226 *
8227 * enum {
8228 * host_name(0), (255)
8229 * } NameType;
8230 * opaque HostName<1..2^16-1>;
8231 *
8232 * struct {
8233 * NameType name_type;
8234 * select (name_type) {
8235 * case host_name: HostName;
8236 * } name;
8237 * } ServerName;
8238 * struct {
8239 * ServerName server_name_list<1..2^16-1>
8240 * } ServerNameList;
8241 */
8242int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8243 const unsigned char *buf,
8244 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008245{
8246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8247 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008248 size_t server_name_list_len, hostname_len;
8249 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008250
XiaokangQianf2a94202022-05-20 06:44:24 +00008251 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008252
8253 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008254 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008255 p += 2;
8256
XiaokangQian9b2b7712022-05-17 02:57:00 +00008257 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8258 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008259 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008260 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008261 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008262 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008263 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8264 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008265
8266 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8267 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008268 /* sni_name is intended to be used only during the parsing of the
8269 * ClientHello message (it is reset to NULL before the end of
8270 * the message parsing). Thus it is ok to just point to the
8271 * reception buffer and not make a copy of it.
8272 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008273 ssl->handshake->sni_name = p + 3;
8274 ssl->handshake->sni_name_len = hostname_len;
8275 if( ssl->conf->f_sni == NULL )
8276 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008277 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008278 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008279 if( ret != 0 )
8280 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008281 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008282 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8283 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008284 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8285 }
8286 return( 0 );
8287 }
8288
8289 p += hostname_len + 3;
8290 }
8291
8292 return( 0 );
8293}
8294#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8295
XiaokangQianacb39922022-06-17 10:18:48 +00008296#if defined(MBEDTLS_SSL_ALPN)
8297int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8298 const unsigned char *buf,
8299 const unsigned char *end )
8300{
8301 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008302 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008303 const unsigned char *protocol_name_list;
8304 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008305 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008306
8307 /* If ALPN not configured, just ignore the extension */
8308 if( ssl->conf->alpn_list == NULL )
8309 return( 0 );
8310
8311 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008312 * RFC7301, section 3.1
8313 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008314 *
XiaokangQianc7403452022-06-23 03:24:12 +00008315 * struct {
8316 * ProtocolName protocol_name_list<2..2^16-1>
8317 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008318 */
8319
XiaokangQianc7403452022-06-23 03:24:12 +00008320 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008321 * protocol_name_list_len 2 bytes
8322 * protocol_name_len 1 bytes
8323 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008324 */
XiaokangQianacb39922022-06-17 10:18:48 +00008325 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8326
XiaokangQianc7403452022-06-23 03:24:12 +00008327 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008328 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008329 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008330 protocol_name_list = p;
8331 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008332
8333 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008334 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008335 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008336 protocol_name_len = *p++;
8337 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8338 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008339 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008340 {
8341 MBEDTLS_SSL_PEND_FATAL_ALERT(
8342 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8343 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008344 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008345 }
8346
8347 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008348 }
8349
8350 /* Use our order of preference */
8351 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8352 {
8353 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008354 p = protocol_name_list;
8355 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008356 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008357 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008358 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008359 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008360 {
8361 ssl->alpn_chosen = *alpn;
8362 return( 0 );
8363 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008364
8365 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008366 }
8367 }
8368
XiaokangQian95d5f542022-06-24 02:29:26 +00008369 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008370 MBEDTLS_SSL_PEND_FATAL_ALERT(
8371 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8372 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8373 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8374}
8375
8376int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8377 unsigned char *buf,
8378 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008379 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008380{
8381 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008382 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008383 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008384
8385 if( ssl->alpn_chosen == NULL )
8386 {
8387 return( 0 );
8388 }
8389
XiaokangQian95d5f542022-06-24 02:29:26 +00008390 protocol_name_len = strlen( ssl->alpn_chosen );
8391 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008392
8393 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8394 /*
8395 * 0 . 1 ext identifier
8396 * 2 . 3 ext length
8397 * 4 . 5 protocol list length
8398 * 6 . 6 protocol name length
8399 * 7 . 7+n protocol name
8400 */
8401 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8402
XiaokangQian95d5f542022-06-24 02:29:26 +00008403 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008404
XiaokangQian95d5f542022-06-24 02:29:26 +00008405 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8406 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008407 /* Note: the length of the chosen protocol has been checked to be less
8408 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8409 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008410 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008411
XiaokangQian95d5f542022-06-24 02:29:26 +00008412 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008413 return ( 0 );
8414}
8415#endif /* MBEDTLS_SSL_ALPN */
8416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008417#endif /* MBEDTLS_SSL_TLS_C */