blob: c5717c0f1be9bc9d7ddb44d99f8916b06967234d [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 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 ssl->handshake->sig_algs_heap_allocated = 0;
857 }
Jerry Yucc539102022-06-27 16:27:35 +0800858#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800859#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000860 return( 0 );
861}
862
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200863#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200864/* Dummy cookie callbacks for defaults */
865static int ssl_cookie_write_dummy( void *ctx,
866 unsigned char **p, unsigned char *end,
867 const unsigned char *cli_id, size_t cli_id_len )
868{
869 ((void) ctx);
870 ((void) p);
871 ((void) end);
872 ((void) cli_id);
873 ((void) cli_id_len);
874
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200876}
877
878static int ssl_cookie_check_dummy( void *ctx,
879 const unsigned char *cookie, size_t cookie_len,
880 const unsigned char *cli_id, size_t cli_id_len )
881{
882 ((void) ctx);
883 ((void) cookie);
884 ((void) cookie_len);
885 ((void) cli_id);
886 ((void) cli_id_len);
887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200889}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200890#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200891
Paul Bakker5121ce52009-01-03 21:22:43 +0000892/*
893 * Initialize an SSL context
894 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200895void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
896{
897 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
898}
899
Jerry Yu60835a82021-08-04 10:13:52 +0800900static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
901{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100902 const mbedtls_ssl_config *conf = ssl->conf;
903
Ronald Cron6f135e12021-12-08 16:57:54 +0100904#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100905 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
906 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000907 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
908 {
909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
910 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
911 }
912
Jerry Yu60835a82021-08-04 10:13:52 +0800913 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
914 return( 0 );
915 }
916#endif
917
918#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100919 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800920 {
921 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
922 return( 0 );
923 }
924#endif
925
Ronald Cron6f135e12021-12-08 16:57:54 +0100926#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100927 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800928 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000929 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
930 {
931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
932 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
933 }
934
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000935 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
936 {
937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
938 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
939 }
940
941
Ronald Crone1d3f062022-02-10 14:50:54 +0100942 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
943 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800944 }
945#endif
946
947 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
948 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
949}
950
951static int ssl_conf_check(const mbedtls_ssl_context *ssl)
952{
953 int ret;
954 ret = ssl_conf_version_check( ssl );
955 if( ret != 0 )
956 return( ret );
957
958 /* Space for further checks */
959
960 return( 0 );
961}
962
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200963/*
964 * Setup an SSL context
965 */
Jerry Yu6272c4d2022-06-22 13:46:55 +0800966
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200967int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200968 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000969{
Janos Follath865b3eb2019-12-16 11:46:15 +0000970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000971 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
972 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000973
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200974 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000975
Jerry Yu60835a82021-08-04 10:13:52 +0800976 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
977 return( ret );
978
Paul Bakker62f2dee2012-09-28 07:31:51 +0000979 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100980 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000981 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200982
983 /* Set to NULL in case of an error condition */
984 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200985
Darryl Greenb33cc762019-11-28 14:29:44 +0000986#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
987 ssl->in_buf_len = in_buf_len;
988#endif
989 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000990 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000991 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200993 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +0200994 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +1000995 }
996
Darryl Greenb33cc762019-11-28 14:29:44 +0000997#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
998 ssl->out_buf_len = out_buf_len;
999#endif
1000 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001001 if( ssl->out_buf == NULL )
1002 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001003 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001004 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001005 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001006 }
1007
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001008 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001009
Johan Pascalb62bb512015-12-03 21:56:45 +01001010#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001011 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001012#endif
1013
Paul Bakker48916f92012-09-16 19:57:18 +00001014 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001015 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001016
1017 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001018
1019error:
1020 mbedtls_free( ssl->in_buf );
1021 mbedtls_free( ssl->out_buf );
1022
1023 ssl->conf = NULL;
1024
Darryl Greenb33cc762019-11-28 14:29:44 +00001025#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1026 ssl->in_buf_len = 0;
1027 ssl->out_buf_len = 0;
1028#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 ssl->in_buf = NULL;
1030 ssl->out_buf = NULL;
1031
1032 ssl->in_hdr = NULL;
1033 ssl->in_ctr = NULL;
1034 ssl->in_len = NULL;
1035 ssl->in_iv = NULL;
1036 ssl->in_msg = NULL;
1037
1038 ssl->out_hdr = NULL;
1039 ssl->out_ctr = NULL;
1040 ssl->out_len = NULL;
1041 ssl->out_iv = NULL;
1042 ssl->out_msg = NULL;
1043
k-stachowiak9f7798e2018-07-31 16:52:32 +02001044 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001045}
1046
1047/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001048 * Reset an initialized and used SSL context for re-use while retaining
1049 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001050 *
1051 * If partial is non-zero, keep data in the input buffer and client ID.
1052 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001053 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001054void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1055 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001056{
Darryl Greenb33cc762019-11-28 14:29:44 +00001057#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1058 size_t in_buf_len = ssl->in_buf_len;
1059 size_t out_buf_len = ssl->out_buf_len;
1060#else
1061 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1062 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1063#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Hanno Beckerb0302c42021-08-03 09:39:42 +01001065#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1066 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001067#endif
1068
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001069 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001070 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001071
Hanno Beckerb0302c42021-08-03 09:39:42 +01001072 mbedtls_ssl_reset_in_out_pointers( ssl );
1073
1074 /* Reset incoming message parsing */
1075 ssl->in_offt = NULL;
1076 ssl->nb_zero = 0;
1077 ssl->in_msgtype = 0;
1078 ssl->in_msglen = 0;
1079 ssl->in_hslen = 0;
1080 ssl->keep_current_message = 0;
1081 ssl->transform_in = NULL;
1082
1083#if defined(MBEDTLS_SSL_PROTO_DTLS)
1084 ssl->next_record_offset = 0;
1085 ssl->in_epoch = 0;
1086#endif
1087
1088 /* Keep current datagram if partial == 1 */
1089 if( partial == 0 )
1090 {
1091 ssl->in_left = 0;
1092 memset( ssl->in_buf, 0, in_buf_len );
1093 }
1094
1095 /* Reset outgoing message writing */
1096 ssl->out_msgtype = 0;
1097 ssl->out_msglen = 0;
1098 ssl->out_left = 0;
1099 memset( ssl->out_buf, 0, out_buf_len );
1100 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1101 ssl->transform_out = NULL;
1102
1103#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1104 mbedtls_ssl_dtls_replay_reset( ssl );
1105#endif
1106
XiaokangQian2b01dc32022-01-21 02:53:13 +00001107#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001108 if( ssl->transform )
1109 {
1110 mbedtls_ssl_transform_free( ssl->transform );
1111 mbedtls_free( ssl->transform );
1112 ssl->transform = NULL;
1113 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001114#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1115
XiaokangQian2b01dc32022-01-21 02:53:13 +00001116#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1117 mbedtls_ssl_transform_free( ssl->transform_application );
1118 mbedtls_free( ssl->transform_application );
1119 ssl->transform_application = NULL;
1120
1121 if( ssl->handshake != NULL )
1122 {
1123 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1124 mbedtls_free( ssl->handshake->transform_earlydata );
1125 ssl->handshake->transform_earlydata = NULL;
1126
1127 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1128 mbedtls_free( ssl->handshake->transform_handshake );
1129 ssl->handshake->transform_handshake = NULL;
1130 }
1131
XiaokangQian2b01dc32022-01-21 02:53:13 +00001132#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001133}
1134
1135int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1136{
1137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1138
1139 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1140
XiaokangQian78b1fa72022-01-19 06:56:30 +00001141 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001142
1143 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SSL_RENEGOTIATION)
1145 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001146 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001147
1148 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1150 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001151#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001153
Hanno Beckerb0302c42021-08-03 09:39:42 +01001154 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001155 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001156 if( ssl->session )
1157 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 mbedtls_ssl_session_free( ssl->session );
1159 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001160 ssl->session = NULL;
1161 }
1162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001164 ssl->alpn_chosen = NULL;
1165#endif
1166
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001167#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001168#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001169 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001170#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001171 {
1172 mbedtls_free( ssl->cli_id );
1173 ssl->cli_id = NULL;
1174 ssl->cli_id_len = 0;
1175 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001176#endif
1177
Paul Bakker48916f92012-09-16 19:57:18 +00001178 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1179 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001180
1181 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001182}
1183
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001184/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001185 * Reset an initialized and used SSL context for re-use while retaining
1186 * all application-set variables, function pointers and data.
1187 */
1188int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1189{
Hanno Becker43aefe22020-02-05 10:44:56 +00001190 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001191}
1192
1193/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001194 * SSL set accessors
1195 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001196void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001197{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001198 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001199}
1200
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001201void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001202{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001203 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001204}
1205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001207void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001209 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001210}
1211#endif
1212
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001213void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001215 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001216}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001219
Hanno Becker1841b0a2018-08-24 11:13:57 +01001220void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1221 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001222{
1223 ssl->disable_datagram_packing = !allow_packing;
1224}
1225
1226void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1227 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001228{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001229 conf->hs_timeout_min = min;
1230 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001231}
1232#endif
1233
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001234void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001235{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001236 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001237}
1238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001240void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001241 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001242 void *p_vrfy )
1243{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001244 conf->f_vrfy = f_vrfy;
1245 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001246}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001248
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001249void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001250 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001251 void *p_rng )
1252{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001253 conf->f_rng = f_rng;
1254 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001255}
1256
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001257void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001258 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001259 void *p_dbg )
1260{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001261 conf->f_dbg = f_dbg;
1262 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001263}
1264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001266 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001267 mbedtls_ssl_send_t *f_send,
1268 mbedtls_ssl_recv_t *f_recv,
1269 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001270{
1271 ssl->p_bio = p_bio;
1272 ssl->f_send = f_send;
1273 ssl->f_recv = f_recv;
1274 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001275}
1276
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001277#if defined(MBEDTLS_SSL_PROTO_DTLS)
1278void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1279{
1280 ssl->mtu = mtu;
1281}
1282#endif
1283
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001284void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001285{
1286 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001287}
1288
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001289void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1290 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001291 mbedtls_ssl_set_timer_t *f_set_timer,
1292 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001293{
1294 ssl->p_timer = p_timer;
1295 ssl->f_set_timer = f_set_timer;
1296 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001297
1298 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001299 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001300}
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001303void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001304 void *p_cache,
1305 mbedtls_ssl_cache_get_t *f_get_cache,
1306 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001307{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001308 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001309 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001310 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001311}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314#if defined(MBEDTLS_SSL_CLI_C)
1315int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001316{
Janos Follath865b3eb2019-12-16 11:46:15 +00001317 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001318
1319 if( ssl == NULL ||
1320 session == NULL ||
1321 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001322 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001325 }
1326
Hanno Beckere810bbc2021-05-14 16:01:05 +01001327 if( ssl->handshake->resume == 1 )
1328 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1329
Hanno Becker52055ae2019-02-06 14:30:46 +00001330 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1331 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001332 return( ret );
1333
Paul Bakker0a597072012-09-25 21:55:46 +00001334 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001335
1336 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001337}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001339
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001340void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1341 const int *ciphersuites )
1342{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001343 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001344}
1345
Ronald Cron6f135e12021-12-08 16:57:54 +01001346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001347void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001348 const int kex_modes )
1349{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001350 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001351}
Ronald Cron6f135e12021-12-08 16:57:54 +01001352#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001355void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001356 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001357{
1358 conf->cert_profile = profile;
1359}
1360
Glenn Strauss36872db2022-01-22 05:06:31 -05001361static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1362{
1363 mbedtls_ssl_key_cert *cur = key_cert, *next;
1364
1365 while( cur != NULL )
1366 {
1367 next = cur->next;
1368 mbedtls_free( cur );
1369 cur = next;
1370 }
1371}
1372
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001373/* Append a new keycert entry to a (possibly empty) list */
1374static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1375 mbedtls_x509_crt *cert,
1376 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001377{
niisato8ee24222018-06-25 19:05:48 +09001378 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001379
Glenn Strauss36872db2022-01-22 05:06:31 -05001380 if( cert == NULL )
1381 {
1382 /* Free list if cert is null */
1383 ssl_key_cert_free( *head );
1384 *head = NULL;
1385 return( 0 );
1386 }
1387
niisato8ee24222018-06-25 19:05:48 +09001388 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1389 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001390 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001391
niisato8ee24222018-06-25 19:05:48 +09001392 new_cert->cert = cert;
1393 new_cert->key = key;
1394 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001395
Glenn Strauss36872db2022-01-22 05:06:31 -05001396 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001397 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001398 {
niisato8ee24222018-06-25 19:05:48 +09001399 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001400 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001401 else
1402 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001403 mbedtls_ssl_key_cert *cur = *head;
1404 while( cur->next != NULL )
1405 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001406 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001407 }
1408
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001409 return( 0 );
1410}
1411
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001412int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001413 mbedtls_x509_crt *own_cert,
1414 mbedtls_pk_context *pk_key )
1415{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001416 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417}
1418
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001419void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001420 mbedtls_x509_crt *ca_chain,
1421 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001422{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001423 conf->ca_chain = ca_chain;
1424 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001425
1426#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1427 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1428 * cannot be used together. */
1429 conf->f_ca_cb = NULL;
1430 conf->p_ca_cb = NULL;
1431#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001432}
Hanno Becker5adaad92019-03-27 16:54:37 +00001433
1434#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1435void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001436 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001437 void *p_ca_cb )
1438{
1439 conf->f_ca_cb = f_ca_cb;
1440 conf->p_ca_cb = p_ca_cb;
1441
1442 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1443 * cannot be used together. */
1444 conf->ca_chain = NULL;
1445 conf->ca_crl = NULL;
1446}
1447#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001449
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001450#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001451const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1452 size_t *name_len )
1453{
1454 *name_len = ssl->handshake->sni_name_len;
1455 return( ssl->handshake->sni_name );
1456}
1457
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001458int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1459 mbedtls_x509_crt *own_cert,
1460 mbedtls_pk_context *pk_key )
1461{
1462 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1463 own_cert, pk_key ) );
1464}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001465
1466void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1467 mbedtls_x509_crt *ca_chain,
1468 mbedtls_x509_crl *ca_crl )
1469{
1470 ssl->handshake->sni_ca_chain = ca_chain;
1471 ssl->handshake->sni_ca_crl = ca_crl;
1472}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001473
1474void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1475 int authmode )
1476{
1477 ssl->handshake->sni_authmode = authmode;
1478}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001479#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1480
Hanno Becker8927c832019-04-03 12:52:50 +01001481#if defined(MBEDTLS_X509_CRT_PARSE_C)
1482void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1483 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1484 void *p_vrfy )
1485{
1486 ssl->f_vrfy = f_vrfy;
1487 ssl->p_vrfy = p_vrfy;
1488}
1489#endif
1490
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001491#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001492/*
1493 * Set EC J-PAKE password for current handshake
1494 */
1495int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1496 const unsigned char *pw,
1497 size_t pw_len )
1498{
1499 mbedtls_ecjpake_role role;
1500
Janos Follath8eb64132016-06-03 15:40:57 +01001501 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001502 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1503
1504 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1505 role = MBEDTLS_ECJPAKE_SERVER;
1506 else
1507 role = MBEDTLS_ECJPAKE_CLIENT;
1508
1509 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1510 role,
1511 MBEDTLS_MD_SHA256,
1512 MBEDTLS_ECP_DP_SECP256R1,
1513 pw, pw_len ) );
1514}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001515#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001516
Gilles Peskineeccd8882020-03-10 12:19:08 +01001517#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001518
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001519static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1520{
1521#if defined(MBEDTLS_USE_PSA_CRYPTO)
1522 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1523 return( 1 );
1524#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001525 if( conf->psk != NULL )
1526 return( 1 );
1527
1528 return( 0 );
1529}
1530
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001531static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1532{
1533 /* Remove reference to existing PSK, if any. */
1534#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001535 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001536 {
1537 /* The maintenance of the PSK key slot is the
1538 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001539 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001540 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001541#endif /* MBEDTLS_USE_PSA_CRYPTO */
1542 if( conf->psk != NULL )
1543 {
1544 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1545
1546 mbedtls_free( conf->psk );
1547 conf->psk = NULL;
1548 conf->psk_len = 0;
1549 }
1550
1551 /* Remove reference to PSK identity, if any. */
1552 if( conf->psk_identity != NULL )
1553 {
1554 mbedtls_free( conf->psk_identity );
1555 conf->psk_identity = NULL;
1556 conf->psk_identity_len = 0;
1557 }
1558}
1559
Hanno Becker7390c712018-11-15 13:33:04 +00001560/* This function assumes that PSK identity in the SSL config is unset.
1561 * It checks that the provided identity is well-formed and attempts
1562 * to make a copy of it in the SSL config.
1563 * On failure, the PSK identity in the config remains unset. */
1564static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1565 unsigned char const *psk_identity,
1566 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001567{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001568 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001569 if( psk_identity == NULL ||
1570 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001571 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001572 {
1573 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1574 }
1575
Hanno Becker7390c712018-11-15 13:33:04 +00001576 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1577 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001578 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001579
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001580 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001581 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001582
1583 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001584}
1585
Hanno Becker7390c712018-11-15 13:33:04 +00001586int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1587 const unsigned char *psk, size_t psk_len,
1588 const unsigned char *psk_identity, size_t psk_identity_len )
1589{
Janos Follath865b3eb2019-12-16 11:46:15 +00001590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001591
1592 /* We currently only support one PSK, raw or opaque. */
1593 if( ssl_conf_psk_is_configured( conf ) )
1594 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001595
1596 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001597 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001598 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001599 if( psk_len == 0 )
1600 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1601 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1602 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1603
Hanno Becker7390c712018-11-15 13:33:04 +00001604 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1605 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1606 conf->psk_len = psk_len;
1607 memcpy( conf->psk, psk, conf->psk_len );
1608
1609 /* Check and set PSK Identity */
1610 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1611 if( ret != 0 )
1612 ssl_conf_remove_psk( conf );
1613
1614 return( ret );
1615}
1616
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001617static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1618{
1619#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001620 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001621 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001622 /* The maintenance of the external PSK key slot is the
1623 * user's responsibility. */
1624 if( ssl->handshake->psk_opaque_is_internal )
1625 {
1626 psa_destroy_key( ssl->handshake->psk_opaque );
1627 ssl->handshake->psk_opaque_is_internal = 0;
1628 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001629 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001630 }
Neil Armstronge952a302022-05-03 10:22:14 +02001631#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001632 if( ssl->handshake->psk != NULL )
1633 {
1634 mbedtls_platform_zeroize( ssl->handshake->psk,
1635 ssl->handshake->psk_len );
1636 mbedtls_free( ssl->handshake->psk );
1637 ssl->handshake->psk_len = 0;
1638 }
Neil Armstronge952a302022-05-03 10:22:14 +02001639#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001640}
1641
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001642int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1643 const unsigned char *psk, size_t psk_len )
1644{
Neil Armstrong501c9322022-05-03 09:35:09 +02001645#if defined(MBEDTLS_USE_PSA_CRYPTO)
1646 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1647 psa_status_t status;
1648 psa_algorithm_t alg;
1649 mbedtls_svc_key_id_t key;
1650#endif /* MBEDTLS_USE_PSA_CRYPTO */
1651
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001652 if( psk == NULL || ssl->handshake == NULL )
1653 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1654
1655 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1656 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1657
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001658 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001659
Neil Armstrong501c9322022-05-03 09:35:09 +02001660#if defined(MBEDTLS_USE_PSA_CRYPTO)
1661 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1662 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1663 else
1664 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1665
1666 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1667 psa_set_key_algorithm( &key_attributes, alg );
1668 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1669
1670 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1671 if( status != PSA_SUCCESS )
1672 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1673
1674 /* Allow calling psa_destroy_key() on psk remove */
1675 ssl->handshake->psk_opaque_is_internal = 1;
1676 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1677#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001678 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001679 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001680
1681 ssl->handshake->psk_len = psk_len;
1682 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1683
1684 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001685#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001686}
1687
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001688#if defined(MBEDTLS_USE_PSA_CRYPTO)
1689int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001690 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001691 const unsigned char *psk_identity,
1692 size_t psk_identity_len )
1693{
Janos Follath865b3eb2019-12-16 11:46:15 +00001694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001695
1696 /* We currently only support one PSK, raw or opaque. */
1697 if( ssl_conf_psk_is_configured( conf ) )
1698 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001699
Hanno Becker7390c712018-11-15 13:33:04 +00001700 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001701 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001703 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001704
1705 /* Check and set PSK Identity */
1706 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1707 psk_identity_len );
1708 if( ret != 0 )
1709 ssl_conf_remove_psk( conf );
1710
1711 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001712}
1713
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001714int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1715 mbedtls_svc_key_id_t psk )
1716{
1717 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1718 ( ssl->handshake == NULL ) )
1719 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1720
1721 ssl_remove_psk( ssl );
1722 ssl->handshake->psk_opaque = psk;
1723 return( 0 );
1724}
1725#endif /* MBEDTLS_USE_PSA_CRYPTO */
1726
1727void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1728 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1729 size_t),
1730 void *p_psk )
1731{
1732 conf->f_psk = f_psk;
1733 conf->p_psk = p_psk;
1734}
1735#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1736
1737#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001738static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1739 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001740{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001741#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001742 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001743 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001744#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001745 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001746 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001747 return( MBEDTLS_SSL_MODE_STREAM );
1748}
1749
1750#else /* MBEDTLS_USE_PSA_CRYPTO */
1751
1752static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1753 mbedtls_cipher_mode_t mode )
1754{
1755#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1756 if( mode == MBEDTLS_MODE_CBC )
1757 return( MBEDTLS_SSL_MODE_CBC );
1758#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1759
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001760#if defined(MBEDTLS_GCM_C) || \
1761 defined(MBEDTLS_CCM_C) || \
1762 defined(MBEDTLS_CHACHAPOLY_C)
1763 if( mode == MBEDTLS_MODE_GCM ||
1764 mode == MBEDTLS_MODE_CCM ||
1765 mode == MBEDTLS_MODE_CHACHAPOLY )
1766 return( MBEDTLS_SSL_MODE_AEAD );
1767#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001768
1769 return( MBEDTLS_SSL_MODE_STREAM );
1770}
Gilles Peskine301711e2022-04-26 16:57:05 +02001771#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001772
Gilles Peskinee108d982022-04-26 16:50:40 +02001773static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1774 mbedtls_ssl_mode_t base_mode,
1775 int encrypt_then_mac )
1776{
1777#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1778 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1779 base_mode == MBEDTLS_SSL_MODE_CBC )
1780 {
1781 return( MBEDTLS_SSL_MODE_CBC_ETM );
1782 }
1783#else
1784 (void) encrypt_then_mac;
1785#endif
1786 return( base_mode );
1787}
1788
Neil Armstrongab555e02022-04-04 11:07:59 +02001789mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001790 const mbedtls_ssl_transform *transform )
1791{
Gilles Peskinee108d982022-04-26 16:50:40 +02001792 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001793#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001794 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001795#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001796 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1797#endif
1798 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001799
Gilles Peskinee108d982022-04-26 16:50:40 +02001800 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001801#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001802 encrypt_then_mac = transform->encrypt_then_mac;
1803#endif
1804 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001805}
1806
Neil Armstrongab555e02022-04-04 11:07:59 +02001807mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001808#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001809 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001810#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001811 const mbedtls_ssl_ciphersuite_t *suite )
1812{
Gilles Peskinee108d982022-04-26 16:50:40 +02001813 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1814
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001815#if defined(MBEDTLS_USE_PSA_CRYPTO)
1816 psa_status_t status;
1817 psa_algorithm_t alg;
1818 psa_key_type_t type;
1819 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001820 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1821 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001822 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001823#else
1824 const mbedtls_cipher_info_t *cipher =
1825 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001826 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001827 {
1828 base_mode =
1829 mbedtls_ssl_get_base_mode(
1830 mbedtls_cipher_info_get_mode( cipher ) );
1831 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001832#endif /* MBEDTLS_USE_PSA_CRYPTO */
1833
Gilles Peskinee108d982022-04-26 16:50:40 +02001834#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1835 int encrypt_then_mac = 0;
1836#endif
1837 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001838}
1839
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001840#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001841psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001842 size_t taglen,
1843 psa_algorithm_t *alg,
1844 psa_key_type_t *key_type,
1845 size_t *key_size )
1846{
1847 switch ( mbedtls_cipher_type )
1848 {
1849 case MBEDTLS_CIPHER_AES_128_CBC:
1850 *alg = PSA_ALG_CBC_NO_PADDING;
1851 *key_type = PSA_KEY_TYPE_AES;
1852 *key_size = 128;
1853 break;
1854 case MBEDTLS_CIPHER_AES_128_CCM:
1855 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1856 *key_type = PSA_KEY_TYPE_AES;
1857 *key_size = 128;
1858 break;
1859 case MBEDTLS_CIPHER_AES_128_GCM:
1860 *alg = PSA_ALG_GCM;
1861 *key_type = PSA_KEY_TYPE_AES;
1862 *key_size = 128;
1863 break;
1864 case MBEDTLS_CIPHER_AES_192_CCM:
1865 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1866 *key_type = PSA_KEY_TYPE_AES;
1867 *key_size = 192;
1868 break;
1869 case MBEDTLS_CIPHER_AES_192_GCM:
1870 *alg = PSA_ALG_GCM;
1871 *key_type = PSA_KEY_TYPE_AES;
1872 *key_size = 192;
1873 break;
1874 case MBEDTLS_CIPHER_AES_256_CBC:
1875 *alg = PSA_ALG_CBC_NO_PADDING;
1876 *key_type = PSA_KEY_TYPE_AES;
1877 *key_size = 256;
1878 break;
1879 case MBEDTLS_CIPHER_AES_256_CCM:
1880 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1881 *key_type = PSA_KEY_TYPE_AES;
1882 *key_size = 256;
1883 break;
1884 case MBEDTLS_CIPHER_AES_256_GCM:
1885 *alg = PSA_ALG_GCM;
1886 *key_type = PSA_KEY_TYPE_AES;
1887 *key_size = 256;
1888 break;
1889 case MBEDTLS_CIPHER_ARIA_128_CBC:
1890 *alg = PSA_ALG_CBC_NO_PADDING;
1891 *key_type = PSA_KEY_TYPE_ARIA;
1892 *key_size = 128;
1893 break;
1894 case MBEDTLS_CIPHER_ARIA_128_CCM:
1895 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1896 *key_type = PSA_KEY_TYPE_ARIA;
1897 *key_size = 128;
1898 break;
1899 case MBEDTLS_CIPHER_ARIA_128_GCM:
1900 *alg = PSA_ALG_GCM;
1901 *key_type = PSA_KEY_TYPE_ARIA;
1902 *key_size = 128;
1903 break;
1904 case MBEDTLS_CIPHER_ARIA_192_CCM:
1905 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1906 *key_type = PSA_KEY_TYPE_ARIA;
1907 *key_size = 192;
1908 break;
1909 case MBEDTLS_CIPHER_ARIA_192_GCM:
1910 *alg = PSA_ALG_GCM;
1911 *key_type = PSA_KEY_TYPE_ARIA;
1912 *key_size = 192;
1913 break;
1914 case MBEDTLS_CIPHER_ARIA_256_CBC:
1915 *alg = PSA_ALG_CBC_NO_PADDING;
1916 *key_type = PSA_KEY_TYPE_ARIA;
1917 *key_size = 256;
1918 break;
1919 case MBEDTLS_CIPHER_ARIA_256_CCM:
1920 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1921 *key_type = PSA_KEY_TYPE_ARIA;
1922 *key_size = 256;
1923 break;
1924 case MBEDTLS_CIPHER_ARIA_256_GCM:
1925 *alg = PSA_ALG_GCM;
1926 *key_type = PSA_KEY_TYPE_ARIA;
1927 *key_size = 256;
1928 break;
1929 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1930 *alg = PSA_ALG_CBC_NO_PADDING;
1931 *key_type = PSA_KEY_TYPE_CAMELLIA;
1932 *key_size = 128;
1933 break;
1934 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1935 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1936 *key_type = PSA_KEY_TYPE_CAMELLIA;
1937 *key_size = 128;
1938 break;
1939 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1940 *alg = PSA_ALG_GCM;
1941 *key_type = PSA_KEY_TYPE_CAMELLIA;
1942 *key_size = 128;
1943 break;
1944 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1945 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1946 *key_type = PSA_KEY_TYPE_CAMELLIA;
1947 *key_size = 192;
1948 break;
1949 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1950 *alg = PSA_ALG_GCM;
1951 *key_type = PSA_KEY_TYPE_CAMELLIA;
1952 *key_size = 192;
1953 break;
1954 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1955 *alg = PSA_ALG_CBC_NO_PADDING;
1956 *key_type = PSA_KEY_TYPE_CAMELLIA;
1957 *key_size = 256;
1958 break;
1959 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1960 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1961 *key_type = PSA_KEY_TYPE_CAMELLIA;
1962 *key_size = 256;
1963 break;
1964 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1965 *alg = PSA_ALG_GCM;
1966 *key_type = PSA_KEY_TYPE_CAMELLIA;
1967 *key_size = 256;
1968 break;
1969 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1970 *alg = PSA_ALG_CHACHA20_POLY1305;
1971 *key_type = PSA_KEY_TYPE_CHACHA20;
1972 *key_size = 256;
1973 break;
1974 case MBEDTLS_CIPHER_NULL:
1975 *alg = MBEDTLS_SSL_NULL_CIPHER;
1976 *key_type = 0;
1977 *key_size = 0;
1978 break;
1979 default:
1980 return PSA_ERROR_NOT_SUPPORTED;
1981 }
1982
1983 return PSA_SUCCESS;
1984}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001985#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001986
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001987#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001988int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1989 const unsigned char *dhm_P, size_t P_len,
1990 const unsigned char *dhm_G, size_t G_len )
1991{
Janos Follath865b3eb2019-12-16 11:46:15 +00001992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001993
Glenn Strausscee11292021-12-20 01:43:17 -05001994 mbedtls_mpi_free( &conf->dhm_P );
1995 mbedtls_mpi_free( &conf->dhm_G );
1996
Hanno Beckera90658f2017-10-04 15:29:08 +01001997 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1998 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1999 {
2000 mbedtls_mpi_free( &conf->dhm_P );
2001 mbedtls_mpi_free( &conf->dhm_G );
2002 return( ret );
2003 }
2004
2005 return( 0 );
2006}
Paul Bakker5121ce52009-01-03 21:22:43 +00002007
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002008int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002009{
Janos Follath865b3eb2019-12-16 11:46:15 +00002010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002011
Glenn Strausscee11292021-12-20 01:43:17 -05002012 mbedtls_mpi_free( &conf->dhm_P );
2013 mbedtls_mpi_free( &conf->dhm_G );
2014
Gilles Peskinee5702482021-06-11 21:59:08 +02002015 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2016 &conf->dhm_P ) ) != 0 ||
2017 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2018 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002019 {
2020 mbedtls_mpi_free( &conf->dhm_P );
2021 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002022 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002023 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002024
2025 return( 0 );
2026}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002027#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002028
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002029#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2030/*
2031 * Set the minimum length for Diffie-Hellman parameters
2032 */
2033void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2034 unsigned int bitlen )
2035{
2036 conf->dhm_min_bitlen = bitlen;
2037}
2038#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2039
Gilles Peskineeccd8882020-03-10 12:19:08 +01002040#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002041#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002042/*
2043 * Set allowed/preferred hashes for handshake signatures
2044 */
2045void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2046 const int *hashes )
2047{
2048 conf->sig_hashes = hashes;
2049}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002050#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002051
Jerry Yuf017ee42022-01-12 15:49:48 +08002052/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002053void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2054 const uint16_t* sig_algs )
2055{
Jerry Yuf017ee42022-01-12 15:49:48 +08002056#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2057 conf->sig_hashes = NULL;
2058#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2059 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002060}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002061#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002062
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002063#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002064#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002065/*
2066 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002067 *
2068 * mbedtls_ssl_setup() takes the provided list
2069 * and translates it to a list of IANA TLS group identifiers,
2070 * stored in ssl->handshake->group_list.
2071 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002072 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002073void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002074 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002075{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002076 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002077 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002078}
Brett Warrene0edc842021-08-17 09:53:13 +01002079#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002080#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002081
Brett Warrene0edc842021-08-17 09:53:13 +01002082/*
2083 * Set the allowed groups
2084 */
2085void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2086 const uint16_t *group_list )
2087{
2088#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2089 conf->curve_list = NULL;
2090#endif
2091 conf->group_list = group_list;
2092}
2093
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002094#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002096{
Hanno Becker947194e2017-04-07 13:25:49 +01002097 /* Initialize to suppress unnecessary compiler warning */
2098 size_t hostname_len = 0;
2099
2100 /* Check if new hostname is valid before
2101 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002102 if( hostname != NULL )
2103 {
2104 hostname_len = strlen( hostname );
2105
2106 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2107 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2108 }
2109
2110 /* Now it's clear that we will overwrite the old hostname,
2111 * so we can free it safely */
2112
2113 if( ssl->hostname != NULL )
2114 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002115 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002116 mbedtls_free( ssl->hostname );
2117 }
2118
2119 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002120
Paul Bakker5121ce52009-01-03 21:22:43 +00002121 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002122 {
2123 ssl->hostname = NULL;
2124 }
2125 else
2126 {
2127 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002128 if( ssl->hostname == NULL )
2129 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002130
Hanno Becker947194e2017-04-07 13:25:49 +01002131 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002132
Hanno Becker947194e2017-04-07 13:25:49 +01002133 ssl->hostname[hostname_len] = '\0';
2134 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002135
2136 return( 0 );
2137}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002138#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002139
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002140#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002141void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002143 const unsigned char *, size_t),
2144 void *p_sni )
2145{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002146 conf->f_sni = f_sni;
2147 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002148}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002152int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002153{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002154 size_t cur_len, tot_len;
2155 const char **p;
2156
2157 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002158 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2159 * MUST NOT be truncated."
2160 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002161 */
2162 tot_len = 0;
2163 for( p = protos; *p != NULL; p++ )
2164 {
2165 cur_len = strlen( *p );
2166 tot_len += cur_len;
2167
Ronald Cron8216dd32020-04-23 16:41:44 +02002168 if( ( cur_len == 0 ) ||
2169 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2170 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002172 }
2173
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002174 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002175
2176 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002177}
2178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002180{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002181 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002182}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002184
Johan Pascalb62bb512015-12-03 21:56:45 +01002185#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002186void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2187 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002188{
2189 conf->dtls_srtp_mki_support = support_mki_value;
2190}
2191
Ron Eldoref72faf2018-07-12 11:54:20 +03002192int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2193 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002194 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002195{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002196 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002197 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002198 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002199 }
Ron Eldor591f1622018-01-22 12:30:04 +02002200
2201 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002202 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002203 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002204 }
Ron Eldor591f1622018-01-22 12:30:04 +02002205
2206 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2207 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002208 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002209}
2210
Ron Eldoref72faf2018-07-12 11:54:20 +03002211int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002212 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002213{
Johan Pascal253d0262020-09-22 13:04:45 +02002214 const mbedtls_ssl_srtp_profile *p;
2215 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002216
Johan Pascal253d0262020-09-22 13:04:45 +02002217 /* check the profiles list: all entry must be valid,
2218 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002219 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2220 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2221 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002222 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002223 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002224 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002225 list_size++;
2226 }
2227 else
2228 {
2229 /* unsupported value, stop parsing and set the size to an error value */
2230 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002231 }
2232 }
2233
Johan Pascal5ef72d22020-10-28 17:05:47 +01002234 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002235 {
Johan Pascal253d0262020-09-22 13:04:45 +02002236 conf->dtls_srtp_profile_list = NULL;
2237 conf->dtls_srtp_profile_list_len = 0;
2238 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2239 }
2240
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002241 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002242 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002243
2244 return( 0 );
2245}
2246
Johan Pascal5ef72d22020-10-28 17:05:47 +01002247void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2248 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002249{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002250 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2251 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002252 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002253 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002254 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002255 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002256 else
2257 {
2258 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002259 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2260 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002261 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002262}
Johan Pascalb62bb512015-12-03 21:56:45 +01002263#endif /* MBEDTLS_SSL_DTLS_SRTP */
2264
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002265void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002266{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002267 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002268}
2269
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002270void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002271{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002272 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002273}
2274
Janos Follath088ce432017-04-10 12:42:31 +01002275#if defined(MBEDTLS_SSL_SRV_C)
2276void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2277 char cert_req_ca_list )
2278{
2279 conf->cert_req_ca_list = cert_req_ca_list;
2280}
2281#endif
2282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002284void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002285{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002286 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002287}
2288#endif
2289
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002291void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002292{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002293 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002294}
2295#endif
2296
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002298int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002299{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002301 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002302 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002304 }
2305
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002306 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002307
2308 return( 0 );
2309}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002311
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002312void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002313{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002314 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002315}
2316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002318void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002319{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002320 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002321}
2322
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002323void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002324{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002325 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002326}
2327
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002328void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002329 const unsigned char period[8] )
2330{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002331 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002332}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002333#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002336#if defined(MBEDTLS_SSL_CLI_C)
2337void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002338{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002339 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002340}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002341#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002342
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002343#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002344void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2345 mbedtls_ssl_ticket_write_t *f_ticket_write,
2346 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2347 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002348{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002349 conf->f_ticket_write = f_ticket_write;
2350 conf->f_ticket_parse = f_ticket_parse;
2351 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002352}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002353#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002355
Hanno Becker7e6c1782021-06-08 09:24:55 +01002356void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2357 mbedtls_ssl_export_keys_t *f_export_keys,
2358 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002359{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002360 ssl->f_export_keys = f_export_keys;
2361 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002362}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002363
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002364#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002365void mbedtls_ssl_conf_async_private_cb(
2366 mbedtls_ssl_config *conf,
2367 mbedtls_ssl_async_sign_t *f_async_sign,
2368 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2369 mbedtls_ssl_async_resume_t *f_async_resume,
2370 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002371 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002372{
2373 conf->f_async_sign_start = f_async_sign;
2374 conf->f_async_decrypt_start = f_async_decrypt;
2375 conf->f_async_resume = f_async_resume;
2376 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002377 conf->p_async_config_data = async_config_data;
2378}
2379
Gilles Peskine8f97af72018-04-26 11:46:10 +02002380void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2381{
2382 return( conf->p_async_config_data );
2383}
2384
Gilles Peskine1febfef2018-04-30 11:54:39 +02002385void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002386{
2387 if( ssl->handshake == NULL )
2388 return( NULL );
2389 else
2390 return( ssl->handshake->user_async_ctx );
2391}
2392
Gilles Peskine1febfef2018-04-30 11:54:39 +02002393void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002394 void *ctx )
2395{
2396 if( ssl->handshake != NULL )
2397 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002398}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002399#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002400
Paul Bakker5121ce52009-01-03 21:22:43 +00002401/*
2402 * SSL get accessors
2403 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002404uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002405{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002406 if( ssl->session != NULL )
2407 return( ssl->session->verify_result );
2408
2409 if( ssl->session_negotiate != NULL )
2410 return( ssl->session_negotiate->verify_result );
2411
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002412 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002413}
2414
Glenn Strauss8f526902022-01-13 00:04:49 -05002415int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2416{
2417 if( ssl == NULL || ssl->session == NULL )
2418 return( 0 );
2419
2420 return( ssl->session->ciphersuite );
2421}
2422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002424{
Paul Bakker926c8e42013-03-06 10:23:34 +01002425 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002426 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002429}
2430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002432{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002434 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002435 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002436 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002437 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002438 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002439 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002440 default:
2441 return( "unknown (DTLS)" );
2442 }
2443 }
2444#endif
2445
Glenn Strauss60bfe602022-03-14 19:04:24 -04002446 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002447 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002448 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002449 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002450 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002451 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002452 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002453 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002454 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002455}
2456
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002457#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002458size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2459{
David Horstmann95d516f2021-05-04 18:36:56 +01002460 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002461 size_t read_mfl;
2462
2463 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2464 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2465 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2466 {
2467 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2468 }
2469
2470 /* Check if a smaller max length was negotiated */
2471 if( ssl->session_out != NULL )
2472 {
2473 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2474 if( read_mfl < max_len )
2475 {
2476 max_len = read_mfl;
2477 }
2478 }
2479
2480 // During a handshake, use the value being negotiated
2481 if( ssl->session_negotiate != NULL )
2482 {
2483 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2484 if( read_mfl < max_len )
2485 {
2486 max_len = read_mfl;
2487 }
2488 }
2489
2490 return( max_len );
2491}
2492
2493size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002494{
2495 size_t max_len;
2496
2497 /*
2498 * Assume mfl_code is correct since it was checked when set
2499 */
Angus Grattond8213d02016-05-25 20:56:48 +10002500 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002501
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002502 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002503 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002504 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002505 {
Angus Grattond8213d02016-05-25 20:56:48 +10002506 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002507 }
2508
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002509 /* During a handshake, use the value being negotiated */
2510 if( ssl->session_negotiate != NULL &&
2511 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2512 {
2513 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2514 }
2515
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002516 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002517}
2518#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2519
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002520#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002521size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002522{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002523 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2524 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2525 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2526 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2527 return ( 0 );
2528
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002529 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2530 return( ssl->mtu );
2531
2532 if( ssl->mtu == 0 )
2533 return( ssl->handshake->mtu );
2534
2535 return( ssl->mtu < ssl->handshake->mtu ?
2536 ssl->mtu : ssl->handshake->mtu );
2537}
2538#endif /* MBEDTLS_SSL_PROTO_DTLS */
2539
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002540int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2541{
2542 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2543
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002544#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2545 !defined(MBEDTLS_SSL_PROTO_DTLS)
2546 (void) ssl;
2547#endif
2548
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002549#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002550 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002551
2552 if( max_len > mfl )
2553 max_len = mfl;
2554#endif
2555
2556#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002557 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002558 {
Hanno Becker89490712020-02-05 10:50:12 +00002559 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002560 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2561 const size_t overhead = (size_t) ret;
2562
2563 if( ret < 0 )
2564 return( ret );
2565
2566 if( mtu <= overhead )
2567 {
2568 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2569 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2570 }
2571
2572 if( max_len > mtu - overhead )
2573 max_len = mtu - overhead;
2574 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002575#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002576
Hanno Becker0defedb2018-08-10 12:35:02 +01002577#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2578 !defined(MBEDTLS_SSL_PROTO_DTLS)
2579 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002580#endif
2581
2582 return( (int) max_len );
2583}
2584
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002585int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2586{
2587 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2588
2589#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2590 (void) ssl;
2591#endif
2592
2593#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2594 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2595
2596 if( max_len > mfl )
2597 max_len = mfl;
2598#endif
2599
2600 return( (int) max_len );
2601}
2602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603#if defined(MBEDTLS_X509_CRT_PARSE_C)
2604const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002605{
2606 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002607 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002608
Hanno Beckere6824572019-02-07 13:18:46 +00002609#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002610 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002611#else
2612 return( NULL );
2613#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002614}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002618int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2619 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002620{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002621 int ret;
2622
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002623 if( ssl == NULL ||
2624 dst == NULL ||
2625 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002626 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002627 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002629 }
2630
Hanno Beckere810bbc2021-05-14 16:01:05 +01002631 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2632 * idempotent: Each session can only be exported once.
2633 *
2634 * (This is in preparation for TLS 1.3 support where we will
2635 * need the ability to export multiple sessions (aka tickets),
2636 * which will be achieved by calling mbedtls_ssl_get_session()
2637 * multiple times until it fails.)
2638 *
2639 * Check whether we have already exported the current session,
2640 * and fail if so.
2641 */
2642 if( ssl->session->exported == 1 )
2643 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2644
2645 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2646 if( ret != 0 )
2647 return( ret );
2648
2649 /* Remember that we've exported the session. */
2650 ssl->session->exported = 1;
2651 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002652}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002654
Paul Bakker5121ce52009-01-03 21:22:43 +00002655/*
Hanno Beckera835da52019-05-16 12:39:07 +01002656 * Define ticket header determining Mbed TLS version
2657 * and structure of the ticket.
2658 */
2659
Hanno Becker94ef3b32019-05-16 12:50:45 +01002660/*
Hanno Becker50b59662019-05-28 14:30:45 +01002661 * Define bitflag determining compile-time settings influencing
2662 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002663 */
2664
Hanno Becker50b59662019-05-28 14:30:45 +01002665#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002666#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002667#else
Hanno Becker3e088662019-05-29 11:10:18 +01002668#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002669#endif /* MBEDTLS_HAVE_TIME */
2670
2671#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002672#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002673#else
Hanno Becker3e088662019-05-29 11:10:18 +01002674#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002675#endif /* MBEDTLS_X509_CRT_PARSE_C */
2676
2677#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002678#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002679#else
Hanno Becker3e088662019-05-29 11:10:18 +01002680#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002681#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2682
2683#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002684#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002685#else
Hanno Becker3e088662019-05-29 11:10:18 +01002686#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002687#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2688
Hanno Becker94ef3b32019-05-16 12:50:45 +01002689#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002690#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002691#else
Hanno Becker3e088662019-05-29 11:10:18 +01002692#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002693#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2694
Hanno Becker94ef3b32019-05-16 12:50:45 +01002695#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2696#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2697#else
2698#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2699#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2700
Hanno Becker3e088662019-05-29 11:10:18 +01002701#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2702#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2703#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2704#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002705#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2706#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002707
Hanno Becker50b59662019-05-28 14:30:45 +01002708#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002709 ( (uint16_t) ( \
2710 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2711 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2712 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2713 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002714 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002715 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002716
Hanno Beckerf8787072019-05-16 12:41:07 +01002717static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002718 MBEDTLS_VERSION_MAJOR,
2719 MBEDTLS_VERSION_MINOR,
2720 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002721 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2722 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002723};
Hanno Beckera835da52019-05-16 12:39:07 +01002724
2725/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002726 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002727 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002728 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002729 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002730 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002731 * opaque mbedtls_version[3]; // library version: major, minor, patch
2732 * opaque session_format[2]; // library-version specific 16-bit field
2733 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002734 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002735 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002736 * Note: When updating the format, remember to keep
2737 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002738 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002739 * // In this version, `session_format` determines
2740 * // the setting of those compile-time
2741 * // configuration options which influence
2742 * // the structure of mbedtls_ssl_session.
2743 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002744 * uint8_t minor_ver; // Protocol minor version. Possible values:
2745 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002746 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002747 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002748 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002749 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002750 * serialized_session_tls12 data;
2751 *
2752 * };
2753 *
2754 * } serialized_session;
2755 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002756 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002757
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002758static int ssl_session_save( const mbedtls_ssl_session *session,
2759 unsigned char omit_header,
2760 unsigned char *buf,
2761 size_t buf_len,
2762 size_t *olen )
2763{
2764 unsigned char *p = buf;
2765 size_t used = 0;
2766
2767 if( !omit_header )
2768 {
2769 /*
2770 * Add Mbed TLS version identifier
2771 */
2772
2773 used += sizeof( ssl_serialized_session_header );
2774
2775 if( used <= buf_len )
2776 {
2777 memcpy( p, ssl_serialized_session_header,
2778 sizeof( ssl_serialized_session_header ) );
2779 p += sizeof( ssl_serialized_session_header );
2780 }
2781 }
2782
2783 /*
2784 * TLS version identifier
2785 */
2786 used += 1;
2787 if( used <= buf_len )
2788 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002789 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002790 }
2791
2792 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002793 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002794 {
2795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002796 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002797 {
2798 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2799 used += ssl_session_save_tls12( session, p, remaining_len );
2800 break;
2801 }
2802#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2803
2804 default:
2805 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2806 }
2807
2808 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002809 if( used > buf_len )
2810 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002811
2812 return( 0 );
2813}
2814
2815/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002816 * Public wrapper for ssl_session_save()
2817 */
2818int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2819 unsigned char *buf,
2820 size_t buf_len,
2821 size_t *olen )
2822{
2823 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2824}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002825
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002826/*
2827 * Deserialize session, see mbedtls_ssl_session_save() for format.
2828 *
2829 * This internal version is wrapped by a public function that cleans up in
2830 * case of error, and has an extra option omit_header.
2831 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002832static int ssl_session_load( mbedtls_ssl_session *session,
2833 unsigned char omit_header,
2834 const unsigned char *buf,
2835 size_t len )
2836{
2837 const unsigned char *p = buf;
2838 const unsigned char * const end = buf + len;
2839
2840 if( !omit_header )
2841 {
2842 /*
2843 * Check Mbed TLS version identifier
2844 */
2845
2846 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2847 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2848
2849 if( memcmp( p, ssl_serialized_session_header,
2850 sizeof( ssl_serialized_session_header ) ) != 0 )
2851 {
2852 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2853 }
2854 p += sizeof( ssl_serialized_session_header );
2855 }
2856
2857 /*
2858 * TLS version identifier
2859 */
2860 if( 1 > (size_t)( end - p ) )
2861 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002862 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002863
2864 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002865 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002866 {
2867#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002868 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002869 {
2870 size_t remaining_len = ( end - p );
2871 return( ssl_session_load_tls12( session, p, remaining_len ) );
2872 }
2873#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2874
2875 default:
2876 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2877 }
2878}
2879
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002880/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002881 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002882 */
2883int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2884 const unsigned char *buf,
2885 size_t len )
2886{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002887 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002888
2889 if( ret != 0 )
2890 mbedtls_ssl_session_free( session );
2891
2892 return( ret );
2893}
2894
2895/*
Paul Bakker1961b702013-01-25 14:49:24 +01002896 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002897 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002898static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2899{
2900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2901
Ronald Cron66dbf912022-02-02 15:33:46 +01002902 /*
2903 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002904 * that were written into the output buffer by the previous handshake step,
2905 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002906 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2907 * We proceed to the next handshake step only when all data from the
2908 * previous one have been sent to the peer, thus we make sure that this is
2909 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2910 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2911 * we have to wait before to go ahead.
2912 * In the case of TLS 1.3, handshake step handlers do not send data to the
2913 * peer. Data are only sent here and through
2914 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002915 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002916 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002917 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2918 return( ret );
2919
2920#if defined(MBEDTLS_SSL_PROTO_DTLS)
2921 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2922 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2923 {
2924 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2925 return( ret );
2926 }
2927#endif /* MBEDTLS_SSL_PROTO_DTLS */
2928
2929 return( ret );
2930}
2931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002933{
Hanno Becker41934dd2021-08-07 19:13:43 +01002934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002935
Hanno Becker41934dd2021-08-07 19:13:43 +01002936 if( ssl == NULL ||
2937 ssl->conf == NULL ||
2938 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002939 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002940 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002941 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002942 }
2943
2944 ret = ssl_prepare_handshake_step( ssl );
2945 if( ret != 0 )
2946 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002947
Jerry Yue7047812021-09-13 19:26:39 +08002948 ret = mbedtls_ssl_handle_pending_alert( ssl );
2949 if( ret != 0 )
2950 goto cleanup;
2951
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002953 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002954 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2956 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002957
Ronald Cron9f0fba32022-02-10 16:45:15 +01002958 switch( ssl->state )
2959 {
2960 case MBEDTLS_SSL_HELLO_REQUEST:
2961 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2962 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002963
Ronald Cron9f0fba32022-02-10 16:45:15 +01002964 case MBEDTLS_SSL_CLIENT_HELLO:
2965 ret = mbedtls_ssl_write_client_hello( ssl );
2966 break;
2967
2968 default:
2969#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002970 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002971 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2972 else
2973 ret = mbedtls_ssl_handshake_client_step( ssl );
2974#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2975 ret = mbedtls_ssl_handshake_client_step( ssl );
2976#else
2977 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2978#endif
2979 }
Jerry Yub9930e72021-08-06 17:11:51 +08002980 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002981#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002983 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002984 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002985#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002986 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002987 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002988#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002989
2990#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2991 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2992 ret = mbedtls_ssl_handshake_server_step( ssl );
2993#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2994 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002995#endif
2996
Jerry Yue7047812021-09-13 19:26:39 +08002997 if( ret != 0 )
2998 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002999 /* handshake_step return error. And it is same
3000 * with alert_reason.
3001 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003002 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003003 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003004 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003005 goto cleanup;
3006 }
3007 }
3008
3009cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003010 return( ret );
3011}
3012
3013/*
3014 * Perform the SSL handshake
3015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003017{
3018 int ret = 0;
3019
Hanno Beckera817ea42020-10-20 15:20:23 +01003020 /* Sanity checks */
3021
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003022 if( ssl == NULL || ssl->conf == NULL )
3023 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3024
Hanno Beckera817ea42020-10-20 15:20:23 +01003025#if defined(MBEDTLS_SSL_PROTO_DTLS)
3026 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3027 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3028 {
3029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3030 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3031 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3032 }
3033#endif /* MBEDTLS_SSL_PROTO_DTLS */
3034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003036
Hanno Beckera817ea42020-10-20 15:20:23 +01003037 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003038 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003039 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003041
3042 if( ret != 0 )
3043 break;
3044 }
3045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003047
3048 return( ret );
3049}
3050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#if defined(MBEDTLS_SSL_RENEGOTIATION)
3052#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003053/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003054 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003057{
Janos Follath865b3eb2019-12-16 11:46:15 +00003058 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003061
3062 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3064 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003065
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003066 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003067 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003068 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003069 return( ret );
3070 }
3071
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003073
3074 return( 0 );
3075}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003077
3078/*
3079 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 * - any side: calling mbedtls_ssl_renegotiate(),
3081 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3082 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003083 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003084 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003086 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003087int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003088{
Janos Follath865b3eb2019-12-16 11:46:15 +00003089 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003092
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003093 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3094 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003095
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003096 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3097 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003099 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003101 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003102 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003103 ssl->handshake->out_msg_seq = 1;
3104 else
3105 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003106 }
3107#endif
3108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3110 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003113 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003115 return( ret );
3116 }
3117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003119
3120 return( 0 );
3121}
3122
3123/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003124 * Renegotiate current connection on client,
3125 * or request renegotiation on server
3126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003128{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003130
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003131 if( ssl == NULL || ssl->conf == NULL )
3132 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003135 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003136 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003137 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003138 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003141 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003142
3143 /* Did we already try/start sending HelloRequest? */
3144 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003146
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003147 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003148 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003152 /*
3153 * On client, either start the renegotiation process or,
3154 * if already in progress, continue the handshake
3155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003157 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003158 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003160
Hanno Becker40cdaa12020-02-05 10:48:27 +00003161 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003162 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003163 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003164 return( ret );
3165 }
3166 }
3167 else
3168 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003172 return( ret );
3173 }
3174 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003176
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003177 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003178}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003180
Gilles Peskine9b562d52018-04-25 20:32:43 +02003181void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003182{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003183 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3184
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003185 if( handshake == NULL )
3186 return;
3187
Brett Warrene0edc842021-08-17 09:53:13 +01003188#if defined(MBEDTLS_ECP_C)
3189#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3190 if ( ssl->handshake->group_list_heap_allocated )
3191 mbedtls_free( (void*) handshake->group_list );
3192 handshake->group_list = NULL;
3193#endif /* MBEDTLS_DEPRECATED_REMOVED */
3194#endif /* MBEDTLS_ECP_C */
3195
Jerry Yuf017ee42022-01-12 15:49:48 +08003196#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3197#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3198 if ( ssl->handshake->sig_algs_heap_allocated )
3199 mbedtls_free( (void*) handshake->sig_algs );
3200 handshake->sig_algs = NULL;
3201#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003202#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3203 if( ssl->handshake->certificate_request_context )
3204 {
3205 mbedtls_free( (void*) handshake->certificate_request_context );
3206 }
3207#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003208#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3209
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003210#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3211 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3212 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003213 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003214 handshake->async_in_progress = 0;
3215 }
3216#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3217
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003218#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003219#if defined(MBEDTLS_USE_PSA_CRYPTO)
3220 psa_hash_abort( &handshake->fin_sha256_psa );
3221#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003222 mbedtls_sha256_free( &handshake->fin_sha256 );
3223#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003224#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003225#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003226#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003227 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003228#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003229 mbedtls_sha512_free( &handshake->fin_sha512 );
3230#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003231#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233#if defined(MBEDTLS_DHM_C)
3234 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003235#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003236#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003238#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003239#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003240 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003241#if defined(MBEDTLS_SSL_CLI_C)
3242 mbedtls_free( handshake->ecjpake_cache );
3243 handshake->ecjpake_cache = NULL;
3244 handshake->ecjpake_cache_len = 0;
3245#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003246#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003247
Janos Follath4ae5c292016-02-10 11:27:43 +00003248#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3249 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003250 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003251 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003252#endif
3253
Gilles Peskineeccd8882020-03-10 12:19:08 +01003254#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003255#if defined(MBEDTLS_USE_PSA_CRYPTO)
3256 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3257 {
3258 /* The maintenance of the external PSK key slot is the
3259 * user's responsibility. */
3260 if( ssl->handshake->psk_opaque_is_internal )
3261 {
3262 psa_destroy_key( ssl->handshake->psk_opaque );
3263 ssl->handshake->psk_opaque_is_internal = 0;
3264 }
3265 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3266 }
Neil Armstronge952a302022-05-03 10:22:14 +02003267#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003268 if( handshake->psk != NULL )
3269 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003270 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003271 mbedtls_free( handshake->psk );
3272 }
Neil Armstronge952a302022-05-03 10:22:14 +02003273#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003274#endif
3275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003276#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3277 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003278 /*
3279 * Free only the linked list wrapper, not the keys themselves
3280 * since the belong to the SNI callback
3281 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003282 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003283#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003284
Gilles Peskineeccd8882020-03-10 12:19:08 +01003285#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003286 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003287 if( handshake->ecrs_peer_cert != NULL )
3288 {
3289 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3290 mbedtls_free( handshake->ecrs_peer_cert );
3291 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003292#endif
3293
Hanno Becker75173122019-02-06 16:18:31 +00003294#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3295 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3296 mbedtls_pk_free( &handshake->peer_pubkey );
3297#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3298
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003299#if defined(MBEDTLS_SSL_CLI_C) && \
3300 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3301 mbedtls_free( handshake->cookie );
3302#endif /* MBEDTLS_SSL_CLI_C &&
3303 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003304
3305#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003306 mbedtls_ssl_flight_free( handshake->flight );
3307 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003308#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003309
Ronald Cronf12b81d2022-03-15 10:42:41 +01003310#if defined(MBEDTLS_ECDH_C) && \
3311 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003312 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003313 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003314#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3315
Ronald Cron6f135e12021-12-08 16:57:54 +01003316#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003317 mbedtls_ssl_transform_free( handshake->transform_handshake );
3318 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003319 mbedtls_free( handshake->transform_earlydata );
3320 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003321#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003322
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003323
3324#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3325 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3326 * processes datagrams and the fact that a datagram is allowed to have
3327 * several records in it, it is possible that the I/O buffers are not
3328 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003329 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3330 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003331#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003332
Jerry Yuba9c7272021-10-30 11:54:10 +08003333 /* mbedtls_platform_zeroize MUST be last one in this function */
3334 mbedtls_platform_zeroize( handshake,
3335 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003336}
3337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003339{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003340 if( session == NULL )
3341 return;
3342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003344 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003345#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003346
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003347#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003349#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003350
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003351 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003352}
3353
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003354#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003355
3356#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3357#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3358#else
3359#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3360#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3361
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003362#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003363
3364#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3365#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3366#else
3367#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3368#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3369
3370#if defined(MBEDTLS_SSL_ALPN)
3371#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3372#else
3373#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3374#endif /* MBEDTLS_SSL_ALPN */
3375
3376#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3377#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3378#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3379#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3380
3381#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3382 ( (uint32_t) ( \
3383 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3384 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3385 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3386 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3387 0u ) )
3388
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003389static unsigned char ssl_serialized_context_header[] = {
3390 MBEDTLS_VERSION_MAJOR,
3391 MBEDTLS_VERSION_MINOR,
3392 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003393 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3394 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3395 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3396 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3397 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003398};
3399
Paul Bakker5121ce52009-01-03 21:22:43 +00003400/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003401 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003402 *
3403 * The format of the serialized data is:
3404 * (in the presentation language of TLS, RFC 8446 section 3)
3405 *
3406 * // header
3407 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003408 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003409 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003410 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003411 * Note: When updating the format, remember to keep these
3412 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003413 *
3414 * // session sub-structure
3415 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3416 * // transform sub-structure
3417 * uint8 random[64]; // ServerHello.random+ClientHello.random
3418 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3419 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3420 * // fields from ssl_context
3421 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3422 * uint64 in_window_top; // DTLS: last validated record seq_num
3423 * uint64 in_window; // DTLS: bitmask for replay protection
3424 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3425 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3426 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3427 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3428 *
3429 * Note that many fields of the ssl_context or sub-structures are not
3430 * serialized, as they fall in one of the following categories:
3431 *
3432 * 1. forced value (eg in_left must be 0)
3433 * 2. pointer to dynamically-allocated memory (eg session, transform)
3434 * 3. value can be re-derived from other data (eg session keys from MS)
3435 * 4. value was temporary (eg content of input buffer)
3436 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003437 */
3438int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3439 unsigned char *buf,
3440 size_t buf_len,
3441 size_t *olen )
3442{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003443 unsigned char *p = buf;
3444 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003445 size_t session_len;
3446 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003447
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003448 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003449 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3450 * this function's documentation.
3451 *
3452 * These are due to assumptions/limitations in the implementation. Some of
3453 * them are likely to stay (no handshake in progress) some might go away
3454 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003455 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003456 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003457 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003458 {
3459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003460 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003461 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003462 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003463 {
3464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003465 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003466 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003467 /* Double-check that sub-structures are indeed ready */
3468 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003469 {
3470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003471 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003472 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003473 /* There must be no pending incoming or outgoing data */
3474 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003475 {
3476 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003477 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003478 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003479 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003480 {
3481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003482 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003483 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003484 /* Protocol must be DLTS, not TLS */
3485 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003486 {
3487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003488 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003489 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003490 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003491 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003492 {
3493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003494 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003495 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003496 /* We must be using an AEAD ciphersuite */
3497 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003498 {
3499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003500 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003501 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003502 /* Renegotiation must not be enabled */
3503#if defined(MBEDTLS_SSL_RENEGOTIATION)
3504 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003505 {
3506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003507 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003508 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003509#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003510
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003511 /*
3512 * Version and format identifier
3513 */
3514 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003515
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003516 if( used <= buf_len )
3517 {
3518 memcpy( p, ssl_serialized_context_header,
3519 sizeof( ssl_serialized_context_header ) );
3520 p += sizeof( ssl_serialized_context_header );
3521 }
3522
3523 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003524 * Session (length + data)
3525 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003526 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003527 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3528 return( ret );
3529
3530 used += 4 + session_len;
3531 if( used <= buf_len )
3532 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003533 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3534 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003535
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003536 ret = ssl_session_save( ssl->session, 1,
3537 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003538 if( ret != 0 )
3539 return( ret );
3540
3541 p += session_len;
3542 }
3543
3544 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003545 * Transform
3546 */
3547 used += sizeof( ssl->transform->randbytes );
3548 if( used <= buf_len )
3549 {
3550 memcpy( p, ssl->transform->randbytes,
3551 sizeof( ssl->transform->randbytes ) );
3552 p += sizeof( ssl->transform->randbytes );
3553 }
3554
3555#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3556 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3557 if( used <= buf_len )
3558 {
3559 *p++ = ssl->transform->in_cid_len;
3560 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3561 p += ssl->transform->in_cid_len;
3562
3563 *p++ = ssl->transform->out_cid_len;
3564 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3565 p += ssl->transform->out_cid_len;
3566 }
3567#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3568
3569 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003570 * Saved fields from top-level ssl_context structure
3571 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003572 used += 4;
3573 if( used <= buf_len )
3574 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003575 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3576 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003577 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003578
3579#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3580 used += 16;
3581 if( used <= buf_len )
3582 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003583 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3584 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003585
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003586 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3587 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003588 }
3589#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3590
3591#if defined(MBEDTLS_SSL_PROTO_DTLS)
3592 used += 1;
3593 if( used <= buf_len )
3594 {
3595 *p++ = ssl->disable_datagram_packing;
3596 }
3597#endif /* MBEDTLS_SSL_PROTO_DTLS */
3598
Jerry Yuae0b2e22021-10-08 15:21:19 +08003599 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003600 if( used <= buf_len )
3601 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003602 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3603 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003604 }
3605
3606#if defined(MBEDTLS_SSL_PROTO_DTLS)
3607 used += 2;
3608 if( used <= buf_len )
3609 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003610 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3611 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003612 }
3613#endif /* MBEDTLS_SSL_PROTO_DTLS */
3614
3615#if defined(MBEDTLS_SSL_ALPN)
3616 {
3617 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003618 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003619 : 0;
3620
3621 used += 1 + alpn_len;
3622 if( used <= buf_len )
3623 {
3624 *p++ = alpn_len;
3625
3626 if( ssl->alpn_chosen != NULL )
3627 {
3628 memcpy( p, ssl->alpn_chosen, alpn_len );
3629 p += alpn_len;
3630 }
3631 }
3632 }
3633#endif /* MBEDTLS_SSL_ALPN */
3634
3635 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003636 * Done
3637 */
3638 *olen = used;
3639
3640 if( used > buf_len )
3641 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003642
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003643 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3644
Hanno Becker43aefe22020-02-05 10:44:56 +00003645 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003646}
3647
3648/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003649 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003650 *
3651 * This internal version is wrapped by a public function that cleans up in
3652 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003653 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003654static int ssl_context_load( mbedtls_ssl_context *ssl,
3655 const unsigned char *buf,
3656 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003657{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003658 const unsigned char *p = buf;
3659 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003660 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003662
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003663 /*
3664 * The context should have been freshly setup or reset.
3665 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003666 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003667 * renegotiating, or if the user mistakenly loaded a session first.)
3668 */
3669 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3670 ssl->session != NULL )
3671 {
3672 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3673 }
3674
3675 /*
3676 * We can't check that the config matches the initial one, but we can at
3677 * least check it matches the requirements for serializing.
3678 */
3679 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003680 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3681 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003682#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003683 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003684#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003685 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003686 {
3687 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3688 }
3689
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003690 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3691
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003692 /*
3693 * Check version identifier
3694 */
3695 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3697
3698 if( memcmp( p, ssl_serialized_context_header,
3699 sizeof( ssl_serialized_context_header ) ) != 0 )
3700 {
3701 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3702 }
3703 p += sizeof( ssl_serialized_context_header );
3704
3705 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003706 * Session
3707 */
3708 if( (size_t)( end - p ) < 4 )
3709 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3710
3711 session_len = ( (size_t) p[0] << 24 ) |
3712 ( (size_t) p[1] << 16 ) |
3713 ( (size_t) p[2] << 8 ) |
3714 ( (size_t) p[3] );
3715 p += 4;
3716
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003717 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003718 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003719 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003720 ssl->session_in = ssl->session;
3721 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003722 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003723
3724 if( (size_t)( end - p ) < session_len )
3725 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3726
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003727 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003728 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003729 {
3730 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003731 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003732 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003733
3734 p += session_len;
3735
3736 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003737 * Transform
3738 */
3739
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003740 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003741 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003742 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003743 ssl->transform_in = ssl->transform;
3744 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003745 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003746
3747 /* Read random bytes and populate structure */
3748 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3749 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003751 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003752 ssl->session->ciphersuite,
3753 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003754#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003755 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003756#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003757 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3758 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003759 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003760 ssl->conf->endpoint,
3761 ssl );
3762 if( ret != 0 )
3763 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003764#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003765 p += sizeof( ssl->transform->randbytes );
3766
3767#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3768 /* Read connection IDs and store them */
3769 if( (size_t)( end - p ) < 1 )
3770 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3771
3772 ssl->transform->in_cid_len = *p++;
3773
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003774 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003775 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3776
3777 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3778 p += ssl->transform->in_cid_len;
3779
3780 ssl->transform->out_cid_len = *p++;
3781
3782 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3783 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3784
3785 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3786 p += ssl->transform->out_cid_len;
3787#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3788
3789 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003790 * Saved fields from top-level ssl_context structure
3791 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003792 if( (size_t)( end - p ) < 4 )
3793 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3794
3795 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3796 ( (uint32_t) p[1] << 16 ) |
3797 ( (uint32_t) p[2] << 8 ) |
3798 ( (uint32_t) p[3] );
3799 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003800
3801#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3802 if( (size_t)( end - p ) < 16 )
3803 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3804
3805 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3806 ( (uint64_t) p[1] << 48 ) |
3807 ( (uint64_t) p[2] << 40 ) |
3808 ( (uint64_t) p[3] << 32 ) |
3809 ( (uint64_t) p[4] << 24 ) |
3810 ( (uint64_t) p[5] << 16 ) |
3811 ( (uint64_t) p[6] << 8 ) |
3812 ( (uint64_t) p[7] );
3813 p += 8;
3814
3815 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3816 ( (uint64_t) p[1] << 48 ) |
3817 ( (uint64_t) p[2] << 40 ) |
3818 ( (uint64_t) p[3] << 32 ) |
3819 ( (uint64_t) p[4] << 24 ) |
3820 ( (uint64_t) p[5] << 16 ) |
3821 ( (uint64_t) p[6] << 8 ) |
3822 ( (uint64_t) p[7] );
3823 p += 8;
3824#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3825
3826#if defined(MBEDTLS_SSL_PROTO_DTLS)
3827 if( (size_t)( end - p ) < 1 )
3828 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3829
3830 ssl->disable_datagram_packing = *p++;
3831#endif /* MBEDTLS_SSL_PROTO_DTLS */
3832
Jerry Yud9a94fe2021-09-28 18:58:59 +08003833 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003834 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003835 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3836 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003837
3838#if defined(MBEDTLS_SSL_PROTO_DTLS)
3839 if( (size_t)( end - p ) < 2 )
3840 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3841
3842 ssl->mtu = ( p[0] << 8 ) | p[1];
3843 p += 2;
3844#endif /* MBEDTLS_SSL_PROTO_DTLS */
3845
3846#if defined(MBEDTLS_SSL_ALPN)
3847 {
3848 uint8_t alpn_len;
3849 const char **cur;
3850
3851 if( (size_t)( end - p ) < 1 )
3852 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3853
3854 alpn_len = *p++;
3855
3856 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3857 {
3858 /* alpn_chosen should point to an item in the configured list */
3859 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3860 {
3861 if( strlen( *cur ) == alpn_len &&
3862 memcmp( p, cur, alpn_len ) == 0 )
3863 {
3864 ssl->alpn_chosen = *cur;
3865 break;
3866 }
3867 }
3868 }
3869
3870 /* can only happen on conf mismatch */
3871 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3872 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3873
3874 p += alpn_len;
3875 }
3876#endif /* MBEDTLS_SSL_ALPN */
3877
3878 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003879 * Forced fields from top-level ssl_context structure
3880 *
3881 * Most of them already set to the correct value by mbedtls_ssl_init() and
3882 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3883 */
3884 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003885 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003886
Hanno Becker361b10d2019-08-30 10:42:49 +01003887 /* Adjust pointers for header fields of outgoing records to
3888 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003889 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003890
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003891#if defined(MBEDTLS_SSL_PROTO_DTLS)
3892 ssl->in_epoch = 1;
3893#endif
3894
3895 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3896 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003897 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3898 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003899 if( ssl->handshake != NULL )
3900 {
3901 mbedtls_ssl_handshake_free( ssl );
3902 mbedtls_free( ssl->handshake );
3903 ssl->handshake = NULL;
3904 }
3905
3906 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003907 * Done - should have consumed entire buffer
3908 */
3909 if( p != end )
3910 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003911
3912 return( 0 );
3913}
3914
3915/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003916 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003917 */
3918int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3919 const unsigned char *buf,
3920 size_t len )
3921{
3922 int ret = ssl_context_load( context, buf, len );
3923
3924 if( ret != 0 )
3925 mbedtls_ssl_free( context );
3926
3927 return( ret );
3928}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003929#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003930
3931/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003932 * Free an SSL context
3933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003934void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003935{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003936 if( ssl == NULL )
3937 return;
3938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003940
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003941 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003942 {
sander-visserb8aa2072020-05-06 22:05:13 +02003943#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3944 size_t out_buf_len = ssl->out_buf_len;
3945#else
3946 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3947#endif
3948
Darryl Greenb33cc762019-11-28 14:29:44 +00003949 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003950 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003951 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003952 }
3953
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003954 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003955 {
sander-visserb8aa2072020-05-06 22:05:13 +02003956#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3957 size_t in_buf_len = ssl->in_buf_len;
3958#else
3959 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3960#endif
3961
Darryl Greenb33cc762019-11-28 14:29:44 +00003962 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003963 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003964 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003965 }
3966
Paul Bakker48916f92012-09-16 19:57:18 +00003967 if( ssl->transform )
3968 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003969 mbedtls_ssl_transform_free( ssl->transform );
3970 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003971 }
3972
3973 if( ssl->handshake )
3974 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003975 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003976 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3977 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003979 mbedtls_free( ssl->handshake );
3980 mbedtls_free( ssl->transform_negotiate );
3981 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003982 }
3983
Ronald Cron6f135e12021-12-08 16:57:54 +01003984#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003985 mbedtls_ssl_transform_free( ssl->transform_application );
3986 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003987#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003988
Paul Bakkerc0463502013-02-14 11:19:38 +01003989 if( ssl->session )
3990 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003991 mbedtls_ssl_session_free( ssl->session );
3992 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003993 }
3994
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003995#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003996 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003997 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003998 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004000 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004001#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004002
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004003#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004004 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004005#endif
4006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004008
Paul Bakker86f04f42013-02-14 11:20:09 +01004009 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004010 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004011}
4012
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004013/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004014 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004015 */
4016void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4017{
4018 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4019}
4020
Gilles Peskineae270bf2021-06-02 00:05:29 +02004021/* The selection should be the same as mbedtls_x509_crt_profile_default in
4022 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004023 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004024 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004025 * about this list.
4026 */
Brett Warrene0edc842021-08-17 09:53:13 +01004027static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004028#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004029 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004030#endif
4031#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004032 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004033#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004034#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004035 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004036#endif
4037#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004038 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004039#endif
4040#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004041 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004042#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004043#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004044 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004045#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004046#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004047 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004048#endif
4049#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004050 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004051#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004052 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004053};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004054
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004055static int ssl_preset_suiteb_ciphersuites[] = {
4056 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4057 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4058 0
4059};
4060
Gilles Peskineeccd8882020-03-10 12:19:08 +01004061#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004062
Jerry Yu909df7b2022-01-22 11:56:27 +08004063/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004064 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004065 * rules SHOULD be upheld.
4066 * - No duplicate entries.
4067 * - But if there is a good reason, do not change the order of the algorithms.
4068 * - ssl_tls12_present* is for TLS 1.2 use only.
4069 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004070 *
Jerry Yua1255e62022-06-24 10:10:47 +08004071 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4072 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4073 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
Jerry Yucc539102022-06-27 16:27:35 +08004074 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4075 * for its signature in the key exchange message. As Mbed TLS 1.2 does not
Jerry Yua1255e62022-06-24 10:10:47 +08004076 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004077 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004078static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004079
Jerry Yued5e9f42022-01-26 11:21:34 +08004080#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4081 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4082 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4083#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4084 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004085
Jerry Yu909df7b2022-01-22 11:56:27 +08004086#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4087 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4088 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4089#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4090 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4091
Jerry Yued5e9f42022-01-26 11:21:34 +08004092#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4093 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4094 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4095#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4096 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004097
Jerry Yuba5e3792022-06-21 15:26:05 +08004098#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4099 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4100#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4101
4102#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4103 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4104#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4105
4106#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4107 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4108#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4109
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004110#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4111 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4112#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4113
4114#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4115 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4116#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4117
4118#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4119 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4120#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4121
Gabor Mezei15b95a62022-05-09 16:37:58 +02004122 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004123};
4124
4125/* NOTICE: see above */
4126#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4127static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004128#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004129#if defined(MBEDTLS_ECDSA_C)
4130 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004131#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004132#if defined(MBEDTLS_RSA_C)
4133 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4134#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004135#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004136#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004137#if defined(MBEDTLS_ECDSA_C)
4138 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004139#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004140#if defined(MBEDTLS_RSA_C)
4141 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4142#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004143#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004144#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004145#if defined(MBEDTLS_ECDSA_C)
4146 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004147#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004148#if defined(MBEDTLS_RSA_C)
4149 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4150#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004151#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004152 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004153};
4154#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4155/* NOTICE: see above */
4156static uint16_t ssl_preset_suiteb_sig_algs[] = {
4157
Jerry Yu909df7b2022-01-22 11:56:27 +08004158#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4159 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4160 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4161#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4162 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4163
Jerry Yu53037892022-01-25 11:02:06 +08004164#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4165 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4166 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4167#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4168 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004169
4170#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4171 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4172#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004173
Jerry Yu53037892022-01-25 11:02:06 +08004174#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4175 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4176#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4177
Gabor Mezei15b95a62022-05-09 16:37:58 +02004178 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004179};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004180
Jerry Yu909df7b2022-01-22 11:56:27 +08004181/* NOTICE: see above */
4182#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4183static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004184#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004185#if defined(MBEDTLS_ECDSA_C)
4186 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004187#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004188#if defined(MBEDTLS_RSA_C)
4189 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4190#endif
4191#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004192#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004193#if defined(MBEDTLS_ECDSA_C)
4194 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004195#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004196#if defined(MBEDTLS_RSA_C)
4197 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4198#endif
4199#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004200 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004201};
Jerry Yu909df7b2022-01-22 11:56:27 +08004202#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4203
Jerry Yu1a8b4812022-01-20 17:56:50 +08004204#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004205
Brett Warrene0edc842021-08-17 09:53:13 +01004206static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004207#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004208 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004209#endif
4210#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004211 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004212#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004213 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004214};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004215
Jerry Yu1a8b4812022-01-20 17:56:50 +08004216#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004217/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004218 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004219static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004220{
4221 size_t i, j;
4222 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004223
Gabor Mezei15b95a62022-05-09 16:37:58 +02004224 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004225 {
Jerry Yuf377d642022-01-25 10:43:59 +08004226 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004227 {
Jerry Yuf377d642022-01-25 10:43:59 +08004228 if( sig_algs[i] != sig_algs[j] )
4229 continue;
4230 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4231 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4232 sig_algs[i], j, i );
4233 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004234 }
4235 }
4236 return( ret );
4237}
4238
4239#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4240
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004241/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004242 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004243 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004244int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004245 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004246{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004247#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004249#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004250
Jerry Yu1a8b4812022-01-20 17:56:50 +08004251#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004252 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004253 {
4254 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4255 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4256 }
4257
Jerry Yuf377d642022-01-25 10:43:59 +08004258 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004259 {
4260 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4261 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4262 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004263
4264#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004265 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004266 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004267 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004268 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4269 }
4270
Jerry Yuf377d642022-01-25 10:43:59 +08004271 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004272 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004273 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004274 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4275 }
4276#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004277#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4278
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004279 /* Use the functions here so that they are covered in tests,
4280 * but otherwise access member directly for efficiency */
4281 mbedtls_ssl_conf_endpoint( conf, endpoint );
4282 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004283
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004284 /*
4285 * Things that are common to all presets
4286 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004287#if defined(MBEDTLS_SSL_CLI_C)
4288 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4289 {
4290 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4291#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4292 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4293#endif
4294 }
4295#endif
4296
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004297#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4298 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4299#endif
4300
4301#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4302 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4303#endif
4304
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004305#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004306 conf->f_cookie_write = ssl_cookie_write_dummy;
4307 conf->f_cookie_check = ssl_cookie_check_dummy;
4308#endif
4309
4310#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4311 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4312#endif
4313
Janos Follath088ce432017-04-10 12:42:31 +01004314#if defined(MBEDTLS_SSL_SRV_C)
4315 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004316 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004317#endif
4318
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004319#if defined(MBEDTLS_SSL_PROTO_DTLS)
4320 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4321 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4322#endif
4323
4324#if defined(MBEDTLS_SSL_RENEGOTIATION)
4325 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004326 memset( conf->renego_period, 0x00, 2 );
4327 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004328#endif
4329
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004330#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004331 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4332 {
4333 const unsigned char dhm_p[] =
4334 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4335 const unsigned char dhm_g[] =
4336 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004337
Hanno Beckere2defad2021-07-24 05:59:17 +01004338 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4339 dhm_p, sizeof( dhm_p ),
4340 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4341 {
4342 return( ret );
4343 }
4344 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004345#endif
4346
Ronald Cron6f135e12021-12-08 16:57:54 +01004347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004348 /*
4349 * Allow all TLS 1.3 key exchange modes by default.
4350 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004351 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004352#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004353
XiaokangQian4d3a6042022-04-21 13:46:17 +00004354 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4355 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004356#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004357 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004358 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004359#else
XiaokangQian060d8672022-04-21 09:24:56 +00004360 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004361#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004362 }
4363 else
4364 {
4365#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4366 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4367 {
4368 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4369 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4370 }
4371 else
4372 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4373 {
4374 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4375 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4376 }
4377#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4378 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4379 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4380#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4381 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4382 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4383#else
4384 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4385#endif
4386 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004387
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004388 /*
4389 * Preset-specific defaults
4390 */
4391 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004392 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004393 /*
4394 * NSA Suite B
4395 */
4396 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004397
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004398 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004399
4400#if defined(MBEDTLS_X509_CRT_PARSE_C)
4401 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004402#endif
4403
Gilles Peskineeccd8882020-03-10 12:19:08 +01004404#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004405#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4406 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4407 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4408 else
4409#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4410 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004411#endif
4412
Brett Warrene0edc842021-08-17 09:53:13 +01004413#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4414 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004415#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004416 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004417 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004418
4419 /*
4420 * Default
4421 */
4422 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004423
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004424 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004425
4426#if defined(MBEDTLS_X509_CRT_PARSE_C)
4427 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4428#endif
4429
Gilles Peskineeccd8882020-03-10 12:19:08 +01004430#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004431#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4432 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4433 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4434 else
4435#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4436 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004437#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004438
Brett Warrene0edc842021-08-17 09:53:13 +01004439#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4440 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004441#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004442 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004443
4444#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4445 conf->dhm_min_bitlen = 1024;
4446#endif
4447 }
4448
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004449 return( 0 );
4450}
4451
4452/*
4453 * Free mbedtls_ssl_config
4454 */
4455void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4456{
4457#if defined(MBEDTLS_DHM_C)
4458 mbedtls_mpi_free( &conf->dhm_P );
4459 mbedtls_mpi_free( &conf->dhm_G );
4460#endif
4461
Gilles Peskineeccd8882020-03-10 12:19:08 +01004462#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004463#if defined(MBEDTLS_USE_PSA_CRYPTO)
4464 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4465 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004466 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4467 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004468#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004469 if( conf->psk != NULL )
4470 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004471 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004472 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004473 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004474 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004475 }
4476
4477 if( conf->psk_identity != NULL )
4478 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004479 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004480 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004481 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004482 conf->psk_identity_len = 0;
4483 }
4484#endif
4485
4486#if defined(MBEDTLS_X509_CRT_PARSE_C)
4487 ssl_key_cert_free( conf->key_cert );
4488#endif
4489
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004490 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004491}
4492
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004493#if defined(MBEDTLS_PK_C) && \
4494 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004495/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004496 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004498unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004499{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004500#if defined(MBEDTLS_RSA_C)
4501 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4502 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004503#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004504#if defined(MBEDTLS_ECDSA_C)
4505 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4506 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004507#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004508 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004509}
4510
Hanno Becker7e5437a2017-04-28 17:15:26 +01004511unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4512{
4513 switch( type ) {
4514 case MBEDTLS_PK_RSA:
4515 return( MBEDTLS_SSL_SIG_RSA );
4516 case MBEDTLS_PK_ECDSA:
4517 case MBEDTLS_PK_ECKEY:
4518 return( MBEDTLS_SSL_SIG_ECDSA );
4519 default:
4520 return( MBEDTLS_SSL_SIG_ANON );
4521 }
4522}
4523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004524mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004525{
4526 switch( sig )
4527 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004528#if defined(MBEDTLS_RSA_C)
4529 case MBEDTLS_SSL_SIG_RSA:
4530 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004531#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532#if defined(MBEDTLS_ECDSA_C)
4533 case MBEDTLS_SSL_SIG_ECDSA:
4534 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004535#endif
4536 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004538 }
4539}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004540#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004541
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004542/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004543 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004546{
4547 switch( hash )
4548 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549#if defined(MBEDTLS_MD5_C)
4550 case MBEDTLS_SSL_HASH_MD5:
4551 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004552#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553#if defined(MBEDTLS_SHA1_C)
4554 case MBEDTLS_SSL_HASH_SHA1:
4555 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004556#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004557#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004558 case MBEDTLS_SSL_HASH_SHA224:
4559 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004560#endif
4561#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004562 case MBEDTLS_SSL_HASH_SHA256:
4563 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004564#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004565#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004566 case MBEDTLS_SSL_HASH_SHA384:
4567 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004568#endif
4569#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570 case MBEDTLS_SSL_HASH_SHA512:
4571 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004572#endif
4573 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004575 }
4576}
4577
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004578/*
4579 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4580 */
4581unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4582{
4583 switch( md )
4584 {
4585#if defined(MBEDTLS_MD5_C)
4586 case MBEDTLS_MD_MD5:
4587 return( MBEDTLS_SSL_HASH_MD5 );
4588#endif
4589#if defined(MBEDTLS_SHA1_C)
4590 case MBEDTLS_MD_SHA1:
4591 return( MBEDTLS_SSL_HASH_SHA1 );
4592#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004593#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004594 case MBEDTLS_MD_SHA224:
4595 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004596#endif
4597#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004598 case MBEDTLS_MD_SHA256:
4599 return( MBEDTLS_SSL_HASH_SHA256 );
4600#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004601#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004602 case MBEDTLS_MD_SHA384:
4603 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004604#endif
4605#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004606 case MBEDTLS_MD_SHA512:
4607 return( MBEDTLS_SSL_HASH_SHA512 );
4608#endif
4609 default:
4610 return( MBEDTLS_SSL_HASH_NONE );
4611 }
4612}
4613
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004614/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004615 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004616 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004617 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004618int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004619{
Brett Warrene0edc842021-08-17 09:53:13 +01004620 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004621
Brett Warrene0edc842021-08-17 09:53:13 +01004622 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004623 return( -1 );
4624
Brett Warrene0edc842021-08-17 09:53:13 +01004625 for( ; *group_list != 0; group_list++ )
4626 {
4627 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004628 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004629 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004630
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004631 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004632}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004633
4634#if defined(MBEDTLS_ECP_C)
4635/*
4636 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4637 */
4638int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4639{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004640 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004641 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4642}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004643#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645#if defined(MBEDTLS_X509_CRT_PARSE_C)
4646int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4647 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004648 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004649 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004650{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004651 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004652 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004653 const char *ext_oid;
4654 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004655
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004656 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004657 {
4658 /* Server part of the key exchange */
4659 switch( ciphersuite->key_exchange )
4660 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 case MBEDTLS_KEY_EXCHANGE_RSA:
4662 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004663 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004664 break;
4665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4667 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4668 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4669 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004670 break;
4671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004672 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4673 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004674 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004675 break;
4676
4677 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678 case MBEDTLS_KEY_EXCHANGE_NONE:
4679 case MBEDTLS_KEY_EXCHANGE_PSK:
4680 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4681 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004682 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004683 usage = 0;
4684 }
4685 }
4686 else
4687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4689 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004690 }
4691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004692 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004693 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004694 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004695 ret = -1;
4696 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004698 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004699 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4701 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004702 }
4703 else
4704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4706 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004707 }
4708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004710 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004711 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004712 ret = -1;
4713 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004714
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004715 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004716}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004718
Jerry Yu148165c2021-09-24 23:20:59 +08004719#if defined(MBEDTLS_USE_PSA_CRYPTO)
4720int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4721 const mbedtls_md_type_t md,
4722 unsigned char *dst,
4723 size_t dst_len,
4724 size_t *olen )
4725{
Ronald Cronf6893e12022-01-07 22:09:01 +01004726 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4727 psa_hash_operation_t *hash_operation_to_clone;
4728 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4729
Jerry Yu148165c2021-09-24 23:20:59 +08004730 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004731
4732 switch( md )
4733 {
4734#if defined(MBEDTLS_SHA384_C)
4735 case MBEDTLS_MD_SHA384:
4736 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4737 break;
4738#endif
4739
4740#if defined(MBEDTLS_SHA256_C)
4741 case MBEDTLS_MD_SHA256:
4742 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4743 break;
4744#endif
4745
4746 default:
4747 goto exit;
4748 }
4749
4750 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4751 if( status != PSA_SUCCESS )
4752 goto exit;
4753
4754 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4755 if( status != PSA_SUCCESS )
4756 goto exit;
4757
4758exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004759 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004760}
4761#else /* MBEDTLS_USE_PSA_CRYPTO */
4762
Jerry Yu24c0ec32021-09-09 14:21:07 +08004763#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004764static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4765 unsigned char *dst,
4766 size_t dst_len,
4767 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004768{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004769 int ret;
4770 mbedtls_sha512_context sha512;
4771
4772 if( dst_len < 48 )
4773 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4774
4775 mbedtls_sha512_init( &sha512 );
4776 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4777
4778 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4779 {
4780 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4781 goto exit;
4782 }
4783
4784 *olen = 48;
4785
4786exit:
4787
4788 mbedtls_sha512_free( &sha512 );
4789 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004790}
4791#endif /* MBEDTLS_SHA384_C */
4792
4793#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004794static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4795 unsigned char *dst,
4796 size_t dst_len,
4797 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004798{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004799 int ret;
4800 mbedtls_sha256_context sha256;
4801
4802 if( dst_len < 32 )
4803 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4804
4805 mbedtls_sha256_init( &sha256 );
4806 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004807
Jerry Yu24c0ec32021-09-09 14:21:07 +08004808 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4809 {
4810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4811 goto exit;
4812 }
4813
4814 *olen = 32;
4815
4816exit:
4817
4818 mbedtls_sha256_free( &sha256 );
4819 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004820}
4821#endif /* MBEDTLS_SHA256_C */
4822
Jerry Yu000f9762021-09-14 11:12:51 +08004823int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4824 const mbedtls_md_type_t md,
4825 unsigned char *dst,
4826 size_t dst_len,
4827 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004828{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004829 switch( md )
4830 {
4831
Jerry Yu24c0ec32021-09-09 14:21:07 +08004832#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004833 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004834 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004835#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004836
Jerry Yu24c0ec32021-09-09 14:21:07 +08004837#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004838 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004839 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004840#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004841
4842 default:
4843 break;
4844 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004845 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004846}
XiaokangQian647719a2021-12-07 09:16:29 +00004847
Jerry Yu148165c2021-09-24 23:20:59 +08004848#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004849
Gabor Mezei078e8032022-04-27 21:17:56 +02004850#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4851/* mbedtls_ssl_parse_sig_alg_ext()
4852 *
4853 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4854 * value (TLS 1.3 RFC8446):
4855 * enum {
4856 * ....
4857 * ecdsa_secp256r1_sha256( 0x0403 ),
4858 * ecdsa_secp384r1_sha384( 0x0503 ),
4859 * ecdsa_secp521r1_sha512( 0x0603 ),
4860 * ....
4861 * } SignatureScheme;
4862 *
4863 * struct {
4864 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4865 * } SignatureSchemeList;
4866 *
4867 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4868 * value (TLS 1.2 RFC5246):
4869 * enum {
4870 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4871 * sha512(6), (255)
4872 * } HashAlgorithm;
4873 *
4874 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4875 * SignatureAlgorithm;
4876 *
4877 * struct {
4878 * HashAlgorithm hash;
4879 * SignatureAlgorithm signature;
4880 * } SignatureAndHashAlgorithm;
4881 *
4882 * SignatureAndHashAlgorithm
4883 * supported_signature_algorithms<2..2^16-2>;
4884 *
4885 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4886 * generalization of the TLS 1.2 signature algorithm extension.
4887 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4888 * `SignatureScheme` field of TLS 1.3
4889 *
4890 */
4891int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4892 const unsigned char *buf,
4893 const unsigned char *end )
4894{
4895 const unsigned char *p = buf;
4896 size_t supported_sig_algs_len = 0;
4897 const unsigned char *supported_sig_algs_end;
4898 uint16_t sig_alg;
4899 uint32_t common_idx = 0;
4900
4901 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4902 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4903 p += 2;
4904
4905 memset( ssl->handshake->received_sig_algs, 0,
4906 sizeof(ssl->handshake->received_sig_algs) );
4907
4908 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4909 supported_sig_algs_end = p + supported_sig_algs_len;
4910 while( p < supported_sig_algs_end )
4911 {
4912 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4913 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4914 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004915 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4916 sig_alg,
4917 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02004918
Jerry Yu660cb422022-06-28 16:17:58 +08004919 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) )
Gabor Mezei078e8032022-04-27 21:17:56 +02004920 continue;
4921
Jerry Yuf3b46b52022-06-19 16:52:27 +08004922 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
4923 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
4924
Gabor Mezei078e8032022-04-27 21:17:56 +02004925 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4926 {
4927 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4928 common_idx += 1;
4929 }
4930 }
4931 /* Check that we consumed all the message. */
4932 if( p != end )
4933 {
4934 MBEDTLS_SSL_DEBUG_MSG( 1,
4935 ( "Signature algorithms extension length misaligned" ) );
4936 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4937 MBEDTLS_ERR_SSL_DECODE_ERROR );
4938 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4939 }
4940
4941 if( common_idx == 0 )
4942 {
4943 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
4944 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
4945 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4946 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4947 }
4948
Gabor Mezei15b95a62022-05-09 16:37:58 +02004949 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02004950 return( 0 );
4951}
4952
4953#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4954
Jerry Yudc7bd172022-02-17 13:44:15 +08004955#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4956
4957#if defined(MBEDTLS_USE_PSA_CRYPTO)
4958
4959static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4960 mbedtls_svc_key_id_t key,
4961 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004962 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004963 const unsigned char* seed, size_t seed_length,
4964 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004965 const unsigned char* other_secret,
4966 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004967 size_t capacity )
4968{
4969 psa_status_t status;
4970
4971 status = psa_key_derivation_setup( derivation, alg );
4972 if( status != PSA_SUCCESS )
4973 return( status );
4974
4975 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4976 {
4977 status = psa_key_derivation_input_bytes( derivation,
4978 PSA_KEY_DERIVATION_INPUT_SEED,
4979 seed, seed_length );
4980 if( status != PSA_SUCCESS )
4981 return( status );
4982
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004983 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02004984 {
4985 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004986 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
4987 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02004988 if( status != PSA_SUCCESS )
4989 return( status );
4990 }
4991
Jerry Yudc7bd172022-02-17 13:44:15 +08004992 if( mbedtls_svc_key_id_is_null( key ) )
4993 {
4994 status = psa_key_derivation_input_bytes(
4995 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004996 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08004997 }
4998 else
4999 {
5000 status = psa_key_derivation_input_key(
5001 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5002 }
5003 if( status != PSA_SUCCESS )
5004 return( status );
5005
5006 status = psa_key_derivation_input_bytes( derivation,
5007 PSA_KEY_DERIVATION_INPUT_LABEL,
5008 label, label_length );
5009 if( status != PSA_SUCCESS )
5010 return( status );
5011 }
5012 else
5013 {
5014 return( PSA_ERROR_NOT_SUPPORTED );
5015 }
5016
5017 status = psa_key_derivation_set_capacity( derivation, capacity );
5018 if( status != PSA_SUCCESS )
5019 return( status );
5020
5021 return( PSA_SUCCESS );
5022}
5023
5024static int tls_prf_generic( mbedtls_md_type_t md_type,
5025 const unsigned char *secret, size_t slen,
5026 const char *label,
5027 const unsigned char *random, size_t rlen,
5028 unsigned char *dstbuf, size_t dlen )
5029{
5030 psa_status_t status;
5031 psa_algorithm_t alg;
5032 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5033 psa_key_derivation_operation_t derivation =
5034 PSA_KEY_DERIVATION_OPERATION_INIT;
5035
5036 if( md_type == MBEDTLS_MD_SHA384 )
5037 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5038 else
5039 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5040
5041 /* Normally a "secret" should be long enough to be impossible to
5042 * find by brute force, and in particular should not be empty. But
5043 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5044 * and for this use case it makes sense to have a 0-length "secret".
5045 * Since the key API doesn't allow importing a key of length 0,
5046 * keep master_key=0, which setup_psa_key_derivation() understands
5047 * to mean a 0-length "secret" input. */
5048 if( slen != 0 )
5049 {
5050 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5051 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5052 psa_set_key_algorithm( &key_attributes, alg );
5053 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5054
5055 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5056 if( status != PSA_SUCCESS )
5057 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5058 }
5059
5060 status = setup_psa_key_derivation( &derivation,
5061 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005062 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005063 random, rlen,
5064 (unsigned char const *) label,
5065 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005066 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005067 dlen );
5068 if( status != PSA_SUCCESS )
5069 {
5070 psa_key_derivation_abort( &derivation );
5071 psa_destroy_key( master_key );
5072 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5073 }
5074
5075 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5076 if( status != PSA_SUCCESS )
5077 {
5078 psa_key_derivation_abort( &derivation );
5079 psa_destroy_key( master_key );
5080 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5081 }
5082
5083 status = psa_key_derivation_abort( &derivation );
5084 if( status != PSA_SUCCESS )
5085 {
5086 psa_destroy_key( master_key );
5087 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5088 }
5089
5090 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5091 status = psa_destroy_key( master_key );
5092 if( status != PSA_SUCCESS )
5093 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5094
5095 return( 0 );
5096}
5097
5098#else /* MBEDTLS_USE_PSA_CRYPTO */
5099
5100static int tls_prf_generic( mbedtls_md_type_t md_type,
5101 const unsigned char *secret, size_t slen,
5102 const char *label,
5103 const unsigned char *random, size_t rlen,
5104 unsigned char *dstbuf, size_t dlen )
5105{
5106 size_t nb;
5107 size_t i, j, k, md_len;
5108 unsigned char *tmp;
5109 size_t tmp_len = 0;
5110 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5111 const mbedtls_md_info_t *md_info;
5112 mbedtls_md_context_t md_ctx;
5113 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5114
5115 mbedtls_md_init( &md_ctx );
5116
5117 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5118 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5119
5120 md_len = mbedtls_md_get_size( md_info );
5121
5122 tmp_len = md_len + strlen( label ) + rlen;
5123 tmp = mbedtls_calloc( 1, tmp_len );
5124 if( tmp == NULL )
5125 {
5126 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5127 goto exit;
5128 }
5129
5130 nb = strlen( label );
5131 memcpy( tmp + md_len, label, nb );
5132 memcpy( tmp + md_len + nb, random, rlen );
5133 nb += rlen;
5134
5135 /*
5136 * Compute P_<hash>(secret, label + random)[0..dlen]
5137 */
5138 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5139 goto exit;
5140
5141 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5142 if( ret != 0 )
5143 goto exit;
5144 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5145 if( ret != 0 )
5146 goto exit;
5147 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5148 if( ret != 0 )
5149 goto exit;
5150
5151 for( i = 0; i < dlen; i += md_len )
5152 {
5153 ret = mbedtls_md_hmac_reset ( &md_ctx );
5154 if( ret != 0 )
5155 goto exit;
5156 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5157 if( ret != 0 )
5158 goto exit;
5159 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5160 if( ret != 0 )
5161 goto exit;
5162
5163 ret = mbedtls_md_hmac_reset ( &md_ctx );
5164 if( ret != 0 )
5165 goto exit;
5166 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5167 if( ret != 0 )
5168 goto exit;
5169 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5170 if( ret != 0 )
5171 goto exit;
5172
5173 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5174
5175 for( j = 0; j < k; j++ )
5176 dstbuf[i + j] = h_i[j];
5177 }
5178
5179exit:
5180 mbedtls_md_free( &md_ctx );
5181
5182 mbedtls_platform_zeroize( tmp, tmp_len );
5183 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5184
5185 mbedtls_free( tmp );
5186
5187 return( ret );
5188}
5189#endif /* MBEDTLS_USE_PSA_CRYPTO */
5190
5191#if defined(MBEDTLS_SHA256_C)
5192static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5193 const char *label,
5194 const unsigned char *random, size_t rlen,
5195 unsigned char *dstbuf, size_t dlen )
5196{
5197 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5198 label, random, rlen, dstbuf, dlen ) );
5199}
5200#endif /* MBEDTLS_SHA256_C */
5201
5202#if defined(MBEDTLS_SHA384_C)
5203static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5204 const char *label,
5205 const unsigned char *random, size_t rlen,
5206 unsigned char *dstbuf, size_t dlen )
5207{
5208 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5209 label, random, rlen, dstbuf, dlen ) );
5210}
5211#endif /* MBEDTLS_SHA384_C */
5212
Jerry Yuf009d862022-02-17 14:01:37 +08005213/*
5214 * Set appropriate PRF function and other SSL / TLS1.2 functions
5215 *
5216 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005217 * - hash associated with the ciphersuite (only used by TLS 1.2)
5218 *
5219 * Outputs:
5220 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5221 */
5222static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005223 mbedtls_md_type_t hash )
5224{
Jerry Yuf009d862022-02-17 14:01:37 +08005225#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005226 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005227 {
5228 handshake->tls_prf = tls_prf_sha384;
5229 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5230 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5231 }
5232 else
5233#endif
5234#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005235 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005236 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005237 handshake->tls_prf = tls_prf_sha256;
5238 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5239 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5240 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005241#else
Jerry Yuf009d862022-02-17 14:01:37 +08005242 {
Jerry Yuf009d862022-02-17 14:01:37 +08005243 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005244 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005245 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5246 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005247#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005248
5249 return( 0 );
5250}
Jerry Yud6ab2352022-02-17 14:03:43 +08005251
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005252/*
5253 * Compute master secret if needed
5254 *
5255 * Parameters:
5256 * [in/out] handshake
5257 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5258 * (PSA-PSK) ciphersuite_info, psk_opaque
5259 * [out] premaster (cleared)
5260 * [out] master
5261 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5262 * debug: conf->f_dbg, conf->p_dbg
5263 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005264 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005265 */
5266static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5267 unsigned char *master,
5268 const mbedtls_ssl_context *ssl )
5269{
5270 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5271
5272 /* cf. RFC 5246, Section 8.1:
5273 * "The master secret is always exactly 48 bytes in length." */
5274 size_t const master_secret_len = 48;
5275
5276#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5277 unsigned char session_hash[48];
5278#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5279
5280 /* The label for the KDF used for key expansion.
5281 * This is either "master secret" or "extended master secret"
5282 * depending on whether the Extended Master Secret extension
5283 * is used. */
5284 char const *lbl = "master secret";
5285
Przemek Stekielae4ed302022-04-05 17:15:55 +02005286 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005287 * - If the Extended Master Secret extension is not used,
5288 * this is ClientHello.Random + ServerHello.Random
5289 * (see Sect. 8.1 in RFC 5246).
5290 * - If the Extended Master Secret extension is used,
5291 * this is the transcript of the handshake so far.
5292 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005293 unsigned char const *seed = handshake->randbytes;
5294 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005295
5296#if !defined(MBEDTLS_DEBUG_C) && \
5297 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5298 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5299 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5300 ssl = NULL; /* make sure we don't use it except for those cases */
5301 (void) ssl;
5302#endif
5303
5304 if( handshake->resume != 0 )
5305 {
5306 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5307 return( 0 );
5308 }
5309
5310#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5311 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5312 {
5313 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005314 seed = session_hash;
5315 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005316
5317 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005318 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005319 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005320#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005321
Przemek Stekiel99114f32022-04-22 11:20:09 +02005322#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005323 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005324 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005325 {
5326 /* Perform PSK-to-MS expansion in a single step. */
5327 psa_status_t status;
5328 psa_algorithm_t alg;
5329 mbedtls_svc_key_id_t psk;
5330 psa_key_derivation_operation_t derivation =
5331 PSA_KEY_DERIVATION_OPERATION_INIT;
5332 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5333
5334 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5335
5336 psk = mbedtls_ssl_get_opaque_psk( ssl );
5337
5338 if( hash_alg == MBEDTLS_MD_SHA384 )
5339 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5340 else
5341 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5342
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005343 size_t other_secret_len = 0;
5344 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005345
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005346 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005347 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005348 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005349 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005350 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005351 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005352 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005353 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005354 other_secret_len = 48;
5355 other_secret = handshake->premaster + 2;
5356 break;
5357 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005358 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005359 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5360 other_secret = handshake->premaster + 2;
5361 break;
5362 default:
5363 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005364 }
5365
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005366 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005367 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005368 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005369 (unsigned char const *) lbl,
5370 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005371 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005372 master_secret_len );
5373 if( status != PSA_SUCCESS )
5374 {
5375 psa_key_derivation_abort( &derivation );
5376 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5377 }
5378
5379 status = psa_key_derivation_output_bytes( &derivation,
5380 master,
5381 master_secret_len );
5382 if( status != PSA_SUCCESS )
5383 {
5384 psa_key_derivation_abort( &derivation );
5385 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5386 }
5387
5388 status = psa_key_derivation_abort( &derivation );
5389 if( status != PSA_SUCCESS )
5390 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5391 }
5392 else
5393#endif
5394 {
5395 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005396 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005397 master,
5398 master_secret_len );
5399 if( ret != 0 )
5400 {
5401 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5402 return( ret );
5403 }
5404
5405 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5406 handshake->premaster,
5407 handshake->pmslen );
5408
5409 mbedtls_platform_zeroize( handshake->premaster,
5410 sizeof(handshake->premaster) );
5411 }
5412
5413 return( 0 );
5414}
5415
Jerry Yud62f87e2022-02-17 14:09:02 +08005416int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5417{
5418 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5419 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5420 ssl->handshake->ciphersuite_info;
5421
5422 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5423
5424 /* Set PRF, calc_verify and calc_finished function pointers */
5425 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005426 ciphersuite_info->mac );
5427 if( ret != 0 )
5428 {
5429 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5430 return( ret );
5431 }
5432
5433 /* Compute master secret if needed */
5434 ret = ssl_compute_master( ssl->handshake,
5435 ssl->session_negotiate->master,
5436 ssl );
5437 if( ret != 0 )
5438 {
5439 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5440 return( ret );
5441 }
5442
5443 /* Swap the client and server random values:
5444 * - MS derivation wanted client+server (RFC 5246 8.1)
5445 * - key derivation wants server+client (RFC 5246 6.3) */
5446 {
5447 unsigned char tmp[64];
5448 memcpy( tmp, ssl->handshake->randbytes, 64 );
5449 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5450 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5451 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5452 }
5453
5454 /* Populate transform structure */
5455 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5456 ssl->session_negotiate->ciphersuite,
5457 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005458#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005459 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005460#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005461 ssl->handshake->tls_prf,
5462 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005463 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005464 ssl->conf->endpoint,
5465 ssl );
5466 if( ret != 0 )
5467 {
5468 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5469 return( ret );
5470 }
5471
5472 /* We no longer need Server/ClientHello.random values */
5473 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5474 sizeof( ssl->handshake->randbytes ) );
5475
5476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5477
5478 return( 0 );
5479}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005480
Ronald Cron4dcbca92022-03-07 10:21:40 +01005481int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5482{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005483 switch( md )
5484 {
5485#if defined(MBEDTLS_SHA384_C)
5486 case MBEDTLS_SSL_HASH_SHA384:
5487 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5488 break;
5489#endif
5490#if defined(MBEDTLS_SHA256_C)
5491 case MBEDTLS_SSL_HASH_SHA256:
5492 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5493 break;
5494#endif
5495 default:
5496 return( -1 );
5497 }
5498
Ronald Cronc2f13a02022-03-07 10:25:24 +01005499 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005500}
5501
Jerry Yu8392e0d2022-02-17 14:10:24 +08005502#if defined(MBEDTLS_SHA256_C)
5503void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5504 unsigned char *hash,
5505 size_t *hlen )
5506{
5507#if defined(MBEDTLS_USE_PSA_CRYPTO)
5508 size_t hash_size;
5509 psa_status_t status;
5510 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5511
5512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5513 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5514 if( status != PSA_SUCCESS )
5515 {
5516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5517 return;
5518 }
5519
5520 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5521 if( status != PSA_SUCCESS )
5522 {
5523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5524 return;
5525 }
5526
5527 *hlen = 32;
5528 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5530#else
5531 mbedtls_sha256_context sha256;
5532
5533 mbedtls_sha256_init( &sha256 );
5534
5535 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5536
5537 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5538 mbedtls_sha256_finish( &sha256, hash );
5539
5540 *hlen = 32;
5541
5542 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5543 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5544
5545 mbedtls_sha256_free( &sha256 );
5546#endif /* MBEDTLS_USE_PSA_CRYPTO */
5547 return;
5548}
5549#endif /* MBEDTLS_SHA256_C */
5550
Jerry Yuc1cb3842022-02-17 14:13:48 +08005551#if defined(MBEDTLS_SHA384_C)
5552void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5553 unsigned char *hash,
5554 size_t *hlen )
5555{
5556#if defined(MBEDTLS_USE_PSA_CRYPTO)
5557 size_t hash_size;
5558 psa_status_t status;
5559 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5560
5561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5562 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5563 if( status != PSA_SUCCESS )
5564 {
5565 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5566 return;
5567 }
5568
5569 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5570 if( status != PSA_SUCCESS )
5571 {
5572 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5573 return;
5574 }
5575
5576 *hlen = 48;
5577 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5579#else
5580 mbedtls_sha512_context sha512;
5581
5582 mbedtls_sha512_init( &sha512 );
5583
5584 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5585
5586 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5587 mbedtls_sha512_finish( &sha512, hash );
5588
5589 *hlen = 48;
5590
5591 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5592 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5593
5594 mbedtls_sha512_free( &sha512 );
5595#endif /* MBEDTLS_USE_PSA_CRYPTO */
5596 return;
5597}
5598#endif /* MBEDTLS_SHA384_C */
5599
Neil Armstrong80f6f322022-05-03 17:56:38 +02005600#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5601 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005602int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5603{
5604 unsigned char *p = ssl->handshake->premaster;
5605 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5606 const unsigned char *psk = NULL;
5607 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005608 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005609
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005610 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005611 {
5612 /*
5613 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005614 * checked before calling this function.
5615 *
5616 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005617 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005618 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005619 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5620 {
5621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5622 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5623 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005624 }
5625
5626 /*
5627 * PMS = struct {
5628 * opaque other_secret<0..2^16-1>;
5629 * opaque psk<0..2^16-1>;
5630 * };
5631 * with "other_secret" depending on the particular key exchange
5632 */
5633#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5634 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5635 {
5636 if( end - p < 2 )
5637 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5638
5639 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5640 p += 2;
5641
5642 if( end < p || (size_t)( end - p ) < psk_len )
5643 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5644
5645 memset( p, 0, psk_len );
5646 p += psk_len;
5647 }
5648 else
5649#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5650#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5651 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5652 {
5653 /*
5654 * other_secret already set by the ClientKeyExchange message,
5655 * and is 48 bytes long
5656 */
5657 if( end - p < 2 )
5658 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5659
5660 *p++ = 0;
5661 *p++ = 48;
5662 p += 48;
5663 }
5664 else
5665#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5666#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5667 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5668 {
5669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5670 size_t len;
5671
5672 /* Write length only when we know the actual value */
5673 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5674 p + 2, end - ( p + 2 ), &len,
5675 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5676 {
5677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5678 return( ret );
5679 }
5680 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5681 p += 2 + len;
5682
5683 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5684 }
5685 else
5686#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005687#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005688 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5689 {
5690 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5691 size_t zlen;
5692
5693 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5694 p + 2, end - ( p + 2 ),
5695 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5696 {
5697 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5698 return( ret );
5699 }
5700
5701 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5702 p += 2 + zlen;
5703
5704 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5705 MBEDTLS_DEBUG_ECDH_Z );
5706 }
5707 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005708#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005709 {
5710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5711 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5712 }
5713
5714 /* opaque psk<0..2^16-1>; */
5715 if( end - p < 2 )
5716 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5717
5718 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5719 p += 2;
5720
5721 if( end < p || (size_t)( end - p ) < psk_len )
5722 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5723
5724 memcpy( p, psk, psk_len );
5725 p += psk_len;
5726
5727 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5728
5729 return( 0 );
5730}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005731#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005732
5733#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5734static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5735
5736#if defined(MBEDTLS_SSL_PROTO_DTLS)
5737int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5738{
5739 /* If renegotiation is not enforced, retransmit until we would reach max
5740 * timeout if we were using the usual handshake doubling scheme */
5741 if( ssl->conf->renego_max_records < 0 )
5742 {
5743 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5744 unsigned char doublings = 1;
5745
5746 while( ratio != 0 )
5747 {
5748 ++doublings;
5749 ratio >>= 1;
5750 }
5751
5752 if( ++ssl->renego_records_seen > doublings )
5753 {
5754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5755 return( 0 );
5756 }
5757 }
5758
5759 return( ssl_write_hello_request( ssl ) );
5760}
5761#endif
5762#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005763
Jerry Yud9526692022-02-17 14:23:47 +08005764/*
5765 * Handshake functions
5766 */
5767#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5768/* No certificate support -> dummy functions */
5769int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5770{
5771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5772 ssl->handshake->ciphersuite_info;
5773
5774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5775
5776 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5777 {
5778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5779 ssl->state++;
5780 return( 0 );
5781 }
5782
5783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5784 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5785}
5786
5787int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5788{
5789 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5790 ssl->handshake->ciphersuite_info;
5791
5792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5793
5794 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5795 {
5796 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5797 ssl->state++;
5798 return( 0 );
5799 }
5800
5801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5802 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5803}
5804
5805#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5806/* Some certificate support -> implement write and parse */
5807
5808int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5809{
5810 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5811 size_t i, n;
5812 const mbedtls_x509_crt *crt;
5813 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5814 ssl->handshake->ciphersuite_info;
5815
5816 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5817
5818 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5819 {
5820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5821 ssl->state++;
5822 return( 0 );
5823 }
5824
5825#if defined(MBEDTLS_SSL_CLI_C)
5826 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5827 {
5828 if( ssl->handshake->client_auth == 0 )
5829 {
5830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5831 ssl->state++;
5832 return( 0 );
5833 }
5834 }
5835#endif /* MBEDTLS_SSL_CLI_C */
5836#if defined(MBEDTLS_SSL_SRV_C)
5837 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5838 {
5839 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5840 {
5841 /* Should never happen because we shouldn't have picked the
5842 * ciphersuite if we don't have a certificate. */
5843 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5844 }
5845 }
5846#endif
5847
5848 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5849
5850 /*
5851 * 0 . 0 handshake type
5852 * 1 . 3 handshake length
5853 * 4 . 6 length of all certs
5854 * 7 . 9 length of cert. 1
5855 * 10 . n-1 peer certificate
5856 * n . n+2 length of cert. 2
5857 * n+3 . ... upper level cert, etc.
5858 */
5859 i = 7;
5860 crt = mbedtls_ssl_own_cert( ssl );
5861
5862 while( crt != NULL )
5863 {
5864 n = crt->raw.len;
5865 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5866 {
5867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5868 " > %" MBEDTLS_PRINTF_SIZET,
5869 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5870 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5871 }
5872
5873 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5874 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5875 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5876
5877 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5878 i += n; crt = crt->next;
5879 }
5880
5881 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5882 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5883 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5884
5885 ssl->out_msglen = i;
5886 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5887 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5888
5889 ssl->state++;
5890
5891 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5892 {
5893 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5894 return( ret );
5895 }
5896
5897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5898
5899 return( ret );
5900}
5901
5902#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5903
5904#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5905static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5906 unsigned char *crt_buf,
5907 size_t crt_buf_len )
5908{
5909 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5910
5911 if( peer_crt == NULL )
5912 return( -1 );
5913
5914 if( peer_crt->raw.len != crt_buf_len )
5915 return( -1 );
5916
5917 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5918}
5919#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5920static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5921 unsigned char *crt_buf,
5922 size_t crt_buf_len )
5923{
5924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5925 unsigned char const * const peer_cert_digest =
5926 ssl->session->peer_cert_digest;
5927 mbedtls_md_type_t const peer_cert_digest_type =
5928 ssl->session->peer_cert_digest_type;
5929 mbedtls_md_info_t const * const digest_info =
5930 mbedtls_md_info_from_type( peer_cert_digest_type );
5931 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5932 size_t digest_len;
5933
5934 if( peer_cert_digest == NULL || digest_info == NULL )
5935 return( -1 );
5936
5937 digest_len = mbedtls_md_get_size( digest_info );
5938 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5939 return( -1 );
5940
5941 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5942 if( ret != 0 )
5943 return( -1 );
5944
5945 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5946}
5947#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5948#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5949
5950/*
5951 * Once the certificate message is read, parse it into a cert chain and
5952 * perform basic checks, but leave actual verification to the caller
5953 */
5954static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5955 mbedtls_x509_crt *chain )
5956{
5957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5958#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5959 int crt_cnt=0;
5960#endif
5961 size_t i, n;
5962 uint8_t alert;
5963
5964 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5965 {
5966 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5967 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5968 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5969 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5970 }
5971
5972 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5973 {
5974 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5975 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5976 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5977 }
5978
5979 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5980 {
5981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5982 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5983 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5984 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5985 }
5986
5987 i = mbedtls_ssl_hs_hdr_len( ssl );
5988
5989 /*
5990 * Same message structure as in mbedtls_ssl_write_certificate()
5991 */
5992 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5993
5994 if( ssl->in_msg[i] != 0 ||
5995 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5996 {
5997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5998 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5999 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6000 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6001 }
6002
6003 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6004 i += 3;
6005
6006 /* Iterate through and parse the CRTs in the provided chain. */
6007 while( i < ssl->in_hslen )
6008 {
6009 /* Check that there's room for the next CRT's length fields. */
6010 if ( i + 3 > ssl->in_hslen ) {
6011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6012 mbedtls_ssl_send_alert_message( ssl,
6013 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6014 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6015 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6016 }
6017 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6018 * anything beyond 2**16 ~ 64K. */
6019 if( ssl->in_msg[i] != 0 )
6020 {
6021 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6022 mbedtls_ssl_send_alert_message( ssl,
6023 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6024 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6025 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6026 }
6027
6028 /* Read length of the next CRT in the chain. */
6029 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6030 | (unsigned int) ssl->in_msg[i + 2];
6031 i += 3;
6032
6033 if( n < 128 || i + n > ssl->in_hslen )
6034 {
6035 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6036 mbedtls_ssl_send_alert_message( ssl,
6037 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6038 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6039 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6040 }
6041
6042 /* Check if we're handling the first CRT in the chain. */
6043#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6044 if( crt_cnt++ == 0 &&
6045 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6046 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6047 {
6048 /* During client-side renegotiation, check that the server's
6049 * end-CRTs hasn't changed compared to the initial handshake,
6050 * mitigating the triple handshake attack. On success, reuse
6051 * the original end-CRT instead of parsing it again. */
6052 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6053 if( ssl_check_peer_crt_unchanged( ssl,
6054 &ssl->in_msg[i],
6055 n ) != 0 )
6056 {
6057 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6058 mbedtls_ssl_send_alert_message( ssl,
6059 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6060 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6061 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6062 }
6063
6064 /* Now we can safely free the original chain. */
6065 ssl_clear_peer_cert( ssl->session );
6066 }
6067#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6068
6069 /* Parse the next certificate in the chain. */
6070#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6071 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6072#else
6073 /* If we don't need to store the CRT chain permanently, parse
6074 * it in-place from the input buffer instead of making a copy. */
6075 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6076#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6077 switch( ret )
6078 {
6079 case 0: /*ok*/
6080 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6081 /* Ignore certificate with an unknown algorithm: maybe a
6082 prior certificate was already trusted. */
6083 break;
6084
6085 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6086 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6087 goto crt_parse_der_failed;
6088
6089 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6090 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6091 goto crt_parse_der_failed;
6092
6093 default:
6094 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6095 crt_parse_der_failed:
6096 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6097 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6098 return( ret );
6099 }
6100
6101 i += n;
6102 }
6103
6104 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6105 return( 0 );
6106}
6107
6108#if defined(MBEDTLS_SSL_SRV_C)
6109static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6110{
6111 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6112 return( -1 );
6113
6114 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6115 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6116 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6117 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6118 {
Ronald Cron19385882022-06-15 16:26:13 +02006119 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006120 return( 0 );
6121 }
6122 return( -1 );
6123}
6124#endif /* MBEDTLS_SSL_SRV_C */
6125
6126/* Check if a certificate message is expected.
6127 * Return either
6128 * - SSL_CERTIFICATE_EXPECTED, or
6129 * - SSL_CERTIFICATE_SKIP
6130 * indicating whether a Certificate message is expected or not.
6131 */
6132#define SSL_CERTIFICATE_EXPECTED 0
6133#define SSL_CERTIFICATE_SKIP 1
6134static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6135 int authmode )
6136{
6137 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6138 ssl->handshake->ciphersuite_info;
6139
6140 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6141 return( SSL_CERTIFICATE_SKIP );
6142
6143#if defined(MBEDTLS_SSL_SRV_C)
6144 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6145 {
6146 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6147 return( SSL_CERTIFICATE_SKIP );
6148
6149 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6150 {
6151 ssl->session_negotiate->verify_result =
6152 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6153 return( SSL_CERTIFICATE_SKIP );
6154 }
6155 }
6156#else
6157 ((void) authmode);
6158#endif /* MBEDTLS_SSL_SRV_C */
6159
6160 return( SSL_CERTIFICATE_EXPECTED );
6161}
6162
6163static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6164 int authmode,
6165 mbedtls_x509_crt *chain,
6166 void *rs_ctx )
6167{
6168 int ret = 0;
6169 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6170 ssl->handshake->ciphersuite_info;
6171 int have_ca_chain = 0;
6172
6173 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6174 void *p_vrfy;
6175
6176 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6177 return( 0 );
6178
6179 if( ssl->f_vrfy != NULL )
6180 {
6181 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6182 f_vrfy = ssl->f_vrfy;
6183 p_vrfy = ssl->p_vrfy;
6184 }
6185 else
6186 {
6187 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6188 f_vrfy = ssl->conf->f_vrfy;
6189 p_vrfy = ssl->conf->p_vrfy;
6190 }
6191
6192 /*
6193 * Main check: verify certificate
6194 */
6195#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6196 if( ssl->conf->f_ca_cb != NULL )
6197 {
6198 ((void) rs_ctx);
6199 have_ca_chain = 1;
6200
6201 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6202 ret = mbedtls_x509_crt_verify_with_ca_cb(
6203 chain,
6204 ssl->conf->f_ca_cb,
6205 ssl->conf->p_ca_cb,
6206 ssl->conf->cert_profile,
6207 ssl->hostname,
6208 &ssl->session_negotiate->verify_result,
6209 f_vrfy, p_vrfy );
6210 }
6211 else
6212#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6213 {
6214 mbedtls_x509_crt *ca_chain;
6215 mbedtls_x509_crl *ca_crl;
6216
6217#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6218 if( ssl->handshake->sni_ca_chain != NULL )
6219 {
6220 ca_chain = ssl->handshake->sni_ca_chain;
6221 ca_crl = ssl->handshake->sni_ca_crl;
6222 }
6223 else
6224#endif
6225 {
6226 ca_chain = ssl->conf->ca_chain;
6227 ca_crl = ssl->conf->ca_crl;
6228 }
6229
6230 if( ca_chain != NULL )
6231 have_ca_chain = 1;
6232
6233 ret = mbedtls_x509_crt_verify_restartable(
6234 chain,
6235 ca_chain, ca_crl,
6236 ssl->conf->cert_profile,
6237 ssl->hostname,
6238 &ssl->session_negotiate->verify_result,
6239 f_vrfy, p_vrfy, rs_ctx );
6240 }
6241
6242 if( ret != 0 )
6243 {
6244 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6245 }
6246
6247#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6248 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6249 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6250#endif
6251
6252 /*
6253 * Secondary checks: always done, but change 'ret' only if it was 0
6254 */
6255
6256#if defined(MBEDTLS_ECP_C)
6257 {
6258 const mbedtls_pk_context *pk = &chain->pk;
6259
6260 /* If certificate uses an EC key, make sure the curve is OK */
6261 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6262 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6263 {
6264 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6265
6266 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6267 if( ret == 0 )
6268 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6269 }
6270 }
6271#endif /* MBEDTLS_ECP_C */
6272
6273 if( mbedtls_ssl_check_cert_usage( chain,
6274 ciphersuite_info,
6275 ! ssl->conf->endpoint,
6276 &ssl->session_negotiate->verify_result ) != 0 )
6277 {
6278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6279 if( ret == 0 )
6280 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6281 }
6282
6283 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6284 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6285 * with details encoded in the verification flags. All other kinds
6286 * of error codes, including those from the user provided f_vrfy
6287 * functions, are treated as fatal and lead to a failure of
6288 * ssl_parse_certificate even if verification was optional. */
6289 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6290 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6291 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6292 {
6293 ret = 0;
6294 }
6295
6296 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6297 {
6298 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6299 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6300 }
6301
6302 if( ret != 0 )
6303 {
6304 uint8_t alert;
6305
6306 /* The certificate may have been rejected for several reasons.
6307 Pick one and send the corresponding alert. Which alert to send
6308 may be a subject of debate in some cases. */
6309 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6310 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6311 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6312 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6313 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6314 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6315 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6316 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6317 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6318 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6319 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6320 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6321 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6322 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6323 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6324 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6325 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6326 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6327 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6328 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6329 else
6330 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6331 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6332 alert );
6333 }
6334
6335#if defined(MBEDTLS_DEBUG_C)
6336 if( ssl->session_negotiate->verify_result != 0 )
6337 {
6338 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6339 (unsigned int) ssl->session_negotiate->verify_result ) );
6340 }
6341 else
6342 {
6343 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6344 }
6345#endif /* MBEDTLS_DEBUG_C */
6346
6347 return( ret );
6348}
6349
6350#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6351static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6352 unsigned char *start, size_t len )
6353{
6354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6355 /* Remember digest of the peer's end-CRT. */
6356 ssl->session_negotiate->peer_cert_digest =
6357 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6358 if( ssl->session_negotiate->peer_cert_digest == NULL )
6359 {
6360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6361 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6362 mbedtls_ssl_send_alert_message( ssl,
6363 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6364 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6365
6366 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6367 }
6368
6369 ret = mbedtls_md( mbedtls_md_info_from_type(
6370 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6371 start, len,
6372 ssl->session_negotiate->peer_cert_digest );
6373
6374 ssl->session_negotiate->peer_cert_digest_type =
6375 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6376 ssl->session_negotiate->peer_cert_digest_len =
6377 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6378
6379 return( ret );
6380}
6381
6382static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6383 unsigned char *start, size_t len )
6384{
6385 unsigned char *end = start + len;
6386 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6387
6388 /* Make a copy of the peer's raw public key. */
6389 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6390 ret = mbedtls_pk_parse_subpubkey( &start, end,
6391 &ssl->handshake->peer_pubkey );
6392 if( ret != 0 )
6393 {
6394 /* We should have parsed the public key before. */
6395 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6396 }
6397
6398 return( 0 );
6399}
6400#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6401
6402int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6403{
6404 int ret = 0;
6405 int crt_expected;
6406#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6407 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6408 ? ssl->handshake->sni_authmode
6409 : ssl->conf->authmode;
6410#else
6411 const int authmode = ssl->conf->authmode;
6412#endif
6413 void *rs_ctx = NULL;
6414 mbedtls_x509_crt *chain = NULL;
6415
6416 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6417
6418 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6419 if( crt_expected == SSL_CERTIFICATE_SKIP )
6420 {
6421 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6422 goto exit;
6423 }
6424
6425#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6426 if( ssl->handshake->ecrs_enabled &&
6427 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6428 {
6429 chain = ssl->handshake->ecrs_peer_cert;
6430 ssl->handshake->ecrs_peer_cert = NULL;
6431 goto crt_verify;
6432 }
6433#endif
6434
6435 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6436 {
6437 /* mbedtls_ssl_read_record may have sent an alert already. We
6438 let it decide whether to alert. */
6439 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6440 goto exit;
6441 }
6442
6443#if defined(MBEDTLS_SSL_SRV_C)
6444 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6445 {
6446 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6447
6448 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6449 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6450
6451 goto exit;
6452 }
6453#endif /* MBEDTLS_SSL_SRV_C */
6454
6455 /* Clear existing peer CRT structure in case we tried to
6456 * reuse a session but it failed, and allocate a new one. */
6457 ssl_clear_peer_cert( ssl->session_negotiate );
6458
6459 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6460 if( chain == NULL )
6461 {
6462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6463 sizeof( mbedtls_x509_crt ) ) );
6464 mbedtls_ssl_send_alert_message( ssl,
6465 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6466 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6467
6468 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6469 goto exit;
6470 }
6471 mbedtls_x509_crt_init( chain );
6472
6473 ret = ssl_parse_certificate_chain( ssl, chain );
6474 if( ret != 0 )
6475 goto exit;
6476
6477#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6478 if( ssl->handshake->ecrs_enabled)
6479 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6480
6481crt_verify:
6482 if( ssl->handshake->ecrs_enabled)
6483 rs_ctx = &ssl->handshake->ecrs_ctx;
6484#endif
6485
6486 ret = ssl_parse_certificate_verify( ssl, authmode,
6487 chain, rs_ctx );
6488 if( ret != 0 )
6489 goto exit;
6490
6491#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6492 {
6493 unsigned char *crt_start, *pk_start;
6494 size_t crt_len, pk_len;
6495
6496 /* We parse the CRT chain without copying, so
6497 * these pointers point into the input buffer,
6498 * and are hence still valid after freeing the
6499 * CRT chain. */
6500
6501 crt_start = chain->raw.p;
6502 crt_len = chain->raw.len;
6503
6504 pk_start = chain->pk_raw.p;
6505 pk_len = chain->pk_raw.len;
6506
6507 /* Free the CRT structures before computing
6508 * digest and copying the peer's public key. */
6509 mbedtls_x509_crt_free( chain );
6510 mbedtls_free( chain );
6511 chain = NULL;
6512
6513 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6514 if( ret != 0 )
6515 goto exit;
6516
6517 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6518 if( ret != 0 )
6519 goto exit;
6520 }
6521#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6522 /* Pass ownership to session structure. */
6523 ssl->session_negotiate->peer_cert = chain;
6524 chain = NULL;
6525#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6526
6527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6528
6529exit:
6530
6531 if( ret == 0 )
6532 ssl->state++;
6533
6534#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6535 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6536 {
6537 ssl->handshake->ecrs_peer_cert = chain;
6538 chain = NULL;
6539 }
6540#endif
6541
6542 if( chain != NULL )
6543 {
6544 mbedtls_x509_crt_free( chain );
6545 mbedtls_free( chain );
6546 }
6547
6548 return( ret );
6549}
6550#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6551
Jerry Yu615bd6f2022-02-17 14:25:15 +08006552#if defined(MBEDTLS_SHA256_C)
6553static void ssl_calc_finished_tls_sha256(
6554 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6555{
6556 int len = 12;
6557 const char *sender;
6558 unsigned char padbuf[32];
6559#if defined(MBEDTLS_USE_PSA_CRYPTO)
6560 size_t hash_size;
6561 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6562 psa_status_t status;
6563#else
6564 mbedtls_sha256_context sha256;
6565#endif
6566
6567 mbedtls_ssl_session *session = ssl->session_negotiate;
6568 if( !session )
6569 session = ssl->session;
6570
6571 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6572 ? "client finished"
6573 : "server finished";
6574
6575#if defined(MBEDTLS_USE_PSA_CRYPTO)
6576 sha256_psa = psa_hash_operation_init();
6577
6578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6579
6580 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6581 if( status != PSA_SUCCESS )
6582 {
6583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6584 return;
6585 }
6586
6587 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6588 if( status != PSA_SUCCESS )
6589 {
6590 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6591 return;
6592 }
6593 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6594#else
6595
6596 mbedtls_sha256_init( &sha256 );
6597
6598 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6599
6600 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6601
6602 /*
6603 * TLSv1.2:
6604 * hash = PRF( master, finished_label,
6605 * Hash( handshake ) )[0.11]
6606 */
6607
6608#if !defined(MBEDTLS_SHA256_ALT)
6609 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6610 sha256.state, sizeof( sha256.state ) );
6611#endif
6612
6613 mbedtls_sha256_finish( &sha256, padbuf );
6614 mbedtls_sha256_free( &sha256 );
6615#endif /* MBEDTLS_USE_PSA_CRYPTO */
6616
6617 ssl->handshake->tls_prf( session->master, 48, sender,
6618 padbuf, 32, buf, len );
6619
6620 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6621
6622 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6623
6624 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6625}
6626#endif /* MBEDTLS_SHA256_C */
6627
Jerry Yub7ba49e2022-02-17 14:25:53 +08006628
6629#if defined(MBEDTLS_SHA384_C)
6630
6631static void ssl_calc_finished_tls_sha384(
6632 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6633{
6634 int len = 12;
6635 const char *sender;
6636 unsigned char padbuf[48];
6637#if defined(MBEDTLS_USE_PSA_CRYPTO)
6638 size_t hash_size;
6639 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6640 psa_status_t status;
6641#else
6642 mbedtls_sha512_context sha512;
6643#endif
6644
6645 mbedtls_ssl_session *session = ssl->session_negotiate;
6646 if( !session )
6647 session = ssl->session;
6648
6649 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6650 ? "client finished"
6651 : "server finished";
6652
6653#if defined(MBEDTLS_USE_PSA_CRYPTO)
6654 sha384_psa = psa_hash_operation_init();
6655
6656 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6657
6658 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6659 if( status != PSA_SUCCESS )
6660 {
6661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6662 return;
6663 }
6664
6665 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6666 if( status != PSA_SUCCESS )
6667 {
6668 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6669 return;
6670 }
6671 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6672#else
6673 mbedtls_sha512_init( &sha512 );
6674
6675 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6676
6677 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6678
6679 /*
6680 * TLSv1.2:
6681 * hash = PRF( master, finished_label,
6682 * Hash( handshake ) )[0.11]
6683 */
6684
6685#if !defined(MBEDTLS_SHA512_ALT)
6686 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6687 sha512.state, sizeof( sha512.state ) );
6688#endif
6689 mbedtls_sha512_finish( &sha512, padbuf );
6690
6691 mbedtls_sha512_free( &sha512 );
6692#endif
6693
6694 ssl->handshake->tls_prf( session->master, 48, sender,
6695 padbuf, 48, buf, len );
6696
6697 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6698
6699 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6700
6701 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6702}
6703#endif /* MBEDTLS_SHA384_C */
6704
Jerry Yuaef00152022-02-17 14:27:31 +08006705void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6706{
6707 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6708
6709 /*
6710 * Free our handshake params
6711 */
6712 mbedtls_ssl_handshake_free( ssl );
6713 mbedtls_free( ssl->handshake );
6714 ssl->handshake = NULL;
6715
6716 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006717 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006718 */
6719 if( ssl->transform )
6720 {
6721 mbedtls_ssl_transform_free( ssl->transform );
6722 mbedtls_free( ssl->transform );
6723 }
6724 ssl->transform = ssl->transform_negotiate;
6725 ssl->transform_negotiate = NULL;
6726
6727 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6728}
6729
Jerry Yu2a9fff52022-02-17 14:28:51 +08006730void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6731{
6732 int resume = ssl->handshake->resume;
6733
6734 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6735
6736#if defined(MBEDTLS_SSL_RENEGOTIATION)
6737 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6738 {
6739 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6740 ssl->renego_records_seen = 0;
6741 }
6742#endif
6743
6744 /*
6745 * Free the previous session and switch in the current one
6746 */
6747 if( ssl->session )
6748 {
6749#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6750 /* RFC 7366 3.1: keep the EtM state */
6751 ssl->session_negotiate->encrypt_then_mac =
6752 ssl->session->encrypt_then_mac;
6753#endif
6754
6755 mbedtls_ssl_session_free( ssl->session );
6756 mbedtls_free( ssl->session );
6757 }
6758 ssl->session = ssl->session_negotiate;
6759 ssl->session_negotiate = NULL;
6760
6761 /*
6762 * Add cache entry
6763 */
6764 if( ssl->conf->f_set_cache != NULL &&
6765 ssl->session->id_len != 0 &&
6766 resume == 0 )
6767 {
6768 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6769 ssl->session->id,
6770 ssl->session->id_len,
6771 ssl->session ) != 0 )
6772 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6773 }
6774
6775#if defined(MBEDTLS_SSL_PROTO_DTLS)
6776 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6777 ssl->handshake->flight != NULL )
6778 {
6779 /* Cancel handshake timer */
6780 mbedtls_ssl_set_timer( ssl, 0 );
6781
6782 /* Keep last flight around in case we need to resend it:
6783 * we need the handshake and transform structures for that */
6784 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6785 }
6786 else
6787#endif
6788 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6789
6790 ssl->state++;
6791
6792 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6793}
6794
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006795int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6796{
6797 int ret, hash_len;
6798
6799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6800
6801 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6802
6803 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6804
6805 /*
6806 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6807 * may define some other value. Currently (early 2016), no defined
6808 * ciphersuite does this (and this is unlikely to change as activity has
6809 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6810 */
6811 hash_len = 12;
6812
6813#if defined(MBEDTLS_SSL_RENEGOTIATION)
6814 ssl->verify_data_len = hash_len;
6815 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6816#endif
6817
6818 ssl->out_msglen = 4 + hash_len;
6819 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6820 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6821
6822 /*
6823 * In case of session resuming, invert the client and server
6824 * ChangeCipherSpec messages order.
6825 */
6826 if( ssl->handshake->resume != 0 )
6827 {
6828#if defined(MBEDTLS_SSL_CLI_C)
6829 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6830 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6831#endif
6832#if defined(MBEDTLS_SSL_SRV_C)
6833 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6834 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6835#endif
6836 }
6837 else
6838 ssl->state++;
6839
6840 /*
6841 * Switch to our negotiated transform and session parameters for outbound
6842 * data.
6843 */
6844 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6845
6846#if defined(MBEDTLS_SSL_PROTO_DTLS)
6847 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6848 {
6849 unsigned char i;
6850
6851 /* Remember current epoch settings for resending */
6852 ssl->handshake->alt_transform_out = ssl->transform_out;
6853 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6854 sizeof( ssl->handshake->alt_out_ctr ) );
6855
6856 /* Set sequence_number to zero */
6857 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6858
6859
6860 /* Increment epoch */
6861 for( i = 2; i > 0; i-- )
6862 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6863 break;
6864
6865 /* The loop goes to its end iff the counter is wrapping */
6866 if( i == 0 )
6867 {
6868 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6869 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6870 }
6871 }
6872 else
6873#endif /* MBEDTLS_SSL_PROTO_DTLS */
6874 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6875
6876 ssl->transform_out = ssl->transform_negotiate;
6877 ssl->session_out = ssl->session_negotiate;
6878
6879#if defined(MBEDTLS_SSL_PROTO_DTLS)
6880 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6881 mbedtls_ssl_send_flight_completed( ssl );
6882#endif
6883
6884 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6885 {
6886 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6887 return( ret );
6888 }
6889
6890#if defined(MBEDTLS_SSL_PROTO_DTLS)
6891 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6892 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6893 {
6894 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6895 return( ret );
6896 }
6897#endif
6898
6899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6900
6901 return( 0 );
6902}
6903
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006904#define SSL_MAX_HASH_LEN 12
6905
6906int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6907{
6908 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6909 unsigned int hash_len = 12;
6910 unsigned char buf[SSL_MAX_HASH_LEN];
6911
6912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6913
6914 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6915
6916 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6917 {
6918 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6919 goto exit;
6920 }
6921
6922 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6923 {
6924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6925 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6926 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6927 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6928 goto exit;
6929 }
6930
6931 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6932 {
6933 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6934 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6935 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6936 goto exit;
6937 }
6938
6939 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6940 {
6941 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6942 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6943 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6944 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6945 goto exit;
6946 }
6947
6948 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6949 buf, hash_len ) != 0 )
6950 {
6951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6952 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6953 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6954 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6955 goto exit;
6956 }
6957
6958#if defined(MBEDTLS_SSL_RENEGOTIATION)
6959 ssl->verify_data_len = hash_len;
6960 memcpy( ssl->peer_verify_data, buf, hash_len );
6961#endif
6962
6963 if( ssl->handshake->resume != 0 )
6964 {
6965#if defined(MBEDTLS_SSL_CLI_C)
6966 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6967 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6968#endif
6969#if defined(MBEDTLS_SSL_SRV_C)
6970 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6971 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6972#endif
6973 }
6974 else
6975 ssl->state++;
6976
6977#if defined(MBEDTLS_SSL_PROTO_DTLS)
6978 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6979 mbedtls_ssl_recv_flight_completed( ssl );
6980#endif
6981
6982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6983
6984exit:
6985 mbedtls_platform_zeroize( buf, hash_len );
6986 return( ret );
6987}
6988
Jerry Yu392112c2022-02-17 14:34:10 +08006989#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6990/*
6991 * Helper to get TLS 1.2 PRF from ciphersuite
6992 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6993 */
6994static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6995{
6996#if defined(MBEDTLS_SHA384_C)
6997 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6998 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6999
7000 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7001 return( tls_prf_sha384 );
7002#else
7003 (void) ciphersuite_id;
7004#endif
7005 return( tls_prf_sha256 );
7006}
7007#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007008
7009static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7010{
7011 ((void) tls_prf);
7012#if defined(MBEDTLS_SHA384_C)
7013 if( tls_prf == tls_prf_sha384 )
7014 {
7015 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7016 }
7017 else
7018#endif
7019#if defined(MBEDTLS_SHA256_C)
7020 if( tls_prf == tls_prf_sha256 )
7021 {
7022 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7023 }
7024 else
7025#endif
7026 return( MBEDTLS_SSL_TLS_PRF_NONE );
7027}
7028
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007029/*
7030 * Populate a transform structure with session keys and all the other
7031 * necessary information.
7032 *
7033 * Parameters:
7034 * - [in/out]: transform: structure to populate
7035 * [in] must be just initialised with mbedtls_ssl_transform_init()
7036 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7037 * - [in] ciphersuite
7038 * - [in] master
7039 * - [in] encrypt_then_mac
7040 * - [in] compression
7041 * - [in] tls_prf: pointer to PRF to use for key derivation
7042 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007043 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007044 * - [in] endpoint: client or server
7045 * - [in] ssl: used for:
7046 * - ssl->conf->{f,p}_export_keys
7047 * [in] optionally used for:
7048 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7049 */
7050static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7051 int ciphersuite,
7052 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007053#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007054 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007055#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007056 ssl_tls_prf_t tls_prf,
7057 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007058 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007059 unsigned endpoint,
7060 const mbedtls_ssl_context *ssl )
7061{
7062 int ret = 0;
7063 unsigned char keyblk[256];
7064 unsigned char *key1;
7065 unsigned char *key2;
7066 unsigned char *mac_enc;
7067 unsigned char *mac_dec;
7068 size_t mac_key_len = 0;
7069 size_t iv_copy_len;
7070 size_t keylen;
7071 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007072 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007073#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007074 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007075 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007076#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007077
7078#if defined(MBEDTLS_USE_PSA_CRYPTO)
7079 psa_key_type_t key_type;
7080 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7081 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007082 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007083 size_t key_bits;
7084 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7085#endif
7086
7087#if !defined(MBEDTLS_DEBUG_C) && \
7088 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7089 if( ssl->f_export_keys == NULL )
7090 {
7091 ssl = NULL; /* make sure we don't use it except for these cases */
7092 (void) ssl;
7093 }
7094#endif
7095
7096 /*
7097 * Some data just needs copying into the structure
7098 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007099#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007100 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007101#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007102 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007103
7104#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7105 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7106#endif
7107
7108#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007109 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007110 {
7111 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7112 * generation separate. This should never happen. */
7113 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7114 }
7115#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7116
7117 /*
7118 * Get various info structures
7119 */
7120 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7121 if( ciphersuite_info == NULL )
7122 {
7123 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7124 ciphersuite ) );
7125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7126 }
7127
Neil Armstrongab555e02022-04-04 11:07:59 +02007128 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007129#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007130 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007131#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007132 ciphersuite_info );
7133
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007134 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7135 transform->taglen =
7136 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7137
7138#if defined(MBEDTLS_USE_PSA_CRYPTO)
7139 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7140 transform->taglen,
7141 &alg,
7142 &key_type,
7143 &key_bits ) ) != PSA_SUCCESS )
7144 {
7145 ret = psa_ssl_status_to_mbedtls( status );
7146 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7147 goto end;
7148 }
7149#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007150 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7151 if( cipher_info == NULL )
7152 {
7153 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7154 ciphersuite_info->cipher ) );
7155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7156 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007157#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007158
Neil Armstronge4512952022-03-08 09:08:22 +01007159#if defined(MBEDTLS_USE_PSA_CRYPTO)
7160 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7161 if( mac_alg == 0 )
7162 {
7163 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7164 (unsigned) ciphersuite_info->mac ) );
7165 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7166 }
7167#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007168 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7169 if( md_info == NULL )
7170 {
7171 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7172 (unsigned) ciphersuite_info->mac ) );
7173 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7174 }
Neil Armstronge4512952022-03-08 09:08:22 +01007175#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007176
7177#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7178 /* Copy own and peer's CID if the use of the CID
7179 * extension has been negotiated. */
7180 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7181 {
7182 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7183
7184 transform->in_cid_len = ssl->own_cid_len;
7185 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7186 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7187 transform->in_cid_len );
7188
7189 transform->out_cid_len = ssl->handshake->peer_cid_len;
7190 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7191 ssl->handshake->peer_cid_len );
7192 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7193 transform->out_cid_len );
7194 }
7195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7196
7197 /*
7198 * Compute key block using the PRF
7199 */
7200 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7201 if( ret != 0 )
7202 {
7203 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7204 return( ret );
7205 }
7206
7207 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7208 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7209 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7210 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7211 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7212
7213 /*
7214 * Determine the appropriate key, IV and MAC length.
7215 */
7216
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007217#if defined(MBEDTLS_USE_PSA_CRYPTO)
7218 keylen = PSA_BITS_TO_BYTES(key_bits);
7219#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007220 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007221#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007222
7223#if defined(MBEDTLS_GCM_C) || \
7224 defined(MBEDTLS_CCM_C) || \
7225 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007226 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007227 {
7228 size_t explicit_ivlen;
7229
7230 transform->maclen = 0;
7231 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007232
7233 /* All modes haves 96-bit IVs, but the length of the static parts vary
7234 * with mode and version:
7235 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7236 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7237 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7238 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7239 * sequence number).
7240 */
7241 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007242#if defined(MBEDTLS_USE_PSA_CRYPTO)
7243 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7244#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007245 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007246#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007247 transform->fixed_ivlen = 12;
7248 else
7249 transform->fixed_ivlen = 4;
7250
7251 /* Minimum length of encrypted record */
7252 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7253 transform->minlen = explicit_ivlen + transform->taglen;
7254 }
7255 else
7256#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7257#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007258 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7259 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7260 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007261 {
Neil Armstronge4512952022-03-08 09:08:22 +01007262#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007263 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007264#else
7265 size_t block_size = cipher_info->block_size;
7266#endif /* MBEDTLS_USE_PSA_CRYPTO */
7267
7268#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007269 /* Get MAC length */
7270 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7271#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007272 /* Initialize HMAC contexts */
7273 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7274 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7275 {
7276 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7277 goto end;
7278 }
7279
7280 /* Get MAC length */
7281 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007282#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007283 transform->maclen = mac_key_len;
7284
7285 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007286#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007287 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007288#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007289 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007290#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007291
7292 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007293 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007294 transform->minlen = transform->maclen;
7295 else
7296 {
7297 /*
7298 * GenericBlockCipher:
7299 * 1. if EtM is in use: one block plus MAC
7300 * otherwise: * first multiple of blocklen greater than maclen
7301 * 2. IV
7302 */
7303#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007304 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007305 {
7306 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007307 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007308 }
7309 else
7310#endif
7311 {
7312 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007313 + block_size
7314 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007315 }
7316
Glenn Strauss07c64162022-03-14 12:34:51 -04007317 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007318 {
7319 transform->minlen += transform->ivlen;
7320 }
7321 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007322 {
7323 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7324 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7325 goto end;
7326 }
7327 }
7328 }
7329 else
7330#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7331 {
7332 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7333 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7334 }
7335
7336 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7337 (unsigned) keylen,
7338 (unsigned) transform->minlen,
7339 (unsigned) transform->ivlen,
7340 (unsigned) transform->maclen ) );
7341
7342 /*
7343 * Finally setup the cipher contexts, IVs and MAC secrets.
7344 */
7345#if defined(MBEDTLS_SSL_CLI_C)
7346 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7347 {
7348 key1 = keyblk + mac_key_len * 2;
7349 key2 = keyblk + mac_key_len * 2 + keylen;
7350
7351 mac_enc = keyblk;
7352 mac_dec = keyblk + mac_key_len;
7353
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007354 iv_copy_len = ( transform->fixed_ivlen ) ?
7355 transform->fixed_ivlen : transform->ivlen;
7356 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7357 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7358 iv_copy_len );
7359 }
7360 else
7361#endif /* MBEDTLS_SSL_CLI_C */
7362#if defined(MBEDTLS_SSL_SRV_C)
7363 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7364 {
7365 key1 = keyblk + mac_key_len * 2 + keylen;
7366 key2 = keyblk + mac_key_len * 2;
7367
7368 mac_enc = keyblk + mac_key_len;
7369 mac_dec = keyblk;
7370
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007371 iv_copy_len = ( transform->fixed_ivlen ) ?
7372 transform->fixed_ivlen : transform->ivlen;
7373 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7374 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7375 iv_copy_len );
7376 }
7377 else
7378#endif /* MBEDTLS_SSL_SRV_C */
7379 {
7380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7381 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7382 goto end;
7383 }
7384
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007385 if( ssl != NULL && ssl->f_export_keys != NULL )
7386 {
7387 ssl->f_export_keys( ssl->p_export_keys,
7388 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7389 master, 48,
7390 randbytes + 32,
7391 randbytes,
7392 tls_prf_get_type( tls_prf ) );
7393 }
7394
7395#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007396 transform->psa_alg = alg;
7397
7398 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7399 {
7400 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7401 psa_set_key_algorithm( &attributes, alg );
7402 psa_set_key_type( &attributes, key_type );
7403
7404 if( ( status = psa_import_key( &attributes,
7405 key1,
7406 PSA_BITS_TO_BYTES( key_bits ),
7407 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7408 {
7409 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7410 ret = psa_ssl_status_to_mbedtls( status );
7411 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7412 goto end;
7413 }
7414
7415 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7416
7417 if( ( status = psa_import_key( &attributes,
7418 key2,
7419 PSA_BITS_TO_BYTES( key_bits ),
7420 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7421 {
7422 ret = psa_ssl_status_to_mbedtls( status );
7423 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7424 goto end;
7425 }
7426 }
7427#else
7428 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7429 cipher_info ) ) != 0 )
7430 {
7431 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7432 goto end;
7433 }
7434
7435 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7436 cipher_info ) ) != 0 )
7437 {
7438 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7439 goto end;
7440 }
7441
7442 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7443 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7444 MBEDTLS_ENCRYPT ) ) != 0 )
7445 {
7446 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7447 goto end;
7448 }
7449
7450 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7451 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7452 MBEDTLS_DECRYPT ) ) != 0 )
7453 {
7454 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7455 goto end;
7456 }
7457
7458#if defined(MBEDTLS_CIPHER_MODE_CBC)
7459 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7460 {
7461 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7462 MBEDTLS_PADDING_NONE ) ) != 0 )
7463 {
7464 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7465 goto end;
7466 }
7467
7468 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7469 MBEDTLS_PADDING_NONE ) ) != 0 )
7470 {
7471 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7472 goto end;
7473 }
7474 }
7475#endif /* MBEDTLS_CIPHER_MODE_CBC */
7476#endif /* MBEDTLS_USE_PSA_CRYPTO */
7477
Neil Armstrong29c0c042022-03-17 17:47:28 +01007478#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7479 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7480 For AEAD-based ciphersuites, there is nothing to do here. */
7481 if( mac_key_len != 0 )
7482 {
7483#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007484 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007485
7486 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007487 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007488 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7489
7490 if( ( status = psa_import_key( &attributes,
7491 mac_enc, mac_key_len,
7492 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7493 {
7494 ret = psa_ssl_status_to_mbedtls( status );
7495 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7496 goto end;
7497 }
7498
Ronald Cronfb39f152022-03-25 14:36:28 +01007499 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7500 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7501 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007502 /* mbedtls_ct_hmac() requires the key to be exportable */
7503 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7504 PSA_KEY_USAGE_VERIFY_HASH );
7505 else
7506 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7507
7508 if( ( status = psa_import_key( &attributes,
7509 mac_dec, mac_key_len,
7510 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7511 {
7512 ret = psa_ssl_status_to_mbedtls( status );
7513 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7514 goto end;
7515 }
7516#else
7517 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7518 if( ret != 0 )
7519 goto end;
7520 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7521 if( ret != 0 )
7522 goto end;
7523#endif /* MBEDTLS_USE_PSA_CRYPTO */
7524 }
7525#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7526
7527 ((void) mac_dec);
7528 ((void) mac_enc);
7529
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007530end:
7531 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7532 return( ret );
7533}
7534
Jerry Yuee40f9d2022-02-17 14:55:16 +08007535#if defined(MBEDTLS_USE_PSA_CRYPTO)
7536int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7537 unsigned char *hash, size_t *hashlen,
7538 unsigned char *data, size_t data_len,
7539 mbedtls_md_type_t md_alg )
7540{
7541 psa_status_t status;
7542 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7543 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7544
7545 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7546
7547 if( ( status = psa_hash_setup( &hash_operation,
7548 hash_alg ) ) != PSA_SUCCESS )
7549 {
7550 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7551 goto exit;
7552 }
7553
7554 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7555 64 ) ) != PSA_SUCCESS )
7556 {
7557 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7558 goto exit;
7559 }
7560
7561 if( ( status = psa_hash_update( &hash_operation,
7562 data, data_len ) ) != PSA_SUCCESS )
7563 {
7564 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7565 goto exit;
7566 }
7567
7568 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7569 hashlen ) ) != PSA_SUCCESS )
7570 {
7571 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7572 goto exit;
7573 }
7574
7575exit:
7576 if( status != PSA_SUCCESS )
7577 {
7578 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7579 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7580 switch( status )
7581 {
7582 case PSA_ERROR_NOT_SUPPORTED:
7583 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7584 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7585 case PSA_ERROR_BUFFER_TOO_SMALL:
7586 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7587 case PSA_ERROR_INSUFFICIENT_MEMORY:
7588 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7589 default:
7590 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7591 }
7592 }
7593 return( 0 );
7594}
7595
7596#else
7597
7598int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7599 unsigned char *hash, size_t *hashlen,
7600 unsigned char *data, size_t data_len,
7601 mbedtls_md_type_t md_alg )
7602{
7603 int ret = 0;
7604 mbedtls_md_context_t ctx;
7605 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7606 *hashlen = mbedtls_md_get_size( md_info );
7607
7608 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7609
7610 mbedtls_md_init( &ctx );
7611
7612 /*
7613 * digitally-signed struct {
7614 * opaque client_random[32];
7615 * opaque server_random[32];
7616 * ServerDHParams params;
7617 * };
7618 */
7619 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7620 {
7621 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7622 goto exit;
7623 }
7624 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7625 {
7626 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7627 goto exit;
7628 }
7629 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7630 {
7631 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7632 goto exit;
7633 }
7634 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7635 {
7636 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7637 goto exit;
7638 }
7639 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7640 {
7641 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7642 goto exit;
7643 }
7644
7645exit:
7646 mbedtls_md_free( &ctx );
7647
7648 if( ret != 0 )
7649 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7650 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7651
7652 return( ret );
7653}
7654#endif /* MBEDTLS_USE_PSA_CRYPTO */
7655
Jerry Yud9d91da2022-02-17 14:57:06 +08007656#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7657
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007658/* Find the preferred hash for a given signature algorithm. */
7659unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7660 mbedtls_ssl_context *ssl,
7661 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007662{
Gabor Mezei078e8032022-04-27 21:17:56 +02007663 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007664 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007665
7666 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007667 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007668
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007669 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007670 {
Gabor Mezei3631cf62022-05-10 12:59:00 +02007671 if( sig_alg == MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7672 received_sig_algs[i] ) )
Gabor Mezei696956d2022-05-13 16:27:29 +02007673 return( MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7674 received_sig_algs[i] ) );
Jerry Yud9d91da2022-02-17 14:57:06 +08007675 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007676
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007677 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007678}
7679
7680#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7681
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007682/* Serialization of TLS 1.2 sessions:
7683 *
7684 * struct {
7685 * uint64 start_time;
7686 * uint8 ciphersuite[2]; // defined by the standard
7687 * uint8 compression; // 0 or 1
7688 * uint8 session_id_len; // at most 32
7689 * opaque session_id[32];
7690 * opaque master[48]; // fixed length in the standard
7691 * uint32 verify_result;
7692 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7693 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7694 * uint32 ticket_lifetime;
7695 * uint8 mfl_code; // up to 255 according to standard
7696 * uint8 encrypt_then_mac; // 0 or 1
7697 * } serialized_session_tls12;
7698 *
7699 */
7700static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7701 unsigned char *buf,
7702 size_t buf_len )
7703{
7704 unsigned char *p = buf;
7705 size_t used = 0;
7706
7707#if defined(MBEDTLS_HAVE_TIME)
7708 uint64_t start;
7709#endif
7710#if defined(MBEDTLS_X509_CRT_PARSE_C)
7711#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7712 size_t cert_len;
7713#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7714#endif /* MBEDTLS_X509_CRT_PARSE_C */
7715
7716 /*
7717 * Time
7718 */
7719#if defined(MBEDTLS_HAVE_TIME)
7720 used += 8;
7721
7722 if( used <= buf_len )
7723 {
7724 start = (uint64_t) session->start;
7725
7726 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7727 p += 8;
7728 }
7729#endif /* MBEDTLS_HAVE_TIME */
7730
7731 /*
7732 * Basic mandatory fields
7733 */
7734 used += 2 /* ciphersuite */
7735 + 1 /* compression */
7736 + 1 /* id_len */
7737 + sizeof( session->id )
7738 + sizeof( session->master )
7739 + 4; /* verify_result */
7740
7741 if( used <= buf_len )
7742 {
7743 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7744 p += 2;
7745
7746 *p++ = MBEDTLS_BYTE_0( session->compression );
7747
7748 *p++ = MBEDTLS_BYTE_0( session->id_len );
7749 memcpy( p, session->id, 32 );
7750 p += 32;
7751
7752 memcpy( p, session->master, 48 );
7753 p += 48;
7754
7755 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7756 p += 4;
7757 }
7758
7759 /*
7760 * Peer's end-entity certificate
7761 */
7762#if defined(MBEDTLS_X509_CRT_PARSE_C)
7763#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7764 if( session->peer_cert == NULL )
7765 cert_len = 0;
7766 else
7767 cert_len = session->peer_cert->raw.len;
7768
7769 used += 3 + cert_len;
7770
7771 if( used <= buf_len )
7772 {
7773 *p++ = MBEDTLS_BYTE_2( cert_len );
7774 *p++ = MBEDTLS_BYTE_1( cert_len );
7775 *p++ = MBEDTLS_BYTE_0( cert_len );
7776
7777 if( session->peer_cert != NULL )
7778 {
7779 memcpy( p, session->peer_cert->raw.p, cert_len );
7780 p += cert_len;
7781 }
7782 }
7783#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7784 if( session->peer_cert_digest != NULL )
7785 {
7786 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7787 if( used <= buf_len )
7788 {
7789 *p++ = (unsigned char) session->peer_cert_digest_type;
7790 *p++ = (unsigned char) session->peer_cert_digest_len;
7791 memcpy( p, session->peer_cert_digest,
7792 session->peer_cert_digest_len );
7793 p += session->peer_cert_digest_len;
7794 }
7795 }
7796 else
7797 {
7798 used += 2;
7799 if( used <= buf_len )
7800 {
7801 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7802 *p++ = 0;
7803 }
7804 }
7805#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7806#endif /* MBEDTLS_X509_CRT_PARSE_C */
7807
7808 /*
7809 * Session ticket if any, plus associated data
7810 */
7811#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7812 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7813
7814 if( used <= buf_len )
7815 {
7816 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7817 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7818 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7819
7820 if( session->ticket != NULL )
7821 {
7822 memcpy( p, session->ticket, session->ticket_len );
7823 p += session->ticket_len;
7824 }
7825
7826 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7827 p += 4;
7828 }
7829#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7830
7831 /*
7832 * Misc extension-related info
7833 */
7834#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7835 used += 1;
7836
7837 if( used <= buf_len )
7838 *p++ = session->mfl_code;
7839#endif
7840
7841#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7842 used += 1;
7843
7844 if( used <= buf_len )
7845 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7846#endif
7847
7848 return( used );
7849}
7850
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007851static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7852 const unsigned char *buf,
7853 size_t len )
7854{
7855#if defined(MBEDTLS_HAVE_TIME)
7856 uint64_t start;
7857#endif
7858#if defined(MBEDTLS_X509_CRT_PARSE_C)
7859#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7860 size_t cert_len;
7861#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7862#endif /* MBEDTLS_X509_CRT_PARSE_C */
7863
7864 const unsigned char *p = buf;
7865 const unsigned char * const end = buf + len;
7866
7867 /*
7868 * Time
7869 */
7870#if defined(MBEDTLS_HAVE_TIME)
7871 if( 8 > (size_t)( end - p ) )
7872 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7873
7874 start = ( (uint64_t) p[0] << 56 ) |
7875 ( (uint64_t) p[1] << 48 ) |
7876 ( (uint64_t) p[2] << 40 ) |
7877 ( (uint64_t) p[3] << 32 ) |
7878 ( (uint64_t) p[4] << 24 ) |
7879 ( (uint64_t) p[5] << 16 ) |
7880 ( (uint64_t) p[6] << 8 ) |
7881 ( (uint64_t) p[7] );
7882 p += 8;
7883
7884 session->start = (time_t) start;
7885#endif /* MBEDTLS_HAVE_TIME */
7886
7887 /*
7888 * Basic mandatory fields
7889 */
7890 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7891 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7892
7893 session->ciphersuite = ( p[0] << 8 ) | p[1];
7894 p += 2;
7895
7896 session->compression = *p++;
7897
7898 session->id_len = *p++;
7899 memcpy( session->id, p, 32 );
7900 p += 32;
7901
7902 memcpy( session->master, p, 48 );
7903 p += 48;
7904
7905 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7906 ( (uint32_t) p[1] << 16 ) |
7907 ( (uint32_t) p[2] << 8 ) |
7908 ( (uint32_t) p[3] );
7909 p += 4;
7910
7911 /* Immediately clear invalid pointer values that have been read, in case
7912 * we exit early before we replaced them with valid ones. */
7913#if defined(MBEDTLS_X509_CRT_PARSE_C)
7914#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7915 session->peer_cert = NULL;
7916#else
7917 session->peer_cert_digest = NULL;
7918#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7919#endif /* MBEDTLS_X509_CRT_PARSE_C */
7920#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7921 session->ticket = NULL;
7922#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7923
7924 /*
7925 * Peer certificate
7926 */
7927#if defined(MBEDTLS_X509_CRT_PARSE_C)
7928#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7929 /* Deserialize CRT from the end of the ticket. */
7930 if( 3 > (size_t)( end - p ) )
7931 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7932
7933 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7934 p += 3;
7935
7936 if( cert_len != 0 )
7937 {
7938 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7939
7940 if( cert_len > (size_t)( end - p ) )
7941 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7942
7943 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7944
7945 if( session->peer_cert == NULL )
7946 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7947
7948 mbedtls_x509_crt_init( session->peer_cert );
7949
7950 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7951 p, cert_len ) ) != 0 )
7952 {
7953 mbedtls_x509_crt_free( session->peer_cert );
7954 mbedtls_free( session->peer_cert );
7955 session->peer_cert = NULL;
7956 return( ret );
7957 }
7958
7959 p += cert_len;
7960 }
7961#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7962 /* Deserialize CRT digest from the end of the ticket. */
7963 if( 2 > (size_t)( end - p ) )
7964 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7965
7966 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7967 session->peer_cert_digest_len = (size_t) *p++;
7968
7969 if( session->peer_cert_digest_len != 0 )
7970 {
7971 const mbedtls_md_info_t *md_info =
7972 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7973 if( md_info == NULL )
7974 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7975 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7976 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7977
7978 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7979 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7980
7981 session->peer_cert_digest =
7982 mbedtls_calloc( 1, session->peer_cert_digest_len );
7983 if( session->peer_cert_digest == NULL )
7984 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7985
7986 memcpy( session->peer_cert_digest, p,
7987 session->peer_cert_digest_len );
7988 p += session->peer_cert_digest_len;
7989 }
7990#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7991#endif /* MBEDTLS_X509_CRT_PARSE_C */
7992
7993 /*
7994 * Session ticket and associated data
7995 */
7996#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7997 if( 3 > (size_t)( end - p ) )
7998 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7999
8000 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8001 p += 3;
8002
8003 if( session->ticket_len != 0 )
8004 {
8005 if( session->ticket_len > (size_t)( end - p ) )
8006 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8007
8008 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8009 if( session->ticket == NULL )
8010 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8011
8012 memcpy( session->ticket, p, session->ticket_len );
8013 p += session->ticket_len;
8014 }
8015
8016 if( 4 > (size_t)( end - p ) )
8017 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8018
8019 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8020 ( (uint32_t) p[1] << 16 ) |
8021 ( (uint32_t) p[2] << 8 ) |
8022 ( (uint32_t) p[3] );
8023 p += 4;
8024#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8025
8026 /*
8027 * Misc extension-related info
8028 */
8029#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8030 if( 1 > (size_t)( end - p ) )
8031 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8032
8033 session->mfl_code = *p++;
8034#endif
8035
8036#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8037 if( 1 > (size_t)( end - p ) )
8038 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8039
8040 session->encrypt_then_mac = *p++;
8041#endif
8042
8043 /* Done, should have consumed entire buffer */
8044 if( p != end )
8045 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8046
8047 return( 0 );
8048}
Jerry Yudc7bd172022-02-17 13:44:15 +08008049#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8050
XiaokangQian75d40ef2022-04-20 11:05:24 +00008051int mbedtls_ssl_validate_ciphersuite(
8052 const mbedtls_ssl_context *ssl,
8053 const mbedtls_ssl_ciphersuite_t *suite_info,
8054 mbedtls_ssl_protocol_version min_tls_version,
8055 mbedtls_ssl_protocol_version max_tls_version )
8056{
8057 (void) ssl;
8058
8059 if( suite_info == NULL )
8060 return( -1 );
8061
8062 if( ( suite_info->min_tls_version > max_tls_version ) ||
8063 ( suite_info->max_tls_version < min_tls_version ) )
8064 {
8065 return( -1 );
8066 }
8067
XiaokangQian060d8672022-04-21 09:24:56 +00008068#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008069#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8070 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8071 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8072 {
8073 return( -1 );
8074 }
8075#endif
8076
8077 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8078#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8079 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8080 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8081 {
8082 return( -1 );
8083 }
8084#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8085#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8086
8087 return( 0 );
8088}
8089
XiaokangQianeaf36512022-04-24 09:07:44 +00008090#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8091/*
8092 * Function for writing a signature algorithm extension.
8093 *
8094 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8095 * value (TLS 1.3 RFC8446):
8096 * enum {
8097 * ....
8098 * ecdsa_secp256r1_sha256( 0x0403 ),
8099 * ecdsa_secp384r1_sha384( 0x0503 ),
8100 * ecdsa_secp521r1_sha512( 0x0603 ),
8101 * ....
8102 * } SignatureScheme;
8103 *
8104 * struct {
8105 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8106 * } SignatureSchemeList;
8107 *
8108 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8109 * value (TLS 1.2 RFC5246):
8110 * enum {
8111 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8112 * sha512(6), (255)
8113 * } HashAlgorithm;
8114 *
8115 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8116 * SignatureAlgorithm;
8117 *
8118 * struct {
8119 * HashAlgorithm hash;
8120 * SignatureAlgorithm signature;
8121 * } SignatureAndHashAlgorithm;
8122 *
8123 * SignatureAndHashAlgorithm
8124 * supported_signature_algorithms<2..2^16-2>;
8125 *
8126 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8127 * generalization of the TLS 1.2 signature algorithm extension.
8128 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8129 * `SignatureScheme` field of TLS 1.3
8130 *
8131 */
8132int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8133 const unsigned char *end, size_t *out_len )
8134{
8135 unsigned char *p = buf;
8136 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8137 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8138
8139 *out_len = 0;
8140
8141 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8142
8143 /* Check if we have space for header and length field:
8144 * - extension_type (2 bytes)
8145 * - extension_data_length (2 bytes)
8146 * - supported_signature_algorithms_length (2 bytes)
8147 */
8148 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8149 p += 6;
8150
8151 /*
8152 * Write supported_signature_algorithms
8153 */
8154 supported_sig_alg = p;
8155 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8156 if( sig_alg == NULL )
8157 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8158
8159 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8160 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008161 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8162 *sig_alg,
8163 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
Jerry Yu80dd5db2022-06-22 19:30:32 +08008164 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8165 continue;
8166 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8167 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8168 p += 2;
8169 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008170 *sig_alg,
8171 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008172 }
8173
8174 /* Length of supported_signature_algorithms */
8175 supported_sig_alg_len = p - supported_sig_alg;
8176 if( supported_sig_alg_len == 0 )
8177 {
8178 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8179 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8180 }
8181
XiaokangQianeaf36512022-04-24 09:07:44 +00008182 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008183 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008184 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8185
XiaokangQianeaf36512022-04-24 09:07:44 +00008186 *out_len = p - buf;
8187
8188#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8189 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8190#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8191 return( 0 );
8192}
8193#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8194
XiaokangQian40a35232022-05-07 09:02:40 +00008195#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008196/*
8197 * mbedtls_ssl_parse_server_name_ext
8198 *
8199 * Structure of server_name extension:
8200 *
8201 * enum {
8202 * host_name(0), (255)
8203 * } NameType;
8204 * opaque HostName<1..2^16-1>;
8205 *
8206 * struct {
8207 * NameType name_type;
8208 * select (name_type) {
8209 * case host_name: HostName;
8210 * } name;
8211 * } ServerName;
8212 * struct {
8213 * ServerName server_name_list<1..2^16-1>
8214 * } ServerNameList;
8215 */
8216int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8217 const unsigned char *buf,
8218 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008219{
8220 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8221 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008222 size_t server_name_list_len, hostname_len;
8223 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008224
XiaokangQianf2a94202022-05-20 06:44:24 +00008225 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008226
8227 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008228 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008229 p += 2;
8230
XiaokangQian9b2b7712022-05-17 02:57:00 +00008231 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8232 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008233 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008234 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008235 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008236 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008237 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8238 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008239
8240 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8241 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008242 /* sni_name is intended to be used only during the parsing of the
8243 * ClientHello message (it is reset to NULL before the end of
8244 * the message parsing). Thus it is ok to just point to the
8245 * reception buffer and not make a copy of it.
8246 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008247 ssl->handshake->sni_name = p + 3;
8248 ssl->handshake->sni_name_len = hostname_len;
8249 if( ssl->conf->f_sni == NULL )
8250 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008251 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008252 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008253 if( ret != 0 )
8254 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008255 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008256 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8257 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008258 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8259 }
8260 return( 0 );
8261 }
8262
8263 p += hostname_len + 3;
8264 }
8265
8266 return( 0 );
8267}
8268#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8269
XiaokangQianacb39922022-06-17 10:18:48 +00008270#if defined(MBEDTLS_SSL_ALPN)
8271int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8272 const unsigned char *buf,
8273 const unsigned char *end )
8274{
8275 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008276 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008277 const unsigned char *protocol_name_list;
8278 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008279 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008280
8281 /* If ALPN not configured, just ignore the extension */
8282 if( ssl->conf->alpn_list == NULL )
8283 return( 0 );
8284
8285 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008286 * RFC7301, section 3.1
8287 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008288 *
XiaokangQianc7403452022-06-23 03:24:12 +00008289 * struct {
8290 * ProtocolName protocol_name_list<2..2^16-1>
8291 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008292 */
8293
XiaokangQianc7403452022-06-23 03:24:12 +00008294 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008295 * protocol_name_list_len 2 bytes
8296 * protocol_name_len 1 bytes
8297 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008298 */
XiaokangQianacb39922022-06-17 10:18:48 +00008299 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8300
XiaokangQianc7403452022-06-23 03:24:12 +00008301 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008302 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008303 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008304 protocol_name_list = p;
8305 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008306
8307 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008308 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008309 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008310 protocol_name_len = *p++;
8311 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8312 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008313 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008314 {
8315 MBEDTLS_SSL_PEND_FATAL_ALERT(
8316 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8317 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008318 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008319 }
8320
8321 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008322 }
8323
8324 /* Use our order of preference */
8325 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8326 {
8327 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008328 p = protocol_name_list;
8329 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008330 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008331 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008332 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008333 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008334 {
8335 ssl->alpn_chosen = *alpn;
8336 return( 0 );
8337 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008338
8339 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008340 }
8341 }
8342
XiaokangQian95d5f542022-06-24 02:29:26 +00008343 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008344 MBEDTLS_SSL_PEND_FATAL_ALERT(
8345 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8346 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8347 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8348}
8349
8350int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8351 unsigned char *buf,
8352 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008353 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008354{
8355 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008356 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008357 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008358
8359 if( ssl->alpn_chosen == NULL )
8360 {
8361 return( 0 );
8362 }
8363
XiaokangQian95d5f542022-06-24 02:29:26 +00008364 protocol_name_len = strlen( ssl->alpn_chosen );
8365 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008366
8367 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8368 /*
8369 * 0 . 1 ext identifier
8370 * 2 . 3 ext length
8371 * 4 . 5 protocol list length
8372 * 6 . 6 protocol name length
8373 * 7 . 7+n protocol name
8374 */
8375 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8376
XiaokangQian95d5f542022-06-24 02:29:26 +00008377 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008378
XiaokangQian95d5f542022-06-24 02:29:26 +00008379 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8380 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008381 /* Note: the length of the chosen protocol has been checked to be less
8382 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8383 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008384 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008385
XiaokangQian95d5f542022-06-24 02:29:26 +00008386 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008387 return ( 0 );
8388}
8389#endif /* MBEDTLS_SSL_ALPN */
8390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008391#endif /* MBEDTLS_SSL_TLS_C */