blob: 85cfa488af211765c0f204afa9d2fdc27cd7cac1 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800387 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200388#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800389 ssl_tls_prf_t tls_prf,
390 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400391 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800392 unsigned endpoint,
393 const mbedtls_ssl_context *ssl );
394
395#if defined(MBEDTLS_SHA256_C)
396static int tls_prf_sha256( const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen );
400static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
401static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
402
403#endif /* MBEDTLS_SHA256_C */
404
405#if defined(MBEDTLS_SHA384_C)
406static int tls_prf_sha384( const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen );
410
411static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
412static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
413#endif /* MBEDTLS_SHA384_C */
414
415static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
416 unsigned char *buf,
417 size_t buf_len );
418static int ssl_session_load_tls12( mbedtls_ssl_session *session,
419 const unsigned char *buf,
420 size_t len );
421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
422
Jerry Yu53d23e22022-02-09 16:25:09 +0800423static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
424
Jerry Yudb8c48a2022-01-27 14:54:54 +0800425#if defined(MBEDTLS_SHA256_C)
426static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800427#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800428
429#if defined(MBEDTLS_SHA384_C)
430static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800431#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000432
Ron Eldor51d3ab52019-05-12 14:54:30 +0300433int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
434 const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen )
438{
439 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
440
441 switch( prf )
442 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300443#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200444#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300445 case MBEDTLS_SSL_TLS_PRF_SHA384:
446 tls_prf = tls_prf_sha384;
447 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200448#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300449#if defined(MBEDTLS_SHA256_C)
450 case MBEDTLS_SSL_TLS_PRF_SHA256:
451 tls_prf = tls_prf_sha256;
452 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300453#endif /* MBEDTLS_SHA256_C */
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300455 default:
456 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
457 }
458
459 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
460}
461
Jerry Yuc73c6182022-02-08 20:29:25 +0800462#if defined(MBEDTLS_X509_CRT_PARSE_C)
463static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
464{
465#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
466 if( session->peer_cert != NULL )
467 {
468 mbedtls_x509_crt_free( session->peer_cert );
469 mbedtls_free( session->peer_cert );
470 session->peer_cert = NULL;
471 }
472#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
473 if( session->peer_cert_digest != NULL )
474 {
475 /* Zeroization is not necessary. */
476 mbedtls_free( session->peer_cert_digest );
477 session->peer_cert_digest = NULL;
478 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
479 session->peer_cert_digest_len = 0;
480 }
481#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
482}
483#endif /* MBEDTLS_X509_CRT_PARSE_C */
484
485void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
487{
488 ((void) ciphersuite_info);
489
490#if defined(MBEDTLS_SHA384_C)
491 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
492 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
493 else
494#endif
495#if defined(MBEDTLS_SHA256_C)
496 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
497 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
498 else
499#endif
500 {
501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
502 return;
503 }
504}
505
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100506static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
507 unsigned hs_type,
508 size_t total_hs_len )
509{
510 unsigned char hs_hdr[4];
511
512 /* Build HS header for checksum update. */
513 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
514 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
515 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
516 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
517
518 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
519}
520
521void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
522 unsigned hs_type,
523 unsigned char const *msg,
524 size_t msg_len )
525{
526 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
527 ssl->handshake->update_checksum( ssl, msg, msg_len );
528}
529
Jerry Yuc73c6182022-02-08 20:29:25 +0800530void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
531{
532 ((void) ssl);
533#if defined(MBEDTLS_SHA256_C)
534#if defined(MBEDTLS_USE_PSA_CRYPTO)
535 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
536 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
537#else
538 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
539#endif
540#endif
541#if defined(MBEDTLS_SHA384_C)
542#if defined(MBEDTLS_USE_PSA_CRYPTO)
543 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
544 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
545#else
546 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
547#endif
548#endif
549}
550
551static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
552 const unsigned char *buf, size_t len )
553{
554#if defined(MBEDTLS_SHA256_C)
555#if defined(MBEDTLS_USE_PSA_CRYPTO)
556 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
557#else
558 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
559#endif
560#endif
561#if defined(MBEDTLS_SHA384_C)
562#if defined(MBEDTLS_USE_PSA_CRYPTO)
563 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
564#else
565 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
566#endif
567#endif
568}
569
570#if defined(MBEDTLS_SHA256_C)
571static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
572 const unsigned char *buf, size_t len )
573{
574#if defined(MBEDTLS_USE_PSA_CRYPTO)
575 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
576#else
577 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
578#endif
579}
580#endif
581
582#if defined(MBEDTLS_SHA384_C)
583static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
584 const unsigned char *buf, size_t len )
585{
586#if defined(MBEDTLS_USE_PSA_CRYPTO)
587 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
588#else
589 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
590#endif
591}
592#endif
593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200595{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500599#if defined(MBEDTLS_USE_PSA_CRYPTO)
600 handshake->fin_sha256_psa = psa_hash_operation_init();
601 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
602#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200604 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200605#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500606#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200607#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500609 handshake->fin_sha384_psa = psa_hash_operation_init();
610 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500611#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200613 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200614#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500615#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616
617 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100618
619#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100620 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100621 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
622#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#if defined(MBEDTLS_DHM_C)
625 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200626#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200627#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200629#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200630#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200632#if defined(MBEDTLS_SSL_CLI_C)
633 handshake->ecjpake_cache = NULL;
634 handshake->ecjpake_cache_len = 0;
635#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200636#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200637
Gilles Peskineeccd8882020-03-10 12:19:08 +0100638#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200639 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200640#endif
641
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200642#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
643 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
644#endif
Hanno Becker75173122019-02-06 16:18:31 +0000645
646#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
647 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
648 mbedtls_pk_init( &handshake->peer_pubkey );
649#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200650}
651
Hanno Beckera18d1322018-01-03 14:27:32 +0000652void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200653{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200655
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
658 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100659#else
660 mbedtls_cipher_init( &transform->cipher_ctx_enc );
661 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100662#endif
663
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100665#if defined(MBEDTLS_USE_PSA_CRYPTO)
666 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
667 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100668#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 mbedtls_md_init( &transform->md_ctx_enc );
670 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000671#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100672#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200673}
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200676{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678}
679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000681{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200682 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000683 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200685 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200688 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689
690 /*
691 * Either the pointers are now NULL or cleared properly and can be freed.
692 * Now allocate missing structures.
693 */
694 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200695 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200696 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 }
Paul Bakker48916f92012-09-16 19:57:18 +0000698
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200699 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200700 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200701 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 }
Paul Bakker48916f92012-09-16 19:57:18 +0000703
Paul Bakker82788fb2014-10-20 13:59:19 +0200704 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200705 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200706 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500708#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
709 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400710
Andrzej Kurek4a063792020-10-21 15:08:44 +0200711 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
712 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500713#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000714
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000716 if( ssl->handshake == NULL ||
717 ssl->transform_negotiate == NULL ||
718 ssl->session_negotiate == NULL )
719 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200720 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 mbedtls_free( ssl->handshake );
723 mbedtls_free( ssl->transform_negotiate );
724 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725
726 ssl->handshake = NULL;
727 ssl->transform_negotiate = NULL;
728 ssl->session_negotiate = NULL;
729
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200730 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000731 }
732
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200733 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200734 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000735 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200736 ssl_handshake_params_init( ssl->handshake );
737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200739 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
740 {
741 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200742
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200743 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
744 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
745 else
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200747
Hanno Becker0f57a652020-02-05 10:37:26 +0000748 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200749 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200750#endif
751
Brett Warrene0edc842021-08-17 09:53:13 +0100752/*
753 * curve_list is translated to IANA TLS group identifiers here because
754 * mbedtls_ssl_conf_curves returns void and so can't return
755 * any error codes.
756 */
757#if defined(MBEDTLS_ECP_C)
758#if !defined(MBEDTLS_DEPRECATED_REMOVED)
759 /* Heap allocate and translate curve_list from internal to IANA group ids */
760 if ( ssl->conf->curve_list != NULL )
761 {
762 size_t length;
763 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
764
765 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
766 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
767
768 /* Leave room for zero termination */
769 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
770 if ( group_list == NULL )
771 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
772
773 for( size_t i = 0; i < length; i++ )
774 {
775 const mbedtls_ecp_curve_info *info =
776 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
777 if ( info == NULL )
778 {
779 mbedtls_free( group_list );
780 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
781 }
782 group_list[i] = info->tls_id;
783 }
784
785 group_list[length] = 0;
786
787 ssl->handshake->group_list = group_list;
788 ssl->handshake->group_list_heap_allocated = 1;
789 }
790 else
791 {
792 ssl->handshake->group_list = ssl->conf->group_list;
793 ssl->handshake->group_list_heap_allocated = 0;
794 }
795#endif /* MBEDTLS_DEPRECATED_REMOVED */
796#endif /* MBEDTLS_ECP_C */
797
Jerry Yuf017ee42022-01-12 15:49:48 +0800798#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
799#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800800#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800801 /* Heap allocate and translate sig_hashes from internal hash identifiers to
802 signature algorithms IANA identifiers. */
803 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800804 ssl->conf->sig_hashes != NULL )
805 {
806 const int *md;
807 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800808 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800809 uint16_t *p;
810
Jerry Yub476a442022-01-21 18:14:45 +0800811#if defined(static_assert)
812 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
813 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
814 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800815#endif
816
Jerry Yuf017ee42022-01-12 15:49:48 +0800817 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
818 {
819 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
820 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800821#if defined(MBEDTLS_ECDSA_C)
822 sig_algs_len += sizeof( uint16_t );
823#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800824
Jerry Yub476a442022-01-21 18:14:45 +0800825#if defined(MBEDTLS_RSA_C)
826 sig_algs_len += sizeof( uint16_t );
827#endif
828 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
829 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 }
831
Jerry Yub476a442022-01-21 18:14:45 +0800832 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800833 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
834
Jerry Yub476a442022-01-21 18:14:45 +0800835 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
836 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800837 if( ssl->handshake->sig_algs == NULL )
838 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
839
840 p = (uint16_t *)ssl->handshake->sig_algs;
841 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
842 {
843 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
844 if( hash == MBEDTLS_SSL_HASH_NONE )
845 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800846#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800847 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
848 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800849#endif
850#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800851 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
852 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800853#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800854 }
855 *p = MBEDTLS_TLS1_3_SIG_NONE;
856 ssl->handshake->sig_algs_heap_allocated = 1;
857 }
858 else
Jerry Yua69269a2022-01-17 21:06:01 +0800859#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800860 {
861 ssl->handshake->sig_algs = ssl->conf->sig_algs;
862 ssl->handshake->sig_algs_heap_allocated = 0;
863 }
864#endif /* MBEDTLS_DEPRECATED_REMOVED */
865#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000866 return( 0 );
867}
868
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200869#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200870/* Dummy cookie callbacks for defaults */
871static int ssl_cookie_write_dummy( void *ctx,
872 unsigned char **p, unsigned char *end,
873 const unsigned char *cli_id, size_t cli_id_len )
874{
875 ((void) ctx);
876 ((void) p);
877 ((void) end);
878 ((void) cli_id);
879 ((void) cli_id_len);
880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200882}
883
884static int ssl_cookie_check_dummy( void *ctx,
885 const unsigned char *cookie, size_t cookie_len,
886 const unsigned char *cli_id, size_t cli_id_len )
887{
888 ((void) ctx);
889 ((void) cookie);
890 ((void) cookie_len);
891 ((void) cli_id);
892 ((void) cli_id_len);
893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200896#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897
Paul Bakker5121ce52009-01-03 21:22:43 +0000898/*
899 * Initialize an SSL context
900 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200901void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
902{
903 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
904}
905
Jerry Yu60835a82021-08-04 10:13:52 +0800906static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
907{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100908 const mbedtls_ssl_config *conf = ssl->conf;
909
Ronald Cron6f135e12021-12-08 16:57:54 +0100910#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100911 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
912 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000913 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
914 {
915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
916 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
917 }
918
Jerry Yu60835a82021-08-04 10:13:52 +0800919 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
920 return( 0 );
921 }
922#endif
923
924#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100925 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800926 {
927 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
928 return( 0 );
929 }
930#endif
931
Ronald Cron6f135e12021-12-08 16:57:54 +0100932#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100933 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800934 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000935 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
936 {
937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
938 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
939 }
940
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000941 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
947
Ronald Crone1d3f062022-02-10 14:50:54 +0100948 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
949 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800950 }
951#endif
952
953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
954 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
955}
956
957static int ssl_conf_check(const mbedtls_ssl_context *ssl)
958{
959 int ret;
960 ret = ssl_conf_version_check( ssl );
961 if( ret != 0 )
962 return( ret );
963
964 /* Space for further checks */
965
966 return( 0 );
967}
968
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200969/*
970 * Setup an SSL context
971 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100972
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200973int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200974 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000975{
Janos Follath865b3eb2019-12-16 11:46:15 +0000976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000977 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
978 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000979
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200980 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000981
Jerry Yu60835a82021-08-04 10:13:52 +0800982 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
983 return( ret );
984
Paul Bakker62f2dee2012-09-28 07:31:51 +0000985 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100986 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000987 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200988
989 /* Set to NULL in case of an error condition */
990 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200991
Darryl Greenb33cc762019-11-28 14:29:44 +0000992#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
993 ssl->in_buf_len = in_buf_len;
994#endif
995 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000996 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000997 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200999 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001000 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001001 }
1002
Darryl Greenb33cc762019-11-28 14:29:44 +00001003#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1004 ssl->out_buf_len = out_buf_len;
1005#endif
1006 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001007 if( ssl->out_buf == NULL )
1008 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001010 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001011 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001012 }
1013
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001014 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001015
Johan Pascalb62bb512015-12-03 21:56:45 +01001016#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001017 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001018#endif
1019
Paul Bakker48916f92012-09-16 19:57:18 +00001020 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001021 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001022
1023 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001024
1025error:
1026 mbedtls_free( ssl->in_buf );
1027 mbedtls_free( ssl->out_buf );
1028
1029 ssl->conf = NULL;
1030
Darryl Greenb33cc762019-11-28 14:29:44 +00001031#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1032 ssl->in_buf_len = 0;
1033 ssl->out_buf_len = 0;
1034#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001035 ssl->in_buf = NULL;
1036 ssl->out_buf = NULL;
1037
1038 ssl->in_hdr = NULL;
1039 ssl->in_ctr = NULL;
1040 ssl->in_len = NULL;
1041 ssl->in_iv = NULL;
1042 ssl->in_msg = NULL;
1043
1044 ssl->out_hdr = NULL;
1045 ssl->out_ctr = NULL;
1046 ssl->out_len = NULL;
1047 ssl->out_iv = NULL;
1048 ssl->out_msg = NULL;
1049
k-stachowiak9f7798e2018-07-31 16:52:32 +02001050 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001051}
1052
1053/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001054 * Reset an initialized and used SSL context for re-use while retaining
1055 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001056 *
1057 * If partial is non-zero, keep data in the input buffer and client ID.
1058 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001059 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001060void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1061 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001062{
Darryl Greenb33cc762019-11-28 14:29:44 +00001063#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1064 size_t in_buf_len = ssl->in_buf_len;
1065 size_t out_buf_len = ssl->out_buf_len;
1066#else
1067 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1068 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1069#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001070
Hanno Beckerb0302c42021-08-03 09:39:42 +01001071#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1072 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001073#endif
1074
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001075 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001076 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001077
Hanno Beckerb0302c42021-08-03 09:39:42 +01001078 mbedtls_ssl_reset_in_out_pointers( ssl );
1079
1080 /* Reset incoming message parsing */
1081 ssl->in_offt = NULL;
1082 ssl->nb_zero = 0;
1083 ssl->in_msgtype = 0;
1084 ssl->in_msglen = 0;
1085 ssl->in_hslen = 0;
1086 ssl->keep_current_message = 0;
1087 ssl->transform_in = NULL;
1088
1089#if defined(MBEDTLS_SSL_PROTO_DTLS)
1090 ssl->next_record_offset = 0;
1091 ssl->in_epoch = 0;
1092#endif
1093
1094 /* Keep current datagram if partial == 1 */
1095 if( partial == 0 )
1096 {
1097 ssl->in_left = 0;
1098 memset( ssl->in_buf, 0, in_buf_len );
1099 }
1100
1101 /* Reset outgoing message writing */
1102 ssl->out_msgtype = 0;
1103 ssl->out_msglen = 0;
1104 ssl->out_left = 0;
1105 memset( ssl->out_buf, 0, out_buf_len );
1106 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1107 ssl->transform_out = NULL;
1108
1109#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1110 mbedtls_ssl_dtls_replay_reset( ssl );
1111#endif
1112
XiaokangQian2b01dc32022-01-21 02:53:13 +00001113#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001114 if( ssl->transform )
1115 {
1116 mbedtls_ssl_transform_free( ssl->transform );
1117 mbedtls_free( ssl->transform );
1118 ssl->transform = NULL;
1119 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001120#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1121
XiaokangQian2b01dc32022-01-21 02:53:13 +00001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1123 mbedtls_ssl_transform_free( ssl->transform_application );
1124 mbedtls_free( ssl->transform_application );
1125 ssl->transform_application = NULL;
1126
1127 if( ssl->handshake != NULL )
1128 {
1129 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1130 mbedtls_free( ssl->handshake->transform_earlydata );
1131 ssl->handshake->transform_earlydata = NULL;
1132
1133 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1134 mbedtls_free( ssl->handshake->transform_handshake );
1135 ssl->handshake->transform_handshake = NULL;
1136 }
1137
XiaokangQian2b01dc32022-01-21 02:53:13 +00001138#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001139}
1140
1141int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1142{
1143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1144
1145 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1146
XiaokangQian78b1fa72022-01-19 06:56:30 +00001147 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001148
1149 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150#if defined(MBEDTLS_SSL_RENEGOTIATION)
1151 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001152 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001153
1154 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1156 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001157#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001159
Hanno Beckerb0302c42021-08-03 09:39:42 +01001160 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001161 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001162 if( ssl->session )
1163 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 mbedtls_ssl_session_free( ssl->session );
1165 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001166 ssl->session = NULL;
1167 }
1168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001170 ssl->alpn_chosen = NULL;
1171#endif
1172
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001173#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001174#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001175 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001176#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001177 {
1178 mbedtls_free( ssl->cli_id );
1179 ssl->cli_id = NULL;
1180 ssl->cli_id_len = 0;
1181 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001182#endif
1183
Paul Bakker48916f92012-09-16 19:57:18 +00001184 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1185 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001186
1187 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001188}
1189
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001190/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001191 * Reset an initialized and used SSL context for re-use while retaining
1192 * all application-set variables, function pointers and data.
1193 */
1194int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1195{
Hanno Becker43aefe22020-02-05 10:44:56 +00001196 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001197}
1198
1199/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001200 * SSL set accessors
1201 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001202void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001203{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001204 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001205}
1206
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001207void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001209 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001210}
1211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001212#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001213void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001215 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001216}
1217#endif
1218
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001219void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001220{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001221 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001222}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001225
Hanno Becker1841b0a2018-08-24 11:13:57 +01001226void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1227 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001228{
1229 ssl->disable_datagram_packing = !allow_packing;
1230}
1231
1232void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1233 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->hs_timeout_min = min;
1236 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001237}
1238#endif
1239
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001240void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001243}
1244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001246void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001247 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001248 void *p_vrfy )
1249{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001250 conf->f_vrfy = f_vrfy;
1251 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001252}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001254
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001255void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001256 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001257 void *p_rng )
1258{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001259 conf->f_rng = f_rng;
1260 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001261}
1262
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001263void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001264 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001265 void *p_dbg )
1266{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001267 conf->f_dbg = f_dbg;
1268 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001269}
1270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001272 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001273 mbedtls_ssl_send_t *f_send,
1274 mbedtls_ssl_recv_t *f_recv,
1275 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001276{
1277 ssl->p_bio = p_bio;
1278 ssl->f_send = f_send;
1279 ssl->f_recv = f_recv;
1280 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001281}
1282
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001283#if defined(MBEDTLS_SSL_PROTO_DTLS)
1284void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1285{
1286 ssl->mtu = mtu;
1287}
1288#endif
1289
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001290void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001291{
1292 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001293}
1294
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001295void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1296 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001297 mbedtls_ssl_set_timer_t *f_set_timer,
1298 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001299{
1300 ssl->p_timer = p_timer;
1301 ssl->f_set_timer = f_set_timer;
1302 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001303
1304 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001305 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001306}
1307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001309void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001310 void *p_cache,
1311 mbedtls_ssl_cache_get_t *f_get_cache,
1312 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001313{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001314 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001315 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001316 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001317}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#if defined(MBEDTLS_SSL_CLI_C)
1321int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001322{
Janos Follath865b3eb2019-12-16 11:46:15 +00001323 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001324
1325 if( ssl == NULL ||
1326 session == NULL ||
1327 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001328 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001331 }
1332
Hanno Beckere810bbc2021-05-14 16:01:05 +01001333 if( ssl->handshake->resume == 1 )
1334 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1335
Hanno Becker52055ae2019-02-06 14:30:46 +00001336 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1337 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001338 return( ret );
1339
Paul Bakker0a597072012-09-25 21:55:46 +00001340 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001341
1342 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001343}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001345
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001346void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1347 const int *ciphersuites )
1348{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001349 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001350}
1351
Ronald Cron6f135e12021-12-08 16:57:54 +01001352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001353void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001354 const int kex_modes )
1355{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001356 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001357}
Ronald Cron6f135e12021-12-08 16:57:54 +01001358#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001361void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001362 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001363{
1364 conf->cert_profile = profile;
1365}
1366
Glenn Strauss36872db2022-01-22 05:06:31 -05001367static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1368{
1369 mbedtls_ssl_key_cert *cur = key_cert, *next;
1370
1371 while( cur != NULL )
1372 {
1373 next = cur->next;
1374 mbedtls_free( cur );
1375 cur = next;
1376 }
1377}
1378
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001379/* Append a new keycert entry to a (possibly empty) list */
1380static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1381 mbedtls_x509_crt *cert,
1382 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001383{
niisato8ee24222018-06-25 19:05:48 +09001384 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001385
Glenn Strauss36872db2022-01-22 05:06:31 -05001386 if( cert == NULL )
1387 {
1388 /* Free list if cert is null */
1389 ssl_key_cert_free( *head );
1390 *head = NULL;
1391 return( 0 );
1392 }
1393
niisato8ee24222018-06-25 19:05:48 +09001394 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1395 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001396 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001397
niisato8ee24222018-06-25 19:05:48 +09001398 new_cert->cert = cert;
1399 new_cert->key = key;
1400 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001401
Glenn Strauss36872db2022-01-22 05:06:31 -05001402 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001403 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001404 {
niisato8ee24222018-06-25 19:05:48 +09001405 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001406 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001407 else
1408 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001409 mbedtls_ssl_key_cert *cur = *head;
1410 while( cur->next != NULL )
1411 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001412 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001413 }
1414
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001415 return( 0 );
1416}
1417
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001418int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001419 mbedtls_x509_crt *own_cert,
1420 mbedtls_pk_context *pk_key )
1421{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001422 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001423}
1424
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001425void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001426 mbedtls_x509_crt *ca_chain,
1427 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001428{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001429 conf->ca_chain = ca_chain;
1430 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001431
1432#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1433 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1434 * cannot be used together. */
1435 conf->f_ca_cb = NULL;
1436 conf->p_ca_cb = NULL;
1437#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001438}
Hanno Becker5adaad92019-03-27 16:54:37 +00001439
1440#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1441void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001442 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001443 void *p_ca_cb )
1444{
1445 conf->f_ca_cb = f_ca_cb;
1446 conf->p_ca_cb = p_ca_cb;
1447
1448 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1449 * cannot be used together. */
1450 conf->ca_chain = NULL;
1451 conf->ca_crl = NULL;
1452}
1453#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001455
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001456#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001457const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1458 size_t *name_len )
1459{
1460 *name_len = ssl->handshake->sni_name_len;
1461 return( ssl->handshake->sni_name );
1462}
1463
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001464int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1465 mbedtls_x509_crt *own_cert,
1466 mbedtls_pk_context *pk_key )
1467{
1468 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1469 own_cert, pk_key ) );
1470}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001471
1472void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1473 mbedtls_x509_crt *ca_chain,
1474 mbedtls_x509_crl *ca_crl )
1475{
1476 ssl->handshake->sni_ca_chain = ca_chain;
1477 ssl->handshake->sni_ca_crl = ca_crl;
1478}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001479
1480void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1481 int authmode )
1482{
1483 ssl->handshake->sni_authmode = authmode;
1484}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001485#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1486
Hanno Becker8927c832019-04-03 12:52:50 +01001487#if defined(MBEDTLS_X509_CRT_PARSE_C)
1488void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1489 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1490 void *p_vrfy )
1491{
1492 ssl->f_vrfy = f_vrfy;
1493 ssl->p_vrfy = p_vrfy;
1494}
1495#endif
1496
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001497#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001498/*
1499 * Set EC J-PAKE password for current handshake
1500 */
1501int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1502 const unsigned char *pw,
1503 size_t pw_len )
1504{
1505 mbedtls_ecjpake_role role;
1506
Janos Follath8eb64132016-06-03 15:40:57 +01001507 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001508 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1509
1510 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1511 role = MBEDTLS_ECJPAKE_SERVER;
1512 else
1513 role = MBEDTLS_ECJPAKE_CLIENT;
1514
1515 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1516 role,
1517 MBEDTLS_MD_SHA256,
1518 MBEDTLS_ECP_DP_SECP256R1,
1519 pw, pw_len ) );
1520}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001521#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001522
Gilles Peskineeccd8882020-03-10 12:19:08 +01001523#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001524
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001525static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1526{
1527#if defined(MBEDTLS_USE_PSA_CRYPTO)
1528 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1529 return( 1 );
1530#endif /* MBEDTLS_USE_PSA_CRYPTO */
1531
1532 if( conf->psk != NULL )
1533 return( 1 );
1534
1535 return( 0 );
1536}
1537
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001538static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1539{
1540 /* Remove reference to existing PSK, if any. */
1541#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001542 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001543 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001544 /* The maintenance of the external PSK key slot is the
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545 * user's responsibility. */
Neil Armstrong501c9322022-05-03 09:35:09 +02001546 if( conf->psk_opaque_is_internal )
1547 {
1548 psa_destroy_key( conf->psk_opaque );
1549 conf->psk_opaque_is_internal = 0;
1550 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001551 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001552 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001553 /* This and the following branch should never
1554 * be taken simultaenously as we maintain the
1555 * invariant that raw and opaque PSKs are never
1556 * configured simultaneously. As a safeguard,
1557 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001558#endif /* MBEDTLS_USE_PSA_CRYPTO */
1559 if( conf->psk != NULL )
1560 {
1561 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1562
1563 mbedtls_free( conf->psk );
1564 conf->psk = NULL;
1565 conf->psk_len = 0;
1566 }
1567
1568 /* Remove reference to PSK identity, if any. */
1569 if( conf->psk_identity != NULL )
1570 {
1571 mbedtls_free( conf->psk_identity );
1572 conf->psk_identity = NULL;
1573 conf->psk_identity_len = 0;
1574 }
1575}
1576
Hanno Becker7390c712018-11-15 13:33:04 +00001577/* This function assumes that PSK identity in the SSL config is unset.
1578 * It checks that the provided identity is well-formed and attempts
1579 * to make a copy of it in the SSL config.
1580 * On failure, the PSK identity in the config remains unset. */
1581static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1582 unsigned char const *psk_identity,
1583 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001584{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001585 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001586 if( psk_identity == NULL ||
1587 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001588 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001589 {
1590 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1591 }
1592
Hanno Becker7390c712018-11-15 13:33:04 +00001593 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1594 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001595 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001596
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001597 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001598 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001599
1600 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001601}
1602
Hanno Becker7390c712018-11-15 13:33:04 +00001603int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1604 const unsigned char *psk, size_t psk_len,
1605 const unsigned char *psk_identity, size_t psk_identity_len )
1606{
Janos Follath865b3eb2019-12-16 11:46:15 +00001607 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong501c9322022-05-03 09:35:09 +02001608#if defined(MBEDTLS_USE_PSA_CRYPTO)
1609 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1610 psa_status_t status;
1611 mbedtls_svc_key_id_t key;
1612#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001613
1614 /* We currently only support one PSK, raw or opaque. */
1615 if( ssl_conf_psk_is_configured( conf ) )
1616 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001617
1618 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001619 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001620 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001621 if( psk_len == 0 )
1622 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1623 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1624 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1625
Neil Armstrong501c9322022-05-03 09:35:09 +02001626#if defined(MBEDTLS_USE_PSA_CRYPTO)
1627 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1628 psa_set_key_algorithm( &key_attributes,
1629 PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256) );
1630 psa_set_key_enrollment_algorithm( &key_attributes,
1631 PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384) );
1632 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1633
1634 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1635 if( status != PSA_SUCCESS )
1636 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1637
1638 /* Allow calling psa_destroy_key() on config psk remove/free */
1639 conf->psk_opaque_is_internal = 1;
1640 ret = mbedtls_ssl_conf_psk_opaque( conf, key,
1641 psk_identity, psk_identity_len );
1642#else
Hanno Becker7390c712018-11-15 13:33:04 +00001643 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1644 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1645 conf->psk_len = psk_len;
1646 memcpy( conf->psk, psk, conf->psk_len );
1647
1648 /* Check and set PSK Identity */
1649 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1650 if( ret != 0 )
1651 ssl_conf_remove_psk( conf );
Neil Armstrong501c9322022-05-03 09:35:09 +02001652#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker7390c712018-11-15 13:33:04 +00001653
1654 return( ret );
1655}
1656
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001657static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1658{
1659#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001660 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001661 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001662 /* The maintenance of the external PSK key slot is the
1663 * user's responsibility. */
1664 if( ssl->handshake->psk_opaque_is_internal )
1665 {
1666 psa_destroy_key( ssl->handshake->psk_opaque );
1667 ssl->handshake->psk_opaque_is_internal = 0;
1668 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001669 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001670 }
1671 else
1672#endif /* MBEDTLS_USE_PSA_CRYPTO */
1673 if( ssl->handshake->psk != NULL )
1674 {
1675 mbedtls_platform_zeroize( ssl->handshake->psk,
1676 ssl->handshake->psk_len );
1677 mbedtls_free( ssl->handshake->psk );
1678 ssl->handshake->psk_len = 0;
1679 }
1680}
1681
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001682int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1683 const unsigned char *psk, size_t psk_len )
1684{
Neil Armstrong501c9322022-05-03 09:35:09 +02001685#if defined(MBEDTLS_USE_PSA_CRYPTO)
1686 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1687 psa_status_t status;
1688 psa_algorithm_t alg;
1689 mbedtls_svc_key_id_t key;
1690#endif /* MBEDTLS_USE_PSA_CRYPTO */
1691
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001692 if( psk == NULL || ssl->handshake == NULL )
1693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1694
1695 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1697
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001698 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001699
Neil Armstrong501c9322022-05-03 09:35:09 +02001700#if defined(MBEDTLS_USE_PSA_CRYPTO)
1701 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1702 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1703 else
1704 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1705
1706 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1707 psa_set_key_algorithm( &key_attributes, alg );
1708 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1709
1710 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1711 if( status != PSA_SUCCESS )
1712 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1713
1714 /* Allow calling psa_destroy_key() on psk remove */
1715 ssl->handshake->psk_opaque_is_internal = 1;
1716 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1717#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001718 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001719 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001720
1721 ssl->handshake->psk_len = psk_len;
1722 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1723
1724 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001725#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001726}
1727
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001728#if defined(MBEDTLS_USE_PSA_CRYPTO)
1729int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001730 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001731 const unsigned char *psk_identity,
1732 size_t psk_identity_len )
1733{
Janos Follath865b3eb2019-12-16 11:46:15 +00001734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001735
1736 /* We currently only support one PSK, raw or opaque. */
1737 if( ssl_conf_psk_is_configured( conf ) )
1738 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001739
Hanno Becker7390c712018-11-15 13:33:04 +00001740 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001741 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001742 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001743 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001744
1745 /* Check and set PSK Identity */
1746 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1747 psk_identity_len );
1748 if( ret != 0 )
1749 ssl_conf_remove_psk( conf );
1750
1751 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001752}
1753
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001754int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1755 mbedtls_svc_key_id_t psk )
1756{
1757 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1758 ( ssl->handshake == NULL ) )
1759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1760
1761 ssl_remove_psk( ssl );
1762 ssl->handshake->psk_opaque = psk;
1763 return( 0 );
1764}
1765#endif /* MBEDTLS_USE_PSA_CRYPTO */
1766
1767void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1768 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1769 size_t),
1770 void *p_psk )
1771{
1772 conf->f_psk = f_psk;
1773 conf->p_psk = p_psk;
1774}
1775#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1776
1777#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001778static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1779 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001780{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001781#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001782 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001783 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001784#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001785 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001786 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001787 return( MBEDTLS_SSL_MODE_STREAM );
1788}
1789
1790#else /* MBEDTLS_USE_PSA_CRYPTO */
1791
1792static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1793 mbedtls_cipher_mode_t mode )
1794{
1795#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1796 if( mode == MBEDTLS_MODE_CBC )
1797 return( MBEDTLS_SSL_MODE_CBC );
1798#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1799
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001800#if defined(MBEDTLS_GCM_C) || \
1801 defined(MBEDTLS_CCM_C) || \
1802 defined(MBEDTLS_CHACHAPOLY_C)
1803 if( mode == MBEDTLS_MODE_GCM ||
1804 mode == MBEDTLS_MODE_CCM ||
1805 mode == MBEDTLS_MODE_CHACHAPOLY )
1806 return( MBEDTLS_SSL_MODE_AEAD );
1807#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001808
1809 return( MBEDTLS_SSL_MODE_STREAM );
1810}
Gilles Peskine301711e2022-04-26 16:57:05 +02001811#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001812
Gilles Peskinee108d982022-04-26 16:50:40 +02001813static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1814 mbedtls_ssl_mode_t base_mode,
1815 int encrypt_then_mac )
1816{
1817#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1818 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1819 base_mode == MBEDTLS_SSL_MODE_CBC )
1820 {
1821 return( MBEDTLS_SSL_MODE_CBC_ETM );
1822 }
1823#else
1824 (void) encrypt_then_mac;
1825#endif
1826 return( base_mode );
1827}
1828
Neil Armstrongab555e02022-04-04 11:07:59 +02001829mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001830 const mbedtls_ssl_transform *transform )
1831{
Gilles Peskinee108d982022-04-26 16:50:40 +02001832 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001833#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001834 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001835#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001836 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1837#endif
1838 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001839
Gilles Peskinee108d982022-04-26 16:50:40 +02001840 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001841#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001842 encrypt_then_mac = transform->encrypt_then_mac;
1843#endif
1844 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001845}
1846
Neil Armstrongab555e02022-04-04 11:07:59 +02001847mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001848#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001849 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001850#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001851 const mbedtls_ssl_ciphersuite_t *suite )
1852{
Gilles Peskinee108d982022-04-26 16:50:40 +02001853 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1854
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001855#if defined(MBEDTLS_USE_PSA_CRYPTO)
1856 psa_status_t status;
1857 psa_algorithm_t alg;
1858 psa_key_type_t type;
1859 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001860 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1861 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001862 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001863#else
1864 const mbedtls_cipher_info_t *cipher =
1865 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001866 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001867 {
1868 base_mode =
1869 mbedtls_ssl_get_base_mode(
1870 mbedtls_cipher_info_get_mode( cipher ) );
1871 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001872#endif /* MBEDTLS_USE_PSA_CRYPTO */
1873
Gilles Peskinee108d982022-04-26 16:50:40 +02001874#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1875 int encrypt_then_mac = 0;
1876#endif
1877 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001878}
1879
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001880#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001881psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001882 size_t taglen,
1883 psa_algorithm_t *alg,
1884 psa_key_type_t *key_type,
1885 size_t *key_size )
1886{
1887 switch ( mbedtls_cipher_type )
1888 {
1889 case MBEDTLS_CIPHER_AES_128_CBC:
1890 *alg = PSA_ALG_CBC_NO_PADDING;
1891 *key_type = PSA_KEY_TYPE_AES;
1892 *key_size = 128;
1893 break;
1894 case MBEDTLS_CIPHER_AES_128_CCM:
1895 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1896 *key_type = PSA_KEY_TYPE_AES;
1897 *key_size = 128;
1898 break;
1899 case MBEDTLS_CIPHER_AES_128_GCM:
1900 *alg = PSA_ALG_GCM;
1901 *key_type = PSA_KEY_TYPE_AES;
1902 *key_size = 128;
1903 break;
1904 case MBEDTLS_CIPHER_AES_192_CCM:
1905 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1906 *key_type = PSA_KEY_TYPE_AES;
1907 *key_size = 192;
1908 break;
1909 case MBEDTLS_CIPHER_AES_192_GCM:
1910 *alg = PSA_ALG_GCM;
1911 *key_type = PSA_KEY_TYPE_AES;
1912 *key_size = 192;
1913 break;
1914 case MBEDTLS_CIPHER_AES_256_CBC:
1915 *alg = PSA_ALG_CBC_NO_PADDING;
1916 *key_type = PSA_KEY_TYPE_AES;
1917 *key_size = 256;
1918 break;
1919 case MBEDTLS_CIPHER_AES_256_CCM:
1920 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1921 *key_type = PSA_KEY_TYPE_AES;
1922 *key_size = 256;
1923 break;
1924 case MBEDTLS_CIPHER_AES_256_GCM:
1925 *alg = PSA_ALG_GCM;
1926 *key_type = PSA_KEY_TYPE_AES;
1927 *key_size = 256;
1928 break;
1929 case MBEDTLS_CIPHER_ARIA_128_CBC:
1930 *alg = PSA_ALG_CBC_NO_PADDING;
1931 *key_type = PSA_KEY_TYPE_ARIA;
1932 *key_size = 128;
1933 break;
1934 case MBEDTLS_CIPHER_ARIA_128_CCM:
1935 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1936 *key_type = PSA_KEY_TYPE_ARIA;
1937 *key_size = 128;
1938 break;
1939 case MBEDTLS_CIPHER_ARIA_128_GCM:
1940 *alg = PSA_ALG_GCM;
1941 *key_type = PSA_KEY_TYPE_ARIA;
1942 *key_size = 128;
1943 break;
1944 case MBEDTLS_CIPHER_ARIA_192_CCM:
1945 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1946 *key_type = PSA_KEY_TYPE_ARIA;
1947 *key_size = 192;
1948 break;
1949 case MBEDTLS_CIPHER_ARIA_192_GCM:
1950 *alg = PSA_ALG_GCM;
1951 *key_type = PSA_KEY_TYPE_ARIA;
1952 *key_size = 192;
1953 break;
1954 case MBEDTLS_CIPHER_ARIA_256_CBC:
1955 *alg = PSA_ALG_CBC_NO_PADDING;
1956 *key_type = PSA_KEY_TYPE_ARIA;
1957 *key_size = 256;
1958 break;
1959 case MBEDTLS_CIPHER_ARIA_256_CCM:
1960 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1961 *key_type = PSA_KEY_TYPE_ARIA;
1962 *key_size = 256;
1963 break;
1964 case MBEDTLS_CIPHER_ARIA_256_GCM:
1965 *alg = PSA_ALG_GCM;
1966 *key_type = PSA_KEY_TYPE_ARIA;
1967 *key_size = 256;
1968 break;
1969 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1970 *alg = PSA_ALG_CBC_NO_PADDING;
1971 *key_type = PSA_KEY_TYPE_CAMELLIA;
1972 *key_size = 128;
1973 break;
1974 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1975 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1976 *key_type = PSA_KEY_TYPE_CAMELLIA;
1977 *key_size = 128;
1978 break;
1979 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1980 *alg = PSA_ALG_GCM;
1981 *key_type = PSA_KEY_TYPE_CAMELLIA;
1982 *key_size = 128;
1983 break;
1984 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1985 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1986 *key_type = PSA_KEY_TYPE_CAMELLIA;
1987 *key_size = 192;
1988 break;
1989 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1990 *alg = PSA_ALG_GCM;
1991 *key_type = PSA_KEY_TYPE_CAMELLIA;
1992 *key_size = 192;
1993 break;
1994 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1995 *alg = PSA_ALG_CBC_NO_PADDING;
1996 *key_type = PSA_KEY_TYPE_CAMELLIA;
1997 *key_size = 256;
1998 break;
1999 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2000 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2001 *key_type = PSA_KEY_TYPE_CAMELLIA;
2002 *key_size = 256;
2003 break;
2004 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2005 *alg = PSA_ALG_GCM;
2006 *key_type = PSA_KEY_TYPE_CAMELLIA;
2007 *key_size = 256;
2008 break;
2009 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2010 *alg = PSA_ALG_CHACHA20_POLY1305;
2011 *key_type = PSA_KEY_TYPE_CHACHA20;
2012 *key_size = 256;
2013 break;
2014 case MBEDTLS_CIPHER_NULL:
2015 *alg = MBEDTLS_SSL_NULL_CIPHER;
2016 *key_type = 0;
2017 *key_size = 0;
2018 break;
2019 default:
2020 return PSA_ERROR_NOT_SUPPORTED;
2021 }
2022
2023 return PSA_SUCCESS;
2024}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002025#endif /* MBEDTLS_USE_PSA_CRYPTO */
2026
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002027#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002028int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2029 const unsigned char *dhm_P, size_t P_len,
2030 const unsigned char *dhm_G, size_t G_len )
2031{
Janos Follath865b3eb2019-12-16 11:46:15 +00002032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002033
Glenn Strausscee11292021-12-20 01:43:17 -05002034 mbedtls_mpi_free( &conf->dhm_P );
2035 mbedtls_mpi_free( &conf->dhm_G );
2036
Hanno Beckera90658f2017-10-04 15:29:08 +01002037 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2038 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2039 {
2040 mbedtls_mpi_free( &conf->dhm_P );
2041 mbedtls_mpi_free( &conf->dhm_G );
2042 return( ret );
2043 }
2044
2045 return( 0 );
2046}
Paul Bakker5121ce52009-01-03 21:22:43 +00002047
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002048int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002049{
Janos Follath865b3eb2019-12-16 11:46:15 +00002050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002051
Glenn Strausscee11292021-12-20 01:43:17 -05002052 mbedtls_mpi_free( &conf->dhm_P );
2053 mbedtls_mpi_free( &conf->dhm_G );
2054
Gilles Peskinee5702482021-06-11 21:59:08 +02002055 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2056 &conf->dhm_P ) ) != 0 ||
2057 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2058 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002059 {
2060 mbedtls_mpi_free( &conf->dhm_P );
2061 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002062 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002063 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002064
2065 return( 0 );
2066}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002067#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002068
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002069#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2070/*
2071 * Set the minimum length for Diffie-Hellman parameters
2072 */
2073void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2074 unsigned int bitlen )
2075{
2076 conf->dhm_min_bitlen = bitlen;
2077}
2078#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2079
Gilles Peskineeccd8882020-03-10 12:19:08 +01002080#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002081#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002082/*
2083 * Set allowed/preferred hashes for handshake signatures
2084 */
2085void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2086 const int *hashes )
2087{
2088 conf->sig_hashes = hashes;
2089}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002090#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002091
Jerry Yuf017ee42022-01-12 15:49:48 +08002092/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002093void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2094 const uint16_t* sig_algs )
2095{
Jerry Yuf017ee42022-01-12 15:49:48 +08002096#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2097 conf->sig_hashes = NULL;
2098#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2099 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002100}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002101#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002102
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002103#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002104#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002105/*
2106 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002107 *
2108 * mbedtls_ssl_setup() takes the provided list
2109 * and translates it to a list of IANA TLS group identifiers,
2110 * stored in ssl->handshake->group_list.
2111 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002112 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002113void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002114 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002115{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002116 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002117 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002118}
Brett Warrene0edc842021-08-17 09:53:13 +01002119#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002120#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002121
Brett Warrene0edc842021-08-17 09:53:13 +01002122/*
2123 * Set the allowed groups
2124 */
2125void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2126 const uint16_t *group_list )
2127{
2128#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2129 conf->curve_list = NULL;
2130#endif
2131 conf->group_list = group_list;
2132}
2133
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002134#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002136{
Hanno Becker947194e2017-04-07 13:25:49 +01002137 /* Initialize to suppress unnecessary compiler warning */
2138 size_t hostname_len = 0;
2139
2140 /* Check if new hostname is valid before
2141 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002142 if( hostname != NULL )
2143 {
2144 hostname_len = strlen( hostname );
2145
2146 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2147 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2148 }
2149
2150 /* Now it's clear that we will overwrite the old hostname,
2151 * so we can free it safely */
2152
2153 if( ssl->hostname != NULL )
2154 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002155 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002156 mbedtls_free( ssl->hostname );
2157 }
2158
2159 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002160
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002162 {
2163 ssl->hostname = NULL;
2164 }
2165 else
2166 {
2167 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002168 if( ssl->hostname == NULL )
2169 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002170
Hanno Becker947194e2017-04-07 13:25:49 +01002171 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002172
Hanno Becker947194e2017-04-07 13:25:49 +01002173 ssl->hostname[hostname_len] = '\0';
2174 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002175
2176 return( 0 );
2177}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002178#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002179
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002180#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002181void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002183 const unsigned char *, size_t),
2184 void *p_sni )
2185{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002186 conf->f_sni = f_sni;
2187 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002188}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002192int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002193{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002194 size_t cur_len, tot_len;
2195 const char **p;
2196
2197 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002198 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2199 * MUST NOT be truncated."
2200 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002201 */
2202 tot_len = 0;
2203 for( p = protos; *p != NULL; p++ )
2204 {
2205 cur_len = strlen( *p );
2206 tot_len += cur_len;
2207
Ronald Cron8216dd32020-04-23 16:41:44 +02002208 if( ( cur_len == 0 ) ||
2209 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2210 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002212 }
2213
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002214 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002215
2216 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002217}
2218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002220{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002221 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002222}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002224
Johan Pascalb62bb512015-12-03 21:56:45 +01002225#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002226void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2227 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002228{
2229 conf->dtls_srtp_mki_support = support_mki_value;
2230}
2231
Ron Eldoref72faf2018-07-12 11:54:20 +03002232int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2233 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002234 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002235{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002236 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002237 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002238 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002239 }
Ron Eldor591f1622018-01-22 12:30:04 +02002240
2241 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002242 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002243 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002244 }
Ron Eldor591f1622018-01-22 12:30:04 +02002245
2246 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2247 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002248 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002249}
2250
Ron Eldoref72faf2018-07-12 11:54:20 +03002251int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002252 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002253{
Johan Pascal253d0262020-09-22 13:04:45 +02002254 const mbedtls_ssl_srtp_profile *p;
2255 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002256
Johan Pascal253d0262020-09-22 13:04:45 +02002257 /* check the profiles list: all entry must be valid,
2258 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002259 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2260 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2261 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002262 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002263 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002264 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002265 list_size++;
2266 }
2267 else
2268 {
2269 /* unsupported value, stop parsing and set the size to an error value */
2270 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002271 }
2272 }
2273
Johan Pascal5ef72d22020-10-28 17:05:47 +01002274 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002275 {
Johan Pascal253d0262020-09-22 13:04:45 +02002276 conf->dtls_srtp_profile_list = NULL;
2277 conf->dtls_srtp_profile_list_len = 0;
2278 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2279 }
2280
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002281 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002282 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002283
2284 return( 0 );
2285}
2286
Johan Pascal5ef72d22020-10-28 17:05:47 +01002287void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2288 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002289{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002290 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2291 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002292 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002293 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002294 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002295 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002296 else
2297 {
2298 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002299 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2300 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002301 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002302}
Johan Pascalb62bb512015-12-03 21:56:45 +01002303#endif /* MBEDTLS_SSL_DTLS_SRTP */
2304
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002305void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002306{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002307 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002308}
2309
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002310void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002311{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002312 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002313}
2314
Janos Follath088ce432017-04-10 12:42:31 +01002315#if defined(MBEDTLS_SSL_SRV_C)
2316void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2317 char cert_req_ca_list )
2318{
2319 conf->cert_req_ca_list = cert_req_ca_list;
2320}
2321#endif
2322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002324void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002325{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002326 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002327}
2328#endif
2329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002331void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002332{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002333 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002334}
2335#endif
2336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002338int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002339{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002341 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002342 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002344 }
2345
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002346 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002347
2348 return( 0 );
2349}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002351
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002352void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002353{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002354 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002355}
2356
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002358void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002359{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002360 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002361}
2362
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002363void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002364{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002365 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002366}
2367
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002368void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002369 const unsigned char period[8] )
2370{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002371 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002372}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002376#if defined(MBEDTLS_SSL_CLI_C)
2377void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002378{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002379 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002380}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002381#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002382
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002383#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002384void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2385 mbedtls_ssl_ticket_write_t *f_ticket_write,
2386 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2387 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002388{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002389 conf->f_ticket_write = f_ticket_write;
2390 conf->f_ticket_parse = f_ticket_parse;
2391 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002392}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002393#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002394#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002395
Hanno Becker7e6c1782021-06-08 09:24:55 +01002396void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2397 mbedtls_ssl_export_keys_t *f_export_keys,
2398 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002399{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002400 ssl->f_export_keys = f_export_keys;
2401 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002402}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002403
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002404#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002405void mbedtls_ssl_conf_async_private_cb(
2406 mbedtls_ssl_config *conf,
2407 mbedtls_ssl_async_sign_t *f_async_sign,
2408 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2409 mbedtls_ssl_async_resume_t *f_async_resume,
2410 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002411 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002412{
2413 conf->f_async_sign_start = f_async_sign;
2414 conf->f_async_decrypt_start = f_async_decrypt;
2415 conf->f_async_resume = f_async_resume;
2416 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002417 conf->p_async_config_data = async_config_data;
2418}
2419
Gilles Peskine8f97af72018-04-26 11:46:10 +02002420void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2421{
2422 return( conf->p_async_config_data );
2423}
2424
Gilles Peskine1febfef2018-04-30 11:54:39 +02002425void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002426{
2427 if( ssl->handshake == NULL )
2428 return( NULL );
2429 else
2430 return( ssl->handshake->user_async_ctx );
2431}
2432
Gilles Peskine1febfef2018-04-30 11:54:39 +02002433void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002434 void *ctx )
2435{
2436 if( ssl->handshake != NULL )
2437 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002438}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002439#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002440
Paul Bakker5121ce52009-01-03 21:22:43 +00002441/*
2442 * SSL get accessors
2443 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002444uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002445{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002446 if( ssl->session != NULL )
2447 return( ssl->session->verify_result );
2448
2449 if( ssl->session_negotiate != NULL )
2450 return( ssl->session_negotiate->verify_result );
2451
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002452 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002453}
2454
Glenn Strauss8f526902022-01-13 00:04:49 -05002455int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2456{
2457 if( ssl == NULL || ssl->session == NULL )
2458 return( 0 );
2459
2460 return( ssl->session->ciphersuite );
2461}
2462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002464{
Paul Bakker926c8e42013-03-06 10:23:34 +01002465 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002466 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002469}
2470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002472{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002474 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002475 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002476 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002477 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002478 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002479 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002480 default:
2481 return( "unknown (DTLS)" );
2482 }
2483 }
2484#endif
2485
Glenn Strauss60bfe602022-03-14 19:04:24 -04002486 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002487 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002488 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002489 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002490 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002491 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002492 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002493 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002494 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002495}
2496
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002497#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002498size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2499{
David Horstmann95d516f2021-05-04 18:36:56 +01002500 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002501 size_t read_mfl;
2502
2503 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2504 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2505 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2506 {
2507 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2508 }
2509
2510 /* Check if a smaller max length was negotiated */
2511 if( ssl->session_out != NULL )
2512 {
2513 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2514 if( read_mfl < max_len )
2515 {
2516 max_len = read_mfl;
2517 }
2518 }
2519
2520 // During a handshake, use the value being negotiated
2521 if( ssl->session_negotiate != NULL )
2522 {
2523 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2524 if( read_mfl < max_len )
2525 {
2526 max_len = read_mfl;
2527 }
2528 }
2529
2530 return( max_len );
2531}
2532
2533size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002534{
2535 size_t max_len;
2536
2537 /*
2538 * Assume mfl_code is correct since it was checked when set
2539 */
Angus Grattond8213d02016-05-25 20:56:48 +10002540 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002541
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002542 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002543 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002544 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002545 {
Angus Grattond8213d02016-05-25 20:56:48 +10002546 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002547 }
2548
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002549 /* During a handshake, use the value being negotiated */
2550 if( ssl->session_negotiate != NULL &&
2551 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2552 {
2553 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2554 }
2555
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002556 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002557}
2558#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2559
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002560#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002561size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002562{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002563 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2564 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2565 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2566 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2567 return ( 0 );
2568
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002569 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2570 return( ssl->mtu );
2571
2572 if( ssl->mtu == 0 )
2573 return( ssl->handshake->mtu );
2574
2575 return( ssl->mtu < ssl->handshake->mtu ?
2576 ssl->mtu : ssl->handshake->mtu );
2577}
2578#endif /* MBEDTLS_SSL_PROTO_DTLS */
2579
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002580int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2581{
2582 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2583
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002584#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2585 !defined(MBEDTLS_SSL_PROTO_DTLS)
2586 (void) ssl;
2587#endif
2588
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002589#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002590 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002591
2592 if( max_len > mfl )
2593 max_len = mfl;
2594#endif
2595
2596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002597 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002598 {
Hanno Becker89490712020-02-05 10:50:12 +00002599 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002600 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2601 const size_t overhead = (size_t) ret;
2602
2603 if( ret < 0 )
2604 return( ret );
2605
2606 if( mtu <= overhead )
2607 {
2608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2609 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2610 }
2611
2612 if( max_len > mtu - overhead )
2613 max_len = mtu - overhead;
2614 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002615#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002616
Hanno Becker0defedb2018-08-10 12:35:02 +01002617#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2618 !defined(MBEDTLS_SSL_PROTO_DTLS)
2619 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002620#endif
2621
2622 return( (int) max_len );
2623}
2624
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002625int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2626{
2627 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2628
2629#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2630 (void) ssl;
2631#endif
2632
2633#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2634 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2635
2636 if( max_len > mfl )
2637 max_len = mfl;
2638#endif
2639
2640 return( (int) max_len );
2641}
2642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643#if defined(MBEDTLS_X509_CRT_PARSE_C)
2644const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002645{
2646 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002647 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002648
Hanno Beckere6824572019-02-07 13:18:46 +00002649#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002650 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002651#else
2652 return( NULL );
2653#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002658int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2659 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002660{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002661 int ret;
2662
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002663 if( ssl == NULL ||
2664 dst == NULL ||
2665 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002666 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002669 }
2670
Hanno Beckere810bbc2021-05-14 16:01:05 +01002671 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2672 * idempotent: Each session can only be exported once.
2673 *
2674 * (This is in preparation for TLS 1.3 support where we will
2675 * need the ability to export multiple sessions (aka tickets),
2676 * which will be achieved by calling mbedtls_ssl_get_session()
2677 * multiple times until it fails.)
2678 *
2679 * Check whether we have already exported the current session,
2680 * and fail if so.
2681 */
2682 if( ssl->session->exported == 1 )
2683 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2684
2685 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2686 if( ret != 0 )
2687 return( ret );
2688
2689 /* Remember that we've exported the session. */
2690 ssl->session->exported = 1;
2691 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002692}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002694
Paul Bakker5121ce52009-01-03 21:22:43 +00002695/*
Hanno Beckera835da52019-05-16 12:39:07 +01002696 * Define ticket header determining Mbed TLS version
2697 * and structure of the ticket.
2698 */
2699
Hanno Becker94ef3b32019-05-16 12:50:45 +01002700/*
Hanno Becker50b59662019-05-28 14:30:45 +01002701 * Define bitflag determining compile-time settings influencing
2702 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002703 */
2704
Hanno Becker50b59662019-05-28 14:30:45 +01002705#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002706#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002707#else
Hanno Becker3e088662019-05-29 11:10:18 +01002708#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002709#endif /* MBEDTLS_HAVE_TIME */
2710
2711#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002712#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002713#else
Hanno Becker3e088662019-05-29 11:10:18 +01002714#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002715#endif /* MBEDTLS_X509_CRT_PARSE_C */
2716
2717#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002718#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002719#else
Hanno Becker3e088662019-05-29 11:10:18 +01002720#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002721#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2722
2723#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002724#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002725#else
Hanno Becker3e088662019-05-29 11:10:18 +01002726#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002727#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2728
Hanno Becker94ef3b32019-05-16 12:50:45 +01002729#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002730#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002731#else
Hanno Becker3e088662019-05-29 11:10:18 +01002732#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002733#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2734
Hanno Becker94ef3b32019-05-16 12:50:45 +01002735#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2736#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2737#else
2738#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2739#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2740
Hanno Becker3e088662019-05-29 11:10:18 +01002741#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2742#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2743#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2744#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002745#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2746#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002747
Hanno Becker50b59662019-05-28 14:30:45 +01002748#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002749 ( (uint16_t) ( \
2750 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2751 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2752 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2753 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002754 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002755 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002756
Hanno Beckerf8787072019-05-16 12:41:07 +01002757static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002758 MBEDTLS_VERSION_MAJOR,
2759 MBEDTLS_VERSION_MINOR,
2760 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002761 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2762 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002763};
Hanno Beckera835da52019-05-16 12:39:07 +01002764
2765/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002766 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002767 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002768 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002769 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002770 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002771 * opaque mbedtls_version[3]; // library version: major, minor, patch
2772 * opaque session_format[2]; // library-version specific 16-bit field
2773 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002774 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002775 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002776 * Note: When updating the format, remember to keep
2777 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002778 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002779 * // In this version, `session_format` determines
2780 * // the setting of those compile-time
2781 * // configuration options which influence
2782 * // the structure of mbedtls_ssl_session.
2783 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002784 * uint8_t minor_ver; // Protocol minor version. Possible values:
2785 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002786 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002787 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002788 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002789 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002790 * serialized_session_tls12 data;
2791 *
2792 * };
2793 *
2794 * } serialized_session;
2795 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002796 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002797
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002798static int ssl_session_save( const mbedtls_ssl_session *session,
2799 unsigned char omit_header,
2800 unsigned char *buf,
2801 size_t buf_len,
2802 size_t *olen )
2803{
2804 unsigned char *p = buf;
2805 size_t used = 0;
2806
2807 if( !omit_header )
2808 {
2809 /*
2810 * Add Mbed TLS version identifier
2811 */
2812
2813 used += sizeof( ssl_serialized_session_header );
2814
2815 if( used <= buf_len )
2816 {
2817 memcpy( p, ssl_serialized_session_header,
2818 sizeof( ssl_serialized_session_header ) );
2819 p += sizeof( ssl_serialized_session_header );
2820 }
2821 }
2822
2823 /*
2824 * TLS version identifier
2825 */
2826 used += 1;
2827 if( used <= buf_len )
2828 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002829 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002830 }
2831
2832 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002833 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002834 {
2835#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002836 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002837 {
2838 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2839 used += ssl_session_save_tls12( session, p, remaining_len );
2840 break;
2841 }
2842#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2843
2844 default:
2845 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2846 }
2847
2848 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002849 if( used > buf_len )
2850 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002851
2852 return( 0 );
2853}
2854
2855/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002856 * Public wrapper for ssl_session_save()
2857 */
2858int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2859 unsigned char *buf,
2860 size_t buf_len,
2861 size_t *olen )
2862{
2863 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2864}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002865
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002866/*
2867 * Deserialize session, see mbedtls_ssl_session_save() for format.
2868 *
2869 * This internal version is wrapped by a public function that cleans up in
2870 * case of error, and has an extra option omit_header.
2871 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002872static int ssl_session_load( mbedtls_ssl_session *session,
2873 unsigned char omit_header,
2874 const unsigned char *buf,
2875 size_t len )
2876{
2877 const unsigned char *p = buf;
2878 const unsigned char * const end = buf + len;
2879
2880 if( !omit_header )
2881 {
2882 /*
2883 * Check Mbed TLS version identifier
2884 */
2885
2886 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2887 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2888
2889 if( memcmp( p, ssl_serialized_session_header,
2890 sizeof( ssl_serialized_session_header ) ) != 0 )
2891 {
2892 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2893 }
2894 p += sizeof( ssl_serialized_session_header );
2895 }
2896
2897 /*
2898 * TLS version identifier
2899 */
2900 if( 1 > (size_t)( end - p ) )
2901 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002902 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002903
2904 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002905 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002906 {
2907#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002908 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002909 {
2910 size_t remaining_len = ( end - p );
2911 return( ssl_session_load_tls12( session, p, remaining_len ) );
2912 }
2913#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2914
2915 default:
2916 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2917 }
2918}
2919
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002920/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002921 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002922 */
2923int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2924 const unsigned char *buf,
2925 size_t len )
2926{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002927 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002928
2929 if( ret != 0 )
2930 mbedtls_ssl_session_free( session );
2931
2932 return( ret );
2933}
2934
2935/*
Paul Bakker1961b702013-01-25 14:49:24 +01002936 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002937 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002938static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2939{
2940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2941
Ronald Cron66dbf912022-02-02 15:33:46 +01002942 /*
2943 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002944 * that were written into the output buffer by the previous handshake step,
2945 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002946 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2947 * We proceed to the next handshake step only when all data from the
2948 * previous one have been sent to the peer, thus we make sure that this is
2949 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2950 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2951 * we have to wait before to go ahead.
2952 * In the case of TLS 1.3, handshake step handlers do not send data to the
2953 * peer. Data are only sent here and through
2954 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2955 * alert occured.
2956 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002957 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2958 return( ret );
2959
2960#if defined(MBEDTLS_SSL_PROTO_DTLS)
2961 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2962 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2963 {
2964 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2965 return( ret );
2966 }
2967#endif /* MBEDTLS_SSL_PROTO_DTLS */
2968
2969 return( ret );
2970}
2971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002973{
Hanno Becker41934dd2021-08-07 19:13:43 +01002974 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002975
Hanno Becker41934dd2021-08-07 19:13:43 +01002976 if( ssl == NULL ||
2977 ssl->conf == NULL ||
2978 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002979 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002980 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002981 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002982 }
2983
2984 ret = ssl_prepare_handshake_step( ssl );
2985 if( ret != 0 )
2986 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002987
Jerry Yue7047812021-09-13 19:26:39 +08002988 ret = mbedtls_ssl_handle_pending_alert( ssl );
2989 if( ret != 0 )
2990 goto cleanup;
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002993 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002994 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2996 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002997
Ronald Cron9f0fba32022-02-10 16:45:15 +01002998 switch( ssl->state )
2999 {
3000 case MBEDTLS_SSL_HELLO_REQUEST:
3001 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3002 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003003
Ronald Cron9f0fba32022-02-10 16:45:15 +01003004 case MBEDTLS_SSL_CLIENT_HELLO:
3005 ret = mbedtls_ssl_write_client_hello( ssl );
3006 break;
3007
3008 default:
3009#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003010 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003011 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3012 else
3013 ret = mbedtls_ssl_handshake_client_step( ssl );
3014#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3015 ret = mbedtls_ssl_handshake_client_step( ssl );
3016#else
3017 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3018#endif
3019 }
Jerry Yub9930e72021-08-06 17:11:51 +08003020 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003021#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003023 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003024 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003025#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003026 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003027 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003028#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003029
3030#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3031 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3032 ret = mbedtls_ssl_handshake_server_step( ssl );
3033#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3034 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003035#endif
3036
Jerry Yue7047812021-09-13 19:26:39 +08003037 if( ret != 0 )
3038 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003039 /* handshake_step return error. And it is same
3040 * with alert_reason.
3041 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003042 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003043 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003044 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003045 goto cleanup;
3046 }
3047 }
3048
3049cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003050 return( ret );
3051}
3052
3053/*
3054 * Perform the SSL handshake
3055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003057{
3058 int ret = 0;
3059
Hanno Beckera817ea42020-10-20 15:20:23 +01003060 /* Sanity checks */
3061
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003062 if( ssl == NULL || ssl->conf == NULL )
3063 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3064
Hanno Beckera817ea42020-10-20 15:20:23 +01003065#if defined(MBEDTLS_SSL_PROTO_DTLS)
3066 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3067 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3068 {
3069 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3070 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3071 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3072 }
3073#endif /* MBEDTLS_SSL_PROTO_DTLS */
3074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003076
Hanno Beckera817ea42020-10-20 15:20:23 +01003077 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003078 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003079 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003081
3082 if( ret != 0 )
3083 break;
3084 }
3085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003087
3088 return( ret );
3089}
3090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#if defined(MBEDTLS_SSL_RENEGOTIATION)
3092#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003093/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003094 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003097{
Janos Follath865b3eb2019-12-16 11:46:15 +00003098 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003099
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003101
3102 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3104 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003105
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003106 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003107 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003108 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003109 return( ret );
3110 }
3111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003113
3114 return( 0 );
3115}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003117
3118/*
3119 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * - any side: calling mbedtls_ssl_renegotiate(),
3121 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3122 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003123 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003124 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003126 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003127int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003128{
Janos Follath865b3eb2019-12-16 11:46:15 +00003129 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003132
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003133 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3134 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003135
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003136 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3137 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003139 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003141 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003142 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003143 ssl->handshake->out_msg_seq = 1;
3144 else
3145 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003146 }
3147#endif
3148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3150 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003153 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003155 return( ret );
3156 }
3157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003159
3160 return( 0 );
3161}
3162
3163/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003164 * Renegotiate current connection on client,
3165 * or request renegotiation on server
3166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003168{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003170
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003171 if( ssl == NULL || ssl->conf == NULL )
3172 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003175 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003176 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003177 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003178 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003182
3183 /* Did we already try/start sending HelloRequest? */
3184 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003186
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003187 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003188 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003192 /*
3193 * On client, either start the renegotiation process or,
3194 * if already in progress, continue the handshake
3195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003197 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003198 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003200
Hanno Becker40cdaa12020-02-05 10:48:27 +00003201 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003202 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003203 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003204 return( ret );
3205 }
3206 }
3207 else
3208 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003210 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003212 return( ret );
3213 }
3214 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003216
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003217 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003218}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003220
Gilles Peskine9b562d52018-04-25 20:32:43 +02003221void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003222{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003223 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3224
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003225 if( handshake == NULL )
3226 return;
3227
Brett Warrene0edc842021-08-17 09:53:13 +01003228#if defined(MBEDTLS_ECP_C)
3229#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3230 if ( ssl->handshake->group_list_heap_allocated )
3231 mbedtls_free( (void*) handshake->group_list );
3232 handshake->group_list = NULL;
3233#endif /* MBEDTLS_DEPRECATED_REMOVED */
3234#endif /* MBEDTLS_ECP_C */
3235
Jerry Yuf017ee42022-01-12 15:49:48 +08003236#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3237#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3238 if ( ssl->handshake->sig_algs_heap_allocated )
3239 mbedtls_free( (void*) handshake->sig_algs );
3240 handshake->sig_algs = NULL;
3241#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003242#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3243 if( ssl->handshake->certificate_request_context )
3244 {
3245 mbedtls_free( (void*) handshake->certificate_request_context );
3246 }
3247#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003248#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3249
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003250#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3251 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3252 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003253 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003254 handshake->async_in_progress = 0;
3255 }
3256#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3257
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003258#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003259#if defined(MBEDTLS_USE_PSA_CRYPTO)
3260 psa_hash_abort( &handshake->fin_sha256_psa );
3261#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003262 mbedtls_sha256_free( &handshake->fin_sha256 );
3263#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003264#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003265#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003266#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003267 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003268#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003269 mbedtls_sha512_free( &handshake->fin_sha512 );
3270#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003271#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273#if defined(MBEDTLS_DHM_C)
3274 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003275#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003276#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003278#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003279#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003280 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003281#if defined(MBEDTLS_SSL_CLI_C)
3282 mbedtls_free( handshake->ecjpake_cache );
3283 handshake->ecjpake_cache = NULL;
3284 handshake->ecjpake_cache_len = 0;
3285#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003286#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003287
Janos Follath4ae5c292016-02-10 11:27:43 +00003288#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3289 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003290 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003292#endif
3293
Gilles Peskineeccd8882020-03-10 12:19:08 +01003294#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003295#if defined(MBEDTLS_USE_PSA_CRYPTO)
3296 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3297 {
3298 /* The maintenance of the external PSK key slot is the
3299 * user's responsibility. */
3300 if( ssl->handshake->psk_opaque_is_internal )
3301 {
3302 psa_destroy_key( ssl->handshake->psk_opaque );
3303 ssl->handshake->psk_opaque_is_internal = 0;
3304 }
3305 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3306 }
3307#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003308 if( handshake->psk != NULL )
3309 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003310 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003311 mbedtls_free( handshake->psk );
3312 }
3313#endif
3314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3316 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003317 /*
3318 * Free only the linked list wrapper, not the keys themselves
3319 * since the belong to the SNI callback
3320 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003321 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003323
Gilles Peskineeccd8882020-03-10 12:19:08 +01003324#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003325 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003326 if( handshake->ecrs_peer_cert != NULL )
3327 {
3328 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3329 mbedtls_free( handshake->ecrs_peer_cert );
3330 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003331#endif
3332
Hanno Becker75173122019-02-06 16:18:31 +00003333#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3334 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3335 mbedtls_pk_free( &handshake->peer_pubkey );
3336#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3337
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003338#if defined(MBEDTLS_SSL_CLI_C) && \
3339 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3340 mbedtls_free( handshake->cookie );
3341#endif /* MBEDTLS_SSL_CLI_C &&
3342 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003343
3344#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003345 mbedtls_ssl_flight_free( handshake->flight );
3346 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003347#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003348
Ronald Cronf12b81d2022-03-15 10:42:41 +01003349#if defined(MBEDTLS_ECDH_C) && \
3350 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003351 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003352 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003353#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3354
Ronald Cron6f135e12021-12-08 16:57:54 +01003355#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003356 mbedtls_ssl_transform_free( handshake->transform_handshake );
3357 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003358 mbedtls_free( handshake->transform_earlydata );
3359 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003360#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003361
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003362
3363#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3364 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3365 * processes datagrams and the fact that a datagram is allowed to have
3366 * several records in it, it is possible that the I/O buffers are not
3367 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003368 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3369 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003370#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003371
Jerry Yuba9c7272021-10-30 11:54:10 +08003372 /* mbedtls_platform_zeroize MUST be last one in this function */
3373 mbedtls_platform_zeroize( handshake,
3374 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003375}
3376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003378{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003379 if( session == NULL )
3380 return;
3381
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003383 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003384#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003385
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003386#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003388#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003389
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003390 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003391}
3392
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003394
3395#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3396#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3397#else
3398#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3399#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3400
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003401#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003402
3403#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3404#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3405#else
3406#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3407#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3408
3409#if defined(MBEDTLS_SSL_ALPN)
3410#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3411#else
3412#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3413#endif /* MBEDTLS_SSL_ALPN */
3414
3415#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3416#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3417#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3418#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3419
3420#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3421 ( (uint32_t) ( \
3422 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3423 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3424 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3425 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3426 0u ) )
3427
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003428static unsigned char ssl_serialized_context_header[] = {
3429 MBEDTLS_VERSION_MAJOR,
3430 MBEDTLS_VERSION_MINOR,
3431 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003432 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3433 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3434 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3435 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3436 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003437};
3438
Paul Bakker5121ce52009-01-03 21:22:43 +00003439/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003440 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003441 *
3442 * The format of the serialized data is:
3443 * (in the presentation language of TLS, RFC 8446 section 3)
3444 *
3445 * // header
3446 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003447 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003448 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003449 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003450 * Note: When updating the format, remember to keep these
3451 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003452 *
3453 * // session sub-structure
3454 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3455 * // transform sub-structure
3456 * uint8 random[64]; // ServerHello.random+ClientHello.random
3457 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3458 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3459 * // fields from ssl_context
3460 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3461 * uint64 in_window_top; // DTLS: last validated record seq_num
3462 * uint64 in_window; // DTLS: bitmask for replay protection
3463 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3464 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3465 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3466 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3467 *
3468 * Note that many fields of the ssl_context or sub-structures are not
3469 * serialized, as they fall in one of the following categories:
3470 *
3471 * 1. forced value (eg in_left must be 0)
3472 * 2. pointer to dynamically-allocated memory (eg session, transform)
3473 * 3. value can be re-derived from other data (eg session keys from MS)
3474 * 4. value was temporary (eg content of input buffer)
3475 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003476 */
3477int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3478 unsigned char *buf,
3479 size_t buf_len,
3480 size_t *olen )
3481{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003482 unsigned char *p = buf;
3483 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003484 size_t session_len;
3485 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003486
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003487 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003488 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3489 * this function's documentation.
3490 *
3491 * These are due to assumptions/limitations in the implementation. Some of
3492 * them are likely to stay (no handshake in progress) some might go away
3493 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003494 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003495 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003496 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003497 {
3498 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003499 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003500 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003501 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003502 {
3503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003504 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003505 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003506 /* Double-check that sub-structures are indeed ready */
3507 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003508 {
3509 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003510 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003511 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003512 /* There must be no pending incoming or outgoing data */
3513 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003514 {
3515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003516 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003517 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003518 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003519 {
3520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003522 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003523 /* Protocol must be DLTS, not TLS */
3524 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003525 {
3526 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003527 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003528 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003529 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003530 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003531 {
3532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003533 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003534 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003535 /* We must be using an AEAD ciphersuite */
3536 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003537 {
3538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003539 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003540 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003541 /* Renegotiation must not be enabled */
3542#if defined(MBEDTLS_SSL_RENEGOTIATION)
3543 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003544 {
3545 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003546 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003547 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003548#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003549
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003550 /*
3551 * Version and format identifier
3552 */
3553 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003554
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003555 if( used <= buf_len )
3556 {
3557 memcpy( p, ssl_serialized_context_header,
3558 sizeof( ssl_serialized_context_header ) );
3559 p += sizeof( ssl_serialized_context_header );
3560 }
3561
3562 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003563 * Session (length + data)
3564 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003565 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003566 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3567 return( ret );
3568
3569 used += 4 + session_len;
3570 if( used <= buf_len )
3571 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003572 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3573 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003574
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003575 ret = ssl_session_save( ssl->session, 1,
3576 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003577 if( ret != 0 )
3578 return( ret );
3579
3580 p += session_len;
3581 }
3582
3583 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003584 * Transform
3585 */
3586 used += sizeof( ssl->transform->randbytes );
3587 if( used <= buf_len )
3588 {
3589 memcpy( p, ssl->transform->randbytes,
3590 sizeof( ssl->transform->randbytes ) );
3591 p += sizeof( ssl->transform->randbytes );
3592 }
3593
3594#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3595 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3596 if( used <= buf_len )
3597 {
3598 *p++ = ssl->transform->in_cid_len;
3599 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3600 p += ssl->transform->in_cid_len;
3601
3602 *p++ = ssl->transform->out_cid_len;
3603 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3604 p += ssl->transform->out_cid_len;
3605 }
3606#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3607
3608 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003609 * Saved fields from top-level ssl_context structure
3610 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003611 used += 4;
3612 if( used <= buf_len )
3613 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003614 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3615 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003616 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003617
3618#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3619 used += 16;
3620 if( used <= buf_len )
3621 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003622 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3623 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003624
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003625 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3626 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003627 }
3628#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3629
3630#if defined(MBEDTLS_SSL_PROTO_DTLS)
3631 used += 1;
3632 if( used <= buf_len )
3633 {
3634 *p++ = ssl->disable_datagram_packing;
3635 }
3636#endif /* MBEDTLS_SSL_PROTO_DTLS */
3637
Jerry Yuae0b2e22021-10-08 15:21:19 +08003638 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003639 if( used <= buf_len )
3640 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003641 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3642 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003643 }
3644
3645#if defined(MBEDTLS_SSL_PROTO_DTLS)
3646 used += 2;
3647 if( used <= buf_len )
3648 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003649 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3650 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003651 }
3652#endif /* MBEDTLS_SSL_PROTO_DTLS */
3653
3654#if defined(MBEDTLS_SSL_ALPN)
3655 {
3656 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003657 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003658 : 0;
3659
3660 used += 1 + alpn_len;
3661 if( used <= buf_len )
3662 {
3663 *p++ = alpn_len;
3664
3665 if( ssl->alpn_chosen != NULL )
3666 {
3667 memcpy( p, ssl->alpn_chosen, alpn_len );
3668 p += alpn_len;
3669 }
3670 }
3671 }
3672#endif /* MBEDTLS_SSL_ALPN */
3673
3674 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003675 * Done
3676 */
3677 *olen = used;
3678
3679 if( used > buf_len )
3680 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003681
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003682 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3683
Hanno Becker43aefe22020-02-05 10:44:56 +00003684 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003685}
3686
3687/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003688 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003689 *
3690 * This internal version is wrapped by a public function that cleans up in
3691 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003692 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003693static int ssl_context_load( mbedtls_ssl_context *ssl,
3694 const unsigned char *buf,
3695 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003696{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003697 const unsigned char *p = buf;
3698 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003699 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003701
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003702 /*
3703 * The context should have been freshly setup or reset.
3704 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003705 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003706 * renegotiating, or if the user mistakenly loaded a session first.)
3707 */
3708 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3709 ssl->session != NULL )
3710 {
3711 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3712 }
3713
3714 /*
3715 * We can't check that the config matches the initial one, but we can at
3716 * least check it matches the requirements for serializing.
3717 */
3718 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003719 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3720 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003721#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003722 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003723#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003724 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003725 {
3726 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3727 }
3728
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3730
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003731 /*
3732 * Check version identifier
3733 */
3734 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3735 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3736
3737 if( memcmp( p, ssl_serialized_context_header,
3738 sizeof( ssl_serialized_context_header ) ) != 0 )
3739 {
3740 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3741 }
3742 p += sizeof( ssl_serialized_context_header );
3743
3744 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003745 * Session
3746 */
3747 if( (size_t)( end - p ) < 4 )
3748 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3749
3750 session_len = ( (size_t) p[0] << 24 ) |
3751 ( (size_t) p[1] << 16 ) |
3752 ( (size_t) p[2] << 8 ) |
3753 ( (size_t) p[3] );
3754 p += 4;
3755
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003756 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003757 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003758 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003759 ssl->session_in = ssl->session;
3760 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003761 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003762
3763 if( (size_t)( end - p ) < session_len )
3764 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3765
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003766 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003767 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003768 {
3769 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003770 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003771 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003772
3773 p += session_len;
3774
3775 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003776 * Transform
3777 */
3778
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003779 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003780 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003781 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003782 ssl->transform_in = ssl->transform;
3783 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003784 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003785
3786 /* Read random bytes and populate structure */
3787 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3788 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003789#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003790 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003791 ssl->session->ciphersuite,
3792 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003793#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003794 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003795#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003796 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3797 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003798 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003799 ssl->conf->endpoint,
3800 ssl );
3801 if( ret != 0 )
3802 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003803#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003804 p += sizeof( ssl->transform->randbytes );
3805
3806#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3807 /* Read connection IDs and store them */
3808 if( (size_t)( end - p ) < 1 )
3809 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3810
3811 ssl->transform->in_cid_len = *p++;
3812
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003813 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003814 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3815
3816 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3817 p += ssl->transform->in_cid_len;
3818
3819 ssl->transform->out_cid_len = *p++;
3820
3821 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3822 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3823
3824 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3825 p += ssl->transform->out_cid_len;
3826#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3827
3828 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003829 * Saved fields from top-level ssl_context structure
3830 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003831 if( (size_t)( end - p ) < 4 )
3832 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3833
3834 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3835 ( (uint32_t) p[1] << 16 ) |
3836 ( (uint32_t) p[2] << 8 ) |
3837 ( (uint32_t) p[3] );
3838 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003839
3840#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3841 if( (size_t)( end - p ) < 16 )
3842 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3843
3844 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3845 ( (uint64_t) p[1] << 48 ) |
3846 ( (uint64_t) p[2] << 40 ) |
3847 ( (uint64_t) p[3] << 32 ) |
3848 ( (uint64_t) p[4] << 24 ) |
3849 ( (uint64_t) p[5] << 16 ) |
3850 ( (uint64_t) p[6] << 8 ) |
3851 ( (uint64_t) p[7] );
3852 p += 8;
3853
3854 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3855 ( (uint64_t) p[1] << 48 ) |
3856 ( (uint64_t) p[2] << 40 ) |
3857 ( (uint64_t) p[3] << 32 ) |
3858 ( (uint64_t) p[4] << 24 ) |
3859 ( (uint64_t) p[5] << 16 ) |
3860 ( (uint64_t) p[6] << 8 ) |
3861 ( (uint64_t) p[7] );
3862 p += 8;
3863#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3864
3865#if defined(MBEDTLS_SSL_PROTO_DTLS)
3866 if( (size_t)( end - p ) < 1 )
3867 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3868
3869 ssl->disable_datagram_packing = *p++;
3870#endif /* MBEDTLS_SSL_PROTO_DTLS */
3871
Jerry Yud9a94fe2021-09-28 18:58:59 +08003872 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003873 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003874 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3875 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003876
3877#if defined(MBEDTLS_SSL_PROTO_DTLS)
3878 if( (size_t)( end - p ) < 2 )
3879 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3880
3881 ssl->mtu = ( p[0] << 8 ) | p[1];
3882 p += 2;
3883#endif /* MBEDTLS_SSL_PROTO_DTLS */
3884
3885#if defined(MBEDTLS_SSL_ALPN)
3886 {
3887 uint8_t alpn_len;
3888 const char **cur;
3889
3890 if( (size_t)( end - p ) < 1 )
3891 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3892
3893 alpn_len = *p++;
3894
3895 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3896 {
3897 /* alpn_chosen should point to an item in the configured list */
3898 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3899 {
3900 if( strlen( *cur ) == alpn_len &&
3901 memcmp( p, cur, alpn_len ) == 0 )
3902 {
3903 ssl->alpn_chosen = *cur;
3904 break;
3905 }
3906 }
3907 }
3908
3909 /* can only happen on conf mismatch */
3910 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3911 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3912
3913 p += alpn_len;
3914 }
3915#endif /* MBEDTLS_SSL_ALPN */
3916
3917 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003918 * Forced fields from top-level ssl_context structure
3919 *
3920 * Most of them already set to the correct value by mbedtls_ssl_init() and
3921 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3922 */
3923 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003924 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003925
Hanno Becker361b10d2019-08-30 10:42:49 +01003926 /* Adjust pointers for header fields of outgoing records to
3927 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003928 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003929
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003930#if defined(MBEDTLS_SSL_PROTO_DTLS)
3931 ssl->in_epoch = 1;
3932#endif
3933
3934 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3935 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003936 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3937 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003938 if( ssl->handshake != NULL )
3939 {
3940 mbedtls_ssl_handshake_free( ssl );
3941 mbedtls_free( ssl->handshake );
3942 ssl->handshake = NULL;
3943 }
3944
3945 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003946 * Done - should have consumed entire buffer
3947 */
3948 if( p != end )
3949 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003950
3951 return( 0 );
3952}
3953
3954/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003955 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003956 */
3957int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3958 const unsigned char *buf,
3959 size_t len )
3960{
3961 int ret = ssl_context_load( context, buf, len );
3962
3963 if( ret != 0 )
3964 mbedtls_ssl_free( context );
3965
3966 return( ret );
3967}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003968#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003969
3970/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003971 * Free an SSL context
3972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003973void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003974{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003975 if( ssl == NULL )
3976 return;
3977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003978 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003979
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003980 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003981 {
sander-visserb8aa2072020-05-06 22:05:13 +02003982#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3983 size_t out_buf_len = ssl->out_buf_len;
3984#else
3985 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3986#endif
3987
Darryl Greenb33cc762019-11-28 14:29:44 +00003988 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003989 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003990 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003991 }
3992
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003993 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003994 {
sander-visserb8aa2072020-05-06 22:05:13 +02003995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3996 size_t in_buf_len = ssl->in_buf_len;
3997#else
3998 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3999#endif
4000
Darryl Greenb33cc762019-11-28 14:29:44 +00004001 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004003 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004004 }
4005
Paul Bakker48916f92012-09-16 19:57:18 +00004006 if( ssl->transform )
4007 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008 mbedtls_ssl_transform_free( ssl->transform );
4009 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004010 }
4011
4012 if( ssl->handshake )
4013 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004014 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4016 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018 mbedtls_free( ssl->handshake );
4019 mbedtls_free( ssl->transform_negotiate );
4020 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004021 }
4022
Ronald Cron6f135e12021-12-08 16:57:54 +01004023#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004024 mbedtls_ssl_transform_free( ssl->transform_application );
4025 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004026#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004027
Paul Bakkerc0463502013-02-14 11:19:38 +01004028 if( ssl->session )
4029 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004030 mbedtls_ssl_session_free( ssl->session );
4031 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004032 }
4033
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004034#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004035 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004036 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004037 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004039 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004040#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004041
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004042#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004044#endif
4045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004047
Paul Bakker86f04f42013-02-14 11:20:09 +01004048 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004049 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004050}
4051
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004052/*
4053 * Initialze mbedtls_ssl_config
4054 */
4055void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4056{
4057 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4058}
4059
Gilles Peskineeccd8882020-03-10 12:19:08 +01004060#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004061#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02004062/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02004063 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
4064 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004065 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
4066 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004067static int ssl_preset_default_hashes[] = {
4068#if defined(MBEDTLS_SHA512_C)
4069 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004070#endif
4071#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004072 MBEDTLS_MD_SHA384,
4073#endif
4074#if defined(MBEDTLS_SHA256_C)
4075 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004076#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004077 MBEDTLS_MD_NONE
4078};
Jerry Yuf017ee42022-01-12 15:49:48 +08004079#endif /* !MBEDTLS_DEPRECATED_REMOVED */
4080#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004081
Gilles Peskineae270bf2021-06-02 00:05:29 +02004082/* The selection should be the same as mbedtls_x509_crt_profile_default in
4083 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004084 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004085 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004086 * about this list.
4087 */
Brett Warrene0edc842021-08-17 09:53:13 +01004088static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004089#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004090 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004091#endif
4092#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004093 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004094#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004095#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004096 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004097#endif
4098#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004099 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004100#endif
4101#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004102 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004103#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004104#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004105 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004106#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004107#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004108 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004109#endif
4110#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004111 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004112#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004113 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004114};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004115
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004116static int ssl_preset_suiteb_ciphersuites[] = {
4117 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4118 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4119 0
4120};
4121
Gilles Peskineeccd8882020-03-10 12:19:08 +01004122#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004123#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004124static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08004125#if defined(MBEDTLS_SHA256_C)
4126 MBEDTLS_MD_SHA256,
4127#endif
Jerry Yu713013f2022-01-17 18:16:35 +08004128#if defined(MBEDTLS_SHA384_C)
4129 MBEDTLS_MD_SHA384,
4130#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004131 MBEDTLS_MD_NONE
4132};
Jerry Yuf017ee42022-01-12 15:49:48 +08004133#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004134
Jerry Yu909df7b2022-01-22 11:56:27 +08004135/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004136 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004137 * rules SHOULD be upheld.
4138 * - No duplicate entries.
4139 * - But if there is a good reason, do not change the order of the algorithms.
4140 * - ssl_tls12_present* is for TLS 1.2 use only.
4141 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004142 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004143static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004144
Jerry Yued5e9f42022-01-26 11:21:34 +08004145#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4146 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4147 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4148#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4149 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004150
Jerry Yu909df7b2022-01-22 11:56:27 +08004151#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4152 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4153 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4154#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4155 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4156
Jerry Yued5e9f42022-01-26 11:21:34 +08004157#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4158 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4159 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4160#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4161 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004162
Jerry Yu909df7b2022-01-22 11:56:27 +08004163#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4164 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4165#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4166
Ronald Cron8540cf62022-03-16 08:01:09 +01004167#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4168 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4169#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4170
4171#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4172 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4173#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4174
Jerry Yu53037892022-01-25 11:02:06 +08004175#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4176 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4177#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4178
Jerry Yu909df7b2022-01-22 11:56:27 +08004179 MBEDTLS_TLS1_3_SIG_NONE
4180};
4181
4182/* NOTICE: see above */
4183#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4184static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004185#if defined(MBEDTLS_SHA512_C)
4186 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4187#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004188#if defined(MBEDTLS_SHA384_C)
4189 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4190#endif
4191#if defined(MBEDTLS_SHA256_C)
4192 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4193#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004194 MBEDTLS_TLS1_3_SIG_NONE
4195};
4196#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4197/* NOTICE: see above */
4198static uint16_t ssl_preset_suiteb_sig_algs[] = {
4199
Jerry Yu909df7b2022-01-22 11:56:27 +08004200#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4201 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4202 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4203#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4204 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4205
Jerry Yu53037892022-01-25 11:02:06 +08004206#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4207 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4208 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4209#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4210 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004211
4212#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4213 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4214#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004215
Jerry Yu53037892022-01-25 11:02:06 +08004216#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4217 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4218#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4219
Jerry Yu713013f2022-01-17 18:16:35 +08004220 MBEDTLS_TLS1_3_SIG_NONE
4221};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004222
Jerry Yu909df7b2022-01-22 11:56:27 +08004223/* NOTICE: see above */
4224#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4225static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004226#if defined(MBEDTLS_SHA256_C)
4227 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4228#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004229#if defined(MBEDTLS_SHA384_C)
4230 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4231#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004232 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004233};
Jerry Yu909df7b2022-01-22 11:56:27 +08004234#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4235
Jerry Yu1a8b4812022-01-20 17:56:50 +08004236#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004237
Brett Warrene0edc842021-08-17 09:53:13 +01004238static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004239#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004240 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004241#endif
4242#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004243 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004244#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004245 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004246};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004247
Jerry Yu1a8b4812022-01-20 17:56:50 +08004248#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004249/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004250 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004251static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004252{
4253 size_t i, j;
4254 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004255
Jerry Yuf377d642022-01-25 10:43:59 +08004256 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004257 {
Jerry Yuf377d642022-01-25 10:43:59 +08004258 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004259 {
Jerry Yuf377d642022-01-25 10:43:59 +08004260 if( sig_algs[i] != sig_algs[j] )
4261 continue;
4262 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4263 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4264 sig_algs[i], j, i );
4265 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004266 }
4267 }
4268 return( ret );
4269}
4270
4271#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4272
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004273/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004274 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004275 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004276int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004277 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004278{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004279#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004280 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004281#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004282
Jerry Yu1a8b4812022-01-20 17:56:50 +08004283#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004284 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004285 {
4286 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4287 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4288 }
4289
Jerry Yuf377d642022-01-25 10:43:59 +08004290 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004291 {
4292 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4293 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4294 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004295
4296#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004297 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004298 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004299 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004300 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4301 }
4302
Jerry Yuf377d642022-01-25 10:43:59 +08004303 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004304 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004305 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004306 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4307 }
4308#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004309#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4310
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004311 /* Use the functions here so that they are covered in tests,
4312 * but otherwise access member directly for efficiency */
4313 mbedtls_ssl_conf_endpoint( conf, endpoint );
4314 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004315
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004316 /*
4317 * Things that are common to all presets
4318 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004319#if defined(MBEDTLS_SSL_CLI_C)
4320 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4321 {
4322 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4323#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4324 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4325#endif
4326 }
4327#endif
4328
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004329#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4330 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4331#endif
4332
4333#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4334 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4335#endif
4336
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004337#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004338 conf->f_cookie_write = ssl_cookie_write_dummy;
4339 conf->f_cookie_check = ssl_cookie_check_dummy;
4340#endif
4341
4342#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4343 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4344#endif
4345
Janos Follath088ce432017-04-10 12:42:31 +01004346#if defined(MBEDTLS_SSL_SRV_C)
4347 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004348 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004349#endif
4350
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004351#if defined(MBEDTLS_SSL_PROTO_DTLS)
4352 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4353 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4354#endif
4355
4356#if defined(MBEDTLS_SSL_RENEGOTIATION)
4357 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004358 memset( conf->renego_period, 0x00, 2 );
4359 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004360#endif
4361
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004362#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004363 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4364 {
4365 const unsigned char dhm_p[] =
4366 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4367 const unsigned char dhm_g[] =
4368 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004369
Hanno Beckere2defad2021-07-24 05:59:17 +01004370 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4371 dhm_p, sizeof( dhm_p ),
4372 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4373 {
4374 return( ret );
4375 }
4376 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004377#endif
4378
Ronald Cron6f135e12021-12-08 16:57:54 +01004379#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004380 /*
4381 * Allow all TLS 1.3 key exchange modes by default.
4382 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004383 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004384#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004385
XiaokangQian4d3a6042022-04-21 13:46:17 +00004386 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4387 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004388#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004389 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004390 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004391#else
XiaokangQian060d8672022-04-21 09:24:56 +00004392 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004393#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004394 }
4395 else
4396 {
4397#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4398 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4399 {
4400 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4401 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4402 }
4403 else
4404 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4405 {
4406 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4407 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4408 }
4409#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4410 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4411 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4412#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4413 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4414 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4415#else
4416 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4417#endif
4418 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004419
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004420 /*
4421 * Preset-specific defaults
4422 */
4423 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004424 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004425 /*
4426 * NSA Suite B
4427 */
4428 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004429
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004430 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004431
4432#if defined(MBEDTLS_X509_CRT_PARSE_C)
4433 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004434#endif
4435
Gilles Peskineeccd8882020-03-10 12:19:08 +01004436#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004437#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004438 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004439#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004440#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4441 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4442 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4443 else
4444#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4445 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004446#endif
4447
Brett Warrene0edc842021-08-17 09:53:13 +01004448#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4449 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004450#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004451 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004452 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004453
4454 /*
4455 * Default
4456 */
4457 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004458
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004459 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004460
4461#if defined(MBEDTLS_X509_CRT_PARSE_C)
4462 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4463#endif
4464
Gilles Peskineeccd8882020-03-10 12:19:08 +01004465#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004466#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004467 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004468#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004469#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4470 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4471 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4472 else
4473#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4474 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004475#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004476
Brett Warrene0edc842021-08-17 09:53:13 +01004477#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4478 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004479#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004480 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004481
4482#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4483 conf->dhm_min_bitlen = 1024;
4484#endif
4485 }
4486
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004487 return( 0 );
4488}
4489
4490/*
4491 * Free mbedtls_ssl_config
4492 */
4493void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4494{
4495#if defined(MBEDTLS_DHM_C)
4496 mbedtls_mpi_free( &conf->dhm_P );
4497 mbedtls_mpi_free( &conf->dhm_G );
4498#endif
4499
Gilles Peskineeccd8882020-03-10 12:19:08 +01004500#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004501#if defined(MBEDTLS_USE_PSA_CRYPTO)
4502 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4503 {
4504 if( conf->psk_opaque_is_internal )
4505 {
4506 psa_destroy_key( conf->psk_opaque );
4507 conf->psk_opaque_is_internal = 0;
4508 }
4509 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4510 }
4511#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004512 if( conf->psk != NULL )
4513 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004514 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004515 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004516 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004517 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004518 }
4519
4520 if( conf->psk_identity != NULL )
4521 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004522 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004523 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004524 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004525 conf->psk_identity_len = 0;
4526 }
4527#endif
4528
4529#if defined(MBEDTLS_X509_CRT_PARSE_C)
4530 ssl_key_cert_free( conf->key_cert );
4531#endif
4532
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004533 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004534}
4535
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004536#if defined(MBEDTLS_PK_C) && \
4537 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004538/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004539 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004542{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543#if defined(MBEDTLS_RSA_C)
4544 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4545 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004546#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547#if defined(MBEDTLS_ECDSA_C)
4548 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4549 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004550#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004552}
4553
Hanno Becker7e5437a2017-04-28 17:15:26 +01004554unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4555{
4556 switch( type ) {
4557 case MBEDTLS_PK_RSA:
4558 return( MBEDTLS_SSL_SIG_RSA );
4559 case MBEDTLS_PK_ECDSA:
4560 case MBEDTLS_PK_ECKEY:
4561 return( MBEDTLS_SSL_SIG_ECDSA );
4562 default:
4563 return( MBEDTLS_SSL_SIG_ANON );
4564 }
4565}
4566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004567mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004568{
4569 switch( sig )
4570 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571#if defined(MBEDTLS_RSA_C)
4572 case MBEDTLS_SSL_SIG_RSA:
4573 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004574#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575#if defined(MBEDTLS_ECDSA_C)
4576 case MBEDTLS_SSL_SIG_ECDSA:
4577 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004578#endif
4579 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004580 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004581 }
4582}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004583#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004584
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004585/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004586 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004589{
4590 switch( hash )
4591 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592#if defined(MBEDTLS_MD5_C)
4593 case MBEDTLS_SSL_HASH_MD5:
4594 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004595#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004596#if defined(MBEDTLS_SHA1_C)
4597 case MBEDTLS_SSL_HASH_SHA1:
4598 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004599#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004600#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004601 case MBEDTLS_SSL_HASH_SHA224:
4602 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004603#endif
4604#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605 case MBEDTLS_SSL_HASH_SHA256:
4606 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004607#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004608#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609 case MBEDTLS_SSL_HASH_SHA384:
4610 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004611#endif
4612#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004613 case MBEDTLS_SSL_HASH_SHA512:
4614 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004615#endif
4616 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004617 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004618 }
4619}
4620
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004621/*
4622 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4623 */
4624unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4625{
4626 switch( md )
4627 {
4628#if defined(MBEDTLS_MD5_C)
4629 case MBEDTLS_MD_MD5:
4630 return( MBEDTLS_SSL_HASH_MD5 );
4631#endif
4632#if defined(MBEDTLS_SHA1_C)
4633 case MBEDTLS_MD_SHA1:
4634 return( MBEDTLS_SSL_HASH_SHA1 );
4635#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004636#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004637 case MBEDTLS_MD_SHA224:
4638 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004639#endif
4640#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004641 case MBEDTLS_MD_SHA256:
4642 return( MBEDTLS_SSL_HASH_SHA256 );
4643#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004644#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004645 case MBEDTLS_MD_SHA384:
4646 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004647#endif
4648#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004649 case MBEDTLS_MD_SHA512:
4650 return( MBEDTLS_SSL_HASH_SHA512 );
4651#endif
4652 default:
4653 return( MBEDTLS_SSL_HASH_NONE );
4654 }
4655}
4656
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004657/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004658 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004659 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004660 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004661int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004662{
Brett Warrene0edc842021-08-17 09:53:13 +01004663 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004664
Brett Warrene0edc842021-08-17 09:53:13 +01004665 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004666 return( -1 );
4667
Brett Warrene0edc842021-08-17 09:53:13 +01004668 for( ; *group_list != 0; group_list++ )
4669 {
4670 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004671 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004672 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004673
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004674 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004675}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004676
4677#if defined(MBEDTLS_ECP_C)
4678/*
4679 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4680 */
4681int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4682{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004683 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004684 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4685}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004686#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688#if defined(MBEDTLS_X509_CRT_PARSE_C)
4689int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4690 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004691 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004692 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004693{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004694 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004695 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004696 const char *ext_oid;
4697 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004700 {
4701 /* Server part of the key exchange */
4702 switch( ciphersuite->key_exchange )
4703 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704 case MBEDTLS_KEY_EXCHANGE_RSA:
4705 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004706 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004707 break;
4708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4710 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4711 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4712 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004713 break;
4714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4716 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004717 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004718 break;
4719
4720 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721 case MBEDTLS_KEY_EXCHANGE_NONE:
4722 case MBEDTLS_KEY_EXCHANGE_PSK:
4723 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4724 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004725 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004726 usage = 0;
4727 }
4728 }
4729 else
4730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4732 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004733 }
4734
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004735 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004736 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004737 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004738 ret = -1;
4739 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004742 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4744 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004745 }
4746 else
4747 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004748 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4749 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004750 }
4751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004753 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004754 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004755 ret = -1;
4756 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004757
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004758 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004759}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004760#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004761
Jerry Yu148165c2021-09-24 23:20:59 +08004762#if defined(MBEDTLS_USE_PSA_CRYPTO)
4763int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4764 const mbedtls_md_type_t md,
4765 unsigned char *dst,
4766 size_t dst_len,
4767 size_t *olen )
4768{
Ronald Cronf6893e12022-01-07 22:09:01 +01004769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4770 psa_hash_operation_t *hash_operation_to_clone;
4771 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4772
Jerry Yu148165c2021-09-24 23:20:59 +08004773 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004774
4775 switch( md )
4776 {
4777#if defined(MBEDTLS_SHA384_C)
4778 case MBEDTLS_MD_SHA384:
4779 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4780 break;
4781#endif
4782
4783#if defined(MBEDTLS_SHA256_C)
4784 case MBEDTLS_MD_SHA256:
4785 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4786 break;
4787#endif
4788
4789 default:
4790 goto exit;
4791 }
4792
4793 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4794 if( status != PSA_SUCCESS )
4795 goto exit;
4796
4797 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4798 if( status != PSA_SUCCESS )
4799 goto exit;
4800
4801exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004802 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004803}
4804#else /* MBEDTLS_USE_PSA_CRYPTO */
4805
Jerry Yu24c0ec32021-09-09 14:21:07 +08004806#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004807static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4808 unsigned char *dst,
4809 size_t dst_len,
4810 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004811{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004812 int ret;
4813 mbedtls_sha512_context sha512;
4814
4815 if( dst_len < 48 )
4816 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4817
4818 mbedtls_sha512_init( &sha512 );
4819 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4820
4821 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4822 {
4823 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4824 goto exit;
4825 }
4826
4827 *olen = 48;
4828
4829exit:
4830
4831 mbedtls_sha512_free( &sha512 );
4832 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004833}
4834#endif /* MBEDTLS_SHA384_C */
4835
4836#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004837static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4838 unsigned char *dst,
4839 size_t dst_len,
4840 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004841{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004842 int ret;
4843 mbedtls_sha256_context sha256;
4844
4845 if( dst_len < 32 )
4846 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4847
4848 mbedtls_sha256_init( &sha256 );
4849 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004850
Jerry Yu24c0ec32021-09-09 14:21:07 +08004851 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4852 {
4853 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4854 goto exit;
4855 }
4856
4857 *olen = 32;
4858
4859exit:
4860
4861 mbedtls_sha256_free( &sha256 );
4862 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004863}
4864#endif /* MBEDTLS_SHA256_C */
4865
Jerry Yu000f9762021-09-14 11:12:51 +08004866int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4867 const mbedtls_md_type_t md,
4868 unsigned char *dst,
4869 size_t dst_len,
4870 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004871{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004872 switch( md )
4873 {
4874
Jerry Yu24c0ec32021-09-09 14:21:07 +08004875#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004876 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004877 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004878#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004879
Jerry Yu24c0ec32021-09-09 14:21:07 +08004880#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004881 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004882 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004883#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004884
4885 default:
4886 break;
4887 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004888 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004889}
XiaokangQian647719a2021-12-07 09:16:29 +00004890
Jerry Yu148165c2021-09-24 23:20:59 +08004891#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004892
Jerry Yudc7bd172022-02-17 13:44:15 +08004893#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4894
4895#if defined(MBEDTLS_USE_PSA_CRYPTO)
4896
4897static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4898 mbedtls_svc_key_id_t key,
4899 psa_algorithm_t alg,
4900 const unsigned char* seed, size_t seed_length,
4901 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004902 const unsigned char* other_secret,
4903 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004904 size_t capacity )
4905{
4906 psa_status_t status;
4907
4908 status = psa_key_derivation_setup( derivation, alg );
4909 if( status != PSA_SUCCESS )
4910 return( status );
4911
4912 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4913 {
4914 status = psa_key_derivation_input_bytes( derivation,
4915 PSA_KEY_DERIVATION_INPUT_SEED,
4916 seed, seed_length );
4917 if( status != PSA_SUCCESS )
4918 return( status );
4919
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004920 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02004921 {
4922 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004923 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
4924 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02004925 if( status != PSA_SUCCESS )
4926 return( status );
4927 }
4928
Jerry Yudc7bd172022-02-17 13:44:15 +08004929 if( mbedtls_svc_key_id_is_null( key ) )
4930 {
4931 status = psa_key_derivation_input_bytes(
4932 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4933 NULL, 0 );
4934 }
4935 else
4936 {
4937 status = psa_key_derivation_input_key(
4938 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4939 }
4940 if( status != PSA_SUCCESS )
4941 return( status );
4942
4943 status = psa_key_derivation_input_bytes( derivation,
4944 PSA_KEY_DERIVATION_INPUT_LABEL,
4945 label, label_length );
4946 if( status != PSA_SUCCESS )
4947 return( status );
4948 }
4949 else
4950 {
4951 return( PSA_ERROR_NOT_SUPPORTED );
4952 }
4953
4954 status = psa_key_derivation_set_capacity( derivation, capacity );
4955 if( status != PSA_SUCCESS )
4956 return( status );
4957
4958 return( PSA_SUCCESS );
4959}
4960
4961static int tls_prf_generic( mbedtls_md_type_t md_type,
4962 const unsigned char *secret, size_t slen,
4963 const char *label,
4964 const unsigned char *random, size_t rlen,
4965 unsigned char *dstbuf, size_t dlen )
4966{
4967 psa_status_t status;
4968 psa_algorithm_t alg;
4969 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4970 psa_key_derivation_operation_t derivation =
4971 PSA_KEY_DERIVATION_OPERATION_INIT;
4972
4973 if( md_type == MBEDTLS_MD_SHA384 )
4974 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4975 else
4976 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4977
4978 /* Normally a "secret" should be long enough to be impossible to
4979 * find by brute force, and in particular should not be empty. But
4980 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4981 * and for this use case it makes sense to have a 0-length "secret".
4982 * Since the key API doesn't allow importing a key of length 0,
4983 * keep master_key=0, which setup_psa_key_derivation() understands
4984 * to mean a 0-length "secret" input. */
4985 if( slen != 0 )
4986 {
4987 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4988 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4989 psa_set_key_algorithm( &key_attributes, alg );
4990 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4991
4992 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4993 if( status != PSA_SUCCESS )
4994 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4995 }
4996
4997 status = setup_psa_key_derivation( &derivation,
4998 master_key, alg,
4999 random, rlen,
5000 (unsigned char const *) label,
5001 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005002 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005003 dlen );
5004 if( status != PSA_SUCCESS )
5005 {
5006 psa_key_derivation_abort( &derivation );
5007 psa_destroy_key( master_key );
5008 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5009 }
5010
5011 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5012 if( status != PSA_SUCCESS )
5013 {
5014 psa_key_derivation_abort( &derivation );
5015 psa_destroy_key( master_key );
5016 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5017 }
5018
5019 status = psa_key_derivation_abort( &derivation );
5020 if( status != PSA_SUCCESS )
5021 {
5022 psa_destroy_key( master_key );
5023 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5024 }
5025
5026 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5027 status = psa_destroy_key( master_key );
5028 if( status != PSA_SUCCESS )
5029 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5030
5031 return( 0 );
5032}
5033
5034#else /* MBEDTLS_USE_PSA_CRYPTO */
5035
5036static int tls_prf_generic( mbedtls_md_type_t md_type,
5037 const unsigned char *secret, size_t slen,
5038 const char *label,
5039 const unsigned char *random, size_t rlen,
5040 unsigned char *dstbuf, size_t dlen )
5041{
5042 size_t nb;
5043 size_t i, j, k, md_len;
5044 unsigned char *tmp;
5045 size_t tmp_len = 0;
5046 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5047 const mbedtls_md_info_t *md_info;
5048 mbedtls_md_context_t md_ctx;
5049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5050
5051 mbedtls_md_init( &md_ctx );
5052
5053 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5054 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5055
5056 md_len = mbedtls_md_get_size( md_info );
5057
5058 tmp_len = md_len + strlen( label ) + rlen;
5059 tmp = mbedtls_calloc( 1, tmp_len );
5060 if( tmp == NULL )
5061 {
5062 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5063 goto exit;
5064 }
5065
5066 nb = strlen( label );
5067 memcpy( tmp + md_len, label, nb );
5068 memcpy( tmp + md_len + nb, random, rlen );
5069 nb += rlen;
5070
5071 /*
5072 * Compute P_<hash>(secret, label + random)[0..dlen]
5073 */
5074 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5075 goto exit;
5076
5077 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5078 if( ret != 0 )
5079 goto exit;
5080 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5081 if( ret != 0 )
5082 goto exit;
5083 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5084 if( ret != 0 )
5085 goto exit;
5086
5087 for( i = 0; i < dlen; i += md_len )
5088 {
5089 ret = mbedtls_md_hmac_reset ( &md_ctx );
5090 if( ret != 0 )
5091 goto exit;
5092 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5093 if( ret != 0 )
5094 goto exit;
5095 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5096 if( ret != 0 )
5097 goto exit;
5098
5099 ret = mbedtls_md_hmac_reset ( &md_ctx );
5100 if( ret != 0 )
5101 goto exit;
5102 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5103 if( ret != 0 )
5104 goto exit;
5105 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5106 if( ret != 0 )
5107 goto exit;
5108
5109 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5110
5111 for( j = 0; j < k; j++ )
5112 dstbuf[i + j] = h_i[j];
5113 }
5114
5115exit:
5116 mbedtls_md_free( &md_ctx );
5117
5118 mbedtls_platform_zeroize( tmp, tmp_len );
5119 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5120
5121 mbedtls_free( tmp );
5122
5123 return( ret );
5124}
5125#endif /* MBEDTLS_USE_PSA_CRYPTO */
5126
5127#if defined(MBEDTLS_SHA256_C)
5128static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5129 const char *label,
5130 const unsigned char *random, size_t rlen,
5131 unsigned char *dstbuf, size_t dlen )
5132{
5133 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5134 label, random, rlen, dstbuf, dlen ) );
5135}
5136#endif /* MBEDTLS_SHA256_C */
5137
5138#if defined(MBEDTLS_SHA384_C)
5139static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5140 const char *label,
5141 const unsigned char *random, size_t rlen,
5142 unsigned char *dstbuf, size_t dlen )
5143{
5144 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5145 label, random, rlen, dstbuf, dlen ) );
5146}
5147#endif /* MBEDTLS_SHA384_C */
5148
Jerry Yuf009d862022-02-17 14:01:37 +08005149/*
5150 * Set appropriate PRF function and other SSL / TLS1.2 functions
5151 *
5152 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005153 * - hash associated with the ciphersuite (only used by TLS 1.2)
5154 *
5155 * Outputs:
5156 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5157 */
5158static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005159 mbedtls_md_type_t hash )
5160{
Jerry Yuf009d862022-02-17 14:01:37 +08005161#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005162 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005163 {
5164 handshake->tls_prf = tls_prf_sha384;
5165 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5166 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5167 }
5168 else
5169#endif
5170#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005171 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005172 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005173 handshake->tls_prf = tls_prf_sha256;
5174 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5175 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5176 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005177#else
Jerry Yuf009d862022-02-17 14:01:37 +08005178 {
Jerry Yuf009d862022-02-17 14:01:37 +08005179 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005180 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005181 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5182 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005183#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005184
5185 return( 0 );
5186}
Jerry Yud6ab2352022-02-17 14:03:43 +08005187
Przemek Stekiel99114f32022-04-22 11:20:09 +02005188
5189
5190#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005191 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED )
Jerry Yud6ab2352022-02-17 14:03:43 +08005192static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
5193{
5194 if( ssl->conf->f_psk != NULL )
5195 {
5196 /* If we've used a callback to select the PSK,
5197 * the static configuration is irrelevant. */
5198 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
5199 return( 1 );
5200
5201 return( 0 );
5202 }
5203
5204 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5205 return( 1 );
5206
5207 return( 0 );
5208}
5209#endif /* MBEDTLS_USE_PSA_CRYPTO &&
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005210 MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yud6ab2352022-02-17 14:03:43 +08005211
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005212/*
5213 * Compute master secret if needed
5214 *
5215 * Parameters:
5216 * [in/out] handshake
5217 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5218 * (PSA-PSK) ciphersuite_info, psk_opaque
5219 * [out] premaster (cleared)
5220 * [out] master
5221 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5222 * debug: conf->f_dbg, conf->p_dbg
5223 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005224 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005225 */
5226static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5227 unsigned char *master,
5228 const mbedtls_ssl_context *ssl )
5229{
5230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5231
5232 /* cf. RFC 5246, Section 8.1:
5233 * "The master secret is always exactly 48 bytes in length." */
5234 size_t const master_secret_len = 48;
5235
5236#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5237 unsigned char session_hash[48];
5238#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5239
5240 /* The label for the KDF used for key expansion.
5241 * This is either "master secret" or "extended master secret"
5242 * depending on whether the Extended Master Secret extension
5243 * is used. */
5244 char const *lbl = "master secret";
5245
Przemek Stekielae4ed302022-04-05 17:15:55 +02005246 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005247 * - If the Extended Master Secret extension is not used,
5248 * this is ClientHello.Random + ServerHello.Random
5249 * (see Sect. 8.1 in RFC 5246).
5250 * - If the Extended Master Secret extension is used,
5251 * this is the transcript of the handshake so far.
5252 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005253 unsigned char const *seed = handshake->randbytes;
5254 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005255
5256#if !defined(MBEDTLS_DEBUG_C) && \
5257 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5258 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5259 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5260 ssl = NULL; /* make sure we don't use it except for those cases */
5261 (void) ssl;
5262#endif
5263
5264 if( handshake->resume != 0 )
5265 {
5266 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5267 return( 0 );
5268 }
5269
5270#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5271 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5272 {
5273 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005274 seed = session_hash;
5275 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005276
5277 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005278 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005279 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005280#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005281
Przemek Stekiel99114f32022-04-22 11:20:09 +02005282#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005283 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5284 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005285 ssl_use_opaque_psk( ssl ) == 1 )
5286 {
5287 /* Perform PSK-to-MS expansion in a single step. */
5288 psa_status_t status;
5289 psa_algorithm_t alg;
5290 mbedtls_svc_key_id_t psk;
5291 psa_key_derivation_operation_t derivation =
5292 PSA_KEY_DERIVATION_OPERATION_INIT;
5293 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5294
5295 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5296
5297 psk = mbedtls_ssl_get_opaque_psk( ssl );
5298
5299 if( hash_alg == MBEDTLS_MD_SHA384 )
5300 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5301 else
5302 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5303
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005304 size_t other_secret_len = 0;
5305 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005306
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005307 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005308 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005309 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005310 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005311 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005312 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005313 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005314 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005315 other_secret_len = 48;
5316 other_secret = handshake->premaster + 2;
5317 break;
5318 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005319 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005320 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5321 other_secret = handshake->premaster + 2;
5322 break;
5323 default:
5324 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005325 }
5326
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005327 status = setup_psa_key_derivation( &derivation, psk, alg,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005328 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005329 (unsigned char const *) lbl,
5330 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005331 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005332 master_secret_len );
5333 if( status != PSA_SUCCESS )
5334 {
5335 psa_key_derivation_abort( &derivation );
5336 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5337 }
5338
5339 status = psa_key_derivation_output_bytes( &derivation,
5340 master,
5341 master_secret_len );
5342 if( status != PSA_SUCCESS )
5343 {
5344 psa_key_derivation_abort( &derivation );
5345 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5346 }
5347
5348 status = psa_key_derivation_abort( &derivation );
5349 if( status != PSA_SUCCESS )
5350 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5351 }
5352 else
5353#endif
5354 {
5355 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005356 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005357 master,
5358 master_secret_len );
5359 if( ret != 0 )
5360 {
5361 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5362 return( ret );
5363 }
5364
5365 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5366 handshake->premaster,
5367 handshake->pmslen );
5368
5369 mbedtls_platform_zeroize( handshake->premaster,
5370 sizeof(handshake->premaster) );
5371 }
5372
5373 return( 0 );
5374}
5375
Jerry Yud62f87e2022-02-17 14:09:02 +08005376int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5377{
5378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5379 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5380 ssl->handshake->ciphersuite_info;
5381
5382 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5383
5384 /* Set PRF, calc_verify and calc_finished function pointers */
5385 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005386 ciphersuite_info->mac );
5387 if( ret != 0 )
5388 {
5389 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5390 return( ret );
5391 }
5392
5393 /* Compute master secret if needed */
5394 ret = ssl_compute_master( ssl->handshake,
5395 ssl->session_negotiate->master,
5396 ssl );
5397 if( ret != 0 )
5398 {
5399 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5400 return( ret );
5401 }
5402
5403 /* Swap the client and server random values:
5404 * - MS derivation wanted client+server (RFC 5246 8.1)
5405 * - key derivation wants server+client (RFC 5246 6.3) */
5406 {
5407 unsigned char tmp[64];
5408 memcpy( tmp, ssl->handshake->randbytes, 64 );
5409 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5410 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5411 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5412 }
5413
5414 /* Populate transform structure */
5415 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5416 ssl->session_negotiate->ciphersuite,
5417 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005419 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005421 ssl->handshake->tls_prf,
5422 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005423 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005424 ssl->conf->endpoint,
5425 ssl );
5426 if( ret != 0 )
5427 {
5428 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5429 return( ret );
5430 }
5431
5432 /* We no longer need Server/ClientHello.random values */
5433 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5434 sizeof( ssl->handshake->randbytes ) );
5435
5436 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5437
5438 return( 0 );
5439}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005440
Ronald Cron4dcbca92022-03-07 10:21:40 +01005441int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5442{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005443 switch( md )
5444 {
5445#if defined(MBEDTLS_SHA384_C)
5446 case MBEDTLS_SSL_HASH_SHA384:
5447 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5448 break;
5449#endif
5450#if defined(MBEDTLS_SHA256_C)
5451 case MBEDTLS_SSL_HASH_SHA256:
5452 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5453 break;
5454#endif
5455 default:
5456 return( -1 );
5457 }
5458
Ronald Cronc2f13a02022-03-07 10:25:24 +01005459 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005460}
5461
Jerry Yu8392e0d2022-02-17 14:10:24 +08005462#if defined(MBEDTLS_SHA256_C)
5463void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5464 unsigned char *hash,
5465 size_t *hlen )
5466{
5467#if defined(MBEDTLS_USE_PSA_CRYPTO)
5468 size_t hash_size;
5469 psa_status_t status;
5470 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5471
5472 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5473 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5474 if( status != PSA_SUCCESS )
5475 {
5476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5477 return;
5478 }
5479
5480 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5481 if( status != PSA_SUCCESS )
5482 {
5483 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5484 return;
5485 }
5486
5487 *hlen = 32;
5488 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5489 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5490#else
5491 mbedtls_sha256_context sha256;
5492
5493 mbedtls_sha256_init( &sha256 );
5494
5495 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5496
5497 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5498 mbedtls_sha256_finish( &sha256, hash );
5499
5500 *hlen = 32;
5501
5502 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5504
5505 mbedtls_sha256_free( &sha256 );
5506#endif /* MBEDTLS_USE_PSA_CRYPTO */
5507 return;
5508}
5509#endif /* MBEDTLS_SHA256_C */
5510
Jerry Yuc1cb3842022-02-17 14:13:48 +08005511#if defined(MBEDTLS_SHA384_C)
5512void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5513 unsigned char *hash,
5514 size_t *hlen )
5515{
5516#if defined(MBEDTLS_USE_PSA_CRYPTO)
5517 size_t hash_size;
5518 psa_status_t status;
5519 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5520
5521 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5522 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5523 if( status != PSA_SUCCESS )
5524 {
5525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5526 return;
5527 }
5528
5529 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5530 if( status != PSA_SUCCESS )
5531 {
5532 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5533 return;
5534 }
5535
5536 *hlen = 48;
5537 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5538 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5539#else
5540 mbedtls_sha512_context sha512;
5541
5542 mbedtls_sha512_init( &sha512 );
5543
5544 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5545
5546 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5547 mbedtls_sha512_finish( &sha512, hash );
5548
5549 *hlen = 48;
5550
5551 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5552 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5553
5554 mbedtls_sha512_free( &sha512 );
5555#endif /* MBEDTLS_USE_PSA_CRYPTO */
5556 return;
5557}
5558#endif /* MBEDTLS_SHA384_C */
5559
Jerry Yuce3dca42022-02-17 14:16:37 +08005560#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5561int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5562{
5563 unsigned char *p = ssl->handshake->premaster;
5564 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5565 const unsigned char *psk = NULL;
5566 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005567 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005568
Neil Armstronga33a2552022-04-12 14:40:47 +02005569#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5570 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5571 (void) key_ex;
5572#endif /* MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5573
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005574 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005575 {
5576 /*
5577 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005578 * checked before calling this function.
5579 *
5580 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005581 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005582 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005583 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5584 {
5585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5586 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5587 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005588 }
5589
5590 /*
5591 * PMS = struct {
5592 * opaque other_secret<0..2^16-1>;
5593 * opaque psk<0..2^16-1>;
5594 * };
5595 * with "other_secret" depending on the particular key exchange
5596 */
5597#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5598 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5599 {
5600 if( end - p < 2 )
5601 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5602
5603 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5604 p += 2;
5605
5606 if( end < p || (size_t)( end - p ) < psk_len )
5607 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5608
5609 memset( p, 0, psk_len );
5610 p += psk_len;
5611 }
5612 else
5613#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5614#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5615 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5616 {
5617 /*
5618 * other_secret already set by the ClientKeyExchange message,
5619 * and is 48 bytes long
5620 */
5621 if( end - p < 2 )
5622 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5623
5624 *p++ = 0;
5625 *p++ = 48;
5626 p += 48;
5627 }
5628 else
5629#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5630#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5631 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5632 {
5633 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5634 size_t len;
5635
5636 /* Write length only when we know the actual value */
5637 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5638 p + 2, end - ( p + 2 ), &len,
5639 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5640 {
5641 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5642 return( ret );
5643 }
5644 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5645 p += 2 + len;
5646
5647 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005648
5649 /* For opaque PSK fill premaster with the the shared secret without PSK. */
5650 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5651 {
5652 MBEDTLS_SSL_DEBUG_MSG( 1,
5653 ( "skip PMS generation for opaque DHE-PSK" ) );
5654 return( 0 );
5655 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005656 }
5657 else
5658#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstronga33a2552022-04-12 14:40:47 +02005659#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5660 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005661 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5662 {
5663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5664 size_t zlen;
5665
5666 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5667 p + 2, end - ( p + 2 ),
5668 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5669 {
5670 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5671 return( ret );
5672 }
5673
5674 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5675 p += 2 + zlen;
5676
5677 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5678 MBEDTLS_DEBUG_ECDH_Z );
5679 }
5680 else
Neil Armstronga33a2552022-04-12 14:40:47 +02005681#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005682 {
5683 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5684 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5685 }
5686
5687 /* opaque psk<0..2^16-1>; */
5688 if( end - p < 2 )
5689 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5690
5691 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5692 p += 2;
5693
5694 if( end < p || (size_t)( end - p ) < psk_len )
5695 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5696
5697 memcpy( p, psk, psk_len );
5698 p += psk_len;
5699
5700 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5701
5702 return( 0 );
5703}
5704#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005705
5706#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5707static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5708
5709#if defined(MBEDTLS_SSL_PROTO_DTLS)
5710int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5711{
5712 /* If renegotiation is not enforced, retransmit until we would reach max
5713 * timeout if we were using the usual handshake doubling scheme */
5714 if( ssl->conf->renego_max_records < 0 )
5715 {
5716 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5717 unsigned char doublings = 1;
5718
5719 while( ratio != 0 )
5720 {
5721 ++doublings;
5722 ratio >>= 1;
5723 }
5724
5725 if( ++ssl->renego_records_seen > doublings )
5726 {
5727 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5728 return( 0 );
5729 }
5730 }
5731
5732 return( ssl_write_hello_request( ssl ) );
5733}
5734#endif
5735#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005736
Jerry Yud9526692022-02-17 14:23:47 +08005737/*
5738 * Handshake functions
5739 */
5740#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5741/* No certificate support -> dummy functions */
5742int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5743{
5744 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5745 ssl->handshake->ciphersuite_info;
5746
5747 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5748
5749 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5750 {
5751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5752 ssl->state++;
5753 return( 0 );
5754 }
5755
5756 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5757 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5758}
5759
5760int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5761{
5762 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5763 ssl->handshake->ciphersuite_info;
5764
5765 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5766
5767 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5768 {
5769 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5770 ssl->state++;
5771 return( 0 );
5772 }
5773
5774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5775 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5776}
5777
5778#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5779/* Some certificate support -> implement write and parse */
5780
5781int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5782{
5783 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5784 size_t i, n;
5785 const mbedtls_x509_crt *crt;
5786 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5787 ssl->handshake->ciphersuite_info;
5788
5789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5790
5791 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5792 {
5793 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5794 ssl->state++;
5795 return( 0 );
5796 }
5797
5798#if defined(MBEDTLS_SSL_CLI_C)
5799 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5800 {
5801 if( ssl->handshake->client_auth == 0 )
5802 {
5803 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5804 ssl->state++;
5805 return( 0 );
5806 }
5807 }
5808#endif /* MBEDTLS_SSL_CLI_C */
5809#if defined(MBEDTLS_SSL_SRV_C)
5810 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5811 {
5812 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5813 {
5814 /* Should never happen because we shouldn't have picked the
5815 * ciphersuite if we don't have a certificate. */
5816 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5817 }
5818 }
5819#endif
5820
5821 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5822
5823 /*
5824 * 0 . 0 handshake type
5825 * 1 . 3 handshake length
5826 * 4 . 6 length of all certs
5827 * 7 . 9 length of cert. 1
5828 * 10 . n-1 peer certificate
5829 * n . n+2 length of cert. 2
5830 * n+3 . ... upper level cert, etc.
5831 */
5832 i = 7;
5833 crt = mbedtls_ssl_own_cert( ssl );
5834
5835 while( crt != NULL )
5836 {
5837 n = crt->raw.len;
5838 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5839 {
5840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5841 " > %" MBEDTLS_PRINTF_SIZET,
5842 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5843 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5844 }
5845
5846 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5847 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5848 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5849
5850 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5851 i += n; crt = crt->next;
5852 }
5853
5854 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5855 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5856 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5857
5858 ssl->out_msglen = i;
5859 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5860 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5861
5862 ssl->state++;
5863
5864 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5865 {
5866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5867 return( ret );
5868 }
5869
5870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5871
5872 return( ret );
5873}
5874
5875#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5876
5877#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5878static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5879 unsigned char *crt_buf,
5880 size_t crt_buf_len )
5881{
5882 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5883
5884 if( peer_crt == NULL )
5885 return( -1 );
5886
5887 if( peer_crt->raw.len != crt_buf_len )
5888 return( -1 );
5889
5890 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5891}
5892#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5893static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5894 unsigned char *crt_buf,
5895 size_t crt_buf_len )
5896{
5897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5898 unsigned char const * const peer_cert_digest =
5899 ssl->session->peer_cert_digest;
5900 mbedtls_md_type_t const peer_cert_digest_type =
5901 ssl->session->peer_cert_digest_type;
5902 mbedtls_md_info_t const * const digest_info =
5903 mbedtls_md_info_from_type( peer_cert_digest_type );
5904 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5905 size_t digest_len;
5906
5907 if( peer_cert_digest == NULL || digest_info == NULL )
5908 return( -1 );
5909
5910 digest_len = mbedtls_md_get_size( digest_info );
5911 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5912 return( -1 );
5913
5914 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5915 if( ret != 0 )
5916 return( -1 );
5917
5918 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5919}
5920#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5921#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5922
5923/*
5924 * Once the certificate message is read, parse it into a cert chain and
5925 * perform basic checks, but leave actual verification to the caller
5926 */
5927static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5928 mbedtls_x509_crt *chain )
5929{
5930 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5931#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5932 int crt_cnt=0;
5933#endif
5934 size_t i, n;
5935 uint8_t alert;
5936
5937 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5938 {
5939 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5940 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5941 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5942 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5943 }
5944
5945 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5946 {
5947 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5948 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5949 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5950 }
5951
5952 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5953 {
5954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5955 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5956 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5957 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5958 }
5959
5960 i = mbedtls_ssl_hs_hdr_len( ssl );
5961
5962 /*
5963 * Same message structure as in mbedtls_ssl_write_certificate()
5964 */
5965 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5966
5967 if( ssl->in_msg[i] != 0 ||
5968 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5969 {
5970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5971 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5972 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5973 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5974 }
5975
5976 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5977 i += 3;
5978
5979 /* Iterate through and parse the CRTs in the provided chain. */
5980 while( i < ssl->in_hslen )
5981 {
5982 /* Check that there's room for the next CRT's length fields. */
5983 if ( i + 3 > ssl->in_hslen ) {
5984 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5985 mbedtls_ssl_send_alert_message( ssl,
5986 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5987 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5988 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5989 }
5990 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5991 * anything beyond 2**16 ~ 64K. */
5992 if( ssl->in_msg[i] != 0 )
5993 {
5994 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5995 mbedtls_ssl_send_alert_message( ssl,
5996 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5997 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5998 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5999 }
6000
6001 /* Read length of the next CRT in the chain. */
6002 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6003 | (unsigned int) ssl->in_msg[i + 2];
6004 i += 3;
6005
6006 if( n < 128 || i + n > ssl->in_hslen )
6007 {
6008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6009 mbedtls_ssl_send_alert_message( ssl,
6010 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6011 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6012 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6013 }
6014
6015 /* Check if we're handling the first CRT in the chain. */
6016#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6017 if( crt_cnt++ == 0 &&
6018 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6019 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6020 {
6021 /* During client-side renegotiation, check that the server's
6022 * end-CRTs hasn't changed compared to the initial handshake,
6023 * mitigating the triple handshake attack. On success, reuse
6024 * the original end-CRT instead of parsing it again. */
6025 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6026 if( ssl_check_peer_crt_unchanged( ssl,
6027 &ssl->in_msg[i],
6028 n ) != 0 )
6029 {
6030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6031 mbedtls_ssl_send_alert_message( ssl,
6032 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6033 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6034 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6035 }
6036
6037 /* Now we can safely free the original chain. */
6038 ssl_clear_peer_cert( ssl->session );
6039 }
6040#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6041
6042 /* Parse the next certificate in the chain. */
6043#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6044 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6045#else
6046 /* If we don't need to store the CRT chain permanently, parse
6047 * it in-place from the input buffer instead of making a copy. */
6048 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6049#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6050 switch( ret )
6051 {
6052 case 0: /*ok*/
6053 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6054 /* Ignore certificate with an unknown algorithm: maybe a
6055 prior certificate was already trusted. */
6056 break;
6057
6058 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6059 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6060 goto crt_parse_der_failed;
6061
6062 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6063 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6064 goto crt_parse_der_failed;
6065
6066 default:
6067 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6068 crt_parse_der_failed:
6069 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6070 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6071 return( ret );
6072 }
6073
6074 i += n;
6075 }
6076
6077 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6078 return( 0 );
6079}
6080
6081#if defined(MBEDTLS_SSL_SRV_C)
6082static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6083{
6084 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6085 return( -1 );
6086
6087 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6088 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6089 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6090 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6091 {
6092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
6093 return( 0 );
6094 }
6095 return( -1 );
6096}
6097#endif /* MBEDTLS_SSL_SRV_C */
6098
6099/* Check if a certificate message is expected.
6100 * Return either
6101 * - SSL_CERTIFICATE_EXPECTED, or
6102 * - SSL_CERTIFICATE_SKIP
6103 * indicating whether a Certificate message is expected or not.
6104 */
6105#define SSL_CERTIFICATE_EXPECTED 0
6106#define SSL_CERTIFICATE_SKIP 1
6107static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6108 int authmode )
6109{
6110 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6111 ssl->handshake->ciphersuite_info;
6112
6113 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6114 return( SSL_CERTIFICATE_SKIP );
6115
6116#if defined(MBEDTLS_SSL_SRV_C)
6117 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6118 {
6119 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6120 return( SSL_CERTIFICATE_SKIP );
6121
6122 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6123 {
6124 ssl->session_negotiate->verify_result =
6125 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6126 return( SSL_CERTIFICATE_SKIP );
6127 }
6128 }
6129#else
6130 ((void) authmode);
6131#endif /* MBEDTLS_SSL_SRV_C */
6132
6133 return( SSL_CERTIFICATE_EXPECTED );
6134}
6135
6136static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6137 int authmode,
6138 mbedtls_x509_crt *chain,
6139 void *rs_ctx )
6140{
6141 int ret = 0;
6142 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6143 ssl->handshake->ciphersuite_info;
6144 int have_ca_chain = 0;
6145
6146 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6147 void *p_vrfy;
6148
6149 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6150 return( 0 );
6151
6152 if( ssl->f_vrfy != NULL )
6153 {
6154 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6155 f_vrfy = ssl->f_vrfy;
6156 p_vrfy = ssl->p_vrfy;
6157 }
6158 else
6159 {
6160 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6161 f_vrfy = ssl->conf->f_vrfy;
6162 p_vrfy = ssl->conf->p_vrfy;
6163 }
6164
6165 /*
6166 * Main check: verify certificate
6167 */
6168#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6169 if( ssl->conf->f_ca_cb != NULL )
6170 {
6171 ((void) rs_ctx);
6172 have_ca_chain = 1;
6173
6174 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6175 ret = mbedtls_x509_crt_verify_with_ca_cb(
6176 chain,
6177 ssl->conf->f_ca_cb,
6178 ssl->conf->p_ca_cb,
6179 ssl->conf->cert_profile,
6180 ssl->hostname,
6181 &ssl->session_negotiate->verify_result,
6182 f_vrfy, p_vrfy );
6183 }
6184 else
6185#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6186 {
6187 mbedtls_x509_crt *ca_chain;
6188 mbedtls_x509_crl *ca_crl;
6189
6190#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6191 if( ssl->handshake->sni_ca_chain != NULL )
6192 {
6193 ca_chain = ssl->handshake->sni_ca_chain;
6194 ca_crl = ssl->handshake->sni_ca_crl;
6195 }
6196 else
6197#endif
6198 {
6199 ca_chain = ssl->conf->ca_chain;
6200 ca_crl = ssl->conf->ca_crl;
6201 }
6202
6203 if( ca_chain != NULL )
6204 have_ca_chain = 1;
6205
6206 ret = mbedtls_x509_crt_verify_restartable(
6207 chain,
6208 ca_chain, ca_crl,
6209 ssl->conf->cert_profile,
6210 ssl->hostname,
6211 &ssl->session_negotiate->verify_result,
6212 f_vrfy, p_vrfy, rs_ctx );
6213 }
6214
6215 if( ret != 0 )
6216 {
6217 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6218 }
6219
6220#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6221 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6222 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6223#endif
6224
6225 /*
6226 * Secondary checks: always done, but change 'ret' only if it was 0
6227 */
6228
6229#if defined(MBEDTLS_ECP_C)
6230 {
6231 const mbedtls_pk_context *pk = &chain->pk;
6232
6233 /* If certificate uses an EC key, make sure the curve is OK */
6234 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6235 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6236 {
6237 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6238
6239 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6240 if( ret == 0 )
6241 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6242 }
6243 }
6244#endif /* MBEDTLS_ECP_C */
6245
6246 if( mbedtls_ssl_check_cert_usage( chain,
6247 ciphersuite_info,
6248 ! ssl->conf->endpoint,
6249 &ssl->session_negotiate->verify_result ) != 0 )
6250 {
6251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6252 if( ret == 0 )
6253 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6254 }
6255
6256 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6257 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6258 * with details encoded in the verification flags. All other kinds
6259 * of error codes, including those from the user provided f_vrfy
6260 * functions, are treated as fatal and lead to a failure of
6261 * ssl_parse_certificate even if verification was optional. */
6262 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6263 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6264 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6265 {
6266 ret = 0;
6267 }
6268
6269 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6270 {
6271 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6272 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6273 }
6274
6275 if( ret != 0 )
6276 {
6277 uint8_t alert;
6278
6279 /* The certificate may have been rejected for several reasons.
6280 Pick one and send the corresponding alert. Which alert to send
6281 may be a subject of debate in some cases. */
6282 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6283 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6284 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6285 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6286 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6287 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6288 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6289 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6290 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6291 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6292 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6293 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6294 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6295 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6296 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6297 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6298 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6299 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6300 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6301 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6302 else
6303 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6304 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6305 alert );
6306 }
6307
6308#if defined(MBEDTLS_DEBUG_C)
6309 if( ssl->session_negotiate->verify_result != 0 )
6310 {
6311 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6312 (unsigned int) ssl->session_negotiate->verify_result ) );
6313 }
6314 else
6315 {
6316 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6317 }
6318#endif /* MBEDTLS_DEBUG_C */
6319
6320 return( ret );
6321}
6322
6323#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6324static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6325 unsigned char *start, size_t len )
6326{
6327 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6328 /* Remember digest of the peer's end-CRT. */
6329 ssl->session_negotiate->peer_cert_digest =
6330 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6331 if( ssl->session_negotiate->peer_cert_digest == NULL )
6332 {
6333 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6334 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6335 mbedtls_ssl_send_alert_message( ssl,
6336 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6337 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6338
6339 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6340 }
6341
6342 ret = mbedtls_md( mbedtls_md_info_from_type(
6343 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6344 start, len,
6345 ssl->session_negotiate->peer_cert_digest );
6346
6347 ssl->session_negotiate->peer_cert_digest_type =
6348 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6349 ssl->session_negotiate->peer_cert_digest_len =
6350 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6351
6352 return( ret );
6353}
6354
6355static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6356 unsigned char *start, size_t len )
6357{
6358 unsigned char *end = start + len;
6359 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6360
6361 /* Make a copy of the peer's raw public key. */
6362 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6363 ret = mbedtls_pk_parse_subpubkey( &start, end,
6364 &ssl->handshake->peer_pubkey );
6365 if( ret != 0 )
6366 {
6367 /* We should have parsed the public key before. */
6368 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6369 }
6370
6371 return( 0 );
6372}
6373#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6374
6375int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6376{
6377 int ret = 0;
6378 int crt_expected;
6379#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6380 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6381 ? ssl->handshake->sni_authmode
6382 : ssl->conf->authmode;
6383#else
6384 const int authmode = ssl->conf->authmode;
6385#endif
6386 void *rs_ctx = NULL;
6387 mbedtls_x509_crt *chain = NULL;
6388
6389 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6390
6391 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6392 if( crt_expected == SSL_CERTIFICATE_SKIP )
6393 {
6394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6395 goto exit;
6396 }
6397
6398#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6399 if( ssl->handshake->ecrs_enabled &&
6400 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6401 {
6402 chain = ssl->handshake->ecrs_peer_cert;
6403 ssl->handshake->ecrs_peer_cert = NULL;
6404 goto crt_verify;
6405 }
6406#endif
6407
6408 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6409 {
6410 /* mbedtls_ssl_read_record may have sent an alert already. We
6411 let it decide whether to alert. */
6412 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6413 goto exit;
6414 }
6415
6416#if defined(MBEDTLS_SSL_SRV_C)
6417 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6418 {
6419 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6420
6421 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6422 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6423
6424 goto exit;
6425 }
6426#endif /* MBEDTLS_SSL_SRV_C */
6427
6428 /* Clear existing peer CRT structure in case we tried to
6429 * reuse a session but it failed, and allocate a new one. */
6430 ssl_clear_peer_cert( ssl->session_negotiate );
6431
6432 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6433 if( chain == NULL )
6434 {
6435 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6436 sizeof( mbedtls_x509_crt ) ) );
6437 mbedtls_ssl_send_alert_message( ssl,
6438 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6439 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6440
6441 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6442 goto exit;
6443 }
6444 mbedtls_x509_crt_init( chain );
6445
6446 ret = ssl_parse_certificate_chain( ssl, chain );
6447 if( ret != 0 )
6448 goto exit;
6449
6450#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6451 if( ssl->handshake->ecrs_enabled)
6452 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6453
6454crt_verify:
6455 if( ssl->handshake->ecrs_enabled)
6456 rs_ctx = &ssl->handshake->ecrs_ctx;
6457#endif
6458
6459 ret = ssl_parse_certificate_verify( ssl, authmode,
6460 chain, rs_ctx );
6461 if( ret != 0 )
6462 goto exit;
6463
6464#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6465 {
6466 unsigned char *crt_start, *pk_start;
6467 size_t crt_len, pk_len;
6468
6469 /* We parse the CRT chain without copying, so
6470 * these pointers point into the input buffer,
6471 * and are hence still valid after freeing the
6472 * CRT chain. */
6473
6474 crt_start = chain->raw.p;
6475 crt_len = chain->raw.len;
6476
6477 pk_start = chain->pk_raw.p;
6478 pk_len = chain->pk_raw.len;
6479
6480 /* Free the CRT structures before computing
6481 * digest and copying the peer's public key. */
6482 mbedtls_x509_crt_free( chain );
6483 mbedtls_free( chain );
6484 chain = NULL;
6485
6486 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6487 if( ret != 0 )
6488 goto exit;
6489
6490 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6491 if( ret != 0 )
6492 goto exit;
6493 }
6494#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6495 /* Pass ownership to session structure. */
6496 ssl->session_negotiate->peer_cert = chain;
6497 chain = NULL;
6498#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6499
6500 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6501
6502exit:
6503
6504 if( ret == 0 )
6505 ssl->state++;
6506
6507#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6508 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6509 {
6510 ssl->handshake->ecrs_peer_cert = chain;
6511 chain = NULL;
6512 }
6513#endif
6514
6515 if( chain != NULL )
6516 {
6517 mbedtls_x509_crt_free( chain );
6518 mbedtls_free( chain );
6519 }
6520
6521 return( ret );
6522}
6523#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6524
Jerry Yu615bd6f2022-02-17 14:25:15 +08006525#if defined(MBEDTLS_SHA256_C)
6526static void ssl_calc_finished_tls_sha256(
6527 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6528{
6529 int len = 12;
6530 const char *sender;
6531 unsigned char padbuf[32];
6532#if defined(MBEDTLS_USE_PSA_CRYPTO)
6533 size_t hash_size;
6534 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6535 psa_status_t status;
6536#else
6537 mbedtls_sha256_context sha256;
6538#endif
6539
6540 mbedtls_ssl_session *session = ssl->session_negotiate;
6541 if( !session )
6542 session = ssl->session;
6543
6544 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6545 ? "client finished"
6546 : "server finished";
6547
6548#if defined(MBEDTLS_USE_PSA_CRYPTO)
6549 sha256_psa = psa_hash_operation_init();
6550
6551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6552
6553 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6554 if( status != PSA_SUCCESS )
6555 {
6556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6557 return;
6558 }
6559
6560 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6561 if( status != PSA_SUCCESS )
6562 {
6563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6564 return;
6565 }
6566 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6567#else
6568
6569 mbedtls_sha256_init( &sha256 );
6570
6571 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6572
6573 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6574
6575 /*
6576 * TLSv1.2:
6577 * hash = PRF( master, finished_label,
6578 * Hash( handshake ) )[0.11]
6579 */
6580
6581#if !defined(MBEDTLS_SHA256_ALT)
6582 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6583 sha256.state, sizeof( sha256.state ) );
6584#endif
6585
6586 mbedtls_sha256_finish( &sha256, padbuf );
6587 mbedtls_sha256_free( &sha256 );
6588#endif /* MBEDTLS_USE_PSA_CRYPTO */
6589
6590 ssl->handshake->tls_prf( session->master, 48, sender,
6591 padbuf, 32, buf, len );
6592
6593 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6594
6595 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6596
6597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6598}
6599#endif /* MBEDTLS_SHA256_C */
6600
Jerry Yub7ba49e2022-02-17 14:25:53 +08006601
6602#if defined(MBEDTLS_SHA384_C)
6603
6604static void ssl_calc_finished_tls_sha384(
6605 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6606{
6607 int len = 12;
6608 const char *sender;
6609 unsigned char padbuf[48];
6610#if defined(MBEDTLS_USE_PSA_CRYPTO)
6611 size_t hash_size;
6612 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6613 psa_status_t status;
6614#else
6615 mbedtls_sha512_context sha512;
6616#endif
6617
6618 mbedtls_ssl_session *session = ssl->session_negotiate;
6619 if( !session )
6620 session = ssl->session;
6621
6622 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6623 ? "client finished"
6624 : "server finished";
6625
6626#if defined(MBEDTLS_USE_PSA_CRYPTO)
6627 sha384_psa = psa_hash_operation_init();
6628
6629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6630
6631 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6632 if( status != PSA_SUCCESS )
6633 {
6634 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6635 return;
6636 }
6637
6638 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6639 if( status != PSA_SUCCESS )
6640 {
6641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6642 return;
6643 }
6644 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6645#else
6646 mbedtls_sha512_init( &sha512 );
6647
6648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6649
6650 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6651
6652 /*
6653 * TLSv1.2:
6654 * hash = PRF( master, finished_label,
6655 * Hash( handshake ) )[0.11]
6656 */
6657
6658#if !defined(MBEDTLS_SHA512_ALT)
6659 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6660 sha512.state, sizeof( sha512.state ) );
6661#endif
6662 mbedtls_sha512_finish( &sha512, padbuf );
6663
6664 mbedtls_sha512_free( &sha512 );
6665#endif
6666
6667 ssl->handshake->tls_prf( session->master, 48, sender,
6668 padbuf, 48, buf, len );
6669
6670 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6671
6672 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6673
6674 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6675}
6676#endif /* MBEDTLS_SHA384_C */
6677
Jerry Yuaef00152022-02-17 14:27:31 +08006678void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6679{
6680 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6681
6682 /*
6683 * Free our handshake params
6684 */
6685 mbedtls_ssl_handshake_free( ssl );
6686 mbedtls_free( ssl->handshake );
6687 ssl->handshake = NULL;
6688
6689 /*
6690 * Free the previous transform and swith in the current one
6691 */
6692 if( ssl->transform )
6693 {
6694 mbedtls_ssl_transform_free( ssl->transform );
6695 mbedtls_free( ssl->transform );
6696 }
6697 ssl->transform = ssl->transform_negotiate;
6698 ssl->transform_negotiate = NULL;
6699
6700 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6701}
6702
Jerry Yu2a9fff52022-02-17 14:28:51 +08006703void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6704{
6705 int resume = ssl->handshake->resume;
6706
6707 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6708
6709#if defined(MBEDTLS_SSL_RENEGOTIATION)
6710 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6711 {
6712 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6713 ssl->renego_records_seen = 0;
6714 }
6715#endif
6716
6717 /*
6718 * Free the previous session and switch in the current one
6719 */
6720 if( ssl->session )
6721 {
6722#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6723 /* RFC 7366 3.1: keep the EtM state */
6724 ssl->session_negotiate->encrypt_then_mac =
6725 ssl->session->encrypt_then_mac;
6726#endif
6727
6728 mbedtls_ssl_session_free( ssl->session );
6729 mbedtls_free( ssl->session );
6730 }
6731 ssl->session = ssl->session_negotiate;
6732 ssl->session_negotiate = NULL;
6733
6734 /*
6735 * Add cache entry
6736 */
6737 if( ssl->conf->f_set_cache != NULL &&
6738 ssl->session->id_len != 0 &&
6739 resume == 0 )
6740 {
6741 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6742 ssl->session->id,
6743 ssl->session->id_len,
6744 ssl->session ) != 0 )
6745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6746 }
6747
6748#if defined(MBEDTLS_SSL_PROTO_DTLS)
6749 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6750 ssl->handshake->flight != NULL )
6751 {
6752 /* Cancel handshake timer */
6753 mbedtls_ssl_set_timer( ssl, 0 );
6754
6755 /* Keep last flight around in case we need to resend it:
6756 * we need the handshake and transform structures for that */
6757 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6758 }
6759 else
6760#endif
6761 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6762
6763 ssl->state++;
6764
6765 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6766}
6767
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006768int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6769{
6770 int ret, hash_len;
6771
6772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6773
6774 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6775
6776 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6777
6778 /*
6779 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6780 * may define some other value. Currently (early 2016), no defined
6781 * ciphersuite does this (and this is unlikely to change as activity has
6782 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6783 */
6784 hash_len = 12;
6785
6786#if defined(MBEDTLS_SSL_RENEGOTIATION)
6787 ssl->verify_data_len = hash_len;
6788 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6789#endif
6790
6791 ssl->out_msglen = 4 + hash_len;
6792 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6793 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6794
6795 /*
6796 * In case of session resuming, invert the client and server
6797 * ChangeCipherSpec messages order.
6798 */
6799 if( ssl->handshake->resume != 0 )
6800 {
6801#if defined(MBEDTLS_SSL_CLI_C)
6802 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6803 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6804#endif
6805#if defined(MBEDTLS_SSL_SRV_C)
6806 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6807 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6808#endif
6809 }
6810 else
6811 ssl->state++;
6812
6813 /*
6814 * Switch to our negotiated transform and session parameters for outbound
6815 * data.
6816 */
6817 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6818
6819#if defined(MBEDTLS_SSL_PROTO_DTLS)
6820 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6821 {
6822 unsigned char i;
6823
6824 /* Remember current epoch settings for resending */
6825 ssl->handshake->alt_transform_out = ssl->transform_out;
6826 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6827 sizeof( ssl->handshake->alt_out_ctr ) );
6828
6829 /* Set sequence_number to zero */
6830 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6831
6832
6833 /* Increment epoch */
6834 for( i = 2; i > 0; i-- )
6835 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6836 break;
6837
6838 /* The loop goes to its end iff the counter is wrapping */
6839 if( i == 0 )
6840 {
6841 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6842 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6843 }
6844 }
6845 else
6846#endif /* MBEDTLS_SSL_PROTO_DTLS */
6847 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6848
6849 ssl->transform_out = ssl->transform_negotiate;
6850 ssl->session_out = ssl->session_negotiate;
6851
6852#if defined(MBEDTLS_SSL_PROTO_DTLS)
6853 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6854 mbedtls_ssl_send_flight_completed( ssl );
6855#endif
6856
6857 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6858 {
6859 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6860 return( ret );
6861 }
6862
6863#if defined(MBEDTLS_SSL_PROTO_DTLS)
6864 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6865 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6866 {
6867 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6868 return( ret );
6869 }
6870#endif
6871
6872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6873
6874 return( 0 );
6875}
6876
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006877#define SSL_MAX_HASH_LEN 12
6878
6879int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6880{
6881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6882 unsigned int hash_len = 12;
6883 unsigned char buf[SSL_MAX_HASH_LEN];
6884
6885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6886
6887 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6888
6889 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6890 {
6891 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6892 goto exit;
6893 }
6894
6895 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6896 {
6897 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6898 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6899 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6900 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6901 goto exit;
6902 }
6903
6904 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6905 {
6906 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6907 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6908 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6909 goto exit;
6910 }
6911
6912 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6913 {
6914 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6915 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6916 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6917 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6918 goto exit;
6919 }
6920
6921 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6922 buf, hash_len ) != 0 )
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_DECRYPT_ERROR );
6927 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6928 goto exit;
6929 }
6930
6931#if defined(MBEDTLS_SSL_RENEGOTIATION)
6932 ssl->verify_data_len = hash_len;
6933 memcpy( ssl->peer_verify_data, buf, hash_len );
6934#endif
6935
6936 if( ssl->handshake->resume != 0 )
6937 {
6938#if defined(MBEDTLS_SSL_CLI_C)
6939 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6940 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6941#endif
6942#if defined(MBEDTLS_SSL_SRV_C)
6943 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6944 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6945#endif
6946 }
6947 else
6948 ssl->state++;
6949
6950#if defined(MBEDTLS_SSL_PROTO_DTLS)
6951 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6952 mbedtls_ssl_recv_flight_completed( ssl );
6953#endif
6954
6955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6956
6957exit:
6958 mbedtls_platform_zeroize( buf, hash_len );
6959 return( ret );
6960}
6961
Jerry Yu392112c2022-02-17 14:34:10 +08006962#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6963/*
6964 * Helper to get TLS 1.2 PRF from ciphersuite
6965 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6966 */
6967static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6968{
6969#if defined(MBEDTLS_SHA384_C)
6970 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6971 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6972
6973 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6974 return( tls_prf_sha384 );
6975#else
6976 (void) ciphersuite_id;
6977#endif
6978 return( tls_prf_sha256 );
6979}
6980#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006981
6982static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6983{
6984 ((void) tls_prf);
6985#if defined(MBEDTLS_SHA384_C)
6986 if( tls_prf == tls_prf_sha384 )
6987 {
6988 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6989 }
6990 else
6991#endif
6992#if defined(MBEDTLS_SHA256_C)
6993 if( tls_prf == tls_prf_sha256 )
6994 {
6995 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6996 }
6997 else
6998#endif
6999 return( MBEDTLS_SSL_TLS_PRF_NONE );
7000}
7001
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007002/*
7003 * Populate a transform structure with session keys and all the other
7004 * necessary information.
7005 *
7006 * Parameters:
7007 * - [in/out]: transform: structure to populate
7008 * [in] must be just initialised with mbedtls_ssl_transform_init()
7009 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7010 * - [in] ciphersuite
7011 * - [in] master
7012 * - [in] encrypt_then_mac
7013 * - [in] compression
7014 * - [in] tls_prf: pointer to PRF to use for key derivation
7015 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007016 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007017 * - [in] endpoint: client or server
7018 * - [in] ssl: used for:
7019 * - ssl->conf->{f,p}_export_keys
7020 * [in] optionally used for:
7021 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7022 */
7023static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7024 int ciphersuite,
7025 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007026#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007027 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007028#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007029 ssl_tls_prf_t tls_prf,
7030 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007031 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007032 unsigned endpoint,
7033 const mbedtls_ssl_context *ssl )
7034{
7035 int ret = 0;
7036 unsigned char keyblk[256];
7037 unsigned char *key1;
7038 unsigned char *key2;
7039 unsigned char *mac_enc;
7040 unsigned char *mac_dec;
7041 size_t mac_key_len = 0;
7042 size_t iv_copy_len;
7043 size_t keylen;
7044 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007045 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007046#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007047 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007048 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007049#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007050
7051#if defined(MBEDTLS_USE_PSA_CRYPTO)
7052 psa_key_type_t key_type;
7053 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7054 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007055 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007056 size_t key_bits;
7057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7058#endif
7059
7060#if !defined(MBEDTLS_DEBUG_C) && \
7061 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7062 if( ssl->f_export_keys == NULL )
7063 {
7064 ssl = NULL; /* make sure we don't use it except for these cases */
7065 (void) ssl;
7066 }
7067#endif
7068
7069 /*
7070 * Some data just needs copying into the structure
7071 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007072#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007073 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007074#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007075 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007076
7077#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7078 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7079#endif
7080
7081#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007082 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007083 {
7084 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7085 * generation separate. This should never happen. */
7086 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7087 }
7088#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7089
7090 /*
7091 * Get various info structures
7092 */
7093 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7094 if( ciphersuite_info == NULL )
7095 {
7096 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7097 ciphersuite ) );
7098 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7099 }
7100
Neil Armstrongab555e02022-04-04 11:07:59 +02007101 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007102#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007103 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007104#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007105 ciphersuite_info );
7106
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007107 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7108 transform->taglen =
7109 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7110
7111#if defined(MBEDTLS_USE_PSA_CRYPTO)
7112 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7113 transform->taglen,
7114 &alg,
7115 &key_type,
7116 &key_bits ) ) != PSA_SUCCESS )
7117 {
7118 ret = psa_ssl_status_to_mbedtls( status );
7119 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7120 goto end;
7121 }
7122#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007123 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7124 if( cipher_info == NULL )
7125 {
7126 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7127 ciphersuite_info->cipher ) );
7128 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7129 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007130#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007131
Neil Armstronge4512952022-03-08 09:08:22 +01007132#if defined(MBEDTLS_USE_PSA_CRYPTO)
7133 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7134 if( mac_alg == 0 )
7135 {
7136 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7137 (unsigned) ciphersuite_info->mac ) );
7138 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7139 }
7140#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007141 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7142 if( md_info == NULL )
7143 {
7144 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7145 (unsigned) ciphersuite_info->mac ) );
7146 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7147 }
Neil Armstronge4512952022-03-08 09:08:22 +01007148#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007149
7150#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7151 /* Copy own and peer's CID if the use of the CID
7152 * extension has been negotiated. */
7153 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7154 {
7155 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7156
7157 transform->in_cid_len = ssl->own_cid_len;
7158 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7159 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7160 transform->in_cid_len );
7161
7162 transform->out_cid_len = ssl->handshake->peer_cid_len;
7163 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7164 ssl->handshake->peer_cid_len );
7165 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7166 transform->out_cid_len );
7167 }
7168#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7169
7170 /*
7171 * Compute key block using the PRF
7172 */
7173 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7174 if( ret != 0 )
7175 {
7176 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7177 return( ret );
7178 }
7179
7180 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7181 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7182 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7183 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7184 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7185
7186 /*
7187 * Determine the appropriate key, IV and MAC length.
7188 */
7189
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007190#if defined(MBEDTLS_USE_PSA_CRYPTO)
7191 keylen = PSA_BITS_TO_BYTES(key_bits);
7192#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007193 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007194#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007195
7196#if defined(MBEDTLS_GCM_C) || \
7197 defined(MBEDTLS_CCM_C) || \
7198 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007199 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007200 {
7201 size_t explicit_ivlen;
7202
7203 transform->maclen = 0;
7204 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007205
7206 /* All modes haves 96-bit IVs, but the length of the static parts vary
7207 * with mode and version:
7208 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7209 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7210 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7211 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7212 * sequence number).
7213 */
7214 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007215#if defined(MBEDTLS_USE_PSA_CRYPTO)
7216 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7217#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007218 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007219#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007220 transform->fixed_ivlen = 12;
7221 else
7222 transform->fixed_ivlen = 4;
7223
7224 /* Minimum length of encrypted record */
7225 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7226 transform->minlen = explicit_ivlen + transform->taglen;
7227 }
7228 else
7229#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7230#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007231 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7232 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7233 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007234 {
Neil Armstronge4512952022-03-08 09:08:22 +01007235#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007236 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007237#else
7238 size_t block_size = cipher_info->block_size;
7239#endif /* MBEDTLS_USE_PSA_CRYPTO */
7240
7241#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007242 /* Get MAC length */
7243 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7244#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007245 /* Initialize HMAC contexts */
7246 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7247 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7248 {
7249 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7250 goto end;
7251 }
7252
7253 /* Get MAC length */
7254 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007255#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007256 transform->maclen = mac_key_len;
7257
7258 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007259#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007260 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007261#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007262 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007263#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007264
7265 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007266 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007267 transform->minlen = transform->maclen;
7268 else
7269 {
7270 /*
7271 * GenericBlockCipher:
7272 * 1. if EtM is in use: one block plus MAC
7273 * otherwise: * first multiple of blocklen greater than maclen
7274 * 2. IV
7275 */
7276#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007277 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007278 {
7279 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007280 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007281 }
7282 else
7283#endif
7284 {
7285 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007286 + block_size
7287 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007288 }
7289
Glenn Strauss07c64162022-03-14 12:34:51 -04007290 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007291 {
7292 transform->minlen += transform->ivlen;
7293 }
7294 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007295 {
7296 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7297 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7298 goto end;
7299 }
7300 }
7301 }
7302 else
7303#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7304 {
7305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7306 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7307 }
7308
7309 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7310 (unsigned) keylen,
7311 (unsigned) transform->minlen,
7312 (unsigned) transform->ivlen,
7313 (unsigned) transform->maclen ) );
7314
7315 /*
7316 * Finally setup the cipher contexts, IVs and MAC secrets.
7317 */
7318#if defined(MBEDTLS_SSL_CLI_C)
7319 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7320 {
7321 key1 = keyblk + mac_key_len * 2;
7322 key2 = keyblk + mac_key_len * 2 + keylen;
7323
7324 mac_enc = keyblk;
7325 mac_dec = keyblk + mac_key_len;
7326
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007327 iv_copy_len = ( transform->fixed_ivlen ) ?
7328 transform->fixed_ivlen : transform->ivlen;
7329 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7330 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7331 iv_copy_len );
7332 }
7333 else
7334#endif /* MBEDTLS_SSL_CLI_C */
7335#if defined(MBEDTLS_SSL_SRV_C)
7336 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7337 {
7338 key1 = keyblk + mac_key_len * 2 + keylen;
7339 key2 = keyblk + mac_key_len * 2;
7340
7341 mac_enc = keyblk + mac_key_len;
7342 mac_dec = keyblk;
7343
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007344 iv_copy_len = ( transform->fixed_ivlen ) ?
7345 transform->fixed_ivlen : transform->ivlen;
7346 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7347 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7348 iv_copy_len );
7349 }
7350 else
7351#endif /* MBEDTLS_SSL_SRV_C */
7352 {
7353 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7354 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7355 goto end;
7356 }
7357
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007358 if( ssl != NULL && ssl->f_export_keys != NULL )
7359 {
7360 ssl->f_export_keys( ssl->p_export_keys,
7361 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7362 master, 48,
7363 randbytes + 32,
7364 randbytes,
7365 tls_prf_get_type( tls_prf ) );
7366 }
7367
7368#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007369 transform->psa_alg = alg;
7370
7371 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7372 {
7373 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7374 psa_set_key_algorithm( &attributes, alg );
7375 psa_set_key_type( &attributes, key_type );
7376
7377 if( ( status = psa_import_key( &attributes,
7378 key1,
7379 PSA_BITS_TO_BYTES( key_bits ),
7380 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7381 {
7382 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7383 ret = psa_ssl_status_to_mbedtls( status );
7384 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7385 goto end;
7386 }
7387
7388 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7389
7390 if( ( status = psa_import_key( &attributes,
7391 key2,
7392 PSA_BITS_TO_BYTES( key_bits ),
7393 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7394 {
7395 ret = psa_ssl_status_to_mbedtls( status );
7396 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7397 goto end;
7398 }
7399 }
7400#else
7401 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7402 cipher_info ) ) != 0 )
7403 {
7404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7405 goto end;
7406 }
7407
7408 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7409 cipher_info ) ) != 0 )
7410 {
7411 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7412 goto end;
7413 }
7414
7415 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7416 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7417 MBEDTLS_ENCRYPT ) ) != 0 )
7418 {
7419 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7420 goto end;
7421 }
7422
7423 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7424 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7425 MBEDTLS_DECRYPT ) ) != 0 )
7426 {
7427 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7428 goto end;
7429 }
7430
7431#if defined(MBEDTLS_CIPHER_MODE_CBC)
7432 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7433 {
7434 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7435 MBEDTLS_PADDING_NONE ) ) != 0 )
7436 {
7437 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7438 goto end;
7439 }
7440
7441 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7442 MBEDTLS_PADDING_NONE ) ) != 0 )
7443 {
7444 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7445 goto end;
7446 }
7447 }
7448#endif /* MBEDTLS_CIPHER_MODE_CBC */
7449#endif /* MBEDTLS_USE_PSA_CRYPTO */
7450
Neil Armstrong29c0c042022-03-17 17:47:28 +01007451#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7452 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7453 For AEAD-based ciphersuites, there is nothing to do here. */
7454 if( mac_key_len != 0 )
7455 {
7456#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007457 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007458
7459 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007460 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007461 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7462
7463 if( ( status = psa_import_key( &attributes,
7464 mac_enc, mac_key_len,
7465 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7466 {
7467 ret = psa_ssl_status_to_mbedtls( status );
7468 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7469 goto end;
7470 }
7471
Ronald Cronfb39f152022-03-25 14:36:28 +01007472 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7473 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7474 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007475 /* mbedtls_ct_hmac() requires the key to be exportable */
7476 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7477 PSA_KEY_USAGE_VERIFY_HASH );
7478 else
7479 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7480
7481 if( ( status = psa_import_key( &attributes,
7482 mac_dec, mac_key_len,
7483 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7484 {
7485 ret = psa_ssl_status_to_mbedtls( status );
7486 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7487 goto end;
7488 }
7489#else
7490 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7491 if( ret != 0 )
7492 goto end;
7493 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7494 if( ret != 0 )
7495 goto end;
7496#endif /* MBEDTLS_USE_PSA_CRYPTO */
7497 }
7498#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7499
7500 ((void) mac_dec);
7501 ((void) mac_enc);
7502
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007503end:
7504 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7505 return( ret );
7506}
7507
Jerry Yuee40f9d2022-02-17 14:55:16 +08007508#if defined(MBEDTLS_USE_PSA_CRYPTO)
7509int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7510 unsigned char *hash, size_t *hashlen,
7511 unsigned char *data, size_t data_len,
7512 mbedtls_md_type_t md_alg )
7513{
7514 psa_status_t status;
7515 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7516 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7517
7518 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7519
7520 if( ( status = psa_hash_setup( &hash_operation,
7521 hash_alg ) ) != PSA_SUCCESS )
7522 {
7523 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7524 goto exit;
7525 }
7526
7527 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7528 64 ) ) != PSA_SUCCESS )
7529 {
7530 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7531 goto exit;
7532 }
7533
7534 if( ( status = psa_hash_update( &hash_operation,
7535 data, data_len ) ) != PSA_SUCCESS )
7536 {
7537 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7538 goto exit;
7539 }
7540
7541 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7542 hashlen ) ) != PSA_SUCCESS )
7543 {
7544 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7545 goto exit;
7546 }
7547
7548exit:
7549 if( status != PSA_SUCCESS )
7550 {
7551 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7552 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7553 switch( status )
7554 {
7555 case PSA_ERROR_NOT_SUPPORTED:
7556 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7557 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7558 case PSA_ERROR_BUFFER_TOO_SMALL:
7559 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7560 case PSA_ERROR_INSUFFICIENT_MEMORY:
7561 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7562 default:
7563 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7564 }
7565 }
7566 return( 0 );
7567}
7568
7569#else
7570
7571int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7572 unsigned char *hash, size_t *hashlen,
7573 unsigned char *data, size_t data_len,
7574 mbedtls_md_type_t md_alg )
7575{
7576 int ret = 0;
7577 mbedtls_md_context_t ctx;
7578 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7579 *hashlen = mbedtls_md_get_size( md_info );
7580
7581 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7582
7583 mbedtls_md_init( &ctx );
7584
7585 /*
7586 * digitally-signed struct {
7587 * opaque client_random[32];
7588 * opaque server_random[32];
7589 * ServerDHParams params;
7590 * };
7591 */
7592 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7593 {
7594 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7595 goto exit;
7596 }
7597 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7598 {
7599 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7600 goto exit;
7601 }
7602 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7603 {
7604 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7605 goto exit;
7606 }
7607 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7608 {
7609 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7610 goto exit;
7611 }
7612 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7613 {
7614 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7615 goto exit;
7616 }
7617
7618exit:
7619 mbedtls_md_free( &ctx );
7620
7621 if( ret != 0 )
7622 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7623 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7624
7625 return( ret );
7626}
7627#endif /* MBEDTLS_USE_PSA_CRYPTO */
7628
Jerry Yud9d91da2022-02-17 14:57:06 +08007629#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7630
7631/* Find an entry in a signature-hash set matching a given hash algorithm. */
7632mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7633 mbedtls_pk_type_t sig_alg )
7634{
7635 switch( sig_alg )
7636 {
7637 case MBEDTLS_PK_RSA:
7638 return( set->rsa );
7639 case MBEDTLS_PK_ECDSA:
7640 return( set->ecdsa );
7641 default:
7642 return( MBEDTLS_MD_NONE );
7643 }
7644}
7645
7646/* Add a signature-hash-pair to a signature-hash set */
7647void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7648 mbedtls_pk_type_t sig_alg,
7649 mbedtls_md_type_t md_alg )
7650{
7651 switch( sig_alg )
7652 {
7653 case MBEDTLS_PK_RSA:
7654 if( set->rsa == MBEDTLS_MD_NONE )
7655 set->rsa = md_alg;
7656 break;
7657
7658 case MBEDTLS_PK_ECDSA:
7659 if( set->ecdsa == MBEDTLS_MD_NONE )
7660 set->ecdsa = md_alg;
7661 break;
7662
7663 default:
7664 break;
7665 }
7666}
7667
7668/* Allow exactly one hash algorithm for each signature. */
7669void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7670 mbedtls_md_type_t md_alg )
7671{
7672 set->rsa = md_alg;
7673 set->ecdsa = md_alg;
7674}
7675
7676#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7677
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007678/* Serialization of TLS 1.2 sessions:
7679 *
7680 * struct {
7681 * uint64 start_time;
7682 * uint8 ciphersuite[2]; // defined by the standard
7683 * uint8 compression; // 0 or 1
7684 * uint8 session_id_len; // at most 32
7685 * opaque session_id[32];
7686 * opaque master[48]; // fixed length in the standard
7687 * uint32 verify_result;
7688 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7689 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7690 * uint32 ticket_lifetime;
7691 * uint8 mfl_code; // up to 255 according to standard
7692 * uint8 encrypt_then_mac; // 0 or 1
7693 * } serialized_session_tls12;
7694 *
7695 */
7696static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7697 unsigned char *buf,
7698 size_t buf_len )
7699{
7700 unsigned char *p = buf;
7701 size_t used = 0;
7702
7703#if defined(MBEDTLS_HAVE_TIME)
7704 uint64_t start;
7705#endif
7706#if defined(MBEDTLS_X509_CRT_PARSE_C)
7707#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7708 size_t cert_len;
7709#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7710#endif /* MBEDTLS_X509_CRT_PARSE_C */
7711
7712 /*
7713 * Time
7714 */
7715#if defined(MBEDTLS_HAVE_TIME)
7716 used += 8;
7717
7718 if( used <= buf_len )
7719 {
7720 start = (uint64_t) session->start;
7721
7722 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7723 p += 8;
7724 }
7725#endif /* MBEDTLS_HAVE_TIME */
7726
7727 /*
7728 * Basic mandatory fields
7729 */
7730 used += 2 /* ciphersuite */
7731 + 1 /* compression */
7732 + 1 /* id_len */
7733 + sizeof( session->id )
7734 + sizeof( session->master )
7735 + 4; /* verify_result */
7736
7737 if( used <= buf_len )
7738 {
7739 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7740 p += 2;
7741
7742 *p++ = MBEDTLS_BYTE_0( session->compression );
7743
7744 *p++ = MBEDTLS_BYTE_0( session->id_len );
7745 memcpy( p, session->id, 32 );
7746 p += 32;
7747
7748 memcpy( p, session->master, 48 );
7749 p += 48;
7750
7751 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7752 p += 4;
7753 }
7754
7755 /*
7756 * Peer's end-entity certificate
7757 */
7758#if defined(MBEDTLS_X509_CRT_PARSE_C)
7759#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7760 if( session->peer_cert == NULL )
7761 cert_len = 0;
7762 else
7763 cert_len = session->peer_cert->raw.len;
7764
7765 used += 3 + cert_len;
7766
7767 if( used <= buf_len )
7768 {
7769 *p++ = MBEDTLS_BYTE_2( cert_len );
7770 *p++ = MBEDTLS_BYTE_1( cert_len );
7771 *p++ = MBEDTLS_BYTE_0( cert_len );
7772
7773 if( session->peer_cert != NULL )
7774 {
7775 memcpy( p, session->peer_cert->raw.p, cert_len );
7776 p += cert_len;
7777 }
7778 }
7779#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7780 if( session->peer_cert_digest != NULL )
7781 {
7782 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7783 if( used <= buf_len )
7784 {
7785 *p++ = (unsigned char) session->peer_cert_digest_type;
7786 *p++ = (unsigned char) session->peer_cert_digest_len;
7787 memcpy( p, session->peer_cert_digest,
7788 session->peer_cert_digest_len );
7789 p += session->peer_cert_digest_len;
7790 }
7791 }
7792 else
7793 {
7794 used += 2;
7795 if( used <= buf_len )
7796 {
7797 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7798 *p++ = 0;
7799 }
7800 }
7801#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7802#endif /* MBEDTLS_X509_CRT_PARSE_C */
7803
7804 /*
7805 * Session ticket if any, plus associated data
7806 */
7807#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7808 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7809
7810 if( used <= buf_len )
7811 {
7812 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7813 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7814 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7815
7816 if( session->ticket != NULL )
7817 {
7818 memcpy( p, session->ticket, session->ticket_len );
7819 p += session->ticket_len;
7820 }
7821
7822 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7823 p += 4;
7824 }
7825#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7826
7827 /*
7828 * Misc extension-related info
7829 */
7830#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7831 used += 1;
7832
7833 if( used <= buf_len )
7834 *p++ = session->mfl_code;
7835#endif
7836
7837#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7838 used += 1;
7839
7840 if( used <= buf_len )
7841 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7842#endif
7843
7844 return( used );
7845}
7846
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007847static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7848 const unsigned char *buf,
7849 size_t len )
7850{
7851#if defined(MBEDTLS_HAVE_TIME)
7852 uint64_t start;
7853#endif
7854#if defined(MBEDTLS_X509_CRT_PARSE_C)
7855#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7856 size_t cert_len;
7857#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7858#endif /* MBEDTLS_X509_CRT_PARSE_C */
7859
7860 const unsigned char *p = buf;
7861 const unsigned char * const end = buf + len;
7862
7863 /*
7864 * Time
7865 */
7866#if defined(MBEDTLS_HAVE_TIME)
7867 if( 8 > (size_t)( end - p ) )
7868 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7869
7870 start = ( (uint64_t) p[0] << 56 ) |
7871 ( (uint64_t) p[1] << 48 ) |
7872 ( (uint64_t) p[2] << 40 ) |
7873 ( (uint64_t) p[3] << 32 ) |
7874 ( (uint64_t) p[4] << 24 ) |
7875 ( (uint64_t) p[5] << 16 ) |
7876 ( (uint64_t) p[6] << 8 ) |
7877 ( (uint64_t) p[7] );
7878 p += 8;
7879
7880 session->start = (time_t) start;
7881#endif /* MBEDTLS_HAVE_TIME */
7882
7883 /*
7884 * Basic mandatory fields
7885 */
7886 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7887 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7888
7889 session->ciphersuite = ( p[0] << 8 ) | p[1];
7890 p += 2;
7891
7892 session->compression = *p++;
7893
7894 session->id_len = *p++;
7895 memcpy( session->id, p, 32 );
7896 p += 32;
7897
7898 memcpy( session->master, p, 48 );
7899 p += 48;
7900
7901 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7902 ( (uint32_t) p[1] << 16 ) |
7903 ( (uint32_t) p[2] << 8 ) |
7904 ( (uint32_t) p[3] );
7905 p += 4;
7906
7907 /* Immediately clear invalid pointer values that have been read, in case
7908 * we exit early before we replaced them with valid ones. */
7909#if defined(MBEDTLS_X509_CRT_PARSE_C)
7910#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7911 session->peer_cert = NULL;
7912#else
7913 session->peer_cert_digest = NULL;
7914#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7915#endif /* MBEDTLS_X509_CRT_PARSE_C */
7916#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7917 session->ticket = NULL;
7918#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7919
7920 /*
7921 * Peer certificate
7922 */
7923#if defined(MBEDTLS_X509_CRT_PARSE_C)
7924#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7925 /* Deserialize CRT from the end of the ticket. */
7926 if( 3 > (size_t)( end - p ) )
7927 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7928
7929 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7930 p += 3;
7931
7932 if( cert_len != 0 )
7933 {
7934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7935
7936 if( cert_len > (size_t)( end - p ) )
7937 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7938
7939 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7940
7941 if( session->peer_cert == NULL )
7942 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7943
7944 mbedtls_x509_crt_init( session->peer_cert );
7945
7946 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7947 p, cert_len ) ) != 0 )
7948 {
7949 mbedtls_x509_crt_free( session->peer_cert );
7950 mbedtls_free( session->peer_cert );
7951 session->peer_cert = NULL;
7952 return( ret );
7953 }
7954
7955 p += cert_len;
7956 }
7957#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7958 /* Deserialize CRT digest from the end of the ticket. */
7959 if( 2 > (size_t)( end - p ) )
7960 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7961
7962 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7963 session->peer_cert_digest_len = (size_t) *p++;
7964
7965 if( session->peer_cert_digest_len != 0 )
7966 {
7967 const mbedtls_md_info_t *md_info =
7968 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7969 if( md_info == NULL )
7970 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7971 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7973
7974 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7975 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7976
7977 session->peer_cert_digest =
7978 mbedtls_calloc( 1, session->peer_cert_digest_len );
7979 if( session->peer_cert_digest == NULL )
7980 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7981
7982 memcpy( session->peer_cert_digest, p,
7983 session->peer_cert_digest_len );
7984 p += session->peer_cert_digest_len;
7985 }
7986#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7987#endif /* MBEDTLS_X509_CRT_PARSE_C */
7988
7989 /*
7990 * Session ticket and associated data
7991 */
7992#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7993 if( 3 > (size_t)( end - p ) )
7994 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7995
7996 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7997 p += 3;
7998
7999 if( session->ticket_len != 0 )
8000 {
8001 if( session->ticket_len > (size_t)( end - p ) )
8002 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8003
8004 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8005 if( session->ticket == NULL )
8006 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8007
8008 memcpy( session->ticket, p, session->ticket_len );
8009 p += session->ticket_len;
8010 }
8011
8012 if( 4 > (size_t)( end - p ) )
8013 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8014
8015 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8016 ( (uint32_t) p[1] << 16 ) |
8017 ( (uint32_t) p[2] << 8 ) |
8018 ( (uint32_t) p[3] );
8019 p += 4;
8020#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8021
8022 /*
8023 * Misc extension-related info
8024 */
8025#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8026 if( 1 > (size_t)( end - p ) )
8027 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8028
8029 session->mfl_code = *p++;
8030#endif
8031
8032#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8033 if( 1 > (size_t)( end - p ) )
8034 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8035
8036 session->encrypt_then_mac = *p++;
8037#endif
8038
8039 /* Done, should have consumed entire buffer */
8040 if( p != end )
8041 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8042
8043 return( 0 );
8044}
Jerry Yudc7bd172022-02-17 13:44:15 +08008045#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8046
XiaokangQian75d40ef2022-04-20 11:05:24 +00008047int mbedtls_ssl_validate_ciphersuite(
8048 const mbedtls_ssl_context *ssl,
8049 const mbedtls_ssl_ciphersuite_t *suite_info,
8050 mbedtls_ssl_protocol_version min_tls_version,
8051 mbedtls_ssl_protocol_version max_tls_version )
8052{
8053 (void) ssl;
8054
8055 if( suite_info == NULL )
8056 return( -1 );
8057
8058 if( ( suite_info->min_tls_version > max_tls_version ) ||
8059 ( suite_info->max_tls_version < min_tls_version ) )
8060 {
8061 return( -1 );
8062 }
8063
XiaokangQian060d8672022-04-21 09:24:56 +00008064#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008065#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8066 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8067 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8068 {
8069 return( -1 );
8070 }
8071#endif
8072
8073 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8074#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8075 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8076 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8077 {
8078 return( -1 );
8079 }
8080#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8081#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8082
8083 return( 0 );
8084}
8085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008086#endif /* MBEDTLS_SSL_TLS_C */