blob: dba70e20dc58009ad84b8f6433eb68bc35e67ca7 [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 */
Jerry Yu6272c4d2022-06-22 13:46:55 +0800967
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
1475void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1476 int authmode )
1477{
1478 ssl->handshake->sni_authmode = authmode;
1479}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001480#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1481
Hanno Becker8927c832019-04-03 12:52:50 +01001482#if defined(MBEDTLS_X509_CRT_PARSE_C)
1483void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1484 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1485 void *p_vrfy )
1486{
1487 ssl->f_vrfy = f_vrfy;
1488 ssl->p_vrfy = p_vrfy;
1489}
1490#endif
1491
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001492#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001493/*
1494 * Set EC J-PAKE password for current handshake
1495 */
1496int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1497 const unsigned char *pw,
1498 size_t pw_len )
1499{
1500 mbedtls_ecjpake_role role;
1501
Janos Follath8eb64132016-06-03 15:40:57 +01001502 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001503 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1504
1505 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1506 role = MBEDTLS_ECJPAKE_SERVER;
1507 else
1508 role = MBEDTLS_ECJPAKE_CLIENT;
1509
1510 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1511 role,
1512 MBEDTLS_MD_SHA256,
1513 MBEDTLS_ECP_DP_SECP256R1,
1514 pw, pw_len ) );
1515}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001516#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001517
Gilles Peskineeccd8882020-03-10 12:19:08 +01001518#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001519
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001520static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1521{
1522#if defined(MBEDTLS_USE_PSA_CRYPTO)
1523 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1524 return( 1 );
1525#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001526 if( conf->psk != NULL )
1527 return( 1 );
1528
1529 return( 0 );
1530}
1531
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001532static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1533{
1534 /* Remove reference to existing PSK, if any. */
1535#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001536 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001537 {
1538 /* The maintenance of the PSK key slot is the
1539 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001540 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001541 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001542#endif /* MBEDTLS_USE_PSA_CRYPTO */
1543 if( conf->psk != NULL )
1544 {
1545 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1546
1547 mbedtls_free( conf->psk );
1548 conf->psk = NULL;
1549 conf->psk_len = 0;
1550 }
1551
1552 /* Remove reference to PSK identity, if any. */
1553 if( conf->psk_identity != NULL )
1554 {
1555 mbedtls_free( conf->psk_identity );
1556 conf->psk_identity = NULL;
1557 conf->psk_identity_len = 0;
1558 }
1559}
1560
Hanno Becker7390c712018-11-15 13:33:04 +00001561/* This function assumes that PSK identity in the SSL config is unset.
1562 * It checks that the provided identity is well-formed and attempts
1563 * to make a copy of it in the SSL config.
1564 * On failure, the PSK identity in the config remains unset. */
1565static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1566 unsigned char const *psk_identity,
1567 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001568{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001569 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001570 if( psk_identity == NULL ||
1571 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001572 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001573 {
1574 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1575 }
1576
Hanno Becker7390c712018-11-15 13:33:04 +00001577 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1578 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001579 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001580
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001581 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001582 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001583
1584 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001585}
1586
Hanno Becker7390c712018-11-15 13:33:04 +00001587int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1588 const unsigned char *psk, size_t psk_len,
1589 const unsigned char *psk_identity, size_t psk_identity_len )
1590{
Janos Follath865b3eb2019-12-16 11:46:15 +00001591 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001592
1593 /* We currently only support one PSK, raw or opaque. */
1594 if( ssl_conf_psk_is_configured( conf ) )
1595 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001596
1597 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001598 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001599 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001600 if( psk_len == 0 )
1601 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1602 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1603 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1604
Hanno Becker7390c712018-11-15 13:33:04 +00001605 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1606 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1607 conf->psk_len = psk_len;
1608 memcpy( conf->psk, psk, conf->psk_len );
1609
1610 /* Check and set PSK Identity */
1611 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1612 if( ret != 0 )
1613 ssl_conf_remove_psk( conf );
1614
1615 return( ret );
1616}
1617
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001618static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1619{
1620#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001621 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001622 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001623 /* The maintenance of the external PSK key slot is the
1624 * user's responsibility. */
1625 if( ssl->handshake->psk_opaque_is_internal )
1626 {
1627 psa_destroy_key( ssl->handshake->psk_opaque );
1628 ssl->handshake->psk_opaque_is_internal = 0;
1629 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001630 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001631 }
Neil Armstronge952a302022-05-03 10:22:14 +02001632#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001633 if( ssl->handshake->psk != NULL )
1634 {
1635 mbedtls_platform_zeroize( ssl->handshake->psk,
1636 ssl->handshake->psk_len );
1637 mbedtls_free( ssl->handshake->psk );
1638 ssl->handshake->psk_len = 0;
1639 }
Neil Armstronge952a302022-05-03 10:22:14 +02001640#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001641}
1642
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001643int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1644 const unsigned char *psk, size_t psk_len )
1645{
Neil Armstrong501c9322022-05-03 09:35:09 +02001646#if defined(MBEDTLS_USE_PSA_CRYPTO)
1647 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1648 psa_status_t status;
1649 psa_algorithm_t alg;
1650 mbedtls_svc_key_id_t key;
1651#endif /* MBEDTLS_USE_PSA_CRYPTO */
1652
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001653 if( psk == NULL || ssl->handshake == NULL )
1654 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1655
1656 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1657 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1658
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001659 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001660
Neil Armstrong501c9322022-05-03 09:35:09 +02001661#if defined(MBEDTLS_USE_PSA_CRYPTO)
1662 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1663 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1664 else
1665 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1666
1667 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1668 psa_set_key_algorithm( &key_attributes, alg );
1669 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1670
1671 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1672 if( status != PSA_SUCCESS )
1673 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1674
1675 /* Allow calling psa_destroy_key() on psk remove */
1676 ssl->handshake->psk_opaque_is_internal = 1;
1677 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1678#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001679 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001680 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001681
1682 ssl->handshake->psk_len = psk_len;
1683 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1684
1685 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001686#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001687}
1688
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001689#if defined(MBEDTLS_USE_PSA_CRYPTO)
1690int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001691 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001692 const unsigned char *psk_identity,
1693 size_t psk_identity_len )
1694{
Janos Follath865b3eb2019-12-16 11:46:15 +00001695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001696
1697 /* We currently only support one PSK, raw or opaque. */
1698 if( ssl_conf_psk_is_configured( conf ) )
1699 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001700
Hanno Becker7390c712018-11-15 13:33:04 +00001701 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001702 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001704 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001705
1706 /* Check and set PSK Identity */
1707 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1708 psk_identity_len );
1709 if( ret != 0 )
1710 ssl_conf_remove_psk( conf );
1711
1712 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001713}
1714
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001715int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1716 mbedtls_svc_key_id_t psk )
1717{
1718 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1719 ( ssl->handshake == NULL ) )
1720 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1721
1722 ssl_remove_psk( ssl );
1723 ssl->handshake->psk_opaque = psk;
1724 return( 0 );
1725}
1726#endif /* MBEDTLS_USE_PSA_CRYPTO */
1727
1728void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1729 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1730 size_t),
1731 void *p_psk )
1732{
1733 conf->f_psk = f_psk;
1734 conf->p_psk = p_psk;
1735}
1736#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1737
1738#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001739static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1740 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001741{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001742#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001743 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001744 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001745#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001746 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001747 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001748 return( MBEDTLS_SSL_MODE_STREAM );
1749}
1750
1751#else /* MBEDTLS_USE_PSA_CRYPTO */
1752
1753static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1754 mbedtls_cipher_mode_t mode )
1755{
1756#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1757 if( mode == MBEDTLS_MODE_CBC )
1758 return( MBEDTLS_SSL_MODE_CBC );
1759#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1760
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001761#if defined(MBEDTLS_GCM_C) || \
1762 defined(MBEDTLS_CCM_C) || \
1763 defined(MBEDTLS_CHACHAPOLY_C)
1764 if( mode == MBEDTLS_MODE_GCM ||
1765 mode == MBEDTLS_MODE_CCM ||
1766 mode == MBEDTLS_MODE_CHACHAPOLY )
1767 return( MBEDTLS_SSL_MODE_AEAD );
1768#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001769
1770 return( MBEDTLS_SSL_MODE_STREAM );
1771}
Gilles Peskine301711e2022-04-26 16:57:05 +02001772#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001773
Gilles Peskinee108d982022-04-26 16:50:40 +02001774static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1775 mbedtls_ssl_mode_t base_mode,
1776 int encrypt_then_mac )
1777{
1778#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1779 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1780 base_mode == MBEDTLS_SSL_MODE_CBC )
1781 {
1782 return( MBEDTLS_SSL_MODE_CBC_ETM );
1783 }
1784#else
1785 (void) encrypt_then_mac;
1786#endif
1787 return( base_mode );
1788}
1789
Neil Armstrongab555e02022-04-04 11:07:59 +02001790mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001791 const mbedtls_ssl_transform *transform )
1792{
Gilles Peskinee108d982022-04-26 16:50:40 +02001793 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001794#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001795 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001796#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001797 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1798#endif
1799 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001800
Gilles Peskinee108d982022-04-26 16:50:40 +02001801 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001802#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001803 encrypt_then_mac = transform->encrypt_then_mac;
1804#endif
1805 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001806}
1807
Neil Armstrongab555e02022-04-04 11:07:59 +02001808mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001809#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001810 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001811#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001812 const mbedtls_ssl_ciphersuite_t *suite )
1813{
Gilles Peskinee108d982022-04-26 16:50:40 +02001814 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1815
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001816#if defined(MBEDTLS_USE_PSA_CRYPTO)
1817 psa_status_t status;
1818 psa_algorithm_t alg;
1819 psa_key_type_t type;
1820 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001821 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1822 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001823 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001824#else
1825 const mbedtls_cipher_info_t *cipher =
1826 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001827 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001828 {
1829 base_mode =
1830 mbedtls_ssl_get_base_mode(
1831 mbedtls_cipher_info_get_mode( cipher ) );
1832 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001833#endif /* MBEDTLS_USE_PSA_CRYPTO */
1834
Gilles Peskinee108d982022-04-26 16:50:40 +02001835#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1836 int encrypt_then_mac = 0;
1837#endif
1838 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001839}
1840
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001841#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001842psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001843 size_t taglen,
1844 psa_algorithm_t *alg,
1845 psa_key_type_t *key_type,
1846 size_t *key_size )
1847{
1848 switch ( mbedtls_cipher_type )
1849 {
1850 case MBEDTLS_CIPHER_AES_128_CBC:
1851 *alg = PSA_ALG_CBC_NO_PADDING;
1852 *key_type = PSA_KEY_TYPE_AES;
1853 *key_size = 128;
1854 break;
1855 case MBEDTLS_CIPHER_AES_128_CCM:
1856 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1857 *key_type = PSA_KEY_TYPE_AES;
1858 *key_size = 128;
1859 break;
1860 case MBEDTLS_CIPHER_AES_128_GCM:
1861 *alg = PSA_ALG_GCM;
1862 *key_type = PSA_KEY_TYPE_AES;
1863 *key_size = 128;
1864 break;
1865 case MBEDTLS_CIPHER_AES_192_CCM:
1866 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1867 *key_type = PSA_KEY_TYPE_AES;
1868 *key_size = 192;
1869 break;
1870 case MBEDTLS_CIPHER_AES_192_GCM:
1871 *alg = PSA_ALG_GCM;
1872 *key_type = PSA_KEY_TYPE_AES;
1873 *key_size = 192;
1874 break;
1875 case MBEDTLS_CIPHER_AES_256_CBC:
1876 *alg = PSA_ALG_CBC_NO_PADDING;
1877 *key_type = PSA_KEY_TYPE_AES;
1878 *key_size = 256;
1879 break;
1880 case MBEDTLS_CIPHER_AES_256_CCM:
1881 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1882 *key_type = PSA_KEY_TYPE_AES;
1883 *key_size = 256;
1884 break;
1885 case MBEDTLS_CIPHER_AES_256_GCM:
1886 *alg = PSA_ALG_GCM;
1887 *key_type = PSA_KEY_TYPE_AES;
1888 *key_size = 256;
1889 break;
1890 case MBEDTLS_CIPHER_ARIA_128_CBC:
1891 *alg = PSA_ALG_CBC_NO_PADDING;
1892 *key_type = PSA_KEY_TYPE_ARIA;
1893 *key_size = 128;
1894 break;
1895 case MBEDTLS_CIPHER_ARIA_128_CCM:
1896 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1897 *key_type = PSA_KEY_TYPE_ARIA;
1898 *key_size = 128;
1899 break;
1900 case MBEDTLS_CIPHER_ARIA_128_GCM:
1901 *alg = PSA_ALG_GCM;
1902 *key_type = PSA_KEY_TYPE_ARIA;
1903 *key_size = 128;
1904 break;
1905 case MBEDTLS_CIPHER_ARIA_192_CCM:
1906 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1907 *key_type = PSA_KEY_TYPE_ARIA;
1908 *key_size = 192;
1909 break;
1910 case MBEDTLS_CIPHER_ARIA_192_GCM:
1911 *alg = PSA_ALG_GCM;
1912 *key_type = PSA_KEY_TYPE_ARIA;
1913 *key_size = 192;
1914 break;
1915 case MBEDTLS_CIPHER_ARIA_256_CBC:
1916 *alg = PSA_ALG_CBC_NO_PADDING;
1917 *key_type = PSA_KEY_TYPE_ARIA;
1918 *key_size = 256;
1919 break;
1920 case MBEDTLS_CIPHER_ARIA_256_CCM:
1921 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1922 *key_type = PSA_KEY_TYPE_ARIA;
1923 *key_size = 256;
1924 break;
1925 case MBEDTLS_CIPHER_ARIA_256_GCM:
1926 *alg = PSA_ALG_GCM;
1927 *key_type = PSA_KEY_TYPE_ARIA;
1928 *key_size = 256;
1929 break;
1930 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1931 *alg = PSA_ALG_CBC_NO_PADDING;
1932 *key_type = PSA_KEY_TYPE_CAMELLIA;
1933 *key_size = 128;
1934 break;
1935 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1936 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1937 *key_type = PSA_KEY_TYPE_CAMELLIA;
1938 *key_size = 128;
1939 break;
1940 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1941 *alg = PSA_ALG_GCM;
1942 *key_type = PSA_KEY_TYPE_CAMELLIA;
1943 *key_size = 128;
1944 break;
1945 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1946 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1947 *key_type = PSA_KEY_TYPE_CAMELLIA;
1948 *key_size = 192;
1949 break;
1950 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1951 *alg = PSA_ALG_GCM;
1952 *key_type = PSA_KEY_TYPE_CAMELLIA;
1953 *key_size = 192;
1954 break;
1955 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1956 *alg = PSA_ALG_CBC_NO_PADDING;
1957 *key_type = PSA_KEY_TYPE_CAMELLIA;
1958 *key_size = 256;
1959 break;
1960 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1961 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1962 *key_type = PSA_KEY_TYPE_CAMELLIA;
1963 *key_size = 256;
1964 break;
1965 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1966 *alg = PSA_ALG_GCM;
1967 *key_type = PSA_KEY_TYPE_CAMELLIA;
1968 *key_size = 256;
1969 break;
1970 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1971 *alg = PSA_ALG_CHACHA20_POLY1305;
1972 *key_type = PSA_KEY_TYPE_CHACHA20;
1973 *key_size = 256;
1974 break;
1975 case MBEDTLS_CIPHER_NULL:
1976 *alg = MBEDTLS_SSL_NULL_CIPHER;
1977 *key_type = 0;
1978 *key_size = 0;
1979 break;
1980 default:
1981 return PSA_ERROR_NOT_SUPPORTED;
1982 }
1983
1984 return PSA_SUCCESS;
1985}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001986#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001987
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001988#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001989int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1990 const unsigned char *dhm_P, size_t P_len,
1991 const unsigned char *dhm_G, size_t G_len )
1992{
Janos Follath865b3eb2019-12-16 11:46:15 +00001993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001994
Glenn Strausscee11292021-12-20 01:43:17 -05001995 mbedtls_mpi_free( &conf->dhm_P );
1996 mbedtls_mpi_free( &conf->dhm_G );
1997
Hanno Beckera90658f2017-10-04 15:29:08 +01001998 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1999 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2000 {
2001 mbedtls_mpi_free( &conf->dhm_P );
2002 mbedtls_mpi_free( &conf->dhm_G );
2003 return( ret );
2004 }
2005
2006 return( 0 );
2007}
Paul Bakker5121ce52009-01-03 21:22:43 +00002008
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002009int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002010{
Janos Follath865b3eb2019-12-16 11:46:15 +00002011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002012
Glenn Strausscee11292021-12-20 01:43:17 -05002013 mbedtls_mpi_free( &conf->dhm_P );
2014 mbedtls_mpi_free( &conf->dhm_G );
2015
Gilles Peskinee5702482021-06-11 21:59:08 +02002016 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2017 &conf->dhm_P ) ) != 0 ||
2018 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2019 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002020 {
2021 mbedtls_mpi_free( &conf->dhm_P );
2022 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002023 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002024 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002025
2026 return( 0 );
2027}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002028#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002029
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002030#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2031/*
2032 * Set the minimum length for Diffie-Hellman parameters
2033 */
2034void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2035 unsigned int bitlen )
2036{
2037 conf->dhm_min_bitlen = bitlen;
2038}
2039#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2040
Gilles Peskineeccd8882020-03-10 12:19:08 +01002041#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002042#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002043/*
2044 * Set allowed/preferred hashes for handshake signatures
2045 */
2046void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2047 const int *hashes )
2048{
2049 conf->sig_hashes = hashes;
2050}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002051#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002052
Jerry Yuf017ee42022-01-12 15:49:48 +08002053/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002054void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2055 const uint16_t* sig_algs )
2056{
Jerry Yuf017ee42022-01-12 15:49:48 +08002057#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2058 conf->sig_hashes = NULL;
2059#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2060 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002061}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002062#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002063
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002064#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002065#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002066/*
2067 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002068 *
2069 * mbedtls_ssl_setup() takes the provided list
2070 * and translates it to a list of IANA TLS group identifiers,
2071 * stored in ssl->handshake->group_list.
2072 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002073 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002074void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002075 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002076{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002077 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002078 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002079}
Brett Warrene0edc842021-08-17 09:53:13 +01002080#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002081#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002082
Brett Warrene0edc842021-08-17 09:53:13 +01002083/*
2084 * Set the allowed groups
2085 */
2086void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2087 const uint16_t *group_list )
2088{
2089#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2090 conf->curve_list = NULL;
2091#endif
2092 conf->group_list = group_list;
2093}
2094
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002095#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002097{
Hanno Becker947194e2017-04-07 13:25:49 +01002098 /* Initialize to suppress unnecessary compiler warning */
2099 size_t hostname_len = 0;
2100
2101 /* Check if new hostname is valid before
2102 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002103 if( hostname != NULL )
2104 {
2105 hostname_len = strlen( hostname );
2106
2107 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2108 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2109 }
2110
2111 /* Now it's clear that we will overwrite the old hostname,
2112 * so we can free it safely */
2113
2114 if( ssl->hostname != NULL )
2115 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002116 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002117 mbedtls_free( ssl->hostname );
2118 }
2119
2120 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002121
Paul Bakker5121ce52009-01-03 21:22:43 +00002122 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002123 {
2124 ssl->hostname = NULL;
2125 }
2126 else
2127 {
2128 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002129 if( ssl->hostname == NULL )
2130 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002131
Hanno Becker947194e2017-04-07 13:25:49 +01002132 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002133
Hanno Becker947194e2017-04-07 13:25:49 +01002134 ssl->hostname[hostname_len] = '\0';
2135 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002136
2137 return( 0 );
2138}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002139#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002140
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002141#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002142void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002144 const unsigned char *, size_t),
2145 void *p_sni )
2146{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002147 conf->f_sni = f_sni;
2148 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002149}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002153int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002154{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002155 size_t cur_len, tot_len;
2156 const char **p;
2157
2158 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002159 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2160 * MUST NOT be truncated."
2161 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002162 */
2163 tot_len = 0;
2164 for( p = protos; *p != NULL; p++ )
2165 {
2166 cur_len = strlen( *p );
2167 tot_len += cur_len;
2168
Ronald Cron8216dd32020-04-23 16:41:44 +02002169 if( ( cur_len == 0 ) ||
2170 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2171 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002173 }
2174
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002175 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002176
2177 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002178}
2179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002181{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002182 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002183}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002185
Johan Pascalb62bb512015-12-03 21:56:45 +01002186#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002187void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2188 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002189{
2190 conf->dtls_srtp_mki_support = support_mki_value;
2191}
2192
Ron Eldoref72faf2018-07-12 11:54:20 +03002193int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2194 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002195 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002196{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002197 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002198 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002199 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002200 }
Ron Eldor591f1622018-01-22 12:30:04 +02002201
2202 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002203 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002204 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002205 }
Ron Eldor591f1622018-01-22 12:30:04 +02002206
2207 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2208 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002209 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002210}
2211
Ron Eldoref72faf2018-07-12 11:54:20 +03002212int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002213 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002214{
Johan Pascal253d0262020-09-22 13:04:45 +02002215 const mbedtls_ssl_srtp_profile *p;
2216 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002217
Johan Pascal253d0262020-09-22 13:04:45 +02002218 /* check the profiles list: all entry must be valid,
2219 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002220 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2221 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2222 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002223 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002224 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002225 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002226 list_size++;
2227 }
2228 else
2229 {
2230 /* unsupported value, stop parsing and set the size to an error value */
2231 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002232 }
2233 }
2234
Johan Pascal5ef72d22020-10-28 17:05:47 +01002235 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002236 {
Johan Pascal253d0262020-09-22 13:04:45 +02002237 conf->dtls_srtp_profile_list = NULL;
2238 conf->dtls_srtp_profile_list_len = 0;
2239 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2240 }
2241
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002242 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002243 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002244
2245 return( 0 );
2246}
2247
Johan Pascal5ef72d22020-10-28 17:05:47 +01002248void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2249 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002250{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002251 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2252 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002253 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002254 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002255 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002256 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002257 else
2258 {
2259 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002260 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2261 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002262 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002263}
Johan Pascalb62bb512015-12-03 21:56:45 +01002264#endif /* MBEDTLS_SSL_DTLS_SRTP */
2265
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002266void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002267{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002268 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002269}
2270
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002271void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002272{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002273 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002274}
2275
Janos Follath088ce432017-04-10 12:42:31 +01002276#if defined(MBEDTLS_SSL_SRV_C)
2277void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2278 char cert_req_ca_list )
2279{
2280 conf->cert_req_ca_list = cert_req_ca_list;
2281}
2282#endif
2283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002285void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002286{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002287 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002288}
2289#endif
2290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002291#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002292void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002293{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002294 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002295}
2296#endif
2297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002299int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002300{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002302 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002303 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002305 }
2306
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002307 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002308
2309 return( 0 );
2310}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002312
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002313void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002314{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002315 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002316}
2317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002319void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002320{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002321 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002322}
2323
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002324void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002325{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002326 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002327}
2328
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002329void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002330 const unsigned char period[8] )
2331{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002332 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002333}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002337#if defined(MBEDTLS_SSL_CLI_C)
2338void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002339{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002340 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002341}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002342#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002343
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002344#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002345void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2346 mbedtls_ssl_ticket_write_t *f_ticket_write,
2347 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2348 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002349{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002350 conf->f_ticket_write = f_ticket_write;
2351 conf->f_ticket_parse = f_ticket_parse;
2352 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002353}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002354#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002356
Hanno Becker7e6c1782021-06-08 09:24:55 +01002357void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2358 mbedtls_ssl_export_keys_t *f_export_keys,
2359 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002360{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002361 ssl->f_export_keys = f_export_keys;
2362 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002363}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002364
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002365#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002366void mbedtls_ssl_conf_async_private_cb(
2367 mbedtls_ssl_config *conf,
2368 mbedtls_ssl_async_sign_t *f_async_sign,
2369 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2370 mbedtls_ssl_async_resume_t *f_async_resume,
2371 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002372 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002373{
2374 conf->f_async_sign_start = f_async_sign;
2375 conf->f_async_decrypt_start = f_async_decrypt;
2376 conf->f_async_resume = f_async_resume;
2377 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002378 conf->p_async_config_data = async_config_data;
2379}
2380
Gilles Peskine8f97af72018-04-26 11:46:10 +02002381void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2382{
2383 return( conf->p_async_config_data );
2384}
2385
Gilles Peskine1febfef2018-04-30 11:54:39 +02002386void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002387{
2388 if( ssl->handshake == NULL )
2389 return( NULL );
2390 else
2391 return( ssl->handshake->user_async_ctx );
2392}
2393
Gilles Peskine1febfef2018-04-30 11:54:39 +02002394void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002395 void *ctx )
2396{
2397 if( ssl->handshake != NULL )
2398 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002399}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002400#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002401
Paul Bakker5121ce52009-01-03 21:22:43 +00002402/*
2403 * SSL get accessors
2404 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002405uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002406{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002407 if( ssl->session != NULL )
2408 return( ssl->session->verify_result );
2409
2410 if( ssl->session_negotiate != NULL )
2411 return( ssl->session_negotiate->verify_result );
2412
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002413 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002414}
2415
Glenn Strauss8f526902022-01-13 00:04:49 -05002416int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2417{
2418 if( ssl == NULL || ssl->session == NULL )
2419 return( 0 );
2420
2421 return( ssl->session->ciphersuite );
2422}
2423
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002425{
Paul Bakker926c8e42013-03-06 10:23:34 +01002426 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002427 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002430}
2431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002433{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002435 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002436 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002437 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002438 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002439 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002440 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002441 default:
2442 return( "unknown (DTLS)" );
2443 }
2444 }
2445#endif
2446
Glenn Strauss60bfe602022-03-14 19:04:24 -04002447 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002448 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002449 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002450 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002451 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002452 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002453 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002454 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002455 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002456}
2457
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002458#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002459size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2460{
David Horstmann95d516f2021-05-04 18:36:56 +01002461 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002462 size_t read_mfl;
2463
2464 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2465 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2466 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2467 {
2468 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2469 }
2470
2471 /* Check if a smaller max length was negotiated */
2472 if( ssl->session_out != NULL )
2473 {
2474 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2475 if( read_mfl < max_len )
2476 {
2477 max_len = read_mfl;
2478 }
2479 }
2480
2481 // During a handshake, use the value being negotiated
2482 if( ssl->session_negotiate != NULL )
2483 {
2484 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2485 if( read_mfl < max_len )
2486 {
2487 max_len = read_mfl;
2488 }
2489 }
2490
2491 return( max_len );
2492}
2493
2494size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002495{
2496 size_t max_len;
2497
2498 /*
2499 * Assume mfl_code is correct since it was checked when set
2500 */
Angus Grattond8213d02016-05-25 20:56:48 +10002501 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002502
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002503 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002504 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002505 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002506 {
Angus Grattond8213d02016-05-25 20:56:48 +10002507 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002508 }
2509
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002510 /* During a handshake, use the value being negotiated */
2511 if( ssl->session_negotiate != NULL &&
2512 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2513 {
2514 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2515 }
2516
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002517 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002518}
2519#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2520
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002522size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002523{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002524 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2525 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2526 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2527 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2528 return ( 0 );
2529
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002530 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2531 return( ssl->mtu );
2532
2533 if( ssl->mtu == 0 )
2534 return( ssl->handshake->mtu );
2535
2536 return( ssl->mtu < ssl->handshake->mtu ?
2537 ssl->mtu : ssl->handshake->mtu );
2538}
2539#endif /* MBEDTLS_SSL_PROTO_DTLS */
2540
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002541int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2542{
2543 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2544
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002545#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2546 !defined(MBEDTLS_SSL_PROTO_DTLS)
2547 (void) ssl;
2548#endif
2549
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002550#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002551 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002552
2553 if( max_len > mfl )
2554 max_len = mfl;
2555#endif
2556
2557#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002558 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002559 {
Hanno Becker89490712020-02-05 10:50:12 +00002560 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002561 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2562 const size_t overhead = (size_t) ret;
2563
2564 if( ret < 0 )
2565 return( ret );
2566
2567 if( mtu <= overhead )
2568 {
2569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2570 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2571 }
2572
2573 if( max_len > mtu - overhead )
2574 max_len = mtu - overhead;
2575 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002576#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002577
Hanno Becker0defedb2018-08-10 12:35:02 +01002578#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2579 !defined(MBEDTLS_SSL_PROTO_DTLS)
2580 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002581#endif
2582
2583 return( (int) max_len );
2584}
2585
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002586int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2587{
2588 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2589
2590#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2591 (void) ssl;
2592#endif
2593
2594#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2595 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2596
2597 if( max_len > mfl )
2598 max_len = mfl;
2599#endif
2600
2601 return( (int) max_len );
2602}
2603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604#if defined(MBEDTLS_X509_CRT_PARSE_C)
2605const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002606{
2607 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002608 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002609
Hanno Beckere6824572019-02-07 13:18:46 +00002610#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002611 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002612#else
2613 return( NULL );
2614#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002615}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002619int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2620 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002621{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002622 int ret;
2623
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002624 if( ssl == NULL ||
2625 dst == NULL ||
2626 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002627 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002628 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002630 }
2631
Hanno Beckere810bbc2021-05-14 16:01:05 +01002632 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2633 * idempotent: Each session can only be exported once.
2634 *
2635 * (This is in preparation for TLS 1.3 support where we will
2636 * need the ability to export multiple sessions (aka tickets),
2637 * which will be achieved by calling mbedtls_ssl_get_session()
2638 * multiple times until it fails.)
2639 *
2640 * Check whether we have already exported the current session,
2641 * and fail if so.
2642 */
2643 if( ssl->session->exported == 1 )
2644 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2645
2646 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2647 if( ret != 0 )
2648 return( ret );
2649
2650 /* Remember that we've exported the session. */
2651 ssl->session->exported = 1;
2652 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002653}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002655
Paul Bakker5121ce52009-01-03 21:22:43 +00002656/*
Hanno Beckera835da52019-05-16 12:39:07 +01002657 * Define ticket header determining Mbed TLS version
2658 * and structure of the ticket.
2659 */
2660
Hanno Becker94ef3b32019-05-16 12:50:45 +01002661/*
Hanno Becker50b59662019-05-28 14:30:45 +01002662 * Define bitflag determining compile-time settings influencing
2663 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002664 */
2665
Hanno Becker50b59662019-05-28 14:30:45 +01002666#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002667#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002668#else
Hanno Becker3e088662019-05-29 11:10:18 +01002669#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002670#endif /* MBEDTLS_HAVE_TIME */
2671
2672#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002673#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002674#else
Hanno Becker3e088662019-05-29 11:10:18 +01002675#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002676#endif /* MBEDTLS_X509_CRT_PARSE_C */
2677
2678#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002679#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002680#else
Hanno Becker3e088662019-05-29 11:10:18 +01002681#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002682#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2683
2684#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002685#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002686#else
Hanno Becker3e088662019-05-29 11:10:18 +01002687#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002688#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2689
Hanno Becker94ef3b32019-05-16 12:50:45 +01002690#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002691#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002692#else
Hanno Becker3e088662019-05-29 11:10:18 +01002693#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002694#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2695
Hanno Becker94ef3b32019-05-16 12:50:45 +01002696#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2697#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2698#else
2699#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2700#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2701
Hanno Becker3e088662019-05-29 11:10:18 +01002702#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2703#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2704#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2705#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002706#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2707#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002708
Hanno Becker50b59662019-05-28 14:30:45 +01002709#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002710 ( (uint16_t) ( \
2711 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2712 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2713 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2714 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002715 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002716 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002717
Hanno Beckerf8787072019-05-16 12:41:07 +01002718static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002719 MBEDTLS_VERSION_MAJOR,
2720 MBEDTLS_VERSION_MINOR,
2721 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002722 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2723 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002724};
Hanno Beckera835da52019-05-16 12:39:07 +01002725
2726/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002727 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002728 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002729 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002730 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002731 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002732 * opaque mbedtls_version[3]; // library version: major, minor, patch
2733 * opaque session_format[2]; // library-version specific 16-bit field
2734 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002735 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002736 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002737 * Note: When updating the format, remember to keep
2738 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002739 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002740 * // In this version, `session_format` determines
2741 * // the setting of those compile-time
2742 * // configuration options which influence
2743 * // the structure of mbedtls_ssl_session.
2744 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002745 * uint8_t minor_ver; // Protocol minor version. Possible values:
2746 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002747 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002748 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002749 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002750 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002751 * serialized_session_tls12 data;
2752 *
2753 * };
2754 *
2755 * } serialized_session;
2756 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002757 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002758
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002759static int ssl_session_save( const mbedtls_ssl_session *session,
2760 unsigned char omit_header,
2761 unsigned char *buf,
2762 size_t buf_len,
2763 size_t *olen )
2764{
2765 unsigned char *p = buf;
2766 size_t used = 0;
2767
2768 if( !omit_header )
2769 {
2770 /*
2771 * Add Mbed TLS version identifier
2772 */
2773
2774 used += sizeof( ssl_serialized_session_header );
2775
2776 if( used <= buf_len )
2777 {
2778 memcpy( p, ssl_serialized_session_header,
2779 sizeof( ssl_serialized_session_header ) );
2780 p += sizeof( ssl_serialized_session_header );
2781 }
2782 }
2783
2784 /*
2785 * TLS version identifier
2786 */
2787 used += 1;
2788 if( used <= buf_len )
2789 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002790 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002791 }
2792
2793 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002794 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002795 {
2796#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002797 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002798 {
2799 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2800 used += ssl_session_save_tls12( session, p, remaining_len );
2801 break;
2802 }
2803#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2804
2805 default:
2806 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2807 }
2808
2809 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002810 if( used > buf_len )
2811 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002812
2813 return( 0 );
2814}
2815
2816/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002817 * Public wrapper for ssl_session_save()
2818 */
2819int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2820 unsigned char *buf,
2821 size_t buf_len,
2822 size_t *olen )
2823{
2824 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2825}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002826
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002827/*
2828 * Deserialize session, see mbedtls_ssl_session_save() for format.
2829 *
2830 * This internal version is wrapped by a public function that cleans up in
2831 * case of error, and has an extra option omit_header.
2832 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002833static int ssl_session_load( mbedtls_ssl_session *session,
2834 unsigned char omit_header,
2835 const unsigned char *buf,
2836 size_t len )
2837{
2838 const unsigned char *p = buf;
2839 const unsigned char * const end = buf + len;
2840
2841 if( !omit_header )
2842 {
2843 /*
2844 * Check Mbed TLS version identifier
2845 */
2846
2847 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2848 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2849
2850 if( memcmp( p, ssl_serialized_session_header,
2851 sizeof( ssl_serialized_session_header ) ) != 0 )
2852 {
2853 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2854 }
2855 p += sizeof( ssl_serialized_session_header );
2856 }
2857
2858 /*
2859 * TLS version identifier
2860 */
2861 if( 1 > (size_t)( end - p ) )
2862 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002863 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002864
2865 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002866 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002867 {
2868#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002869 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002870 {
2871 size_t remaining_len = ( end - p );
2872 return( ssl_session_load_tls12( session, p, remaining_len ) );
2873 }
2874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2875
2876 default:
2877 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2878 }
2879}
2880
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002881/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002882 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002883 */
2884int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2885 const unsigned char *buf,
2886 size_t len )
2887{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002888 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002889
2890 if( ret != 0 )
2891 mbedtls_ssl_session_free( session );
2892
2893 return( ret );
2894}
2895
2896/*
Paul Bakker1961b702013-01-25 14:49:24 +01002897 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002898 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002899static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2900{
2901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2902
Ronald Cron66dbf912022-02-02 15:33:46 +01002903 /*
2904 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002905 * that were written into the output buffer by the previous handshake step,
2906 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002907 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2908 * We proceed to the next handshake step only when all data from the
2909 * previous one have been sent to the peer, thus we make sure that this is
2910 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2911 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2912 * we have to wait before to go ahead.
2913 * In the case of TLS 1.3, handshake step handlers do not send data to the
2914 * peer. Data are only sent here and through
2915 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002916 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002917 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002918 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2919 return( ret );
2920
2921#if defined(MBEDTLS_SSL_PROTO_DTLS)
2922 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2923 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2924 {
2925 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2926 return( ret );
2927 }
2928#endif /* MBEDTLS_SSL_PROTO_DTLS */
2929
2930 return( ret );
2931}
2932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002934{
Hanno Becker41934dd2021-08-07 19:13:43 +01002935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002936
Hanno Becker41934dd2021-08-07 19:13:43 +01002937 if( ssl == NULL ||
2938 ssl->conf == NULL ||
2939 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002940 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002941 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002942 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002943 }
2944
2945 ret = ssl_prepare_handshake_step( ssl );
2946 if( ret != 0 )
2947 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002948
Jerry Yue7047812021-09-13 19:26:39 +08002949 ret = mbedtls_ssl_handle_pending_alert( ssl );
2950 if( ret != 0 )
2951 goto cleanup;
2952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002954 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002955 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002956 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2957 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002958
Ronald Cron9f0fba32022-02-10 16:45:15 +01002959 switch( ssl->state )
2960 {
2961 case MBEDTLS_SSL_HELLO_REQUEST:
2962 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2963 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002964
Ronald Cron9f0fba32022-02-10 16:45:15 +01002965 case MBEDTLS_SSL_CLIENT_HELLO:
2966 ret = mbedtls_ssl_write_client_hello( ssl );
2967 break;
2968
2969 default:
2970#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002971 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002972 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2973 else
2974 ret = mbedtls_ssl_handshake_client_step( ssl );
2975#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2976 ret = mbedtls_ssl_handshake_client_step( ssl );
2977#else
2978 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2979#endif
2980 }
Jerry Yub9930e72021-08-06 17:11:51 +08002981 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002982#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002984 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002985 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002986#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002987 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002988 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002989#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002990
2991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2992 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2993 ret = mbedtls_ssl_handshake_server_step( ssl );
2994#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2995 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002996#endif
2997
Jerry Yue7047812021-09-13 19:26:39 +08002998 if( ret != 0 )
2999 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003000 /* handshake_step return error. And it is same
3001 * with alert_reason.
3002 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003003 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003004 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003005 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003006 goto cleanup;
3007 }
3008 }
3009
3010cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003011 return( ret );
3012}
3013
3014/*
3015 * Perform the SSL handshake
3016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003018{
3019 int ret = 0;
3020
Hanno Beckera817ea42020-10-20 15:20:23 +01003021 /* Sanity checks */
3022
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003023 if( ssl == NULL || ssl->conf == NULL )
3024 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3025
Hanno Beckera817ea42020-10-20 15:20:23 +01003026#if defined(MBEDTLS_SSL_PROTO_DTLS)
3027 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3028 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3029 {
3030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3031 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3033 }
3034#endif /* MBEDTLS_SSL_PROTO_DTLS */
3035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003037
Hanno Beckera817ea42020-10-20 15:20:23 +01003038 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003039 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003040 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003042
3043 if( ret != 0 )
3044 break;
3045 }
3046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003048
3049 return( ret );
3050}
3051
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052#if defined(MBEDTLS_SSL_RENEGOTIATION)
3053#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003054/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003055 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003058{
Janos Follath865b3eb2019-12-16 11:46:15 +00003059 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003062
3063 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3065 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003066
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003067 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003068 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003069 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003070 return( ret );
3071 }
3072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003074
3075 return( 0 );
3076}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003078
3079/*
3080 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081 * - any side: calling mbedtls_ssl_renegotiate(),
3082 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3083 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003084 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003085 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003087 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003088int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003089{
Janos Follath865b3eb2019-12-16 11:46:15 +00003090 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003093
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003094 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3095 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003096
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003097 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3098 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003100 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003102 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003103 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003104 ssl->handshake->out_msg_seq = 1;
3105 else
3106 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003107 }
3108#endif
3109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3111 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003114 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003115 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003116 return( ret );
3117 }
3118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003120
3121 return( 0 );
3122}
3123
3124/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003125 * Renegotiate current connection on client,
3126 * or request renegotiation on server
3127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003129{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003131
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003132 if( ssl == NULL || ssl->conf == NULL )
3133 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003136 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003137 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003138 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003139 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003143
3144 /* Did we already try/start sending HelloRequest? */
3145 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003147
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003148 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003149 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003153 /*
3154 * On client, either start the renegotiation process or,
3155 * if already in progress, continue the handshake
3156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003158 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003159 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003161
Hanno Becker40cdaa12020-02-05 10:48:27 +00003162 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003163 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003164 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003165 return( ret );
3166 }
3167 }
3168 else
3169 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003171 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003173 return( ret );
3174 }
3175 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003177
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003178 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003179}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003180#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003181
Gilles Peskine9b562d52018-04-25 20:32:43 +02003182void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003183{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003184 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3185
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003186 if( handshake == NULL )
3187 return;
3188
Brett Warrene0edc842021-08-17 09:53:13 +01003189#if defined(MBEDTLS_ECP_C)
3190#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3191 if ( ssl->handshake->group_list_heap_allocated )
3192 mbedtls_free( (void*) handshake->group_list );
3193 handshake->group_list = NULL;
3194#endif /* MBEDTLS_DEPRECATED_REMOVED */
3195#endif /* MBEDTLS_ECP_C */
3196
Jerry Yuf017ee42022-01-12 15:49:48 +08003197#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3198#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3199 if ( ssl->handshake->sig_algs_heap_allocated )
3200 mbedtls_free( (void*) handshake->sig_algs );
3201 handshake->sig_algs = NULL;
3202#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003203#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3204 if( ssl->handshake->certificate_request_context )
3205 {
3206 mbedtls_free( (void*) handshake->certificate_request_context );
3207 }
3208#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003209#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3210
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003211#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3212 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3213 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003214 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003215 handshake->async_in_progress = 0;
3216 }
3217#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3218
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003219#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003220#if defined(MBEDTLS_USE_PSA_CRYPTO)
3221 psa_hash_abort( &handshake->fin_sha256_psa );
3222#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003223 mbedtls_sha256_free( &handshake->fin_sha256 );
3224#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003225#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003226#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003227#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003228 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003229#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003230 mbedtls_sha512_free( &handshake->fin_sha512 );
3231#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003232#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#if defined(MBEDTLS_DHM_C)
3235 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003236#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003237#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003239#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003240#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003241 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003242#if defined(MBEDTLS_SSL_CLI_C)
3243 mbedtls_free( handshake->ecjpake_cache );
3244 handshake->ecjpake_cache = NULL;
3245 handshake->ecjpake_cache_len = 0;
3246#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003247#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003248
Janos Follath4ae5c292016-02-10 11:27:43 +00003249#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3250 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003251 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003253#endif
3254
Gilles Peskineeccd8882020-03-10 12:19:08 +01003255#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003256#if defined(MBEDTLS_USE_PSA_CRYPTO)
3257 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3258 {
3259 /* The maintenance of the external PSK key slot is the
3260 * user's responsibility. */
3261 if( ssl->handshake->psk_opaque_is_internal )
3262 {
3263 psa_destroy_key( ssl->handshake->psk_opaque );
3264 ssl->handshake->psk_opaque_is_internal = 0;
3265 }
3266 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3267 }
Neil Armstronge952a302022-05-03 10:22:14 +02003268#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003269 if( handshake->psk != NULL )
3270 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003271 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003272 mbedtls_free( handshake->psk );
3273 }
Neil Armstronge952a302022-05-03 10:22:14 +02003274#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003275#endif
3276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3278 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003279 /*
3280 * Free only the linked list wrapper, not the keys themselves
3281 * since the belong to the SNI callback
3282 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003283 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003285
Gilles Peskineeccd8882020-03-10 12:19:08 +01003286#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003287 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003288 if( handshake->ecrs_peer_cert != NULL )
3289 {
3290 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3291 mbedtls_free( handshake->ecrs_peer_cert );
3292 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003293#endif
3294
Hanno Becker75173122019-02-06 16:18:31 +00003295#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3296 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3297 mbedtls_pk_free( &handshake->peer_pubkey );
3298#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3299
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003300#if defined(MBEDTLS_SSL_CLI_C) && \
3301 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3302 mbedtls_free( handshake->cookie );
3303#endif /* MBEDTLS_SSL_CLI_C &&
3304 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003305
3306#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003307 mbedtls_ssl_flight_free( handshake->flight );
3308 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003309#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003310
Ronald Cronf12b81d2022-03-15 10:42:41 +01003311#if defined(MBEDTLS_ECDH_C) && \
3312 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003313 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003314 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003315#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3316
Ronald Cron6f135e12021-12-08 16:57:54 +01003317#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003318 mbedtls_ssl_transform_free( handshake->transform_handshake );
3319 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003320 mbedtls_free( handshake->transform_earlydata );
3321 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003322#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003323
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003324
3325#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3326 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3327 * processes datagrams and the fact that a datagram is allowed to have
3328 * several records in it, it is possible that the I/O buffers are not
3329 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003330 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3331 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003332#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003333
Jerry Yuba9c7272021-10-30 11:54:10 +08003334 /* mbedtls_platform_zeroize MUST be last one in this function */
3335 mbedtls_platform_zeroize( handshake,
3336 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003337}
3338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003340{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003341 if( session == NULL )
3342 return;
3343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003345 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003346#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003347
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003348#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003350#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003351
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003352 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003353}
3354
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003355#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003356
3357#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3358#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3359#else
3360#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3361#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3362
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003363#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003364
3365#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3366#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3367#else
3368#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3369#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3370
3371#if defined(MBEDTLS_SSL_ALPN)
3372#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3373#else
3374#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3375#endif /* MBEDTLS_SSL_ALPN */
3376
3377#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3378#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3379#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3380#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3381
3382#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3383 ( (uint32_t) ( \
3384 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3385 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3386 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3387 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3388 0u ) )
3389
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003390static unsigned char ssl_serialized_context_header[] = {
3391 MBEDTLS_VERSION_MAJOR,
3392 MBEDTLS_VERSION_MINOR,
3393 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003394 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3395 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3396 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3397 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3398 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003399};
3400
Paul Bakker5121ce52009-01-03 21:22:43 +00003401/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003402 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003403 *
3404 * The format of the serialized data is:
3405 * (in the presentation language of TLS, RFC 8446 section 3)
3406 *
3407 * // header
3408 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003409 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003410 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003411 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003412 * Note: When updating the format, remember to keep these
3413 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003414 *
3415 * // session sub-structure
3416 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3417 * // transform sub-structure
3418 * uint8 random[64]; // ServerHello.random+ClientHello.random
3419 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3420 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3421 * // fields from ssl_context
3422 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3423 * uint64 in_window_top; // DTLS: last validated record seq_num
3424 * uint64 in_window; // DTLS: bitmask for replay protection
3425 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3426 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3427 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3428 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3429 *
3430 * Note that many fields of the ssl_context or sub-structures are not
3431 * serialized, as they fall in one of the following categories:
3432 *
3433 * 1. forced value (eg in_left must be 0)
3434 * 2. pointer to dynamically-allocated memory (eg session, transform)
3435 * 3. value can be re-derived from other data (eg session keys from MS)
3436 * 4. value was temporary (eg content of input buffer)
3437 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003438 */
3439int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3440 unsigned char *buf,
3441 size_t buf_len,
3442 size_t *olen )
3443{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003444 unsigned char *p = buf;
3445 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003446 size_t session_len;
3447 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003448
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003449 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003450 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3451 * this function's documentation.
3452 *
3453 * These are due to assumptions/limitations in the implementation. Some of
3454 * them are likely to stay (no handshake in progress) some might go away
3455 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003456 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003457 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003458 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003459 {
3460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003461 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003462 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003463 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003464 {
3465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003466 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003467 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003468 /* Double-check that sub-structures are indeed ready */
3469 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003470 {
3471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003472 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003473 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003474 /* There must be no pending incoming or outgoing data */
3475 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003476 {
3477 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003478 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003479 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003480 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003481 {
3482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003483 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003484 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003485 /* Protocol must be DLTS, not TLS */
3486 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003487 {
3488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003489 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003490 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003491 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003492 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003493 {
3494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003495 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003496 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003497 /* We must be using an AEAD ciphersuite */
3498 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003499 {
3500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003501 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003502 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003503 /* Renegotiation must not be enabled */
3504#if defined(MBEDTLS_SSL_RENEGOTIATION)
3505 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003506 {
3507 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003508 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003509 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003510#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003511
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003512 /*
3513 * Version and format identifier
3514 */
3515 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003516
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003517 if( used <= buf_len )
3518 {
3519 memcpy( p, ssl_serialized_context_header,
3520 sizeof( ssl_serialized_context_header ) );
3521 p += sizeof( ssl_serialized_context_header );
3522 }
3523
3524 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003525 * Session (length + data)
3526 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003527 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003528 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3529 return( ret );
3530
3531 used += 4 + session_len;
3532 if( used <= buf_len )
3533 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003534 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3535 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003536
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003537 ret = ssl_session_save( ssl->session, 1,
3538 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003539 if( ret != 0 )
3540 return( ret );
3541
3542 p += session_len;
3543 }
3544
3545 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003546 * Transform
3547 */
3548 used += sizeof( ssl->transform->randbytes );
3549 if( used <= buf_len )
3550 {
3551 memcpy( p, ssl->transform->randbytes,
3552 sizeof( ssl->transform->randbytes ) );
3553 p += sizeof( ssl->transform->randbytes );
3554 }
3555
3556#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3557 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3558 if( used <= buf_len )
3559 {
3560 *p++ = ssl->transform->in_cid_len;
3561 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3562 p += ssl->transform->in_cid_len;
3563
3564 *p++ = ssl->transform->out_cid_len;
3565 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3566 p += ssl->transform->out_cid_len;
3567 }
3568#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3569
3570 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003571 * Saved fields from top-level ssl_context structure
3572 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003573 used += 4;
3574 if( used <= buf_len )
3575 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003576 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3577 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003578 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003579
3580#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3581 used += 16;
3582 if( used <= buf_len )
3583 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003584 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3585 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003586
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003587 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3588 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003589 }
3590#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3591
3592#if defined(MBEDTLS_SSL_PROTO_DTLS)
3593 used += 1;
3594 if( used <= buf_len )
3595 {
3596 *p++ = ssl->disable_datagram_packing;
3597 }
3598#endif /* MBEDTLS_SSL_PROTO_DTLS */
3599
Jerry Yuae0b2e22021-10-08 15:21:19 +08003600 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003601 if( used <= buf_len )
3602 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003603 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3604 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003605 }
3606
3607#if defined(MBEDTLS_SSL_PROTO_DTLS)
3608 used += 2;
3609 if( used <= buf_len )
3610 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003611 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3612 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003613 }
3614#endif /* MBEDTLS_SSL_PROTO_DTLS */
3615
3616#if defined(MBEDTLS_SSL_ALPN)
3617 {
3618 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003619 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003620 : 0;
3621
3622 used += 1 + alpn_len;
3623 if( used <= buf_len )
3624 {
3625 *p++ = alpn_len;
3626
3627 if( ssl->alpn_chosen != NULL )
3628 {
3629 memcpy( p, ssl->alpn_chosen, alpn_len );
3630 p += alpn_len;
3631 }
3632 }
3633 }
3634#endif /* MBEDTLS_SSL_ALPN */
3635
3636 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003637 * Done
3638 */
3639 *olen = used;
3640
3641 if( used > buf_len )
3642 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003643
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003644 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3645
Hanno Becker43aefe22020-02-05 10:44:56 +00003646 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003647}
3648
3649/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003650 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003651 *
3652 * This internal version is wrapped by a public function that cleans up in
3653 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003654 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003655static int ssl_context_load( mbedtls_ssl_context *ssl,
3656 const unsigned char *buf,
3657 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003658{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003659 const unsigned char *p = buf;
3660 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003661 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003663
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003664 /*
3665 * The context should have been freshly setup or reset.
3666 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003667 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003668 * renegotiating, or if the user mistakenly loaded a session first.)
3669 */
3670 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3671 ssl->session != NULL )
3672 {
3673 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3674 }
3675
3676 /*
3677 * We can't check that the config matches the initial one, but we can at
3678 * least check it matches the requirements for serializing.
3679 */
3680 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003681 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3682 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003683#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003684 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003685#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003686 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003687 {
3688 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3689 }
3690
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003691 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3692
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003693 /*
3694 * Check version identifier
3695 */
3696 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3697 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3698
3699 if( memcmp( p, ssl_serialized_context_header,
3700 sizeof( ssl_serialized_context_header ) ) != 0 )
3701 {
3702 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3703 }
3704 p += sizeof( ssl_serialized_context_header );
3705
3706 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003707 * Session
3708 */
3709 if( (size_t)( end - p ) < 4 )
3710 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3711
3712 session_len = ( (size_t) p[0] << 24 ) |
3713 ( (size_t) p[1] << 16 ) |
3714 ( (size_t) p[2] << 8 ) |
3715 ( (size_t) p[3] );
3716 p += 4;
3717
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003718 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003719 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003720 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003721 ssl->session_in = ssl->session;
3722 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003723 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003724
3725 if( (size_t)( end - p ) < session_len )
3726 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3727
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003728 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003730 {
3731 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003732 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003733 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003734
3735 p += session_len;
3736
3737 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003738 * Transform
3739 */
3740
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003741 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003742 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003743 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003744 ssl->transform_in = ssl->transform;
3745 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003746 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003747
3748 /* Read random bytes and populate structure */
3749 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3750 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003751#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003752 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003753 ssl->session->ciphersuite,
3754 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003755#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003756 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003757#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003758 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3759 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003760 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003761 ssl->conf->endpoint,
3762 ssl );
3763 if( ret != 0 )
3764 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003765#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003766 p += sizeof( ssl->transform->randbytes );
3767
3768#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3769 /* Read connection IDs and store them */
3770 if( (size_t)( end - p ) < 1 )
3771 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3772
3773 ssl->transform->in_cid_len = *p++;
3774
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003775 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3777
3778 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3779 p += ssl->transform->in_cid_len;
3780
3781 ssl->transform->out_cid_len = *p++;
3782
3783 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3785
3786 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3787 p += ssl->transform->out_cid_len;
3788#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3789
3790 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003791 * Saved fields from top-level ssl_context structure
3792 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003793 if( (size_t)( end - p ) < 4 )
3794 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3795
3796 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3797 ( (uint32_t) p[1] << 16 ) |
3798 ( (uint32_t) p[2] << 8 ) |
3799 ( (uint32_t) p[3] );
3800 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003801
3802#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3803 if( (size_t)( end - p ) < 16 )
3804 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3805
3806 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3807 ( (uint64_t) p[1] << 48 ) |
3808 ( (uint64_t) p[2] << 40 ) |
3809 ( (uint64_t) p[3] << 32 ) |
3810 ( (uint64_t) p[4] << 24 ) |
3811 ( (uint64_t) p[5] << 16 ) |
3812 ( (uint64_t) p[6] << 8 ) |
3813 ( (uint64_t) p[7] );
3814 p += 8;
3815
3816 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3817 ( (uint64_t) p[1] << 48 ) |
3818 ( (uint64_t) p[2] << 40 ) |
3819 ( (uint64_t) p[3] << 32 ) |
3820 ( (uint64_t) p[4] << 24 ) |
3821 ( (uint64_t) p[5] << 16 ) |
3822 ( (uint64_t) p[6] << 8 ) |
3823 ( (uint64_t) p[7] );
3824 p += 8;
3825#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3826
3827#if defined(MBEDTLS_SSL_PROTO_DTLS)
3828 if( (size_t)( end - p ) < 1 )
3829 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3830
3831 ssl->disable_datagram_packing = *p++;
3832#endif /* MBEDTLS_SSL_PROTO_DTLS */
3833
Jerry Yud9a94fe2021-09-28 18:58:59 +08003834 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003835 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003836 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3837 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003838
3839#if defined(MBEDTLS_SSL_PROTO_DTLS)
3840 if( (size_t)( end - p ) < 2 )
3841 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3842
3843 ssl->mtu = ( p[0] << 8 ) | p[1];
3844 p += 2;
3845#endif /* MBEDTLS_SSL_PROTO_DTLS */
3846
3847#if defined(MBEDTLS_SSL_ALPN)
3848 {
3849 uint8_t alpn_len;
3850 const char **cur;
3851
3852 if( (size_t)( end - p ) < 1 )
3853 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3854
3855 alpn_len = *p++;
3856
3857 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3858 {
3859 /* alpn_chosen should point to an item in the configured list */
3860 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3861 {
3862 if( strlen( *cur ) == alpn_len &&
3863 memcmp( p, cur, alpn_len ) == 0 )
3864 {
3865 ssl->alpn_chosen = *cur;
3866 break;
3867 }
3868 }
3869 }
3870
3871 /* can only happen on conf mismatch */
3872 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3873 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3874
3875 p += alpn_len;
3876 }
3877#endif /* MBEDTLS_SSL_ALPN */
3878
3879 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003880 * Forced fields from top-level ssl_context structure
3881 *
3882 * Most of them already set to the correct value by mbedtls_ssl_init() and
3883 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3884 */
3885 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003886 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003887
Hanno Becker361b10d2019-08-30 10:42:49 +01003888 /* Adjust pointers for header fields of outgoing records to
3889 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003890 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003891
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003892#if defined(MBEDTLS_SSL_PROTO_DTLS)
3893 ssl->in_epoch = 1;
3894#endif
3895
3896 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3897 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003898 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3899 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003900 if( ssl->handshake != NULL )
3901 {
3902 mbedtls_ssl_handshake_free( ssl );
3903 mbedtls_free( ssl->handshake );
3904 ssl->handshake = NULL;
3905 }
3906
3907 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003908 * Done - should have consumed entire buffer
3909 */
3910 if( p != end )
3911 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003912
3913 return( 0 );
3914}
3915
3916/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003917 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003918 */
3919int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3920 const unsigned char *buf,
3921 size_t len )
3922{
3923 int ret = ssl_context_load( context, buf, len );
3924
3925 if( ret != 0 )
3926 mbedtls_ssl_free( context );
3927
3928 return( ret );
3929}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003930#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003931
3932/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003933 * Free an SSL context
3934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003935void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003936{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003937 if( ssl == NULL )
3938 return;
3939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003941
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003942 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003943 {
sander-visserb8aa2072020-05-06 22:05:13 +02003944#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3945 size_t out_buf_len = ssl->out_buf_len;
3946#else
3947 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3948#endif
3949
Darryl Greenb33cc762019-11-28 14:29:44 +00003950 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003951 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003952 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003953 }
3954
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003955 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003956 {
sander-visserb8aa2072020-05-06 22:05:13 +02003957#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3958 size_t in_buf_len = ssl->in_buf_len;
3959#else
3960 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3961#endif
3962
Darryl Greenb33cc762019-11-28 14:29:44 +00003963 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003964 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003965 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003966 }
3967
Paul Bakker48916f92012-09-16 19:57:18 +00003968 if( ssl->transform )
3969 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003970 mbedtls_ssl_transform_free( ssl->transform );
3971 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003972 }
3973
3974 if( ssl->handshake )
3975 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003976 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3978 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003980 mbedtls_free( ssl->handshake );
3981 mbedtls_free( ssl->transform_negotiate );
3982 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003983 }
3984
Ronald Cron6f135e12021-12-08 16:57:54 +01003985#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003986 mbedtls_ssl_transform_free( ssl->transform_application );
3987 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003988#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003989
Paul Bakkerc0463502013-02-14 11:19:38 +01003990 if( ssl->session )
3991 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003992 mbedtls_ssl_session_free( ssl->session );
3993 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003994 }
3995
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003996#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003997 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003998 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003999 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004000 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004001 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004002#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004003
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004004#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004006#endif
4007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004009
Paul Bakker86f04f42013-02-14 11:20:09 +01004010 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004011 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004012}
4013
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004014/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004015 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004016 */
4017void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4018{
4019 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4020}
4021
Gilles Peskineae270bf2021-06-02 00:05:29 +02004022/* The selection should be the same as mbedtls_x509_crt_profile_default in
4023 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004024 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004025 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004026 * about this list.
4027 */
Brett Warrene0edc842021-08-17 09:53:13 +01004028static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004029#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004030 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004031#endif
4032#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004033 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004034#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004035#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004036 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004037#endif
4038#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004039 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004040#endif
4041#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004042 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004043#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004044#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004045 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004046#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004047#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004048 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004049#endif
4050#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004051 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004052#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004053 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004054};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004055
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004056static int ssl_preset_suiteb_ciphersuites[] = {
4057 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4058 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4059 0
4060};
4061
Gilles Peskineeccd8882020-03-10 12:19:08 +01004062#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004063
Jerry Yu909df7b2022-01-22 11:56:27 +08004064/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004065 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004066 * rules SHOULD be upheld.
4067 * - No duplicate entries.
4068 * - But if there is a good reason, do not change the order of the algorithms.
4069 * - ssl_tls12_present* is for TLS 1.2 use only.
4070 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004071 *
Jerry Yua1255e62022-06-24 10:10:47 +08004072 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4073 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4074 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
4075 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4076 * for its signature in the key exchange message and as Mbed TLS 1.2 does not
4077 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004078 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004079static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004080
Jerry Yued5e9f42022-01-26 11:21:34 +08004081#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4082 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4083 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4084#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4085 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004086
Jerry Yu909df7b2022-01-22 11:56:27 +08004087#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4088 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4089 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4090#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4091 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4092
Jerry Yued5e9f42022-01-26 11:21:34 +08004093#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4094 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4095 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4096#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4097 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004098
Jerry Yuba5e3792022-06-21 15:26:05 +08004099#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4100 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4101#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4102
4103#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4104 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4105#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4106
4107#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4108 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4109#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4110
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004111#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4112 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4113#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4114
4115#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4116 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4117#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4118
4119#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4120 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4121#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4122
Gabor Mezei15b95a62022-05-09 16:37:58 +02004123 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004124};
4125
4126/* NOTICE: see above */
4127#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4128static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004129#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004130#if defined(MBEDTLS_ECDSA_C)
4131 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004132#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004133#if defined(MBEDTLS_RSA_C)
4134 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4135#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004136#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004137#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004138#if defined(MBEDTLS_ECDSA_C)
4139 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004140#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004141#if defined(MBEDTLS_RSA_C)
4142 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4143#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004144#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004145#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004146#if defined(MBEDTLS_ECDSA_C)
4147 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004148#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004149#if defined(MBEDTLS_RSA_C)
4150 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4151#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004152#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004153 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004154};
4155#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4156/* NOTICE: see above */
4157static uint16_t ssl_preset_suiteb_sig_algs[] = {
4158
Jerry Yu909df7b2022-01-22 11:56:27 +08004159#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4160 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4161 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4162#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4163 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4164
Jerry Yu53037892022-01-25 11:02:06 +08004165#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4166 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4167 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4168#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4169 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004170
4171#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4172 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4173#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004174
Jerry Yu53037892022-01-25 11:02:06 +08004175#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4176 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4177#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4178
Gabor Mezei15b95a62022-05-09 16:37:58 +02004179 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004180};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004181
Jerry Yu909df7b2022-01-22 11:56:27 +08004182/* NOTICE: see above */
4183#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4184static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004185#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004186#if defined(MBEDTLS_ECDSA_C)
4187 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004188#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004189#if defined(MBEDTLS_RSA_C)
4190 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4191#endif
4192#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004193#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004194#if defined(MBEDTLS_ECDSA_C)
4195 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004196#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004197#if defined(MBEDTLS_RSA_C)
4198 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4199#endif
4200#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004201 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004202};
Jerry Yu909df7b2022-01-22 11:56:27 +08004203#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4204
Jerry Yu1a8b4812022-01-20 17:56:50 +08004205#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004206
Brett Warrene0edc842021-08-17 09:53:13 +01004207static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004208#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004209 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004210#endif
4211#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004212 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004213#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004214 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004215};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004216
Jerry Yu1a8b4812022-01-20 17:56:50 +08004217#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004218/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004219 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004220static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004221{
4222 size_t i, j;
4223 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004224
Gabor Mezei15b95a62022-05-09 16:37:58 +02004225 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004226 {
Jerry Yuf377d642022-01-25 10:43:59 +08004227 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004228 {
Jerry Yuf377d642022-01-25 10:43:59 +08004229 if( sig_algs[i] != sig_algs[j] )
4230 continue;
4231 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4232 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4233 sig_algs[i], j, i );
4234 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004235 }
4236 }
4237 return( ret );
4238}
4239
4240#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4241
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004242/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004243 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004244 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004245int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004246 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004247{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004248#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004250#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004251
Jerry Yu1a8b4812022-01-20 17:56:50 +08004252#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004253 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004254 {
4255 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4256 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4257 }
4258
Jerry Yuf377d642022-01-25 10:43:59 +08004259 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004260 {
4261 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4262 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4263 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004264
4265#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004266 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004267 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004268 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004269 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4270 }
4271
Jerry Yuf377d642022-01-25 10:43:59 +08004272 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004273 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004274 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004275 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4276 }
4277#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004278#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4279
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004280 /* Use the functions here so that they are covered in tests,
4281 * but otherwise access member directly for efficiency */
4282 mbedtls_ssl_conf_endpoint( conf, endpoint );
4283 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004284
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004285 /*
4286 * Things that are common to all presets
4287 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004288#if defined(MBEDTLS_SSL_CLI_C)
4289 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4290 {
4291 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4292#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4293 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4294#endif
4295 }
4296#endif
4297
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004298#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4299 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4300#endif
4301
4302#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4303 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4304#endif
4305
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004306#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004307 conf->f_cookie_write = ssl_cookie_write_dummy;
4308 conf->f_cookie_check = ssl_cookie_check_dummy;
4309#endif
4310
4311#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4312 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4313#endif
4314
Janos Follath088ce432017-04-10 12:42:31 +01004315#if defined(MBEDTLS_SSL_SRV_C)
4316 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004317 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004318#endif
4319
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004320#if defined(MBEDTLS_SSL_PROTO_DTLS)
4321 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4322 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4323#endif
4324
4325#if defined(MBEDTLS_SSL_RENEGOTIATION)
4326 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004327 memset( conf->renego_period, 0x00, 2 );
4328 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004329#endif
4330
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004331#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004332 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4333 {
4334 const unsigned char dhm_p[] =
4335 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4336 const unsigned char dhm_g[] =
4337 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004338
Hanno Beckere2defad2021-07-24 05:59:17 +01004339 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4340 dhm_p, sizeof( dhm_p ),
4341 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4342 {
4343 return( ret );
4344 }
4345 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004346#endif
4347
Ronald Cron6f135e12021-12-08 16:57:54 +01004348#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004349 /*
4350 * Allow all TLS 1.3 key exchange modes by default.
4351 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004352 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004354
XiaokangQian4d3a6042022-04-21 13:46:17 +00004355 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4356 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004357#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004358 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004359 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004360#else
XiaokangQian060d8672022-04-21 09:24:56 +00004361 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004362#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004363 }
4364 else
4365 {
4366#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4367 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4368 {
4369 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4370 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4371 }
4372 else
4373 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4374 {
4375 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4376 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4377 }
4378#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4379 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4380 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4381#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4382 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4383 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4384#else
4385 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4386#endif
4387 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004388
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004389 /*
4390 * Preset-specific defaults
4391 */
4392 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004393 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004394 /*
4395 * NSA Suite B
4396 */
4397 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004398
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004399 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004400
4401#if defined(MBEDTLS_X509_CRT_PARSE_C)
4402 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004403#endif
4404
Gilles Peskineeccd8882020-03-10 12:19:08 +01004405#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004406#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4407 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4408 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4409 else
4410#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4411 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004412#endif
4413
Brett Warrene0edc842021-08-17 09:53:13 +01004414#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4415 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004416#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004417 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004418 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004419
4420 /*
4421 * Default
4422 */
4423 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004424
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004425 conf->ciphersuite_list = mbedtls_ssl_list_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_default;
4429#endif
4430
Gilles Peskineeccd8882020-03-10 12:19:08 +01004431#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004432#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4433 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4434 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4435 else
4436#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4437 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004438#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004439
Brett Warrene0edc842021-08-17 09:53:13 +01004440#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4441 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004442#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004443 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004444
4445#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4446 conf->dhm_min_bitlen = 1024;
4447#endif
4448 }
4449
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004450 return( 0 );
4451}
4452
4453/*
4454 * Free mbedtls_ssl_config
4455 */
4456void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4457{
4458#if defined(MBEDTLS_DHM_C)
4459 mbedtls_mpi_free( &conf->dhm_P );
4460 mbedtls_mpi_free( &conf->dhm_G );
4461#endif
4462
Gilles Peskineeccd8882020-03-10 12:19:08 +01004463#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004464#if defined(MBEDTLS_USE_PSA_CRYPTO)
4465 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4466 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004467 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4468 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004469#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004470 if( conf->psk != NULL )
4471 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004472 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004473 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004474 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004475 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004476 }
4477
4478 if( conf->psk_identity != NULL )
4479 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004480 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004481 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004482 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004483 conf->psk_identity_len = 0;
4484 }
4485#endif
4486
4487#if defined(MBEDTLS_X509_CRT_PARSE_C)
4488 ssl_key_cert_free( conf->key_cert );
4489#endif
4490
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004491 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004492}
4493
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004494#if defined(MBEDTLS_PK_C) && \
4495 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004496/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004499unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004500{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004501#if defined(MBEDTLS_RSA_C)
4502 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4503 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004504#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004505#if defined(MBEDTLS_ECDSA_C)
4506 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4507 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004508#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004510}
4511
Hanno Becker7e5437a2017-04-28 17:15:26 +01004512unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4513{
4514 switch( type ) {
4515 case MBEDTLS_PK_RSA:
4516 return( MBEDTLS_SSL_SIG_RSA );
4517 case MBEDTLS_PK_ECDSA:
4518 case MBEDTLS_PK_ECKEY:
4519 return( MBEDTLS_SSL_SIG_ECDSA );
4520 default:
4521 return( MBEDTLS_SSL_SIG_ANON );
4522 }
4523}
4524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004525mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004526{
4527 switch( sig )
4528 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004529#if defined(MBEDTLS_RSA_C)
4530 case MBEDTLS_SSL_SIG_RSA:
4531 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004532#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_ECDSA_C)
4534 case MBEDTLS_SSL_SIG_ECDSA:
4535 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004536#endif
4537 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004538 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004539 }
4540}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004541#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004542
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004543/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004544 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004546mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004547{
4548 switch( hash )
4549 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004550#if defined(MBEDTLS_MD5_C)
4551 case MBEDTLS_SSL_HASH_MD5:
4552 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004554#if defined(MBEDTLS_SHA1_C)
4555 case MBEDTLS_SSL_HASH_SHA1:
4556 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004557#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004558#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004559 case MBEDTLS_SSL_HASH_SHA224:
4560 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004561#endif
4562#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004563 case MBEDTLS_SSL_HASH_SHA256:
4564 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004565#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004566#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004567 case MBEDTLS_SSL_HASH_SHA384:
4568 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004569#endif
4570#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571 case MBEDTLS_SSL_HASH_SHA512:
4572 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004573#endif
4574 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004576 }
4577}
4578
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004579/*
4580 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4581 */
4582unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4583{
4584 switch( md )
4585 {
4586#if defined(MBEDTLS_MD5_C)
4587 case MBEDTLS_MD_MD5:
4588 return( MBEDTLS_SSL_HASH_MD5 );
4589#endif
4590#if defined(MBEDTLS_SHA1_C)
4591 case MBEDTLS_MD_SHA1:
4592 return( MBEDTLS_SSL_HASH_SHA1 );
4593#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004594#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004595 case MBEDTLS_MD_SHA224:
4596 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004597#endif
4598#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004599 case MBEDTLS_MD_SHA256:
4600 return( MBEDTLS_SSL_HASH_SHA256 );
4601#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004602#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004603 case MBEDTLS_MD_SHA384:
4604 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004605#endif
4606#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004607 case MBEDTLS_MD_SHA512:
4608 return( MBEDTLS_SSL_HASH_SHA512 );
4609#endif
4610 default:
4611 return( MBEDTLS_SSL_HASH_NONE );
4612 }
4613}
4614
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004615/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004616 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004617 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004618 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004619int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004620{
Brett Warrene0edc842021-08-17 09:53:13 +01004621 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004622
Brett Warrene0edc842021-08-17 09:53:13 +01004623 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004624 return( -1 );
4625
Brett Warrene0edc842021-08-17 09:53:13 +01004626 for( ; *group_list != 0; group_list++ )
4627 {
4628 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004629 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004630 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004631
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004632 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004633}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004634
4635#if defined(MBEDTLS_ECP_C)
4636/*
4637 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4638 */
4639int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4640{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004641 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004642 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4643}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004644#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004646#if defined(MBEDTLS_X509_CRT_PARSE_C)
4647int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4648 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004649 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004650 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004651{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004652 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004653 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004654 const char *ext_oid;
4655 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004658 {
4659 /* Server part of the key exchange */
4660 switch( ciphersuite->key_exchange )
4661 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004662 case MBEDTLS_KEY_EXCHANGE_RSA:
4663 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004664 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004665 break;
4666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004667 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4668 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4669 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4670 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004671 break;
4672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004673 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4674 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004675 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004676 break;
4677
4678 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004679 case MBEDTLS_KEY_EXCHANGE_NONE:
4680 case MBEDTLS_KEY_EXCHANGE_PSK:
4681 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4682 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004683 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004684 usage = 0;
4685 }
4686 }
4687 else
4688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004689 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4690 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004691 }
4692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004694 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004695 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004696 ret = -1;
4697 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004700 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004701 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4702 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004703 }
4704 else
4705 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4707 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004708 }
4709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004711 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004712 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004713 ret = -1;
4714 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004715
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004716 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004717}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004719
Jerry Yu148165c2021-09-24 23:20:59 +08004720#if defined(MBEDTLS_USE_PSA_CRYPTO)
4721int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4722 const mbedtls_md_type_t md,
4723 unsigned char *dst,
4724 size_t dst_len,
4725 size_t *olen )
4726{
Ronald Cronf6893e12022-01-07 22:09:01 +01004727 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4728 psa_hash_operation_t *hash_operation_to_clone;
4729 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4730
Jerry Yu148165c2021-09-24 23:20:59 +08004731 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004732
4733 switch( md )
4734 {
4735#if defined(MBEDTLS_SHA384_C)
4736 case MBEDTLS_MD_SHA384:
4737 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4738 break;
4739#endif
4740
4741#if defined(MBEDTLS_SHA256_C)
4742 case MBEDTLS_MD_SHA256:
4743 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4744 break;
4745#endif
4746
4747 default:
4748 goto exit;
4749 }
4750
4751 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4752 if( status != PSA_SUCCESS )
4753 goto exit;
4754
4755 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4756 if( status != PSA_SUCCESS )
4757 goto exit;
4758
4759exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004760 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004761}
4762#else /* MBEDTLS_USE_PSA_CRYPTO */
4763
Jerry Yu24c0ec32021-09-09 14:21:07 +08004764#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004765static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4766 unsigned char *dst,
4767 size_t dst_len,
4768 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004769{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004770 int ret;
4771 mbedtls_sha512_context sha512;
4772
4773 if( dst_len < 48 )
4774 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4775
4776 mbedtls_sha512_init( &sha512 );
4777 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4778
4779 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4780 {
4781 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4782 goto exit;
4783 }
4784
4785 *olen = 48;
4786
4787exit:
4788
4789 mbedtls_sha512_free( &sha512 );
4790 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004791}
4792#endif /* MBEDTLS_SHA384_C */
4793
4794#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004795static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4796 unsigned char *dst,
4797 size_t dst_len,
4798 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004799{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004800 int ret;
4801 mbedtls_sha256_context sha256;
4802
4803 if( dst_len < 32 )
4804 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4805
4806 mbedtls_sha256_init( &sha256 );
4807 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004808
Jerry Yu24c0ec32021-09-09 14:21:07 +08004809 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4810 {
4811 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4812 goto exit;
4813 }
4814
4815 *olen = 32;
4816
4817exit:
4818
4819 mbedtls_sha256_free( &sha256 );
4820 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004821}
4822#endif /* MBEDTLS_SHA256_C */
4823
Jerry Yu000f9762021-09-14 11:12:51 +08004824int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4825 const mbedtls_md_type_t md,
4826 unsigned char *dst,
4827 size_t dst_len,
4828 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004829{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004830 switch( md )
4831 {
4832
Jerry Yu24c0ec32021-09-09 14:21:07 +08004833#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004834 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004835 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004836#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004837
Jerry Yu24c0ec32021-09-09 14:21:07 +08004838#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004839 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004840 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004841#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004842
4843 default:
4844 break;
4845 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004846 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004847}
XiaokangQian647719a2021-12-07 09:16:29 +00004848
Jerry Yu148165c2021-09-24 23:20:59 +08004849#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004850
Gabor Mezei078e8032022-04-27 21:17:56 +02004851#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4852/* mbedtls_ssl_parse_sig_alg_ext()
4853 *
4854 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4855 * value (TLS 1.3 RFC8446):
4856 * enum {
4857 * ....
4858 * ecdsa_secp256r1_sha256( 0x0403 ),
4859 * ecdsa_secp384r1_sha384( 0x0503 ),
4860 * ecdsa_secp521r1_sha512( 0x0603 ),
4861 * ....
4862 * } SignatureScheme;
4863 *
4864 * struct {
4865 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4866 * } SignatureSchemeList;
4867 *
4868 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4869 * value (TLS 1.2 RFC5246):
4870 * enum {
4871 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4872 * sha512(6), (255)
4873 * } HashAlgorithm;
4874 *
4875 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4876 * SignatureAlgorithm;
4877 *
4878 * struct {
4879 * HashAlgorithm hash;
4880 * SignatureAlgorithm signature;
4881 * } SignatureAndHashAlgorithm;
4882 *
4883 * SignatureAndHashAlgorithm
4884 * supported_signature_algorithms<2..2^16-2>;
4885 *
4886 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4887 * generalization of the TLS 1.2 signature algorithm extension.
4888 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4889 * `SignatureScheme` field of TLS 1.3
4890 *
4891 */
4892int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4893 const unsigned char *buf,
4894 const unsigned char *end )
4895{
4896 const unsigned char *p = buf;
4897 size_t supported_sig_algs_len = 0;
4898 const unsigned char *supported_sig_algs_end;
4899 uint16_t sig_alg;
4900 uint32_t common_idx = 0;
4901
4902 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4903 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4904 p += 2;
4905
4906 memset( ssl->handshake->received_sig_algs, 0,
4907 sizeof(ssl->handshake->received_sig_algs) );
4908
4909 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4910 supported_sig_algs_end = p + supported_sig_algs_len;
4911 while( p < supported_sig_algs_end )
4912 {
4913 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4914 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4915 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004916 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4917 sig_alg,
4918 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02004919
4920 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) ||
4921 ! mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) )
4922 continue;
4923
Jerry Yuf3b46b52022-06-19 16:52:27 +08004924 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
4925 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
4926
Gabor Mezei078e8032022-04-27 21:17:56 +02004927 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4928 {
4929 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4930 common_idx += 1;
4931 }
4932 }
4933 /* Check that we consumed all the message. */
4934 if( p != end )
4935 {
4936 MBEDTLS_SSL_DEBUG_MSG( 1,
4937 ( "Signature algorithms extension length misaligned" ) );
4938 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4939 MBEDTLS_ERR_SSL_DECODE_ERROR );
4940 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4941 }
4942
4943 if( common_idx == 0 )
4944 {
4945 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
4946 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
4947 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4948 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4949 }
4950
Gabor Mezei15b95a62022-05-09 16:37:58 +02004951 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02004952 return( 0 );
4953}
4954
4955#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4956
Jerry Yudc7bd172022-02-17 13:44:15 +08004957#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4958
4959#if defined(MBEDTLS_USE_PSA_CRYPTO)
4960
4961static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4962 mbedtls_svc_key_id_t key,
4963 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004964 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004965 const unsigned char* seed, size_t seed_length,
4966 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004967 const unsigned char* other_secret,
4968 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004969 size_t capacity )
4970{
4971 psa_status_t status;
4972
4973 status = psa_key_derivation_setup( derivation, alg );
4974 if( status != PSA_SUCCESS )
4975 return( status );
4976
4977 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4978 {
4979 status = psa_key_derivation_input_bytes( derivation,
4980 PSA_KEY_DERIVATION_INPUT_SEED,
4981 seed, seed_length );
4982 if( status != PSA_SUCCESS )
4983 return( status );
4984
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004985 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02004986 {
4987 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004988 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
4989 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02004990 if( status != PSA_SUCCESS )
4991 return( status );
4992 }
4993
Jerry Yudc7bd172022-02-17 13:44:15 +08004994 if( mbedtls_svc_key_id_is_null( key ) )
4995 {
4996 status = psa_key_derivation_input_bytes(
4997 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004998 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08004999 }
5000 else
5001 {
5002 status = psa_key_derivation_input_key(
5003 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5004 }
5005 if( status != PSA_SUCCESS )
5006 return( status );
5007
5008 status = psa_key_derivation_input_bytes( derivation,
5009 PSA_KEY_DERIVATION_INPUT_LABEL,
5010 label, label_length );
5011 if( status != PSA_SUCCESS )
5012 return( status );
5013 }
5014 else
5015 {
5016 return( PSA_ERROR_NOT_SUPPORTED );
5017 }
5018
5019 status = psa_key_derivation_set_capacity( derivation, capacity );
5020 if( status != PSA_SUCCESS )
5021 return( status );
5022
5023 return( PSA_SUCCESS );
5024}
5025
5026static int tls_prf_generic( mbedtls_md_type_t md_type,
5027 const unsigned char *secret, size_t slen,
5028 const char *label,
5029 const unsigned char *random, size_t rlen,
5030 unsigned char *dstbuf, size_t dlen )
5031{
5032 psa_status_t status;
5033 psa_algorithm_t alg;
5034 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5035 psa_key_derivation_operation_t derivation =
5036 PSA_KEY_DERIVATION_OPERATION_INIT;
5037
5038 if( md_type == MBEDTLS_MD_SHA384 )
5039 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5040 else
5041 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5042
5043 /* Normally a "secret" should be long enough to be impossible to
5044 * find by brute force, and in particular should not be empty. But
5045 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5046 * and for this use case it makes sense to have a 0-length "secret".
5047 * Since the key API doesn't allow importing a key of length 0,
5048 * keep master_key=0, which setup_psa_key_derivation() understands
5049 * to mean a 0-length "secret" input. */
5050 if( slen != 0 )
5051 {
5052 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5053 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5054 psa_set_key_algorithm( &key_attributes, alg );
5055 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5056
5057 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5058 if( status != PSA_SUCCESS )
5059 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5060 }
5061
5062 status = setup_psa_key_derivation( &derivation,
5063 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005064 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005065 random, rlen,
5066 (unsigned char const *) label,
5067 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005068 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005069 dlen );
5070 if( status != PSA_SUCCESS )
5071 {
5072 psa_key_derivation_abort( &derivation );
5073 psa_destroy_key( master_key );
5074 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5075 }
5076
5077 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5078 if( status != PSA_SUCCESS )
5079 {
5080 psa_key_derivation_abort( &derivation );
5081 psa_destroy_key( master_key );
5082 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5083 }
5084
5085 status = psa_key_derivation_abort( &derivation );
5086 if( status != PSA_SUCCESS )
5087 {
5088 psa_destroy_key( master_key );
5089 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5090 }
5091
5092 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5093 status = psa_destroy_key( master_key );
5094 if( status != PSA_SUCCESS )
5095 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5096
5097 return( 0 );
5098}
5099
5100#else /* MBEDTLS_USE_PSA_CRYPTO */
5101
5102static int tls_prf_generic( mbedtls_md_type_t md_type,
5103 const unsigned char *secret, size_t slen,
5104 const char *label,
5105 const unsigned char *random, size_t rlen,
5106 unsigned char *dstbuf, size_t dlen )
5107{
5108 size_t nb;
5109 size_t i, j, k, md_len;
5110 unsigned char *tmp;
5111 size_t tmp_len = 0;
5112 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5113 const mbedtls_md_info_t *md_info;
5114 mbedtls_md_context_t md_ctx;
5115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5116
5117 mbedtls_md_init( &md_ctx );
5118
5119 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5120 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5121
5122 md_len = mbedtls_md_get_size( md_info );
5123
5124 tmp_len = md_len + strlen( label ) + rlen;
5125 tmp = mbedtls_calloc( 1, tmp_len );
5126 if( tmp == NULL )
5127 {
5128 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5129 goto exit;
5130 }
5131
5132 nb = strlen( label );
5133 memcpy( tmp + md_len, label, nb );
5134 memcpy( tmp + md_len + nb, random, rlen );
5135 nb += rlen;
5136
5137 /*
5138 * Compute P_<hash>(secret, label + random)[0..dlen]
5139 */
5140 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5141 goto exit;
5142
5143 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5144 if( ret != 0 )
5145 goto exit;
5146 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5147 if( ret != 0 )
5148 goto exit;
5149 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5150 if( ret != 0 )
5151 goto exit;
5152
5153 for( i = 0; i < dlen; i += md_len )
5154 {
5155 ret = mbedtls_md_hmac_reset ( &md_ctx );
5156 if( ret != 0 )
5157 goto exit;
5158 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5159 if( ret != 0 )
5160 goto exit;
5161 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5162 if( ret != 0 )
5163 goto exit;
5164
5165 ret = mbedtls_md_hmac_reset ( &md_ctx );
5166 if( ret != 0 )
5167 goto exit;
5168 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5169 if( ret != 0 )
5170 goto exit;
5171 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5172 if( ret != 0 )
5173 goto exit;
5174
5175 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5176
5177 for( j = 0; j < k; j++ )
5178 dstbuf[i + j] = h_i[j];
5179 }
5180
5181exit:
5182 mbedtls_md_free( &md_ctx );
5183
5184 mbedtls_platform_zeroize( tmp, tmp_len );
5185 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5186
5187 mbedtls_free( tmp );
5188
5189 return( ret );
5190}
5191#endif /* MBEDTLS_USE_PSA_CRYPTO */
5192
5193#if defined(MBEDTLS_SHA256_C)
5194static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5195 const char *label,
5196 const unsigned char *random, size_t rlen,
5197 unsigned char *dstbuf, size_t dlen )
5198{
5199 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5200 label, random, rlen, dstbuf, dlen ) );
5201}
5202#endif /* MBEDTLS_SHA256_C */
5203
5204#if defined(MBEDTLS_SHA384_C)
5205static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5206 const char *label,
5207 const unsigned char *random, size_t rlen,
5208 unsigned char *dstbuf, size_t dlen )
5209{
5210 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5211 label, random, rlen, dstbuf, dlen ) );
5212}
5213#endif /* MBEDTLS_SHA384_C */
5214
Jerry Yuf009d862022-02-17 14:01:37 +08005215/*
5216 * Set appropriate PRF function and other SSL / TLS1.2 functions
5217 *
5218 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005219 * - hash associated with the ciphersuite (only used by TLS 1.2)
5220 *
5221 * Outputs:
5222 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5223 */
5224static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005225 mbedtls_md_type_t hash )
5226{
Jerry Yuf009d862022-02-17 14:01:37 +08005227#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005228 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005229 {
5230 handshake->tls_prf = tls_prf_sha384;
5231 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5232 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5233 }
5234 else
5235#endif
5236#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005237 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005238 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005239 handshake->tls_prf = tls_prf_sha256;
5240 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5241 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5242 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005243#else
Jerry Yuf009d862022-02-17 14:01:37 +08005244 {
Jerry Yuf009d862022-02-17 14:01:37 +08005245 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005246 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005247 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5248 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005249#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005250
5251 return( 0 );
5252}
Jerry Yud6ab2352022-02-17 14:03:43 +08005253
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005254/*
5255 * Compute master secret if needed
5256 *
5257 * Parameters:
5258 * [in/out] handshake
5259 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5260 * (PSA-PSK) ciphersuite_info, psk_opaque
5261 * [out] premaster (cleared)
5262 * [out] master
5263 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5264 * debug: conf->f_dbg, conf->p_dbg
5265 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005266 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005267 */
5268static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5269 unsigned char *master,
5270 const mbedtls_ssl_context *ssl )
5271{
5272 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5273
5274 /* cf. RFC 5246, Section 8.1:
5275 * "The master secret is always exactly 48 bytes in length." */
5276 size_t const master_secret_len = 48;
5277
5278#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5279 unsigned char session_hash[48];
5280#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5281
5282 /* The label for the KDF used for key expansion.
5283 * This is either "master secret" or "extended master secret"
5284 * depending on whether the Extended Master Secret extension
5285 * is used. */
5286 char const *lbl = "master secret";
5287
Przemek Stekielae4ed302022-04-05 17:15:55 +02005288 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005289 * - If the Extended Master Secret extension is not used,
5290 * this is ClientHello.Random + ServerHello.Random
5291 * (see Sect. 8.1 in RFC 5246).
5292 * - If the Extended Master Secret extension is used,
5293 * this is the transcript of the handshake so far.
5294 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005295 unsigned char const *seed = handshake->randbytes;
5296 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005297
5298#if !defined(MBEDTLS_DEBUG_C) && \
5299 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5300 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5301 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5302 ssl = NULL; /* make sure we don't use it except for those cases */
5303 (void) ssl;
5304#endif
5305
5306 if( handshake->resume != 0 )
5307 {
5308 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5309 return( 0 );
5310 }
5311
5312#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5313 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5314 {
5315 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005316 seed = session_hash;
5317 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005318
5319 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005320 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005321 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005322#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005323
Przemek Stekiel99114f32022-04-22 11:20:09 +02005324#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005325 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005326 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005327 {
5328 /* Perform PSK-to-MS expansion in a single step. */
5329 psa_status_t status;
5330 psa_algorithm_t alg;
5331 mbedtls_svc_key_id_t psk;
5332 psa_key_derivation_operation_t derivation =
5333 PSA_KEY_DERIVATION_OPERATION_INIT;
5334 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5335
5336 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5337
5338 psk = mbedtls_ssl_get_opaque_psk( ssl );
5339
5340 if( hash_alg == MBEDTLS_MD_SHA384 )
5341 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5342 else
5343 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5344
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005345 size_t other_secret_len = 0;
5346 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005347
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005348 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005349 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005350 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005351 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005352 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005353 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005354 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005355 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005356 other_secret_len = 48;
5357 other_secret = handshake->premaster + 2;
5358 break;
5359 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005360 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005361 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5362 other_secret = handshake->premaster + 2;
5363 break;
5364 default:
5365 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005366 }
5367
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005368 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005369 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005370 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005371 (unsigned char const *) lbl,
5372 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005373 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005374 master_secret_len );
5375 if( status != PSA_SUCCESS )
5376 {
5377 psa_key_derivation_abort( &derivation );
5378 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5379 }
5380
5381 status = psa_key_derivation_output_bytes( &derivation,
5382 master,
5383 master_secret_len );
5384 if( status != PSA_SUCCESS )
5385 {
5386 psa_key_derivation_abort( &derivation );
5387 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5388 }
5389
5390 status = psa_key_derivation_abort( &derivation );
5391 if( status != PSA_SUCCESS )
5392 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5393 }
5394 else
5395#endif
5396 {
5397 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005398 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005399 master,
5400 master_secret_len );
5401 if( ret != 0 )
5402 {
5403 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5404 return( ret );
5405 }
5406
5407 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5408 handshake->premaster,
5409 handshake->pmslen );
5410
5411 mbedtls_platform_zeroize( handshake->premaster,
5412 sizeof(handshake->premaster) );
5413 }
5414
5415 return( 0 );
5416}
5417
Jerry Yud62f87e2022-02-17 14:09:02 +08005418int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5419{
5420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5421 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5422 ssl->handshake->ciphersuite_info;
5423
5424 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5425
5426 /* Set PRF, calc_verify and calc_finished function pointers */
5427 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005428 ciphersuite_info->mac );
5429 if( ret != 0 )
5430 {
5431 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5432 return( ret );
5433 }
5434
5435 /* Compute master secret if needed */
5436 ret = ssl_compute_master( ssl->handshake,
5437 ssl->session_negotiate->master,
5438 ssl );
5439 if( ret != 0 )
5440 {
5441 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5442 return( ret );
5443 }
5444
5445 /* Swap the client and server random values:
5446 * - MS derivation wanted client+server (RFC 5246 8.1)
5447 * - key derivation wants server+client (RFC 5246 6.3) */
5448 {
5449 unsigned char tmp[64];
5450 memcpy( tmp, ssl->handshake->randbytes, 64 );
5451 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5452 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5453 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5454 }
5455
5456 /* Populate transform structure */
5457 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5458 ssl->session_negotiate->ciphersuite,
5459 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005460#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005461 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005462#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005463 ssl->handshake->tls_prf,
5464 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005465 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005466 ssl->conf->endpoint,
5467 ssl );
5468 if( ret != 0 )
5469 {
5470 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5471 return( ret );
5472 }
5473
5474 /* We no longer need Server/ClientHello.random values */
5475 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5476 sizeof( ssl->handshake->randbytes ) );
5477
5478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5479
5480 return( 0 );
5481}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005482
Ronald Cron4dcbca92022-03-07 10:21:40 +01005483int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5484{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005485 switch( md )
5486 {
5487#if defined(MBEDTLS_SHA384_C)
5488 case MBEDTLS_SSL_HASH_SHA384:
5489 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5490 break;
5491#endif
5492#if defined(MBEDTLS_SHA256_C)
5493 case MBEDTLS_SSL_HASH_SHA256:
5494 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5495 break;
5496#endif
5497 default:
5498 return( -1 );
5499 }
5500
Ronald Cronc2f13a02022-03-07 10:25:24 +01005501 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005502}
5503
Jerry Yu8392e0d2022-02-17 14:10:24 +08005504#if defined(MBEDTLS_SHA256_C)
5505void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5506 unsigned char *hash,
5507 size_t *hlen )
5508{
5509#if defined(MBEDTLS_USE_PSA_CRYPTO)
5510 size_t hash_size;
5511 psa_status_t status;
5512 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5513
5514 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5515 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5516 if( status != PSA_SUCCESS )
5517 {
5518 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5519 return;
5520 }
5521
5522 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5523 if( status != PSA_SUCCESS )
5524 {
5525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5526 return;
5527 }
5528
5529 *hlen = 32;
5530 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5531 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5532#else
5533 mbedtls_sha256_context sha256;
5534
5535 mbedtls_sha256_init( &sha256 );
5536
5537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5538
5539 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5540 mbedtls_sha256_finish( &sha256, hash );
5541
5542 *hlen = 32;
5543
5544 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5545 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5546
5547 mbedtls_sha256_free( &sha256 );
5548#endif /* MBEDTLS_USE_PSA_CRYPTO */
5549 return;
5550}
5551#endif /* MBEDTLS_SHA256_C */
5552
Jerry Yuc1cb3842022-02-17 14:13:48 +08005553#if defined(MBEDTLS_SHA384_C)
5554void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5555 unsigned char *hash,
5556 size_t *hlen )
5557{
5558#if defined(MBEDTLS_USE_PSA_CRYPTO)
5559 size_t hash_size;
5560 psa_status_t status;
5561 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5562
5563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5564 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5565 if( status != PSA_SUCCESS )
5566 {
5567 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5568 return;
5569 }
5570
5571 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5572 if( status != PSA_SUCCESS )
5573 {
5574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5575 return;
5576 }
5577
5578 *hlen = 48;
5579 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5581#else
5582 mbedtls_sha512_context sha512;
5583
5584 mbedtls_sha512_init( &sha512 );
5585
5586 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5587
5588 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5589 mbedtls_sha512_finish( &sha512, hash );
5590
5591 *hlen = 48;
5592
5593 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5595
5596 mbedtls_sha512_free( &sha512 );
5597#endif /* MBEDTLS_USE_PSA_CRYPTO */
5598 return;
5599}
5600#endif /* MBEDTLS_SHA384_C */
5601
Neil Armstrong80f6f322022-05-03 17:56:38 +02005602#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5603 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005604int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5605{
5606 unsigned char *p = ssl->handshake->premaster;
5607 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5608 const unsigned char *psk = NULL;
5609 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005610 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005611
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005612 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005613 {
5614 /*
5615 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005616 * checked before calling this function.
5617 *
5618 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005619 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005620 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005621 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5622 {
5623 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5624 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5625 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005626 }
5627
5628 /*
5629 * PMS = struct {
5630 * opaque other_secret<0..2^16-1>;
5631 * opaque psk<0..2^16-1>;
5632 * };
5633 * with "other_secret" depending on the particular key exchange
5634 */
5635#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5636 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5637 {
5638 if( end - p < 2 )
5639 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5640
5641 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5642 p += 2;
5643
5644 if( end < p || (size_t)( end - p ) < psk_len )
5645 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5646
5647 memset( p, 0, psk_len );
5648 p += psk_len;
5649 }
5650 else
5651#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5652#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5653 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5654 {
5655 /*
5656 * other_secret already set by the ClientKeyExchange message,
5657 * and is 48 bytes long
5658 */
5659 if( end - p < 2 )
5660 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5661
5662 *p++ = 0;
5663 *p++ = 48;
5664 p += 48;
5665 }
5666 else
5667#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5668#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5669 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5670 {
5671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5672 size_t len;
5673
5674 /* Write length only when we know the actual value */
5675 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5676 p + 2, end - ( p + 2 ), &len,
5677 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5678 {
5679 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5680 return( ret );
5681 }
5682 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5683 p += 2 + len;
5684
5685 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5686 }
5687 else
5688#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005689#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005690 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5691 {
5692 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5693 size_t zlen;
5694
5695 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5696 p + 2, end - ( p + 2 ),
5697 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5698 {
5699 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5700 return( ret );
5701 }
5702
5703 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5704 p += 2 + zlen;
5705
5706 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5707 MBEDTLS_DEBUG_ECDH_Z );
5708 }
5709 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005710#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005711 {
5712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5713 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5714 }
5715
5716 /* opaque psk<0..2^16-1>; */
5717 if( end - p < 2 )
5718 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5719
5720 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5721 p += 2;
5722
5723 if( end < p || (size_t)( end - p ) < psk_len )
5724 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5725
5726 memcpy( p, psk, psk_len );
5727 p += psk_len;
5728
5729 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5730
5731 return( 0 );
5732}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005733#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005734
5735#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5736static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5737
5738#if defined(MBEDTLS_SSL_PROTO_DTLS)
5739int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5740{
5741 /* If renegotiation is not enforced, retransmit until we would reach max
5742 * timeout if we were using the usual handshake doubling scheme */
5743 if( ssl->conf->renego_max_records < 0 )
5744 {
5745 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5746 unsigned char doublings = 1;
5747
5748 while( ratio != 0 )
5749 {
5750 ++doublings;
5751 ratio >>= 1;
5752 }
5753
5754 if( ++ssl->renego_records_seen > doublings )
5755 {
5756 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5757 return( 0 );
5758 }
5759 }
5760
5761 return( ssl_write_hello_request( ssl ) );
5762}
5763#endif
5764#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005765
Jerry Yud9526692022-02-17 14:23:47 +08005766/*
5767 * Handshake functions
5768 */
5769#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5770/* No certificate support -> dummy functions */
5771int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5772{
5773 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5774 ssl->handshake->ciphersuite_info;
5775
5776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5777
5778 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5779 {
5780 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5781 ssl->state++;
5782 return( 0 );
5783 }
5784
5785 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5786 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5787}
5788
5789int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5790{
5791 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5792 ssl->handshake->ciphersuite_info;
5793
5794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5795
5796 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5797 {
5798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5799 ssl->state++;
5800 return( 0 );
5801 }
5802
5803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5804 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5805}
5806
5807#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5808/* Some certificate support -> implement write and parse */
5809
5810int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5811{
5812 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5813 size_t i, n;
5814 const mbedtls_x509_crt *crt;
5815 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5816 ssl->handshake->ciphersuite_info;
5817
5818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5819
5820 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5821 {
5822 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5823 ssl->state++;
5824 return( 0 );
5825 }
5826
5827#if defined(MBEDTLS_SSL_CLI_C)
5828 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5829 {
5830 if( ssl->handshake->client_auth == 0 )
5831 {
5832 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5833 ssl->state++;
5834 return( 0 );
5835 }
5836 }
5837#endif /* MBEDTLS_SSL_CLI_C */
5838#if defined(MBEDTLS_SSL_SRV_C)
5839 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5840 {
5841 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5842 {
5843 /* Should never happen because we shouldn't have picked the
5844 * ciphersuite if we don't have a certificate. */
5845 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5846 }
5847 }
5848#endif
5849
5850 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5851
5852 /*
5853 * 0 . 0 handshake type
5854 * 1 . 3 handshake length
5855 * 4 . 6 length of all certs
5856 * 7 . 9 length of cert. 1
5857 * 10 . n-1 peer certificate
5858 * n . n+2 length of cert. 2
5859 * n+3 . ... upper level cert, etc.
5860 */
5861 i = 7;
5862 crt = mbedtls_ssl_own_cert( ssl );
5863
5864 while( crt != NULL )
5865 {
5866 n = crt->raw.len;
5867 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5868 {
5869 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5870 " > %" MBEDTLS_PRINTF_SIZET,
5871 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5872 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5873 }
5874
5875 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5876 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5877 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5878
5879 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5880 i += n; crt = crt->next;
5881 }
5882
5883 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5884 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5885 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5886
5887 ssl->out_msglen = i;
5888 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5889 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5890
5891 ssl->state++;
5892
5893 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5894 {
5895 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5896 return( ret );
5897 }
5898
5899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5900
5901 return( ret );
5902}
5903
5904#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5905
5906#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5907static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5908 unsigned char *crt_buf,
5909 size_t crt_buf_len )
5910{
5911 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5912
5913 if( peer_crt == NULL )
5914 return( -1 );
5915
5916 if( peer_crt->raw.len != crt_buf_len )
5917 return( -1 );
5918
5919 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5920}
5921#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5922static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5923 unsigned char *crt_buf,
5924 size_t crt_buf_len )
5925{
5926 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5927 unsigned char const * const peer_cert_digest =
5928 ssl->session->peer_cert_digest;
5929 mbedtls_md_type_t const peer_cert_digest_type =
5930 ssl->session->peer_cert_digest_type;
5931 mbedtls_md_info_t const * const digest_info =
5932 mbedtls_md_info_from_type( peer_cert_digest_type );
5933 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5934 size_t digest_len;
5935
5936 if( peer_cert_digest == NULL || digest_info == NULL )
5937 return( -1 );
5938
5939 digest_len = mbedtls_md_get_size( digest_info );
5940 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5941 return( -1 );
5942
5943 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5944 if( ret != 0 )
5945 return( -1 );
5946
5947 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5948}
5949#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5950#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5951
5952/*
5953 * Once the certificate message is read, parse it into a cert chain and
5954 * perform basic checks, but leave actual verification to the caller
5955 */
5956static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5957 mbedtls_x509_crt *chain )
5958{
5959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5960#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5961 int crt_cnt=0;
5962#endif
5963 size_t i, n;
5964 uint8_t alert;
5965
5966 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5967 {
5968 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5969 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5970 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5971 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5972 }
5973
5974 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5975 {
5976 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5977 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5978 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5979 }
5980
5981 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5982 {
5983 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5984 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5985 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5986 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5987 }
5988
5989 i = mbedtls_ssl_hs_hdr_len( ssl );
5990
5991 /*
5992 * Same message structure as in mbedtls_ssl_write_certificate()
5993 */
5994 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5995
5996 if( ssl->in_msg[i] != 0 ||
5997 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5998 {
5999 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6000 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6001 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6002 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6003 }
6004
6005 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6006 i += 3;
6007
6008 /* Iterate through and parse the CRTs in the provided chain. */
6009 while( i < ssl->in_hslen )
6010 {
6011 /* Check that there's room for the next CRT's length fields. */
6012 if ( i + 3 > ssl->in_hslen ) {
6013 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6014 mbedtls_ssl_send_alert_message( ssl,
6015 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6016 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6017 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6018 }
6019 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6020 * anything beyond 2**16 ~ 64K. */
6021 if( ssl->in_msg[i] != 0 )
6022 {
6023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6024 mbedtls_ssl_send_alert_message( ssl,
6025 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6026 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6027 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6028 }
6029
6030 /* Read length of the next CRT in the chain. */
6031 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6032 | (unsigned int) ssl->in_msg[i + 2];
6033 i += 3;
6034
6035 if( n < 128 || i + n > ssl->in_hslen )
6036 {
6037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6038 mbedtls_ssl_send_alert_message( ssl,
6039 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6040 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6041 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6042 }
6043
6044 /* Check if we're handling the first CRT in the chain. */
6045#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6046 if( crt_cnt++ == 0 &&
6047 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6048 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6049 {
6050 /* During client-side renegotiation, check that the server's
6051 * end-CRTs hasn't changed compared to the initial handshake,
6052 * mitigating the triple handshake attack. On success, reuse
6053 * the original end-CRT instead of parsing it again. */
6054 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6055 if( ssl_check_peer_crt_unchanged( ssl,
6056 &ssl->in_msg[i],
6057 n ) != 0 )
6058 {
6059 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6060 mbedtls_ssl_send_alert_message( ssl,
6061 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6062 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6063 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6064 }
6065
6066 /* Now we can safely free the original chain. */
6067 ssl_clear_peer_cert( ssl->session );
6068 }
6069#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6070
6071 /* Parse the next certificate in the chain. */
6072#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6073 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6074#else
6075 /* If we don't need to store the CRT chain permanently, parse
6076 * it in-place from the input buffer instead of making a copy. */
6077 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6078#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6079 switch( ret )
6080 {
6081 case 0: /*ok*/
6082 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6083 /* Ignore certificate with an unknown algorithm: maybe a
6084 prior certificate was already trusted. */
6085 break;
6086
6087 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6088 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6089 goto crt_parse_der_failed;
6090
6091 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6092 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6093 goto crt_parse_der_failed;
6094
6095 default:
6096 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6097 crt_parse_der_failed:
6098 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6099 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6100 return( ret );
6101 }
6102
6103 i += n;
6104 }
6105
6106 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6107 return( 0 );
6108}
6109
6110#if defined(MBEDTLS_SSL_SRV_C)
6111static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6112{
6113 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6114 return( -1 );
6115
6116 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6117 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6118 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6119 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6120 {
Ronald Cron19385882022-06-15 16:26:13 +02006121 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006122 return( 0 );
6123 }
6124 return( -1 );
6125}
6126#endif /* MBEDTLS_SSL_SRV_C */
6127
6128/* Check if a certificate message is expected.
6129 * Return either
6130 * - SSL_CERTIFICATE_EXPECTED, or
6131 * - SSL_CERTIFICATE_SKIP
6132 * indicating whether a Certificate message is expected or not.
6133 */
6134#define SSL_CERTIFICATE_EXPECTED 0
6135#define SSL_CERTIFICATE_SKIP 1
6136static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6137 int authmode )
6138{
6139 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6140 ssl->handshake->ciphersuite_info;
6141
6142 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6143 return( SSL_CERTIFICATE_SKIP );
6144
6145#if defined(MBEDTLS_SSL_SRV_C)
6146 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6147 {
6148 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6149 return( SSL_CERTIFICATE_SKIP );
6150
6151 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6152 {
6153 ssl->session_negotiate->verify_result =
6154 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6155 return( SSL_CERTIFICATE_SKIP );
6156 }
6157 }
6158#else
6159 ((void) authmode);
6160#endif /* MBEDTLS_SSL_SRV_C */
6161
6162 return( SSL_CERTIFICATE_EXPECTED );
6163}
6164
6165static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6166 int authmode,
6167 mbedtls_x509_crt *chain,
6168 void *rs_ctx )
6169{
6170 int ret = 0;
6171 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6172 ssl->handshake->ciphersuite_info;
6173 int have_ca_chain = 0;
6174
6175 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6176 void *p_vrfy;
6177
6178 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6179 return( 0 );
6180
6181 if( ssl->f_vrfy != NULL )
6182 {
6183 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6184 f_vrfy = ssl->f_vrfy;
6185 p_vrfy = ssl->p_vrfy;
6186 }
6187 else
6188 {
6189 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6190 f_vrfy = ssl->conf->f_vrfy;
6191 p_vrfy = ssl->conf->p_vrfy;
6192 }
6193
6194 /*
6195 * Main check: verify certificate
6196 */
6197#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6198 if( ssl->conf->f_ca_cb != NULL )
6199 {
6200 ((void) rs_ctx);
6201 have_ca_chain = 1;
6202
6203 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6204 ret = mbedtls_x509_crt_verify_with_ca_cb(
6205 chain,
6206 ssl->conf->f_ca_cb,
6207 ssl->conf->p_ca_cb,
6208 ssl->conf->cert_profile,
6209 ssl->hostname,
6210 &ssl->session_negotiate->verify_result,
6211 f_vrfy, p_vrfy );
6212 }
6213 else
6214#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6215 {
6216 mbedtls_x509_crt *ca_chain;
6217 mbedtls_x509_crl *ca_crl;
6218
6219#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6220 if( ssl->handshake->sni_ca_chain != NULL )
6221 {
6222 ca_chain = ssl->handshake->sni_ca_chain;
6223 ca_crl = ssl->handshake->sni_ca_crl;
6224 }
6225 else
6226#endif
6227 {
6228 ca_chain = ssl->conf->ca_chain;
6229 ca_crl = ssl->conf->ca_crl;
6230 }
6231
6232 if( ca_chain != NULL )
6233 have_ca_chain = 1;
6234
6235 ret = mbedtls_x509_crt_verify_restartable(
6236 chain,
6237 ca_chain, ca_crl,
6238 ssl->conf->cert_profile,
6239 ssl->hostname,
6240 &ssl->session_negotiate->verify_result,
6241 f_vrfy, p_vrfy, rs_ctx );
6242 }
6243
6244 if( ret != 0 )
6245 {
6246 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6247 }
6248
6249#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6250 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6251 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6252#endif
6253
6254 /*
6255 * Secondary checks: always done, but change 'ret' only if it was 0
6256 */
6257
6258#if defined(MBEDTLS_ECP_C)
6259 {
6260 const mbedtls_pk_context *pk = &chain->pk;
6261
6262 /* If certificate uses an EC key, make sure the curve is OK */
6263 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6264 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6265 {
6266 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6267
6268 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6269 if( ret == 0 )
6270 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6271 }
6272 }
6273#endif /* MBEDTLS_ECP_C */
6274
6275 if( mbedtls_ssl_check_cert_usage( chain,
6276 ciphersuite_info,
6277 ! ssl->conf->endpoint,
6278 &ssl->session_negotiate->verify_result ) != 0 )
6279 {
6280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6281 if( ret == 0 )
6282 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6283 }
6284
6285 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6286 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6287 * with details encoded in the verification flags. All other kinds
6288 * of error codes, including those from the user provided f_vrfy
6289 * functions, are treated as fatal and lead to a failure of
6290 * ssl_parse_certificate even if verification was optional. */
6291 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6292 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6293 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6294 {
6295 ret = 0;
6296 }
6297
6298 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6299 {
6300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6301 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6302 }
6303
6304 if( ret != 0 )
6305 {
6306 uint8_t alert;
6307
6308 /* The certificate may have been rejected for several reasons.
6309 Pick one and send the corresponding alert. Which alert to send
6310 may be a subject of debate in some cases. */
6311 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6312 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6313 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6314 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6315 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6316 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6317 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6318 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6319 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6320 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6321 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6322 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6323 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6324 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6325 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6326 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6327 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6328 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6329 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6330 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6331 else
6332 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6333 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6334 alert );
6335 }
6336
6337#if defined(MBEDTLS_DEBUG_C)
6338 if( ssl->session_negotiate->verify_result != 0 )
6339 {
6340 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6341 (unsigned int) ssl->session_negotiate->verify_result ) );
6342 }
6343 else
6344 {
6345 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6346 }
6347#endif /* MBEDTLS_DEBUG_C */
6348
6349 return( ret );
6350}
6351
6352#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6353static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6354 unsigned char *start, size_t len )
6355{
6356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6357 /* Remember digest of the peer's end-CRT. */
6358 ssl->session_negotiate->peer_cert_digest =
6359 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6360 if( ssl->session_negotiate->peer_cert_digest == NULL )
6361 {
6362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6363 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6364 mbedtls_ssl_send_alert_message( ssl,
6365 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6366 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6367
6368 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6369 }
6370
6371 ret = mbedtls_md( mbedtls_md_info_from_type(
6372 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6373 start, len,
6374 ssl->session_negotiate->peer_cert_digest );
6375
6376 ssl->session_negotiate->peer_cert_digest_type =
6377 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6378 ssl->session_negotiate->peer_cert_digest_len =
6379 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6380
6381 return( ret );
6382}
6383
6384static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6385 unsigned char *start, size_t len )
6386{
6387 unsigned char *end = start + len;
6388 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6389
6390 /* Make a copy of the peer's raw public key. */
6391 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6392 ret = mbedtls_pk_parse_subpubkey( &start, end,
6393 &ssl->handshake->peer_pubkey );
6394 if( ret != 0 )
6395 {
6396 /* We should have parsed the public key before. */
6397 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6398 }
6399
6400 return( 0 );
6401}
6402#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6403
6404int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6405{
6406 int ret = 0;
6407 int crt_expected;
6408#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6409 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6410 ? ssl->handshake->sni_authmode
6411 : ssl->conf->authmode;
6412#else
6413 const int authmode = ssl->conf->authmode;
6414#endif
6415 void *rs_ctx = NULL;
6416 mbedtls_x509_crt *chain = NULL;
6417
6418 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6419
6420 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6421 if( crt_expected == SSL_CERTIFICATE_SKIP )
6422 {
6423 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6424 goto exit;
6425 }
6426
6427#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6428 if( ssl->handshake->ecrs_enabled &&
6429 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6430 {
6431 chain = ssl->handshake->ecrs_peer_cert;
6432 ssl->handshake->ecrs_peer_cert = NULL;
6433 goto crt_verify;
6434 }
6435#endif
6436
6437 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6438 {
6439 /* mbedtls_ssl_read_record may have sent an alert already. We
6440 let it decide whether to alert. */
6441 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6442 goto exit;
6443 }
6444
6445#if defined(MBEDTLS_SSL_SRV_C)
6446 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6447 {
6448 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6449
6450 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6451 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6452
6453 goto exit;
6454 }
6455#endif /* MBEDTLS_SSL_SRV_C */
6456
6457 /* Clear existing peer CRT structure in case we tried to
6458 * reuse a session but it failed, and allocate a new one. */
6459 ssl_clear_peer_cert( ssl->session_negotiate );
6460
6461 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6462 if( chain == NULL )
6463 {
6464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6465 sizeof( mbedtls_x509_crt ) ) );
6466 mbedtls_ssl_send_alert_message( ssl,
6467 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6468 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6469
6470 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6471 goto exit;
6472 }
6473 mbedtls_x509_crt_init( chain );
6474
6475 ret = ssl_parse_certificate_chain( ssl, chain );
6476 if( ret != 0 )
6477 goto exit;
6478
6479#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6480 if( ssl->handshake->ecrs_enabled)
6481 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6482
6483crt_verify:
6484 if( ssl->handshake->ecrs_enabled)
6485 rs_ctx = &ssl->handshake->ecrs_ctx;
6486#endif
6487
6488 ret = ssl_parse_certificate_verify( ssl, authmode,
6489 chain, rs_ctx );
6490 if( ret != 0 )
6491 goto exit;
6492
6493#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6494 {
6495 unsigned char *crt_start, *pk_start;
6496 size_t crt_len, pk_len;
6497
6498 /* We parse the CRT chain without copying, so
6499 * these pointers point into the input buffer,
6500 * and are hence still valid after freeing the
6501 * CRT chain. */
6502
6503 crt_start = chain->raw.p;
6504 crt_len = chain->raw.len;
6505
6506 pk_start = chain->pk_raw.p;
6507 pk_len = chain->pk_raw.len;
6508
6509 /* Free the CRT structures before computing
6510 * digest and copying the peer's public key. */
6511 mbedtls_x509_crt_free( chain );
6512 mbedtls_free( chain );
6513 chain = NULL;
6514
6515 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6516 if( ret != 0 )
6517 goto exit;
6518
6519 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6520 if( ret != 0 )
6521 goto exit;
6522 }
6523#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6524 /* Pass ownership to session structure. */
6525 ssl->session_negotiate->peer_cert = chain;
6526 chain = NULL;
6527#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6528
6529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6530
6531exit:
6532
6533 if( ret == 0 )
6534 ssl->state++;
6535
6536#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6537 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6538 {
6539 ssl->handshake->ecrs_peer_cert = chain;
6540 chain = NULL;
6541 }
6542#endif
6543
6544 if( chain != NULL )
6545 {
6546 mbedtls_x509_crt_free( chain );
6547 mbedtls_free( chain );
6548 }
6549
6550 return( ret );
6551}
6552#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6553
Jerry Yu615bd6f2022-02-17 14:25:15 +08006554#if defined(MBEDTLS_SHA256_C)
6555static void ssl_calc_finished_tls_sha256(
6556 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6557{
6558 int len = 12;
6559 const char *sender;
6560 unsigned char padbuf[32];
6561#if defined(MBEDTLS_USE_PSA_CRYPTO)
6562 size_t hash_size;
6563 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6564 psa_status_t status;
6565#else
6566 mbedtls_sha256_context sha256;
6567#endif
6568
6569 mbedtls_ssl_session *session = ssl->session_negotiate;
6570 if( !session )
6571 session = ssl->session;
6572
6573 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6574 ? "client finished"
6575 : "server finished";
6576
6577#if defined(MBEDTLS_USE_PSA_CRYPTO)
6578 sha256_psa = psa_hash_operation_init();
6579
6580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6581
6582 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6583 if( status != PSA_SUCCESS )
6584 {
6585 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6586 return;
6587 }
6588
6589 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6590 if( status != PSA_SUCCESS )
6591 {
6592 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6593 return;
6594 }
6595 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6596#else
6597
6598 mbedtls_sha256_init( &sha256 );
6599
6600 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6601
6602 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6603
6604 /*
6605 * TLSv1.2:
6606 * hash = PRF( master, finished_label,
6607 * Hash( handshake ) )[0.11]
6608 */
6609
6610#if !defined(MBEDTLS_SHA256_ALT)
6611 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6612 sha256.state, sizeof( sha256.state ) );
6613#endif
6614
6615 mbedtls_sha256_finish( &sha256, padbuf );
6616 mbedtls_sha256_free( &sha256 );
6617#endif /* MBEDTLS_USE_PSA_CRYPTO */
6618
6619 ssl->handshake->tls_prf( session->master, 48, sender,
6620 padbuf, 32, buf, len );
6621
6622 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6623
6624 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6625
6626 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6627}
6628#endif /* MBEDTLS_SHA256_C */
6629
Jerry Yub7ba49e2022-02-17 14:25:53 +08006630
6631#if defined(MBEDTLS_SHA384_C)
6632
6633static void ssl_calc_finished_tls_sha384(
6634 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6635{
6636 int len = 12;
6637 const char *sender;
6638 unsigned char padbuf[48];
6639#if defined(MBEDTLS_USE_PSA_CRYPTO)
6640 size_t hash_size;
6641 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6642 psa_status_t status;
6643#else
6644 mbedtls_sha512_context sha512;
6645#endif
6646
6647 mbedtls_ssl_session *session = ssl->session_negotiate;
6648 if( !session )
6649 session = ssl->session;
6650
6651 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6652 ? "client finished"
6653 : "server finished";
6654
6655#if defined(MBEDTLS_USE_PSA_CRYPTO)
6656 sha384_psa = psa_hash_operation_init();
6657
6658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6659
6660 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6661 if( status != PSA_SUCCESS )
6662 {
6663 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6664 return;
6665 }
6666
6667 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6668 if( status != PSA_SUCCESS )
6669 {
6670 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6671 return;
6672 }
6673 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6674#else
6675 mbedtls_sha512_init( &sha512 );
6676
6677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6678
6679 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6680
6681 /*
6682 * TLSv1.2:
6683 * hash = PRF( master, finished_label,
6684 * Hash( handshake ) )[0.11]
6685 */
6686
6687#if !defined(MBEDTLS_SHA512_ALT)
6688 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6689 sha512.state, sizeof( sha512.state ) );
6690#endif
6691 mbedtls_sha512_finish( &sha512, padbuf );
6692
6693 mbedtls_sha512_free( &sha512 );
6694#endif
6695
6696 ssl->handshake->tls_prf( session->master, 48, sender,
6697 padbuf, 48, buf, len );
6698
6699 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6700
6701 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6702
6703 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6704}
6705#endif /* MBEDTLS_SHA384_C */
6706
Jerry Yuaef00152022-02-17 14:27:31 +08006707void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6708{
6709 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6710
6711 /*
6712 * Free our handshake params
6713 */
6714 mbedtls_ssl_handshake_free( ssl );
6715 mbedtls_free( ssl->handshake );
6716 ssl->handshake = NULL;
6717
6718 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006719 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006720 */
6721 if( ssl->transform )
6722 {
6723 mbedtls_ssl_transform_free( ssl->transform );
6724 mbedtls_free( ssl->transform );
6725 }
6726 ssl->transform = ssl->transform_negotiate;
6727 ssl->transform_negotiate = NULL;
6728
6729 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6730}
6731
Jerry Yu2a9fff52022-02-17 14:28:51 +08006732void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6733{
6734 int resume = ssl->handshake->resume;
6735
6736 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6737
6738#if defined(MBEDTLS_SSL_RENEGOTIATION)
6739 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6740 {
6741 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6742 ssl->renego_records_seen = 0;
6743 }
6744#endif
6745
6746 /*
6747 * Free the previous session and switch in the current one
6748 */
6749 if( ssl->session )
6750 {
6751#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6752 /* RFC 7366 3.1: keep the EtM state */
6753 ssl->session_negotiate->encrypt_then_mac =
6754 ssl->session->encrypt_then_mac;
6755#endif
6756
6757 mbedtls_ssl_session_free( ssl->session );
6758 mbedtls_free( ssl->session );
6759 }
6760 ssl->session = ssl->session_negotiate;
6761 ssl->session_negotiate = NULL;
6762
6763 /*
6764 * Add cache entry
6765 */
6766 if( ssl->conf->f_set_cache != NULL &&
6767 ssl->session->id_len != 0 &&
6768 resume == 0 )
6769 {
6770 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6771 ssl->session->id,
6772 ssl->session->id_len,
6773 ssl->session ) != 0 )
6774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6775 }
6776
6777#if defined(MBEDTLS_SSL_PROTO_DTLS)
6778 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6779 ssl->handshake->flight != NULL )
6780 {
6781 /* Cancel handshake timer */
6782 mbedtls_ssl_set_timer( ssl, 0 );
6783
6784 /* Keep last flight around in case we need to resend it:
6785 * we need the handshake and transform structures for that */
6786 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6787 }
6788 else
6789#endif
6790 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6791
6792 ssl->state++;
6793
6794 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6795}
6796
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006797int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6798{
6799 int ret, hash_len;
6800
6801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6802
6803 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6804
6805 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6806
6807 /*
6808 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6809 * may define some other value. Currently (early 2016), no defined
6810 * ciphersuite does this (and this is unlikely to change as activity has
6811 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6812 */
6813 hash_len = 12;
6814
6815#if defined(MBEDTLS_SSL_RENEGOTIATION)
6816 ssl->verify_data_len = hash_len;
6817 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6818#endif
6819
6820 ssl->out_msglen = 4 + hash_len;
6821 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6822 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6823
6824 /*
6825 * In case of session resuming, invert the client and server
6826 * ChangeCipherSpec messages order.
6827 */
6828 if( ssl->handshake->resume != 0 )
6829 {
6830#if defined(MBEDTLS_SSL_CLI_C)
6831 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6832 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6833#endif
6834#if defined(MBEDTLS_SSL_SRV_C)
6835 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6836 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6837#endif
6838 }
6839 else
6840 ssl->state++;
6841
6842 /*
6843 * Switch to our negotiated transform and session parameters for outbound
6844 * data.
6845 */
6846 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6847
6848#if defined(MBEDTLS_SSL_PROTO_DTLS)
6849 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6850 {
6851 unsigned char i;
6852
6853 /* Remember current epoch settings for resending */
6854 ssl->handshake->alt_transform_out = ssl->transform_out;
6855 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6856 sizeof( ssl->handshake->alt_out_ctr ) );
6857
6858 /* Set sequence_number to zero */
6859 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6860
6861
6862 /* Increment epoch */
6863 for( i = 2; i > 0; i-- )
6864 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6865 break;
6866
6867 /* The loop goes to its end iff the counter is wrapping */
6868 if( i == 0 )
6869 {
6870 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6871 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6872 }
6873 }
6874 else
6875#endif /* MBEDTLS_SSL_PROTO_DTLS */
6876 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6877
6878 ssl->transform_out = ssl->transform_negotiate;
6879 ssl->session_out = ssl->session_negotiate;
6880
6881#if defined(MBEDTLS_SSL_PROTO_DTLS)
6882 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6883 mbedtls_ssl_send_flight_completed( ssl );
6884#endif
6885
6886 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6887 {
6888 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6889 return( ret );
6890 }
6891
6892#if defined(MBEDTLS_SSL_PROTO_DTLS)
6893 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6894 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6895 {
6896 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6897 return( ret );
6898 }
6899#endif
6900
6901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6902
6903 return( 0 );
6904}
6905
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006906#define SSL_MAX_HASH_LEN 12
6907
6908int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6909{
6910 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6911 unsigned int hash_len = 12;
6912 unsigned char buf[SSL_MAX_HASH_LEN];
6913
6914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6915
6916 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6917
6918 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6919 {
6920 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6921 goto exit;
6922 }
6923
6924 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6925 {
6926 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6927 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6928 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6929 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6930 goto exit;
6931 }
6932
6933 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6934 {
6935 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6936 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6937 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6938 goto exit;
6939 }
6940
6941 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6942 {
6943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6944 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6945 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6946 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6947 goto exit;
6948 }
6949
6950 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6951 buf, hash_len ) != 0 )
6952 {
6953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6954 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6955 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6956 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6957 goto exit;
6958 }
6959
6960#if defined(MBEDTLS_SSL_RENEGOTIATION)
6961 ssl->verify_data_len = hash_len;
6962 memcpy( ssl->peer_verify_data, buf, hash_len );
6963#endif
6964
6965 if( ssl->handshake->resume != 0 )
6966 {
6967#if defined(MBEDTLS_SSL_CLI_C)
6968 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6969 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6970#endif
6971#if defined(MBEDTLS_SSL_SRV_C)
6972 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6973 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6974#endif
6975 }
6976 else
6977 ssl->state++;
6978
6979#if defined(MBEDTLS_SSL_PROTO_DTLS)
6980 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6981 mbedtls_ssl_recv_flight_completed( ssl );
6982#endif
6983
6984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6985
6986exit:
6987 mbedtls_platform_zeroize( buf, hash_len );
6988 return( ret );
6989}
6990
Jerry Yu392112c2022-02-17 14:34:10 +08006991#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6992/*
6993 * Helper to get TLS 1.2 PRF from ciphersuite
6994 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6995 */
6996static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6997{
6998#if defined(MBEDTLS_SHA384_C)
6999 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7000 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7001
7002 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7003 return( tls_prf_sha384 );
7004#else
7005 (void) ciphersuite_id;
7006#endif
7007 return( tls_prf_sha256 );
7008}
7009#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007010
7011static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7012{
7013 ((void) tls_prf);
7014#if defined(MBEDTLS_SHA384_C)
7015 if( tls_prf == tls_prf_sha384 )
7016 {
7017 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7018 }
7019 else
7020#endif
7021#if defined(MBEDTLS_SHA256_C)
7022 if( tls_prf == tls_prf_sha256 )
7023 {
7024 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7025 }
7026 else
7027#endif
7028 return( MBEDTLS_SSL_TLS_PRF_NONE );
7029}
7030
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007031/*
7032 * Populate a transform structure with session keys and all the other
7033 * necessary information.
7034 *
7035 * Parameters:
7036 * - [in/out]: transform: structure to populate
7037 * [in] must be just initialised with mbedtls_ssl_transform_init()
7038 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7039 * - [in] ciphersuite
7040 * - [in] master
7041 * - [in] encrypt_then_mac
7042 * - [in] compression
7043 * - [in] tls_prf: pointer to PRF to use for key derivation
7044 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007045 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007046 * - [in] endpoint: client or server
7047 * - [in] ssl: used for:
7048 * - ssl->conf->{f,p}_export_keys
7049 * [in] optionally used for:
7050 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7051 */
7052static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7053 int ciphersuite,
7054 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007055#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007056 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007057#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007058 ssl_tls_prf_t tls_prf,
7059 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007060 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007061 unsigned endpoint,
7062 const mbedtls_ssl_context *ssl )
7063{
7064 int ret = 0;
7065 unsigned char keyblk[256];
7066 unsigned char *key1;
7067 unsigned char *key2;
7068 unsigned char *mac_enc;
7069 unsigned char *mac_dec;
7070 size_t mac_key_len = 0;
7071 size_t iv_copy_len;
7072 size_t keylen;
7073 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007074 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007075#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007076 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007077 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007078#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007079
7080#if defined(MBEDTLS_USE_PSA_CRYPTO)
7081 psa_key_type_t key_type;
7082 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7083 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007084 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007085 size_t key_bits;
7086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7087#endif
7088
7089#if !defined(MBEDTLS_DEBUG_C) && \
7090 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7091 if( ssl->f_export_keys == NULL )
7092 {
7093 ssl = NULL; /* make sure we don't use it except for these cases */
7094 (void) ssl;
7095 }
7096#endif
7097
7098 /*
7099 * Some data just needs copying into the structure
7100 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007101#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007102 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007103#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007104 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007105
7106#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7107 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7108#endif
7109
7110#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007111 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007112 {
7113 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7114 * generation separate. This should never happen. */
7115 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7116 }
7117#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7118
7119 /*
7120 * Get various info structures
7121 */
7122 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7123 if( ciphersuite_info == NULL )
7124 {
7125 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7126 ciphersuite ) );
7127 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7128 }
7129
Neil Armstrongab555e02022-04-04 11:07:59 +02007130 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007131#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007132 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007134 ciphersuite_info );
7135
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007136 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7137 transform->taglen =
7138 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7139
7140#if defined(MBEDTLS_USE_PSA_CRYPTO)
7141 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7142 transform->taglen,
7143 &alg,
7144 &key_type,
7145 &key_bits ) ) != PSA_SUCCESS )
7146 {
7147 ret = psa_ssl_status_to_mbedtls( status );
7148 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7149 goto end;
7150 }
7151#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007152 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7153 if( cipher_info == NULL )
7154 {
7155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7156 ciphersuite_info->cipher ) );
7157 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7158 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007159#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007160
Neil Armstronge4512952022-03-08 09:08:22 +01007161#if defined(MBEDTLS_USE_PSA_CRYPTO)
7162 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7163 if( mac_alg == 0 )
7164 {
7165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7166 (unsigned) ciphersuite_info->mac ) );
7167 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7168 }
7169#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007170 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7171 if( md_info == NULL )
7172 {
7173 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7174 (unsigned) ciphersuite_info->mac ) );
7175 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7176 }
Neil Armstronge4512952022-03-08 09:08:22 +01007177#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007178
7179#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7180 /* Copy own and peer's CID if the use of the CID
7181 * extension has been negotiated. */
7182 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7183 {
7184 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7185
7186 transform->in_cid_len = ssl->own_cid_len;
7187 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7188 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7189 transform->in_cid_len );
7190
7191 transform->out_cid_len = ssl->handshake->peer_cid_len;
7192 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7193 ssl->handshake->peer_cid_len );
7194 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7195 transform->out_cid_len );
7196 }
7197#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7198
7199 /*
7200 * Compute key block using the PRF
7201 */
7202 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7203 if( ret != 0 )
7204 {
7205 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7206 return( ret );
7207 }
7208
7209 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7210 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7211 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7212 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7213 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7214
7215 /*
7216 * Determine the appropriate key, IV and MAC length.
7217 */
7218
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007219#if defined(MBEDTLS_USE_PSA_CRYPTO)
7220 keylen = PSA_BITS_TO_BYTES(key_bits);
7221#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007222 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007223#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007224
7225#if defined(MBEDTLS_GCM_C) || \
7226 defined(MBEDTLS_CCM_C) || \
7227 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007228 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007229 {
7230 size_t explicit_ivlen;
7231
7232 transform->maclen = 0;
7233 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007234
7235 /* All modes haves 96-bit IVs, but the length of the static parts vary
7236 * with mode and version:
7237 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7238 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7239 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7240 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7241 * sequence number).
7242 */
7243 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007244#if defined(MBEDTLS_USE_PSA_CRYPTO)
7245 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7246#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007247 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007248#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007249 transform->fixed_ivlen = 12;
7250 else
7251 transform->fixed_ivlen = 4;
7252
7253 /* Minimum length of encrypted record */
7254 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7255 transform->minlen = explicit_ivlen + transform->taglen;
7256 }
7257 else
7258#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7259#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007260 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7261 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7262 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007263 {
Neil Armstronge4512952022-03-08 09:08:22 +01007264#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007265 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007266#else
7267 size_t block_size = cipher_info->block_size;
7268#endif /* MBEDTLS_USE_PSA_CRYPTO */
7269
7270#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007271 /* Get MAC length */
7272 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7273#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007274 /* Initialize HMAC contexts */
7275 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7276 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7277 {
7278 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7279 goto end;
7280 }
7281
7282 /* Get MAC length */
7283 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007284#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007285 transform->maclen = mac_key_len;
7286
7287 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007289 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007290#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007291 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007292#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007293
7294 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007295 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007296 transform->minlen = transform->maclen;
7297 else
7298 {
7299 /*
7300 * GenericBlockCipher:
7301 * 1. if EtM is in use: one block plus MAC
7302 * otherwise: * first multiple of blocklen greater than maclen
7303 * 2. IV
7304 */
7305#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007306 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007307 {
7308 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007309 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007310 }
7311 else
7312#endif
7313 {
7314 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007315 + block_size
7316 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007317 }
7318
Glenn Strauss07c64162022-03-14 12:34:51 -04007319 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007320 {
7321 transform->minlen += transform->ivlen;
7322 }
7323 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007324 {
7325 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7326 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7327 goto end;
7328 }
7329 }
7330 }
7331 else
7332#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7333 {
7334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7335 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7336 }
7337
7338 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7339 (unsigned) keylen,
7340 (unsigned) transform->minlen,
7341 (unsigned) transform->ivlen,
7342 (unsigned) transform->maclen ) );
7343
7344 /*
7345 * Finally setup the cipher contexts, IVs and MAC secrets.
7346 */
7347#if defined(MBEDTLS_SSL_CLI_C)
7348 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7349 {
7350 key1 = keyblk + mac_key_len * 2;
7351 key2 = keyblk + mac_key_len * 2 + keylen;
7352
7353 mac_enc = keyblk;
7354 mac_dec = keyblk + mac_key_len;
7355
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007356 iv_copy_len = ( transform->fixed_ivlen ) ?
7357 transform->fixed_ivlen : transform->ivlen;
7358 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7359 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7360 iv_copy_len );
7361 }
7362 else
7363#endif /* MBEDTLS_SSL_CLI_C */
7364#if defined(MBEDTLS_SSL_SRV_C)
7365 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7366 {
7367 key1 = keyblk + mac_key_len * 2 + keylen;
7368 key2 = keyblk + mac_key_len * 2;
7369
7370 mac_enc = keyblk + mac_key_len;
7371 mac_dec = keyblk;
7372
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007373 iv_copy_len = ( transform->fixed_ivlen ) ?
7374 transform->fixed_ivlen : transform->ivlen;
7375 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7376 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7377 iv_copy_len );
7378 }
7379 else
7380#endif /* MBEDTLS_SSL_SRV_C */
7381 {
7382 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7383 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7384 goto end;
7385 }
7386
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007387 if( ssl != NULL && ssl->f_export_keys != NULL )
7388 {
7389 ssl->f_export_keys( ssl->p_export_keys,
7390 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7391 master, 48,
7392 randbytes + 32,
7393 randbytes,
7394 tls_prf_get_type( tls_prf ) );
7395 }
7396
7397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007398 transform->psa_alg = alg;
7399
7400 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7401 {
7402 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7403 psa_set_key_algorithm( &attributes, alg );
7404 psa_set_key_type( &attributes, key_type );
7405
7406 if( ( status = psa_import_key( &attributes,
7407 key1,
7408 PSA_BITS_TO_BYTES( key_bits ),
7409 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7410 {
7411 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7412 ret = psa_ssl_status_to_mbedtls( status );
7413 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7414 goto end;
7415 }
7416
7417 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7418
7419 if( ( status = psa_import_key( &attributes,
7420 key2,
7421 PSA_BITS_TO_BYTES( key_bits ),
7422 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7423 {
7424 ret = psa_ssl_status_to_mbedtls( status );
7425 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7426 goto end;
7427 }
7428 }
7429#else
7430 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7431 cipher_info ) ) != 0 )
7432 {
7433 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7434 goto end;
7435 }
7436
7437 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7438 cipher_info ) ) != 0 )
7439 {
7440 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7441 goto end;
7442 }
7443
7444 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7445 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7446 MBEDTLS_ENCRYPT ) ) != 0 )
7447 {
7448 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7449 goto end;
7450 }
7451
7452 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7453 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7454 MBEDTLS_DECRYPT ) ) != 0 )
7455 {
7456 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7457 goto end;
7458 }
7459
7460#if defined(MBEDTLS_CIPHER_MODE_CBC)
7461 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7462 {
7463 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7464 MBEDTLS_PADDING_NONE ) ) != 0 )
7465 {
7466 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7467 goto end;
7468 }
7469
7470 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7471 MBEDTLS_PADDING_NONE ) ) != 0 )
7472 {
7473 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7474 goto end;
7475 }
7476 }
7477#endif /* MBEDTLS_CIPHER_MODE_CBC */
7478#endif /* MBEDTLS_USE_PSA_CRYPTO */
7479
Neil Armstrong29c0c042022-03-17 17:47:28 +01007480#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7481 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7482 For AEAD-based ciphersuites, there is nothing to do here. */
7483 if( mac_key_len != 0 )
7484 {
7485#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007486 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007487
7488 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007489 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007490 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7491
7492 if( ( status = psa_import_key( &attributes,
7493 mac_enc, mac_key_len,
7494 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7495 {
7496 ret = psa_ssl_status_to_mbedtls( status );
7497 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7498 goto end;
7499 }
7500
Ronald Cronfb39f152022-03-25 14:36:28 +01007501 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7502 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7503 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007504 /* mbedtls_ct_hmac() requires the key to be exportable */
7505 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7506 PSA_KEY_USAGE_VERIFY_HASH );
7507 else
7508 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7509
7510 if( ( status = psa_import_key( &attributes,
7511 mac_dec, mac_key_len,
7512 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7513 {
7514 ret = psa_ssl_status_to_mbedtls( status );
7515 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7516 goto end;
7517 }
7518#else
7519 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7520 if( ret != 0 )
7521 goto end;
7522 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7523 if( ret != 0 )
7524 goto end;
7525#endif /* MBEDTLS_USE_PSA_CRYPTO */
7526 }
7527#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7528
7529 ((void) mac_dec);
7530 ((void) mac_enc);
7531
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007532end:
7533 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7534 return( ret );
7535}
7536
Jerry Yuee40f9d2022-02-17 14:55:16 +08007537#if defined(MBEDTLS_USE_PSA_CRYPTO)
7538int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7539 unsigned char *hash, size_t *hashlen,
7540 unsigned char *data, size_t data_len,
7541 mbedtls_md_type_t md_alg )
7542{
7543 psa_status_t status;
7544 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7545 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7546
7547 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7548
7549 if( ( status = psa_hash_setup( &hash_operation,
7550 hash_alg ) ) != PSA_SUCCESS )
7551 {
7552 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7553 goto exit;
7554 }
7555
7556 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7557 64 ) ) != PSA_SUCCESS )
7558 {
7559 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7560 goto exit;
7561 }
7562
7563 if( ( status = psa_hash_update( &hash_operation,
7564 data, data_len ) ) != PSA_SUCCESS )
7565 {
7566 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7567 goto exit;
7568 }
7569
7570 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7571 hashlen ) ) != PSA_SUCCESS )
7572 {
7573 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7574 goto exit;
7575 }
7576
7577exit:
7578 if( status != PSA_SUCCESS )
7579 {
7580 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7581 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7582 switch( status )
7583 {
7584 case PSA_ERROR_NOT_SUPPORTED:
7585 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7586 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7587 case PSA_ERROR_BUFFER_TOO_SMALL:
7588 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7589 case PSA_ERROR_INSUFFICIENT_MEMORY:
7590 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7591 default:
7592 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7593 }
7594 }
7595 return( 0 );
7596}
7597
7598#else
7599
7600int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7601 unsigned char *hash, size_t *hashlen,
7602 unsigned char *data, size_t data_len,
7603 mbedtls_md_type_t md_alg )
7604{
7605 int ret = 0;
7606 mbedtls_md_context_t ctx;
7607 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7608 *hashlen = mbedtls_md_get_size( md_info );
7609
7610 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7611
7612 mbedtls_md_init( &ctx );
7613
7614 /*
7615 * digitally-signed struct {
7616 * opaque client_random[32];
7617 * opaque server_random[32];
7618 * ServerDHParams params;
7619 * };
7620 */
7621 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7622 {
7623 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7624 goto exit;
7625 }
7626 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7627 {
7628 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7629 goto exit;
7630 }
7631 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7632 {
7633 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7634 goto exit;
7635 }
7636 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7637 {
7638 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7639 goto exit;
7640 }
7641 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7642 {
7643 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7644 goto exit;
7645 }
7646
7647exit:
7648 mbedtls_md_free( &ctx );
7649
7650 if( ret != 0 )
7651 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7652 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7653
7654 return( ret );
7655}
7656#endif /* MBEDTLS_USE_PSA_CRYPTO */
7657
Jerry Yud9d91da2022-02-17 14:57:06 +08007658#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7659
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007660/* Find the preferred hash for a given signature algorithm. */
7661unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7662 mbedtls_ssl_context *ssl,
7663 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007664{
Gabor Mezei078e8032022-04-27 21:17:56 +02007665 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007666 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007667
7668 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007669 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007670
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007671 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007672 {
Gabor Mezei3631cf62022-05-10 12:59:00 +02007673 if( sig_alg == MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7674 received_sig_algs[i] ) )
Gabor Mezei696956d2022-05-13 16:27:29 +02007675 return( MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7676 received_sig_algs[i] ) );
Jerry Yud9d91da2022-02-17 14:57:06 +08007677 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007678
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007679 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007680}
7681
7682#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7683
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007684/* Serialization of TLS 1.2 sessions:
7685 *
7686 * struct {
7687 * uint64 start_time;
7688 * uint8 ciphersuite[2]; // defined by the standard
7689 * uint8 compression; // 0 or 1
7690 * uint8 session_id_len; // at most 32
7691 * opaque session_id[32];
7692 * opaque master[48]; // fixed length in the standard
7693 * uint32 verify_result;
7694 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7695 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7696 * uint32 ticket_lifetime;
7697 * uint8 mfl_code; // up to 255 according to standard
7698 * uint8 encrypt_then_mac; // 0 or 1
7699 * } serialized_session_tls12;
7700 *
7701 */
7702static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7703 unsigned char *buf,
7704 size_t buf_len )
7705{
7706 unsigned char *p = buf;
7707 size_t used = 0;
7708
7709#if defined(MBEDTLS_HAVE_TIME)
7710 uint64_t start;
7711#endif
7712#if defined(MBEDTLS_X509_CRT_PARSE_C)
7713#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7714 size_t cert_len;
7715#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7716#endif /* MBEDTLS_X509_CRT_PARSE_C */
7717
7718 /*
7719 * Time
7720 */
7721#if defined(MBEDTLS_HAVE_TIME)
7722 used += 8;
7723
7724 if( used <= buf_len )
7725 {
7726 start = (uint64_t) session->start;
7727
7728 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7729 p += 8;
7730 }
7731#endif /* MBEDTLS_HAVE_TIME */
7732
7733 /*
7734 * Basic mandatory fields
7735 */
7736 used += 2 /* ciphersuite */
7737 + 1 /* compression */
7738 + 1 /* id_len */
7739 + sizeof( session->id )
7740 + sizeof( session->master )
7741 + 4; /* verify_result */
7742
7743 if( used <= buf_len )
7744 {
7745 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7746 p += 2;
7747
7748 *p++ = MBEDTLS_BYTE_0( session->compression );
7749
7750 *p++ = MBEDTLS_BYTE_0( session->id_len );
7751 memcpy( p, session->id, 32 );
7752 p += 32;
7753
7754 memcpy( p, session->master, 48 );
7755 p += 48;
7756
7757 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7758 p += 4;
7759 }
7760
7761 /*
7762 * Peer's end-entity certificate
7763 */
7764#if defined(MBEDTLS_X509_CRT_PARSE_C)
7765#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7766 if( session->peer_cert == NULL )
7767 cert_len = 0;
7768 else
7769 cert_len = session->peer_cert->raw.len;
7770
7771 used += 3 + cert_len;
7772
7773 if( used <= buf_len )
7774 {
7775 *p++ = MBEDTLS_BYTE_2( cert_len );
7776 *p++ = MBEDTLS_BYTE_1( cert_len );
7777 *p++ = MBEDTLS_BYTE_0( cert_len );
7778
7779 if( session->peer_cert != NULL )
7780 {
7781 memcpy( p, session->peer_cert->raw.p, cert_len );
7782 p += cert_len;
7783 }
7784 }
7785#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7786 if( session->peer_cert_digest != NULL )
7787 {
7788 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7789 if( used <= buf_len )
7790 {
7791 *p++ = (unsigned char) session->peer_cert_digest_type;
7792 *p++ = (unsigned char) session->peer_cert_digest_len;
7793 memcpy( p, session->peer_cert_digest,
7794 session->peer_cert_digest_len );
7795 p += session->peer_cert_digest_len;
7796 }
7797 }
7798 else
7799 {
7800 used += 2;
7801 if( used <= buf_len )
7802 {
7803 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7804 *p++ = 0;
7805 }
7806 }
7807#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7808#endif /* MBEDTLS_X509_CRT_PARSE_C */
7809
7810 /*
7811 * Session ticket if any, plus associated data
7812 */
7813#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7814 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7815
7816 if( used <= buf_len )
7817 {
7818 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7819 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7820 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7821
7822 if( session->ticket != NULL )
7823 {
7824 memcpy( p, session->ticket, session->ticket_len );
7825 p += session->ticket_len;
7826 }
7827
7828 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7829 p += 4;
7830 }
7831#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7832
7833 /*
7834 * Misc extension-related info
7835 */
7836#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7837 used += 1;
7838
7839 if( used <= buf_len )
7840 *p++ = session->mfl_code;
7841#endif
7842
7843#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7844 used += 1;
7845
7846 if( used <= buf_len )
7847 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7848#endif
7849
7850 return( used );
7851}
7852
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007853static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7854 const unsigned char *buf,
7855 size_t len )
7856{
7857#if defined(MBEDTLS_HAVE_TIME)
7858 uint64_t start;
7859#endif
7860#if defined(MBEDTLS_X509_CRT_PARSE_C)
7861#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7862 size_t cert_len;
7863#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7864#endif /* MBEDTLS_X509_CRT_PARSE_C */
7865
7866 const unsigned char *p = buf;
7867 const unsigned char * const end = buf + len;
7868
7869 /*
7870 * Time
7871 */
7872#if defined(MBEDTLS_HAVE_TIME)
7873 if( 8 > (size_t)( end - p ) )
7874 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7875
7876 start = ( (uint64_t) p[0] << 56 ) |
7877 ( (uint64_t) p[1] << 48 ) |
7878 ( (uint64_t) p[2] << 40 ) |
7879 ( (uint64_t) p[3] << 32 ) |
7880 ( (uint64_t) p[4] << 24 ) |
7881 ( (uint64_t) p[5] << 16 ) |
7882 ( (uint64_t) p[6] << 8 ) |
7883 ( (uint64_t) p[7] );
7884 p += 8;
7885
7886 session->start = (time_t) start;
7887#endif /* MBEDTLS_HAVE_TIME */
7888
7889 /*
7890 * Basic mandatory fields
7891 */
7892 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7893 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7894
7895 session->ciphersuite = ( p[0] << 8 ) | p[1];
7896 p += 2;
7897
7898 session->compression = *p++;
7899
7900 session->id_len = *p++;
7901 memcpy( session->id, p, 32 );
7902 p += 32;
7903
7904 memcpy( session->master, p, 48 );
7905 p += 48;
7906
7907 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7908 ( (uint32_t) p[1] << 16 ) |
7909 ( (uint32_t) p[2] << 8 ) |
7910 ( (uint32_t) p[3] );
7911 p += 4;
7912
7913 /* Immediately clear invalid pointer values that have been read, in case
7914 * we exit early before we replaced them with valid ones. */
7915#if defined(MBEDTLS_X509_CRT_PARSE_C)
7916#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7917 session->peer_cert = NULL;
7918#else
7919 session->peer_cert_digest = NULL;
7920#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7921#endif /* MBEDTLS_X509_CRT_PARSE_C */
7922#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7923 session->ticket = NULL;
7924#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7925
7926 /*
7927 * Peer certificate
7928 */
7929#if defined(MBEDTLS_X509_CRT_PARSE_C)
7930#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7931 /* Deserialize CRT from the end of the ticket. */
7932 if( 3 > (size_t)( end - p ) )
7933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7934
7935 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7936 p += 3;
7937
7938 if( cert_len != 0 )
7939 {
7940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7941
7942 if( cert_len > (size_t)( end - p ) )
7943 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7944
7945 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7946
7947 if( session->peer_cert == NULL )
7948 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7949
7950 mbedtls_x509_crt_init( session->peer_cert );
7951
7952 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7953 p, cert_len ) ) != 0 )
7954 {
7955 mbedtls_x509_crt_free( session->peer_cert );
7956 mbedtls_free( session->peer_cert );
7957 session->peer_cert = NULL;
7958 return( ret );
7959 }
7960
7961 p += cert_len;
7962 }
7963#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7964 /* Deserialize CRT digest from the end of the ticket. */
7965 if( 2 > (size_t)( end - p ) )
7966 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7967
7968 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7969 session->peer_cert_digest_len = (size_t) *p++;
7970
7971 if( session->peer_cert_digest_len != 0 )
7972 {
7973 const mbedtls_md_info_t *md_info =
7974 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7975 if( md_info == NULL )
7976 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7977 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7978 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7979
7980 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7981 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7982
7983 session->peer_cert_digest =
7984 mbedtls_calloc( 1, session->peer_cert_digest_len );
7985 if( session->peer_cert_digest == NULL )
7986 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7987
7988 memcpy( session->peer_cert_digest, p,
7989 session->peer_cert_digest_len );
7990 p += session->peer_cert_digest_len;
7991 }
7992#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7993#endif /* MBEDTLS_X509_CRT_PARSE_C */
7994
7995 /*
7996 * Session ticket and associated data
7997 */
7998#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7999 if( 3 > (size_t)( end - p ) )
8000 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8001
8002 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8003 p += 3;
8004
8005 if( session->ticket_len != 0 )
8006 {
8007 if( session->ticket_len > (size_t)( end - p ) )
8008 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8009
8010 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8011 if( session->ticket == NULL )
8012 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8013
8014 memcpy( session->ticket, p, session->ticket_len );
8015 p += session->ticket_len;
8016 }
8017
8018 if( 4 > (size_t)( end - p ) )
8019 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8020
8021 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8022 ( (uint32_t) p[1] << 16 ) |
8023 ( (uint32_t) p[2] << 8 ) |
8024 ( (uint32_t) p[3] );
8025 p += 4;
8026#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8027
8028 /*
8029 * Misc extension-related info
8030 */
8031#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8032 if( 1 > (size_t)( end - p ) )
8033 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8034
8035 session->mfl_code = *p++;
8036#endif
8037
8038#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8039 if( 1 > (size_t)( end - p ) )
8040 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8041
8042 session->encrypt_then_mac = *p++;
8043#endif
8044
8045 /* Done, should have consumed entire buffer */
8046 if( p != end )
8047 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8048
8049 return( 0 );
8050}
Jerry Yudc7bd172022-02-17 13:44:15 +08008051#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8052
XiaokangQian75d40ef2022-04-20 11:05:24 +00008053int mbedtls_ssl_validate_ciphersuite(
8054 const mbedtls_ssl_context *ssl,
8055 const mbedtls_ssl_ciphersuite_t *suite_info,
8056 mbedtls_ssl_protocol_version min_tls_version,
8057 mbedtls_ssl_protocol_version max_tls_version )
8058{
8059 (void) ssl;
8060
8061 if( suite_info == NULL )
8062 return( -1 );
8063
8064 if( ( suite_info->min_tls_version > max_tls_version ) ||
8065 ( suite_info->max_tls_version < min_tls_version ) )
8066 {
8067 return( -1 );
8068 }
8069
XiaokangQian060d8672022-04-21 09:24:56 +00008070#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008071#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8072 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8073 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8074 {
8075 return( -1 );
8076 }
8077#endif
8078
8079 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8080#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8081 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8082 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8083 {
8084 return( -1 );
8085 }
8086#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8087#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8088
8089 return( 0 );
8090}
8091
XiaokangQianeaf36512022-04-24 09:07:44 +00008092#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8093/*
8094 * Function for writing a signature algorithm extension.
8095 *
8096 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8097 * value (TLS 1.3 RFC8446):
8098 * enum {
8099 * ....
8100 * ecdsa_secp256r1_sha256( 0x0403 ),
8101 * ecdsa_secp384r1_sha384( 0x0503 ),
8102 * ecdsa_secp521r1_sha512( 0x0603 ),
8103 * ....
8104 * } SignatureScheme;
8105 *
8106 * struct {
8107 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8108 * } SignatureSchemeList;
8109 *
8110 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8111 * value (TLS 1.2 RFC5246):
8112 * enum {
8113 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8114 * sha512(6), (255)
8115 * } HashAlgorithm;
8116 *
8117 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8118 * SignatureAlgorithm;
8119 *
8120 * struct {
8121 * HashAlgorithm hash;
8122 * SignatureAlgorithm signature;
8123 * } SignatureAndHashAlgorithm;
8124 *
8125 * SignatureAndHashAlgorithm
8126 * supported_signature_algorithms<2..2^16-2>;
8127 *
8128 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8129 * generalization of the TLS 1.2 signature algorithm extension.
8130 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8131 * `SignatureScheme` field of TLS 1.3
8132 *
8133 */
8134int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8135 const unsigned char *end, size_t *out_len )
8136{
8137 unsigned char *p = buf;
8138 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8139 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8140
8141 *out_len = 0;
8142
8143 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8144
8145 /* Check if we have space for header and length field:
8146 * - extension_type (2 bytes)
8147 * - extension_data_length (2 bytes)
8148 * - supported_signature_algorithms_length (2 bytes)
8149 */
8150 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8151 p += 6;
8152
8153 /*
8154 * Write supported_signature_algorithms
8155 */
8156 supported_sig_alg = p;
8157 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8158 if( sig_alg == NULL )
8159 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8160
8161 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8162 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8164 *sig_alg,
8165 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
Jerry Yu80dd5db2022-06-22 19:30:32 +08008166 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8167 continue;
8168 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8169 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8170 p += 2;
8171 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008172 *sig_alg,
8173 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008174 }
8175
8176 /* Length of supported_signature_algorithms */
8177 supported_sig_alg_len = p - supported_sig_alg;
8178 if( supported_sig_alg_len == 0 )
8179 {
8180 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8181 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8182 }
8183
XiaokangQianeaf36512022-04-24 09:07:44 +00008184 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008185 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008186 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8187
XiaokangQianeaf36512022-04-24 09:07:44 +00008188 *out_len = p - buf;
8189
8190#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8191 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8192#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8193 return( 0 );
8194}
8195#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8196
XiaokangQian40a35232022-05-07 09:02:40 +00008197#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008198/*
8199 * mbedtls_ssl_parse_server_name_ext
8200 *
8201 * Structure of server_name extension:
8202 *
8203 * enum {
8204 * host_name(0), (255)
8205 * } NameType;
8206 * opaque HostName<1..2^16-1>;
8207 *
8208 * struct {
8209 * NameType name_type;
8210 * select (name_type) {
8211 * case host_name: HostName;
8212 * } name;
8213 * } ServerName;
8214 * struct {
8215 * ServerName server_name_list<1..2^16-1>
8216 * } ServerNameList;
8217 */
8218int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8219 const unsigned char *buf,
8220 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008221{
8222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8223 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008224 size_t server_name_list_len, hostname_len;
8225 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008226
XiaokangQianf2a94202022-05-20 06:44:24 +00008227 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008228
8229 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008230 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008231 p += 2;
8232
XiaokangQian9b2b7712022-05-17 02:57:00 +00008233 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8234 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008235 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008236 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008237 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008238 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008239 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8240 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008241
8242 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8243 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008244 /* sni_name is intended to be used only during the parsing of the
8245 * ClientHello message (it is reset to NULL before the end of
8246 * the message parsing). Thus it is ok to just point to the
8247 * reception buffer and not make a copy of it.
8248 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008249 ssl->handshake->sni_name = p + 3;
8250 ssl->handshake->sni_name_len = hostname_len;
8251 if( ssl->conf->f_sni == NULL )
8252 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008253 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008254 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008255 if( ret != 0 )
8256 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008257 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008258 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8259 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008260 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8261 }
8262 return( 0 );
8263 }
8264
8265 p += hostname_len + 3;
8266 }
8267
8268 return( 0 );
8269}
8270#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8271
XiaokangQianacb39922022-06-17 10:18:48 +00008272#if defined(MBEDTLS_SSL_ALPN)
8273int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8274 const unsigned char *buf,
8275 const unsigned char *end )
8276{
8277 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008278 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008279 const unsigned char *protocol_name_list;
8280 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008281 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008282
8283 /* If ALPN not configured, just ignore the extension */
8284 if( ssl->conf->alpn_list == NULL )
8285 return( 0 );
8286
8287 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008288 * RFC7301, section 3.1
8289 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008290 *
XiaokangQianc7403452022-06-23 03:24:12 +00008291 * struct {
8292 * ProtocolName protocol_name_list<2..2^16-1>
8293 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008294 */
8295
XiaokangQianc7403452022-06-23 03:24:12 +00008296 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008297 * protocol_name_list_len 2 bytes
8298 * protocol_name_len 1 bytes
8299 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008300 */
XiaokangQianacb39922022-06-17 10:18:48 +00008301 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8302
XiaokangQianc7403452022-06-23 03:24:12 +00008303 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008304 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008305 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008306 protocol_name_list = p;
8307 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008308
8309 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008310 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008311 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008312 protocol_name_len = *p++;
8313 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8314 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008315 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008316 {
8317 MBEDTLS_SSL_PEND_FATAL_ALERT(
8318 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8319 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008320 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008321 }
8322
8323 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008324 }
8325
8326 /* Use our order of preference */
8327 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8328 {
8329 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008330 p = protocol_name_list;
8331 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008332 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008333 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008334 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008335 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008336 {
8337 ssl->alpn_chosen = *alpn;
8338 return( 0 );
8339 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008340
8341 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008342 }
8343 }
8344
XiaokangQian95d5f542022-06-24 02:29:26 +00008345 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008346 MBEDTLS_SSL_PEND_FATAL_ALERT(
8347 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8348 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8349 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8350}
8351
8352int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8353 unsigned char *buf,
8354 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008355 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008356{
8357 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008358 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008359 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008360
8361 if( ssl->alpn_chosen == NULL )
8362 {
8363 return( 0 );
8364 }
8365
XiaokangQian95d5f542022-06-24 02:29:26 +00008366 protocol_name_len = strlen( ssl->alpn_chosen );
8367 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008368
8369 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8370 /*
8371 * 0 . 1 ext identifier
8372 * 2 . 3 ext length
8373 * 4 . 5 protocol list length
8374 * 6 . 6 protocol name length
8375 * 7 . 7+n protocol name
8376 */
8377 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8378
XiaokangQian95d5f542022-06-24 02:29:26 +00008379 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008380
XiaokangQian95d5f542022-06-24 02:29:26 +00008381 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8382 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008383 /* Note: the length of the chosen protocol has been checked to be less
8384 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8385 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008386 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008387
XiaokangQian95d5f542022-06-24 02:29:26 +00008388 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008389 return ( 0 );
8390}
8391#endif /* MBEDTLS_SSL_ALPN */
8392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008393#endif /* MBEDTLS_SSL_TLS_C */