blob: 0a067f2fc3f67b1a39b435cdb45f368279ef56f8 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800387 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200388#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800389 ssl_tls_prf_t tls_prf,
390 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400391 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800392 unsigned endpoint,
393 const mbedtls_ssl_context *ssl );
394
395#if defined(MBEDTLS_SHA256_C)
396static int tls_prf_sha256( const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen );
400static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
401static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
402
403#endif /* MBEDTLS_SHA256_C */
404
405#if defined(MBEDTLS_SHA384_C)
406static int tls_prf_sha384( const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen );
410
411static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
412static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
413#endif /* MBEDTLS_SHA384_C */
414
415static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
416 unsigned char *buf,
417 size_t buf_len );
418static int ssl_session_load_tls12( mbedtls_ssl_session *session,
419 const unsigned char *buf,
420 size_t len );
421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
422
Jerry Yu53d23e22022-02-09 16:25:09 +0800423static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
424
Jerry Yudb8c48a2022-01-27 14:54:54 +0800425#if defined(MBEDTLS_SHA256_C)
426static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800427#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800428
429#if defined(MBEDTLS_SHA384_C)
430static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800431#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000432
Ron Eldor51d3ab52019-05-12 14:54:30 +0300433int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
434 const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen )
438{
439 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
440
441 switch( prf )
442 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300443#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200444#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300445 case MBEDTLS_SSL_TLS_PRF_SHA384:
446 tls_prf = tls_prf_sha384;
447 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200448#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300449#if defined(MBEDTLS_SHA256_C)
450 case MBEDTLS_SSL_TLS_PRF_SHA256:
451 tls_prf = tls_prf_sha256;
452 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300453#endif /* MBEDTLS_SHA256_C */
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300455 default:
456 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
457 }
458
459 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
460}
461
Jerry Yuc73c6182022-02-08 20:29:25 +0800462#if defined(MBEDTLS_X509_CRT_PARSE_C)
463static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
464{
465#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
466 if( session->peer_cert != NULL )
467 {
468 mbedtls_x509_crt_free( session->peer_cert );
469 mbedtls_free( session->peer_cert );
470 session->peer_cert = NULL;
471 }
472#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
473 if( session->peer_cert_digest != NULL )
474 {
475 /* Zeroization is not necessary. */
476 mbedtls_free( session->peer_cert_digest );
477 session->peer_cert_digest = NULL;
478 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
479 session->peer_cert_digest_len = 0;
480 }
481#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
482}
483#endif /* MBEDTLS_X509_CRT_PARSE_C */
484
485void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
487{
488 ((void) ciphersuite_info);
489
490#if defined(MBEDTLS_SHA384_C)
491 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
492 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
493 else
494#endif
495#if defined(MBEDTLS_SHA256_C)
496 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
497 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
498 else
499#endif
500 {
501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
502 return;
503 }
504}
505
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100506static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
507 unsigned hs_type,
508 size_t total_hs_len )
509{
510 unsigned char hs_hdr[4];
511
512 /* Build HS header for checksum update. */
513 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
514 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
515 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
516 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
517
518 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
519}
520
521void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
522 unsigned hs_type,
523 unsigned char const *msg,
524 size_t msg_len )
525{
526 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
527 ssl->handshake->update_checksum( ssl, msg, msg_len );
528}
529
Jerry Yuc73c6182022-02-08 20:29:25 +0800530void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
531{
532 ((void) ssl);
533#if defined(MBEDTLS_SHA256_C)
534#if defined(MBEDTLS_USE_PSA_CRYPTO)
535 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
536 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
537#else
538 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
539#endif
540#endif
541#if defined(MBEDTLS_SHA384_C)
542#if defined(MBEDTLS_USE_PSA_CRYPTO)
543 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
544 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
545#else
546 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
547#endif
548#endif
549}
550
551static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
552 const unsigned char *buf, size_t len )
553{
554#if defined(MBEDTLS_SHA256_C)
555#if defined(MBEDTLS_USE_PSA_CRYPTO)
556 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
557#else
558 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
559#endif
560#endif
561#if defined(MBEDTLS_SHA384_C)
562#if defined(MBEDTLS_USE_PSA_CRYPTO)
563 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
564#else
565 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
566#endif
567#endif
568}
569
570#if defined(MBEDTLS_SHA256_C)
571static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
572 const unsigned char *buf, size_t len )
573{
574#if defined(MBEDTLS_USE_PSA_CRYPTO)
575 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
576#else
577 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
578#endif
579}
580#endif
581
582#if defined(MBEDTLS_SHA384_C)
583static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
584 const unsigned char *buf, size_t len )
585{
586#if defined(MBEDTLS_USE_PSA_CRYPTO)
587 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
588#else
589 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
590#endif
591}
592#endif
593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200595{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500599#if defined(MBEDTLS_USE_PSA_CRYPTO)
600 handshake->fin_sha256_psa = psa_hash_operation_init();
601 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
602#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200604 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200605#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500606#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200607#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500609 handshake->fin_sha384_psa = psa_hash_operation_init();
610 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500611#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200613 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200614#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500615#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616
617 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#if defined(MBEDTLS_DHM_C)
620 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200621#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200622#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200624#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200625#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200626 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200627#if defined(MBEDTLS_SSL_CLI_C)
628 handshake->ecjpake_cache = NULL;
629 handshake->ecjpake_cache_len = 0;
630#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200632
Gilles Peskineeccd8882020-03-10 12:19:08 +0100633#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200634 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200635#endif
636
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200637#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
638 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
639#endif
Hanno Becker75173122019-02-06 16:18:31 +0000640
641#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
642 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
643 mbedtls_pk_init( &handshake->peer_pubkey );
644#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200645}
646
Hanno Beckera18d1322018-01-03 14:27:32 +0000647void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200648{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200650
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100651#if defined(MBEDTLS_USE_PSA_CRYPTO)
652 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
653 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100654#else
655 mbedtls_cipher_init( &transform->cipher_ctx_enc );
656 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100657#endif
658
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000659#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100660#if defined(MBEDTLS_USE_PSA_CRYPTO)
661 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
662 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100663#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 mbedtls_md_init( &transform->md_ctx_enc );
665 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000666#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100667#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200668}
669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200671{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200673}
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000676{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200677 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000678 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200682 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200683 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684
685 /*
686 * Either the pointers are now NULL or cleared properly and can be freed.
687 * Now allocate missing structures.
688 */
689 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200690 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200691 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200692 }
Paul Bakker48916f92012-09-16 19:57:18 +0000693
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200694 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200695 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200696 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 }
Paul Bakker48916f92012-09-16 19:57:18 +0000698
Paul Bakker82788fb2014-10-20 13:59:19 +0200699 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200700 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200701 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500703#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
704 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400705
Andrzej Kurek4a063792020-10-21 15:08:44 +0200706 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
707 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500708#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000709
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200710 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000711 if( ssl->handshake == NULL ||
712 ssl->transform_negotiate == NULL ||
713 ssl->session_negotiate == NULL )
714 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 mbedtls_free( ssl->handshake );
718 mbedtls_free( ssl->transform_negotiate );
719 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200720
721 ssl->handshake = NULL;
722 ssl->transform_negotiate = NULL;
723 ssl->session_negotiate = NULL;
724
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200725 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000726 }
727
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200728 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000730 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200731 ssl_handshake_params_init( ssl->handshake );
732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200734 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
735 {
736 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200737
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200738 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
739 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
740 else
741 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200742
Hanno Becker0f57a652020-02-05 10:37:26 +0000743 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200744 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200745#endif
746
Brett Warrene0edc842021-08-17 09:53:13 +0100747/*
748 * curve_list is translated to IANA TLS group identifiers here because
749 * mbedtls_ssl_conf_curves returns void and so can't return
750 * any error codes.
751 */
752#if defined(MBEDTLS_ECP_C)
753#if !defined(MBEDTLS_DEPRECATED_REMOVED)
754 /* Heap allocate and translate curve_list from internal to IANA group ids */
755 if ( ssl->conf->curve_list != NULL )
756 {
757 size_t length;
758 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
759
760 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
761 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
762
763 /* Leave room for zero termination */
764 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
765 if ( group_list == NULL )
766 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
767
768 for( size_t i = 0; i < length; i++ )
769 {
770 const mbedtls_ecp_curve_info *info =
771 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
772 if ( info == NULL )
773 {
774 mbedtls_free( group_list );
775 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
776 }
777 group_list[i] = info->tls_id;
778 }
779
780 group_list[length] = 0;
781
782 ssl->handshake->group_list = group_list;
783 ssl->handshake->group_list_heap_allocated = 1;
784 }
785 else
786 {
787 ssl->handshake->group_list = ssl->conf->group_list;
788 ssl->handshake->group_list_heap_allocated = 0;
789 }
790#endif /* MBEDTLS_DEPRECATED_REMOVED */
791#endif /* MBEDTLS_ECP_C */
792
Jerry Yuf017ee42022-01-12 15:49:48 +0800793#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
794#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800796 /* Heap allocate and translate sig_hashes from internal hash identifiers to
797 signature algorithms IANA identifiers. */
798 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800799 ssl->conf->sig_hashes != NULL )
800 {
801 const int *md;
802 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800803 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800804 uint16_t *p;
805
Jerry Yub476a442022-01-21 18:14:45 +0800806#if defined(static_assert)
807 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
808 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
809 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800810#endif
811
Jerry Yuf017ee42022-01-12 15:49:48 +0800812 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
813 {
814 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
815 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800816#if defined(MBEDTLS_ECDSA_C)
817 sig_algs_len += sizeof( uint16_t );
818#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800819
Jerry Yub476a442022-01-21 18:14:45 +0800820#if defined(MBEDTLS_RSA_C)
821 sig_algs_len += sizeof( uint16_t );
822#endif
823 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
824 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800825 }
826
Jerry Yub476a442022-01-21 18:14:45 +0800827 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800828 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
829
Jerry Yub476a442022-01-21 18:14:45 +0800830 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
831 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 if( ssl->handshake->sig_algs == NULL )
833 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
834
835 p = (uint16_t *)ssl->handshake->sig_algs;
836 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
837 {
838 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
839 if( hash == MBEDTLS_SSL_HASH_NONE )
840 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800841#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800842 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
843 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800844#endif
845#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800846 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
847 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200850 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800851 ssl->handshake->sig_algs_heap_allocated = 1;
852 }
853 else
Jerry Yua69269a2022-01-17 21:06:01 +0800854#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800855 {
856 ssl->handshake->sig_algs = ssl->conf->sig_algs;
857 ssl->handshake->sig_algs_heap_allocated = 0;
858 }
859#endif /* MBEDTLS_DEPRECATED_REMOVED */
860#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000861 return( 0 );
862}
863
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200864#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200865/* Dummy cookie callbacks for defaults */
866static int ssl_cookie_write_dummy( void *ctx,
867 unsigned char **p, unsigned char *end,
868 const unsigned char *cli_id, size_t cli_id_len )
869{
870 ((void) ctx);
871 ((void) p);
872 ((void) end);
873 ((void) cli_id);
874 ((void) cli_id_len);
875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200877}
878
879static int ssl_cookie_check_dummy( void *ctx,
880 const unsigned char *cookie, size_t cookie_len,
881 const unsigned char *cli_id, size_t cli_id_len )
882{
883 ((void) ctx);
884 ((void) cookie);
885 ((void) cookie_len);
886 ((void) cli_id);
887 ((void) cli_id_len);
888
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200890}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200891#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200892
Paul Bakker5121ce52009-01-03 21:22:43 +0000893/*
894 * Initialize an SSL context
895 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200896void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
897{
898 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
899}
900
Jerry Yu60835a82021-08-04 10:13:52 +0800901static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
902{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100903 const mbedtls_ssl_config *conf = ssl->conf;
904
Ronald Cron6f135e12021-12-08 16:57:54 +0100905#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100906 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
907 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000908 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
909 {
910 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
911 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
912 }
913
Jerry Yu60835a82021-08-04 10:13:52 +0800914 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
915 return( 0 );
916 }
917#endif
918
919#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100920 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800921 {
922 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
923 return( 0 );
924 }
925#endif
926
Ronald Cron6f135e12021-12-08 16:57:54 +0100927#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100928 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800929 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
931 {
932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
933 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
934 }
935
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000936 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
937 {
938 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
939 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
940 }
941
942
Ronald Crone1d3f062022-02-10 14:50:54 +0100943 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
944 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800945 }
946#endif
947
948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
949 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
950}
951
952static int ssl_conf_check(const mbedtls_ssl_context *ssl)
953{
954 int ret;
955 ret = ssl_conf_version_check( ssl );
956 if( ret != 0 )
957 return( ret );
958
959 /* Space for further checks */
960
961 return( 0 );
962}
963
Jerry Yu3f71ca02022-06-21 14:42:03 +0800964#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
965 defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
966 defined(MBEDTLS_SSL_SRV_C) && \
967 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
968/* Remove below lines if server side hybrid mode implemented.
969 * To fix wrong default signature algorithm setting when both
970 * TLS1.2 and TLS1.3 enabled.
971 */
972static void ssl_fix_server_side_negotiation_fail( mbedtls_ssl_context *ssl );
973#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
974 MBEDTLS_SSL_PROTO_TLS1_3 &&
975 MBEDTLS_SSL_SRV_C &&
976 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
977
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200978/*
979 * Setup an SSL context
980 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200981int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200982 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000983{
Janos Follath865b3eb2019-12-16 11:46:15 +0000984 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000985 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
986 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000987
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200988 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000989
Jerry Yu60835a82021-08-04 10:13:52 +0800990 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
991 return( ret );
992
Paul Bakker62f2dee2012-09-28 07:31:51 +0000993 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100994 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000995 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200996
997 /* Set to NULL in case of an error condition */
998 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200999
Darryl Greenb33cc762019-11-28 14:29:44 +00001000#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1001 ssl->in_buf_len = in_buf_len;
1002#endif
1003 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001004 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001005 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001006 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001007 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001008 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001009 }
1010
Darryl Greenb33cc762019-11-28 14:29:44 +00001011#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1012 ssl->out_buf_len = out_buf_len;
1013#endif
1014 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001015 if( ssl->out_buf == NULL )
1016 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001018 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001019 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001020 }
1021
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001022 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001023
Johan Pascalb62bb512015-12-03 21:56:45 +01001024#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001025 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001026#endif
1027
Paul Bakker48916f92012-09-16 19:57:18 +00001028 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001030
1031 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001032
1033error:
1034 mbedtls_free( ssl->in_buf );
1035 mbedtls_free( ssl->out_buf );
1036
1037 ssl->conf = NULL;
1038
Darryl Greenb33cc762019-11-28 14:29:44 +00001039#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1040 ssl->in_buf_len = 0;
1041 ssl->out_buf_len = 0;
1042#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001043 ssl->in_buf = NULL;
1044 ssl->out_buf = NULL;
1045
1046 ssl->in_hdr = NULL;
1047 ssl->in_ctr = NULL;
1048 ssl->in_len = NULL;
1049 ssl->in_iv = NULL;
1050 ssl->in_msg = NULL;
1051
1052 ssl->out_hdr = NULL;
1053 ssl->out_ctr = NULL;
1054 ssl->out_len = NULL;
1055 ssl->out_iv = NULL;
1056 ssl->out_msg = NULL;
1057
k-stachowiak9f7798e2018-07-31 16:52:32 +02001058 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001059}
1060
1061/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001062 * Reset an initialized and used SSL context for re-use while retaining
1063 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001064 *
1065 * If partial is non-zero, keep data in the input buffer and client ID.
1066 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001067 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001068void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1069 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001070{
Darryl Greenb33cc762019-11-28 14:29:44 +00001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 size_t in_buf_len = ssl->in_buf_len;
1073 size_t out_buf_len = ssl->out_buf_len;
1074#else
1075 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1076 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1077#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001078
Hanno Beckerb0302c42021-08-03 09:39:42 +01001079#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1080 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001081#endif
1082
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001083 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001084 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001085
Hanno Beckerb0302c42021-08-03 09:39:42 +01001086 mbedtls_ssl_reset_in_out_pointers( ssl );
1087
1088 /* Reset incoming message parsing */
1089 ssl->in_offt = NULL;
1090 ssl->nb_zero = 0;
1091 ssl->in_msgtype = 0;
1092 ssl->in_msglen = 0;
1093 ssl->in_hslen = 0;
1094 ssl->keep_current_message = 0;
1095 ssl->transform_in = NULL;
1096
1097#if defined(MBEDTLS_SSL_PROTO_DTLS)
1098 ssl->next_record_offset = 0;
1099 ssl->in_epoch = 0;
1100#endif
1101
1102 /* Keep current datagram if partial == 1 */
1103 if( partial == 0 )
1104 {
1105 ssl->in_left = 0;
1106 memset( ssl->in_buf, 0, in_buf_len );
1107 }
1108
1109 /* Reset outgoing message writing */
1110 ssl->out_msgtype = 0;
1111 ssl->out_msglen = 0;
1112 ssl->out_left = 0;
1113 memset( ssl->out_buf, 0, out_buf_len );
1114 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1115 ssl->transform_out = NULL;
1116
1117#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1118 mbedtls_ssl_dtls_replay_reset( ssl );
1119#endif
1120
XiaokangQian2b01dc32022-01-21 02:53:13 +00001121#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001122 if( ssl->transform )
1123 {
1124 mbedtls_ssl_transform_free( ssl->transform );
1125 mbedtls_free( ssl->transform );
1126 ssl->transform = NULL;
1127 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001128#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1129
XiaokangQian2b01dc32022-01-21 02:53:13 +00001130#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1131 mbedtls_ssl_transform_free( ssl->transform_application );
1132 mbedtls_free( ssl->transform_application );
1133 ssl->transform_application = NULL;
1134
1135 if( ssl->handshake != NULL )
1136 {
1137 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1138 mbedtls_free( ssl->handshake->transform_earlydata );
1139 ssl->handshake->transform_earlydata = NULL;
1140
1141 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1142 mbedtls_free( ssl->handshake->transform_handshake );
1143 ssl->handshake->transform_handshake = NULL;
1144 }
1145
XiaokangQian2b01dc32022-01-21 02:53:13 +00001146#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001147}
1148
1149int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1150{
1151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1152
1153 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1154
XiaokangQian78b1fa72022-01-19 06:56:30 +00001155 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001156
1157 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158#if defined(MBEDTLS_SSL_RENEGOTIATION)
1159 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001160 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001161
1162 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1164 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001165#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001167
Hanno Beckerb0302c42021-08-03 09:39:42 +01001168 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001169 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001170 if( ssl->session )
1171 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 mbedtls_ssl_session_free( ssl->session );
1173 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001174 ssl->session = NULL;
1175 }
1176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001178 ssl->alpn_chosen = NULL;
1179#endif
1180
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001181#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001182#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001183 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001184#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001185 {
1186 mbedtls_free( ssl->cli_id );
1187 ssl->cli_id = NULL;
1188 ssl->cli_id_len = 0;
1189 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001190#endif
1191
Paul Bakker48916f92012-09-16 19:57:18 +00001192 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1193 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001194
1195 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001196}
1197
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001198/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001199 * Reset an initialized and used SSL context for re-use while retaining
1200 * all application-set variables, function pointers and data.
1201 */
1202int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1203{
Hanno Becker43aefe22020-02-05 10:44:56 +00001204 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001205}
1206
1207/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001208 * SSL set accessors
1209 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001210void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001211{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001212 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001213}
1214
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001215void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001216{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001217 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001218}
1219
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001221void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001222{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001223 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001224}
1225#endif
1226
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001227void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001228{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001229 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001230}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001232#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001233
Hanno Becker1841b0a2018-08-24 11:13:57 +01001234void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1235 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001236{
1237 ssl->disable_datagram_packing = !allow_packing;
1238}
1239
1240void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1241 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001242{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001243 conf->hs_timeout_min = min;
1244 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001245}
1246#endif
1247
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001248void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001249{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001250 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001251}
1252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001254void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001255 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001256 void *p_vrfy )
1257{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001258 conf->f_vrfy = f_vrfy;
1259 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001260}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001262
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001263void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001264 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001265 void *p_rng )
1266{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001267 conf->f_rng = f_rng;
1268 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001269}
1270
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001271void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001272 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001273 void *p_dbg )
1274{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001275 conf->f_dbg = f_dbg;
1276 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001277}
1278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001280 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001281 mbedtls_ssl_send_t *f_send,
1282 mbedtls_ssl_recv_t *f_recv,
1283 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001284{
1285 ssl->p_bio = p_bio;
1286 ssl->f_send = f_send;
1287 ssl->f_recv = f_recv;
1288 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001289}
1290
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001291#if defined(MBEDTLS_SSL_PROTO_DTLS)
1292void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1293{
1294 ssl->mtu = mtu;
1295}
1296#endif
1297
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001298void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001299{
1300 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001301}
1302
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001303void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1304 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001305 mbedtls_ssl_set_timer_t *f_set_timer,
1306 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001307{
1308 ssl->p_timer = p_timer;
1309 ssl->f_set_timer = f_set_timer;
1310 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001311
1312 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001313 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001314}
1315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001317void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001318 void *p_cache,
1319 mbedtls_ssl_cache_get_t *f_get_cache,
1320 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001321{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001322 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001323 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001324 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001325}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328#if defined(MBEDTLS_SSL_CLI_C)
1329int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001330{
Janos Follath865b3eb2019-12-16 11:46:15 +00001331 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001332
1333 if( ssl == NULL ||
1334 session == NULL ||
1335 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001336 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001337 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001339 }
1340
Hanno Beckere810bbc2021-05-14 16:01:05 +01001341 if( ssl->handshake->resume == 1 )
1342 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1343
Hanno Becker52055ae2019-02-06 14:30:46 +00001344 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1345 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001346 return( ret );
1347
Paul Bakker0a597072012-09-25 21:55:46 +00001348 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001349
1350 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001351}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001353
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001354void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1355 const int *ciphersuites )
1356{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001357 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001358}
1359
Ronald Cron6f135e12021-12-08 16:57:54 +01001360#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001361void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001362 const int kex_modes )
1363{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001364 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001365}
Ronald Cron6f135e12021-12-08 16:57:54 +01001366#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001369void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001370 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001371{
1372 conf->cert_profile = profile;
1373}
1374
Glenn Strauss36872db2022-01-22 05:06:31 -05001375static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1376{
1377 mbedtls_ssl_key_cert *cur = key_cert, *next;
1378
1379 while( cur != NULL )
1380 {
1381 next = cur->next;
1382 mbedtls_free( cur );
1383 cur = next;
1384 }
1385}
1386
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001387/* Append a new keycert entry to a (possibly empty) list */
1388static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1389 mbedtls_x509_crt *cert,
1390 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001391{
niisato8ee24222018-06-25 19:05:48 +09001392 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001393
Glenn Strauss36872db2022-01-22 05:06:31 -05001394 if( cert == NULL )
1395 {
1396 /* Free list if cert is null */
1397 ssl_key_cert_free( *head );
1398 *head = NULL;
1399 return( 0 );
1400 }
1401
niisato8ee24222018-06-25 19:05:48 +09001402 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1403 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001404 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001405
niisato8ee24222018-06-25 19:05:48 +09001406 new_cert->cert = cert;
1407 new_cert->key = key;
1408 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001409
Glenn Strauss36872db2022-01-22 05:06:31 -05001410 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001411 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001412 {
niisato8ee24222018-06-25 19:05:48 +09001413 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001414 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415 else
1416 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001417 mbedtls_ssl_key_cert *cur = *head;
1418 while( cur->next != NULL )
1419 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001420 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001421 }
1422
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001423 return( 0 );
1424}
1425
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001426int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001427 mbedtls_x509_crt *own_cert,
1428 mbedtls_pk_context *pk_key )
1429{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001430 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001431}
1432
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001433void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001434 mbedtls_x509_crt *ca_chain,
1435 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001436{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001437 conf->ca_chain = ca_chain;
1438 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001439
1440#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1441 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1442 * cannot be used together. */
1443 conf->f_ca_cb = NULL;
1444 conf->p_ca_cb = NULL;
1445#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
Hanno Becker5adaad92019-03-27 16:54:37 +00001447
1448#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1449void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001450 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001451 void *p_ca_cb )
1452{
1453 conf->f_ca_cb = f_ca_cb;
1454 conf->p_ca_cb = p_ca_cb;
1455
1456 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1457 * cannot be used together. */
1458 conf->ca_chain = NULL;
1459 conf->ca_crl = NULL;
1460}
1461#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001463
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001464#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001465const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1466 size_t *name_len )
1467{
1468 *name_len = ssl->handshake->sni_name_len;
1469 return( ssl->handshake->sni_name );
1470}
1471
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001472int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1473 mbedtls_x509_crt *own_cert,
1474 mbedtls_pk_context *pk_key )
1475{
1476 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1477 own_cert, pk_key ) );
1478}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001479
1480void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1481 mbedtls_x509_crt *ca_chain,
1482 mbedtls_x509_crl *ca_crl )
1483{
1484 ssl->handshake->sni_ca_chain = ca_chain;
1485 ssl->handshake->sni_ca_crl = ca_crl;
1486}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001487
1488void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1489 int authmode )
1490{
1491 ssl->handshake->sni_authmode = authmode;
1492}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001493#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1494
Hanno Becker8927c832019-04-03 12:52:50 +01001495#if defined(MBEDTLS_X509_CRT_PARSE_C)
1496void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1497 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1498 void *p_vrfy )
1499{
1500 ssl->f_vrfy = f_vrfy;
1501 ssl->p_vrfy = p_vrfy;
1502}
1503#endif
1504
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001505#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001506/*
1507 * Set EC J-PAKE password for current handshake
1508 */
1509int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1510 const unsigned char *pw,
1511 size_t pw_len )
1512{
1513 mbedtls_ecjpake_role role;
1514
Janos Follath8eb64132016-06-03 15:40:57 +01001515 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001516 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1517
1518 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1519 role = MBEDTLS_ECJPAKE_SERVER;
1520 else
1521 role = MBEDTLS_ECJPAKE_CLIENT;
1522
1523 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1524 role,
1525 MBEDTLS_MD_SHA256,
1526 MBEDTLS_ECP_DP_SECP256R1,
1527 pw, pw_len ) );
1528}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001529#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001530
Gilles Peskineeccd8882020-03-10 12:19:08 +01001531#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001532
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001533static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1534{
1535#if defined(MBEDTLS_USE_PSA_CRYPTO)
1536 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1537 return( 1 );
1538#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001539 if( conf->psk != NULL )
1540 return( 1 );
1541
1542 return( 0 );
1543}
1544
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1546{
1547 /* Remove reference to existing PSK, if any. */
1548#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001549 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001550 {
1551 /* The maintenance of the PSK key slot is the
1552 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001553 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001554 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001555#endif /* MBEDTLS_USE_PSA_CRYPTO */
1556 if( conf->psk != NULL )
1557 {
1558 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1559
1560 mbedtls_free( conf->psk );
1561 conf->psk = NULL;
1562 conf->psk_len = 0;
1563 }
1564
1565 /* Remove reference to PSK identity, if any. */
1566 if( conf->psk_identity != NULL )
1567 {
1568 mbedtls_free( conf->psk_identity );
1569 conf->psk_identity = NULL;
1570 conf->psk_identity_len = 0;
1571 }
1572}
1573
Hanno Becker7390c712018-11-15 13:33:04 +00001574/* This function assumes that PSK identity in the SSL config is unset.
1575 * It checks that the provided identity is well-formed and attempts
1576 * to make a copy of it in the SSL config.
1577 * On failure, the PSK identity in the config remains unset. */
1578static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1579 unsigned char const *psk_identity,
1580 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001581{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001582 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001583 if( psk_identity == NULL ||
1584 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001585 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001586 {
1587 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1588 }
1589
Hanno Becker7390c712018-11-15 13:33:04 +00001590 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1591 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001592 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001593
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001594 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001595 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001596
1597 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001598}
1599
Hanno Becker7390c712018-11-15 13:33:04 +00001600int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1601 const unsigned char *psk, size_t psk_len,
1602 const unsigned char *psk_identity, size_t psk_identity_len )
1603{
Janos Follath865b3eb2019-12-16 11:46:15 +00001604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001605
1606 /* We currently only support one PSK, raw or opaque. */
1607 if( ssl_conf_psk_is_configured( conf ) )
1608 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001609
1610 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001611 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001612 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001613 if( psk_len == 0 )
1614 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1615 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1616 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1617
Hanno Becker7390c712018-11-15 13:33:04 +00001618 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1619 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1620 conf->psk_len = psk_len;
1621 memcpy( conf->psk, psk, conf->psk_len );
1622
1623 /* Check and set PSK Identity */
1624 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1625 if( ret != 0 )
1626 ssl_conf_remove_psk( conf );
1627
1628 return( ret );
1629}
1630
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001631static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1632{
1633#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001634 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001635 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001636 /* The maintenance of the external PSK key slot is the
1637 * user's responsibility. */
1638 if( ssl->handshake->psk_opaque_is_internal )
1639 {
1640 psa_destroy_key( ssl->handshake->psk_opaque );
1641 ssl->handshake->psk_opaque_is_internal = 0;
1642 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001643 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001644 }
Neil Armstronge952a302022-05-03 10:22:14 +02001645#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001646 if( ssl->handshake->psk != NULL )
1647 {
1648 mbedtls_platform_zeroize( ssl->handshake->psk,
1649 ssl->handshake->psk_len );
1650 mbedtls_free( ssl->handshake->psk );
1651 ssl->handshake->psk_len = 0;
1652 }
Neil Armstronge952a302022-05-03 10:22:14 +02001653#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001654}
1655
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001656int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1657 const unsigned char *psk, size_t psk_len )
1658{
Neil Armstrong501c9322022-05-03 09:35:09 +02001659#if defined(MBEDTLS_USE_PSA_CRYPTO)
1660 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1661 psa_status_t status;
1662 psa_algorithm_t alg;
1663 mbedtls_svc_key_id_t key;
1664#endif /* MBEDTLS_USE_PSA_CRYPTO */
1665
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001666 if( psk == NULL || ssl->handshake == NULL )
1667 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1668
1669 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1670 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1671
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001672 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001673
Neil Armstrong501c9322022-05-03 09:35:09 +02001674#if defined(MBEDTLS_USE_PSA_CRYPTO)
1675 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1676 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1677 else
1678 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1679
1680 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1681 psa_set_key_algorithm( &key_attributes, alg );
1682 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1683
1684 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1685 if( status != PSA_SUCCESS )
1686 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1687
1688 /* Allow calling psa_destroy_key() on psk remove */
1689 ssl->handshake->psk_opaque_is_internal = 1;
1690 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1691#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001692 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001693 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001694
1695 ssl->handshake->psk_len = psk_len;
1696 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1697
1698 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001699#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001700}
1701
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001702#if defined(MBEDTLS_USE_PSA_CRYPTO)
1703int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001704 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001705 const unsigned char *psk_identity,
1706 size_t psk_identity_len )
1707{
Janos Follath865b3eb2019-12-16 11:46:15 +00001708 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001709
1710 /* We currently only support one PSK, raw or opaque. */
1711 if( ssl_conf_psk_is_configured( conf ) )
1712 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001713
Hanno Becker7390c712018-11-15 13:33:04 +00001714 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001715 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001716 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001717 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001718
1719 /* Check and set PSK Identity */
1720 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1721 psk_identity_len );
1722 if( ret != 0 )
1723 ssl_conf_remove_psk( conf );
1724
1725 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001726}
1727
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001728int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1729 mbedtls_svc_key_id_t psk )
1730{
1731 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1732 ( ssl->handshake == NULL ) )
1733 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1734
1735 ssl_remove_psk( ssl );
1736 ssl->handshake->psk_opaque = psk;
1737 return( 0 );
1738}
1739#endif /* MBEDTLS_USE_PSA_CRYPTO */
1740
1741void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1742 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1743 size_t),
1744 void *p_psk )
1745{
1746 conf->f_psk = f_psk;
1747 conf->p_psk = p_psk;
1748}
1749#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1750
1751#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001752static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1753 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001754{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001755#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001756 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001757 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001758#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001759 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001760 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001761 return( MBEDTLS_SSL_MODE_STREAM );
1762}
1763
1764#else /* MBEDTLS_USE_PSA_CRYPTO */
1765
1766static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1767 mbedtls_cipher_mode_t mode )
1768{
1769#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1770 if( mode == MBEDTLS_MODE_CBC )
1771 return( MBEDTLS_SSL_MODE_CBC );
1772#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1773
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001774#if defined(MBEDTLS_GCM_C) || \
1775 defined(MBEDTLS_CCM_C) || \
1776 defined(MBEDTLS_CHACHAPOLY_C)
1777 if( mode == MBEDTLS_MODE_GCM ||
1778 mode == MBEDTLS_MODE_CCM ||
1779 mode == MBEDTLS_MODE_CHACHAPOLY )
1780 return( MBEDTLS_SSL_MODE_AEAD );
1781#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001782
1783 return( MBEDTLS_SSL_MODE_STREAM );
1784}
Gilles Peskine301711e2022-04-26 16:57:05 +02001785#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001786
Gilles Peskinee108d982022-04-26 16:50:40 +02001787static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1788 mbedtls_ssl_mode_t base_mode,
1789 int encrypt_then_mac )
1790{
1791#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1792 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1793 base_mode == MBEDTLS_SSL_MODE_CBC )
1794 {
1795 return( MBEDTLS_SSL_MODE_CBC_ETM );
1796 }
1797#else
1798 (void) encrypt_then_mac;
1799#endif
1800 return( base_mode );
1801}
1802
Neil Armstrongab555e02022-04-04 11:07:59 +02001803mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001804 const mbedtls_ssl_transform *transform )
1805{
Gilles Peskinee108d982022-04-26 16:50:40 +02001806 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001808 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001809#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001810 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1811#endif
1812 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001813
Gilles Peskinee108d982022-04-26 16:50:40 +02001814 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001815#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001816 encrypt_then_mac = transform->encrypt_then_mac;
1817#endif
1818 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001819}
1820
Neil Armstrongab555e02022-04-04 11:07:59 +02001821mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001822#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001823 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001824#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001825 const mbedtls_ssl_ciphersuite_t *suite )
1826{
Gilles Peskinee108d982022-04-26 16:50:40 +02001827 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1828
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001829#if defined(MBEDTLS_USE_PSA_CRYPTO)
1830 psa_status_t status;
1831 psa_algorithm_t alg;
1832 psa_key_type_t type;
1833 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001834 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1835 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001836 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001837#else
1838 const mbedtls_cipher_info_t *cipher =
1839 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001840 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001841 {
1842 base_mode =
1843 mbedtls_ssl_get_base_mode(
1844 mbedtls_cipher_info_get_mode( cipher ) );
1845 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001846#endif /* MBEDTLS_USE_PSA_CRYPTO */
1847
Gilles Peskinee108d982022-04-26 16:50:40 +02001848#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1849 int encrypt_then_mac = 0;
1850#endif
1851 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001852}
1853
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001854#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001855psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001856 size_t taglen,
1857 psa_algorithm_t *alg,
1858 psa_key_type_t *key_type,
1859 size_t *key_size )
1860{
1861 switch ( mbedtls_cipher_type )
1862 {
1863 case MBEDTLS_CIPHER_AES_128_CBC:
1864 *alg = PSA_ALG_CBC_NO_PADDING;
1865 *key_type = PSA_KEY_TYPE_AES;
1866 *key_size = 128;
1867 break;
1868 case MBEDTLS_CIPHER_AES_128_CCM:
1869 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1870 *key_type = PSA_KEY_TYPE_AES;
1871 *key_size = 128;
1872 break;
1873 case MBEDTLS_CIPHER_AES_128_GCM:
1874 *alg = PSA_ALG_GCM;
1875 *key_type = PSA_KEY_TYPE_AES;
1876 *key_size = 128;
1877 break;
1878 case MBEDTLS_CIPHER_AES_192_CCM:
1879 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1880 *key_type = PSA_KEY_TYPE_AES;
1881 *key_size = 192;
1882 break;
1883 case MBEDTLS_CIPHER_AES_192_GCM:
1884 *alg = PSA_ALG_GCM;
1885 *key_type = PSA_KEY_TYPE_AES;
1886 *key_size = 192;
1887 break;
1888 case MBEDTLS_CIPHER_AES_256_CBC:
1889 *alg = PSA_ALG_CBC_NO_PADDING;
1890 *key_type = PSA_KEY_TYPE_AES;
1891 *key_size = 256;
1892 break;
1893 case MBEDTLS_CIPHER_AES_256_CCM:
1894 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1895 *key_type = PSA_KEY_TYPE_AES;
1896 *key_size = 256;
1897 break;
1898 case MBEDTLS_CIPHER_AES_256_GCM:
1899 *alg = PSA_ALG_GCM;
1900 *key_type = PSA_KEY_TYPE_AES;
1901 *key_size = 256;
1902 break;
1903 case MBEDTLS_CIPHER_ARIA_128_CBC:
1904 *alg = PSA_ALG_CBC_NO_PADDING;
1905 *key_type = PSA_KEY_TYPE_ARIA;
1906 *key_size = 128;
1907 break;
1908 case MBEDTLS_CIPHER_ARIA_128_CCM:
1909 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1910 *key_type = PSA_KEY_TYPE_ARIA;
1911 *key_size = 128;
1912 break;
1913 case MBEDTLS_CIPHER_ARIA_128_GCM:
1914 *alg = PSA_ALG_GCM;
1915 *key_type = PSA_KEY_TYPE_ARIA;
1916 *key_size = 128;
1917 break;
1918 case MBEDTLS_CIPHER_ARIA_192_CCM:
1919 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1920 *key_type = PSA_KEY_TYPE_ARIA;
1921 *key_size = 192;
1922 break;
1923 case MBEDTLS_CIPHER_ARIA_192_GCM:
1924 *alg = PSA_ALG_GCM;
1925 *key_type = PSA_KEY_TYPE_ARIA;
1926 *key_size = 192;
1927 break;
1928 case MBEDTLS_CIPHER_ARIA_256_CBC:
1929 *alg = PSA_ALG_CBC_NO_PADDING;
1930 *key_type = PSA_KEY_TYPE_ARIA;
1931 *key_size = 256;
1932 break;
1933 case MBEDTLS_CIPHER_ARIA_256_CCM:
1934 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1935 *key_type = PSA_KEY_TYPE_ARIA;
1936 *key_size = 256;
1937 break;
1938 case MBEDTLS_CIPHER_ARIA_256_GCM:
1939 *alg = PSA_ALG_GCM;
1940 *key_type = PSA_KEY_TYPE_ARIA;
1941 *key_size = 256;
1942 break;
1943 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1944 *alg = PSA_ALG_CBC_NO_PADDING;
1945 *key_type = PSA_KEY_TYPE_CAMELLIA;
1946 *key_size = 128;
1947 break;
1948 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1949 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1950 *key_type = PSA_KEY_TYPE_CAMELLIA;
1951 *key_size = 128;
1952 break;
1953 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1954 *alg = PSA_ALG_GCM;
1955 *key_type = PSA_KEY_TYPE_CAMELLIA;
1956 *key_size = 128;
1957 break;
1958 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1959 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1960 *key_type = PSA_KEY_TYPE_CAMELLIA;
1961 *key_size = 192;
1962 break;
1963 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1964 *alg = PSA_ALG_GCM;
1965 *key_type = PSA_KEY_TYPE_CAMELLIA;
1966 *key_size = 192;
1967 break;
1968 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1969 *alg = PSA_ALG_CBC_NO_PADDING;
1970 *key_type = PSA_KEY_TYPE_CAMELLIA;
1971 *key_size = 256;
1972 break;
1973 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1974 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1975 *key_type = PSA_KEY_TYPE_CAMELLIA;
1976 *key_size = 256;
1977 break;
1978 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1979 *alg = PSA_ALG_GCM;
1980 *key_type = PSA_KEY_TYPE_CAMELLIA;
1981 *key_size = 256;
1982 break;
1983 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1984 *alg = PSA_ALG_CHACHA20_POLY1305;
1985 *key_type = PSA_KEY_TYPE_CHACHA20;
1986 *key_size = 256;
1987 break;
1988 case MBEDTLS_CIPHER_NULL:
1989 *alg = MBEDTLS_SSL_NULL_CIPHER;
1990 *key_type = 0;
1991 *key_size = 0;
1992 break;
1993 default:
1994 return PSA_ERROR_NOT_SUPPORTED;
1995 }
1996
1997 return PSA_SUCCESS;
1998}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001999#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002000
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002001#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002002int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2003 const unsigned char *dhm_P, size_t P_len,
2004 const unsigned char *dhm_G, size_t G_len )
2005{
Janos Follath865b3eb2019-12-16 11:46:15 +00002006 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002007
Glenn Strausscee11292021-12-20 01:43:17 -05002008 mbedtls_mpi_free( &conf->dhm_P );
2009 mbedtls_mpi_free( &conf->dhm_G );
2010
Hanno Beckera90658f2017-10-04 15:29:08 +01002011 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2012 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2013 {
2014 mbedtls_mpi_free( &conf->dhm_P );
2015 mbedtls_mpi_free( &conf->dhm_G );
2016 return( ret );
2017 }
2018
2019 return( 0 );
2020}
Paul Bakker5121ce52009-01-03 21:22:43 +00002021
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002022int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002023{
Janos Follath865b3eb2019-12-16 11:46:15 +00002024 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002025
Glenn Strausscee11292021-12-20 01:43:17 -05002026 mbedtls_mpi_free( &conf->dhm_P );
2027 mbedtls_mpi_free( &conf->dhm_G );
2028
Gilles Peskinee5702482021-06-11 21:59:08 +02002029 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2030 &conf->dhm_P ) ) != 0 ||
2031 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2032 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002033 {
2034 mbedtls_mpi_free( &conf->dhm_P );
2035 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002036 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002037 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002038
2039 return( 0 );
2040}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002041#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002042
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002043#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2044/*
2045 * Set the minimum length for Diffie-Hellman parameters
2046 */
2047void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2048 unsigned int bitlen )
2049{
2050 conf->dhm_min_bitlen = bitlen;
2051}
2052#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2053
Gilles Peskineeccd8882020-03-10 12:19:08 +01002054#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002055#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002056/*
2057 * Set allowed/preferred hashes for handshake signatures
2058 */
2059void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2060 const int *hashes )
2061{
2062 conf->sig_hashes = hashes;
2063}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002064#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002065
Jerry Yuf017ee42022-01-12 15:49:48 +08002066/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002067void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2068 const uint16_t* sig_algs )
2069{
Jerry Yuf017ee42022-01-12 15:49:48 +08002070#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2071 conf->sig_hashes = NULL;
2072#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2073 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002074}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002075#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002076
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002077#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002078#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002079/*
2080 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002081 *
2082 * mbedtls_ssl_setup() takes the provided list
2083 * and translates it to a list of IANA TLS group identifiers,
2084 * stored in ssl->handshake->group_list.
2085 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002086 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002087void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002088 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002089{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002090 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002091 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002092}
Brett Warrene0edc842021-08-17 09:53:13 +01002093#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002094#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002095
Brett Warrene0edc842021-08-17 09:53:13 +01002096/*
2097 * Set the allowed groups
2098 */
2099void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2100 const uint16_t *group_list )
2101{
2102#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2103 conf->curve_list = NULL;
2104#endif
2105 conf->group_list = group_list;
2106}
2107
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002108#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002110{
Hanno Becker947194e2017-04-07 13:25:49 +01002111 /* Initialize to suppress unnecessary compiler warning */
2112 size_t hostname_len = 0;
2113
2114 /* Check if new hostname is valid before
2115 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002116 if( hostname != NULL )
2117 {
2118 hostname_len = strlen( hostname );
2119
2120 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2121 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2122 }
2123
2124 /* Now it's clear that we will overwrite the old hostname,
2125 * so we can free it safely */
2126
2127 if( ssl->hostname != NULL )
2128 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002129 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002130 mbedtls_free( ssl->hostname );
2131 }
2132
2133 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002134
Paul Bakker5121ce52009-01-03 21:22:43 +00002135 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002136 {
2137 ssl->hostname = NULL;
2138 }
2139 else
2140 {
2141 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002142 if( ssl->hostname == NULL )
2143 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002144
Hanno Becker947194e2017-04-07 13:25:49 +01002145 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002146
Hanno Becker947194e2017-04-07 13:25:49 +01002147 ssl->hostname[hostname_len] = '\0';
2148 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002149
2150 return( 0 );
2151}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002152#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002153
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002154#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002155void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002157 const unsigned char *, size_t),
2158 void *p_sni )
2159{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002160 conf->f_sni = f_sni;
2161 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002162}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002166int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002167{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002168 size_t cur_len, tot_len;
2169 const char **p;
2170
2171 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002172 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2173 * MUST NOT be truncated."
2174 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002175 */
2176 tot_len = 0;
2177 for( p = protos; *p != NULL; p++ )
2178 {
2179 cur_len = strlen( *p );
2180 tot_len += cur_len;
2181
Ronald Cron8216dd32020-04-23 16:41:44 +02002182 if( ( cur_len == 0 ) ||
2183 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2184 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002186 }
2187
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002188 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002189
2190 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002191}
2192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002194{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002195 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002196}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002198
Johan Pascalb62bb512015-12-03 21:56:45 +01002199#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002200void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2201 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002202{
2203 conf->dtls_srtp_mki_support = support_mki_value;
2204}
2205
Ron Eldoref72faf2018-07-12 11:54:20 +03002206int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2207 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002208 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002209{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002210 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002211 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002212 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002213 }
Ron Eldor591f1622018-01-22 12:30:04 +02002214
2215 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002216 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002217 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002218 }
Ron Eldor591f1622018-01-22 12:30:04 +02002219
2220 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2221 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002222 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002223}
2224
Ron Eldoref72faf2018-07-12 11:54:20 +03002225int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002226 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002227{
Johan Pascal253d0262020-09-22 13:04:45 +02002228 const mbedtls_ssl_srtp_profile *p;
2229 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002230
Johan Pascal253d0262020-09-22 13:04:45 +02002231 /* check the profiles list: all entry must be valid,
2232 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002233 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2234 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2235 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002236 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002237 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002238 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002239 list_size++;
2240 }
2241 else
2242 {
2243 /* unsupported value, stop parsing and set the size to an error value */
2244 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002245 }
2246 }
2247
Johan Pascal5ef72d22020-10-28 17:05:47 +01002248 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002249 {
Johan Pascal253d0262020-09-22 13:04:45 +02002250 conf->dtls_srtp_profile_list = NULL;
2251 conf->dtls_srtp_profile_list_len = 0;
2252 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2253 }
2254
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002255 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002256 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002257
2258 return( 0 );
2259}
2260
Johan Pascal5ef72d22020-10-28 17:05:47 +01002261void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2262 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002263{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002264 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2265 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002266 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002267 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002268 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002269 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002270 else
2271 {
2272 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002273 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2274 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002275 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002276}
Johan Pascalb62bb512015-12-03 21:56:45 +01002277#endif /* MBEDTLS_SSL_DTLS_SRTP */
2278
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002279void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002280{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002281 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002282}
2283
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002284void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002285{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002286 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002287}
2288
Janos Follath088ce432017-04-10 12:42:31 +01002289#if defined(MBEDTLS_SSL_SRV_C)
2290void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2291 char cert_req_ca_list )
2292{
2293 conf->cert_req_ca_list = cert_req_ca_list;
2294}
2295#endif
2296
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002298void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002299{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002300 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002301}
2302#endif
2303
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002305void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002306{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002307 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002308}
2309#endif
2310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002312int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002313{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002315 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002316 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002318 }
2319
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002320 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002321
2322 return( 0 );
2323}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002325
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002326void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002327{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002328 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002329}
2330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002332void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002333{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002334 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002335}
2336
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002337void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002338{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002339 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002340}
2341
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002342void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002343 const unsigned char period[8] )
2344{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002345 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002346}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002350#if defined(MBEDTLS_SSL_CLI_C)
2351void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002352{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002353 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002354}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002355#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002356
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002357#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002358void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2359 mbedtls_ssl_ticket_write_t *f_ticket_write,
2360 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2361 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002362{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002363 conf->f_ticket_write = f_ticket_write;
2364 conf->f_ticket_parse = f_ticket_parse;
2365 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002366}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002367#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002369
Hanno Becker7e6c1782021-06-08 09:24:55 +01002370void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2371 mbedtls_ssl_export_keys_t *f_export_keys,
2372 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002373{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002374 ssl->f_export_keys = f_export_keys;
2375 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002376}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002377
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002378#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002379void mbedtls_ssl_conf_async_private_cb(
2380 mbedtls_ssl_config *conf,
2381 mbedtls_ssl_async_sign_t *f_async_sign,
2382 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2383 mbedtls_ssl_async_resume_t *f_async_resume,
2384 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002385 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002386{
2387 conf->f_async_sign_start = f_async_sign;
2388 conf->f_async_decrypt_start = f_async_decrypt;
2389 conf->f_async_resume = f_async_resume;
2390 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002391 conf->p_async_config_data = async_config_data;
2392}
2393
Gilles Peskine8f97af72018-04-26 11:46:10 +02002394void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2395{
2396 return( conf->p_async_config_data );
2397}
2398
Gilles Peskine1febfef2018-04-30 11:54:39 +02002399void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002400{
2401 if( ssl->handshake == NULL )
2402 return( NULL );
2403 else
2404 return( ssl->handshake->user_async_ctx );
2405}
2406
Gilles Peskine1febfef2018-04-30 11:54:39 +02002407void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002408 void *ctx )
2409{
2410 if( ssl->handshake != NULL )
2411 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002412}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002413#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002414
Paul Bakker5121ce52009-01-03 21:22:43 +00002415/*
2416 * SSL get accessors
2417 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002418uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002419{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002420 if( ssl->session != NULL )
2421 return( ssl->session->verify_result );
2422
2423 if( ssl->session_negotiate != NULL )
2424 return( ssl->session_negotiate->verify_result );
2425
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002426 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002427}
2428
Glenn Strauss8f526902022-01-13 00:04:49 -05002429int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2430{
2431 if( ssl == NULL || ssl->session == NULL )
2432 return( 0 );
2433
2434 return( ssl->session->ciphersuite );
2435}
2436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002438{
Paul Bakker926c8e42013-03-06 10:23:34 +01002439 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002440 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002443}
2444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002446{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002448 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002449 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002450 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002451 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002452 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002453 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002454 default:
2455 return( "unknown (DTLS)" );
2456 }
2457 }
2458#endif
2459
Glenn Strauss60bfe602022-03-14 19:04:24 -04002460 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002461 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002462 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002463 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002464 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002465 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002466 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002467 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002468 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002469}
2470
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002471#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002472size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2473{
David Horstmann95d516f2021-05-04 18:36:56 +01002474 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002475 size_t read_mfl;
2476
2477 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2478 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2479 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2480 {
2481 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2482 }
2483
2484 /* Check if a smaller max length was negotiated */
2485 if( ssl->session_out != NULL )
2486 {
2487 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2488 if( read_mfl < max_len )
2489 {
2490 max_len = read_mfl;
2491 }
2492 }
2493
2494 // During a handshake, use the value being negotiated
2495 if( ssl->session_negotiate != NULL )
2496 {
2497 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2498 if( read_mfl < max_len )
2499 {
2500 max_len = read_mfl;
2501 }
2502 }
2503
2504 return( max_len );
2505}
2506
2507size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002508{
2509 size_t max_len;
2510
2511 /*
2512 * Assume mfl_code is correct since it was checked when set
2513 */
Angus Grattond8213d02016-05-25 20:56:48 +10002514 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002515
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002516 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002517 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002518 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002519 {
Angus Grattond8213d02016-05-25 20:56:48 +10002520 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002521 }
2522
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002523 /* During a handshake, use the value being negotiated */
2524 if( ssl->session_negotiate != NULL &&
2525 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2526 {
2527 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2528 }
2529
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002530 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002531}
2532#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2533
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002534#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002535size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002536{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002537 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2538 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2539 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2540 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2541 return ( 0 );
2542
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002543 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2544 return( ssl->mtu );
2545
2546 if( ssl->mtu == 0 )
2547 return( ssl->handshake->mtu );
2548
2549 return( ssl->mtu < ssl->handshake->mtu ?
2550 ssl->mtu : ssl->handshake->mtu );
2551}
2552#endif /* MBEDTLS_SSL_PROTO_DTLS */
2553
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002554int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2555{
2556 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2557
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002558#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2559 !defined(MBEDTLS_SSL_PROTO_DTLS)
2560 (void) ssl;
2561#endif
2562
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002563#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002564 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002565
2566 if( max_len > mfl )
2567 max_len = mfl;
2568#endif
2569
2570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002571 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002572 {
Hanno Becker89490712020-02-05 10:50:12 +00002573 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002574 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2575 const size_t overhead = (size_t) ret;
2576
2577 if( ret < 0 )
2578 return( ret );
2579
2580 if( mtu <= overhead )
2581 {
2582 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2583 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2584 }
2585
2586 if( max_len > mtu - overhead )
2587 max_len = mtu - overhead;
2588 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002589#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002590
Hanno Becker0defedb2018-08-10 12:35:02 +01002591#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2592 !defined(MBEDTLS_SSL_PROTO_DTLS)
2593 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002594#endif
2595
2596 return( (int) max_len );
2597}
2598
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002599int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2600{
2601 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2602
2603#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2604 (void) ssl;
2605#endif
2606
2607#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2608 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2609
2610 if( max_len > mfl )
2611 max_len = mfl;
2612#endif
2613
2614 return( (int) max_len );
2615}
2616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#if defined(MBEDTLS_X509_CRT_PARSE_C)
2618const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002619{
2620 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002621 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002622
Hanno Beckere6824572019-02-07 13:18:46 +00002623#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002624 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002625#else
2626 return( NULL );
2627#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002628}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002632int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2633 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002634{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002635 int ret;
2636
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002637 if( ssl == NULL ||
2638 dst == NULL ||
2639 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002640 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002641 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002643 }
2644
Hanno Beckere810bbc2021-05-14 16:01:05 +01002645 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2646 * idempotent: Each session can only be exported once.
2647 *
2648 * (This is in preparation for TLS 1.3 support where we will
2649 * need the ability to export multiple sessions (aka tickets),
2650 * which will be achieved by calling mbedtls_ssl_get_session()
2651 * multiple times until it fails.)
2652 *
2653 * Check whether we have already exported the current session,
2654 * and fail if so.
2655 */
2656 if( ssl->session->exported == 1 )
2657 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2658
2659 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2660 if( ret != 0 )
2661 return( ret );
2662
2663 /* Remember that we've exported the session. */
2664 ssl->session->exported = 1;
2665 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002666}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002668
Paul Bakker5121ce52009-01-03 21:22:43 +00002669/*
Hanno Beckera835da52019-05-16 12:39:07 +01002670 * Define ticket header determining Mbed TLS version
2671 * and structure of the ticket.
2672 */
2673
Hanno Becker94ef3b32019-05-16 12:50:45 +01002674/*
Hanno Becker50b59662019-05-28 14:30:45 +01002675 * Define bitflag determining compile-time settings influencing
2676 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002677 */
2678
Hanno Becker50b59662019-05-28 14:30:45 +01002679#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002680#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002681#else
Hanno Becker3e088662019-05-29 11:10:18 +01002682#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002683#endif /* MBEDTLS_HAVE_TIME */
2684
2685#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002686#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002687#else
Hanno Becker3e088662019-05-29 11:10:18 +01002688#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002689#endif /* MBEDTLS_X509_CRT_PARSE_C */
2690
2691#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002692#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002693#else
Hanno Becker3e088662019-05-29 11:10:18 +01002694#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002695#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2696
2697#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002698#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002699#else
Hanno Becker3e088662019-05-29 11:10:18 +01002700#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002701#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2702
Hanno Becker94ef3b32019-05-16 12:50:45 +01002703#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002704#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002705#else
Hanno Becker3e088662019-05-29 11:10:18 +01002706#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002707#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2708
Hanno Becker94ef3b32019-05-16 12:50:45 +01002709#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2710#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2711#else
2712#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2713#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2714
Hanno Becker3e088662019-05-29 11:10:18 +01002715#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2716#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2717#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2718#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002719#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2720#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002721
Hanno Becker50b59662019-05-28 14:30:45 +01002722#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002723 ( (uint16_t) ( \
2724 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2725 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2726 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2727 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002728 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002729 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002730
Hanno Beckerf8787072019-05-16 12:41:07 +01002731static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002732 MBEDTLS_VERSION_MAJOR,
2733 MBEDTLS_VERSION_MINOR,
2734 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002735 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2736 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002737};
Hanno Beckera835da52019-05-16 12:39:07 +01002738
2739/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002740 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002741 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002742 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002743 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002744 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002745 * opaque mbedtls_version[3]; // library version: major, minor, patch
2746 * opaque session_format[2]; // library-version specific 16-bit field
2747 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002748 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002749 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002750 * Note: When updating the format, remember to keep
2751 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002752 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002753 * // In this version, `session_format` determines
2754 * // the setting of those compile-time
2755 * // configuration options which influence
2756 * // the structure of mbedtls_ssl_session.
2757 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002758 * uint8_t minor_ver; // Protocol minor version. Possible values:
2759 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002760 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002761 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002762 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002763 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002764 * serialized_session_tls12 data;
2765 *
2766 * };
2767 *
2768 * } serialized_session;
2769 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002770 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002771
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002772static int ssl_session_save( const mbedtls_ssl_session *session,
2773 unsigned char omit_header,
2774 unsigned char *buf,
2775 size_t buf_len,
2776 size_t *olen )
2777{
2778 unsigned char *p = buf;
2779 size_t used = 0;
2780
2781 if( !omit_header )
2782 {
2783 /*
2784 * Add Mbed TLS version identifier
2785 */
2786
2787 used += sizeof( ssl_serialized_session_header );
2788
2789 if( used <= buf_len )
2790 {
2791 memcpy( p, ssl_serialized_session_header,
2792 sizeof( ssl_serialized_session_header ) );
2793 p += sizeof( ssl_serialized_session_header );
2794 }
2795 }
2796
2797 /*
2798 * TLS version identifier
2799 */
2800 used += 1;
2801 if( used <= buf_len )
2802 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002803 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002804 }
2805
2806 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002807 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002808 {
2809#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002810 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002811 {
2812 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2813 used += ssl_session_save_tls12( session, p, remaining_len );
2814 break;
2815 }
2816#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2817
2818 default:
2819 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2820 }
2821
2822 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002823 if( used > buf_len )
2824 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002825
2826 return( 0 );
2827}
2828
2829/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002830 * Public wrapper for ssl_session_save()
2831 */
2832int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2833 unsigned char *buf,
2834 size_t buf_len,
2835 size_t *olen )
2836{
2837 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2838}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002839
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002840/*
2841 * Deserialize session, see mbedtls_ssl_session_save() for format.
2842 *
2843 * This internal version is wrapped by a public function that cleans up in
2844 * case of error, and has an extra option omit_header.
2845 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002846static int ssl_session_load( mbedtls_ssl_session *session,
2847 unsigned char omit_header,
2848 const unsigned char *buf,
2849 size_t len )
2850{
2851 const unsigned char *p = buf;
2852 const unsigned char * const end = buf + len;
2853
2854 if( !omit_header )
2855 {
2856 /*
2857 * Check Mbed TLS version identifier
2858 */
2859
2860 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2861 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2862
2863 if( memcmp( p, ssl_serialized_session_header,
2864 sizeof( ssl_serialized_session_header ) ) != 0 )
2865 {
2866 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2867 }
2868 p += sizeof( ssl_serialized_session_header );
2869 }
2870
2871 /*
2872 * TLS version identifier
2873 */
2874 if( 1 > (size_t)( end - p ) )
2875 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002876 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002877
2878 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002879 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002880 {
2881#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002882 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002883 {
2884 size_t remaining_len = ( end - p );
2885 return( ssl_session_load_tls12( session, p, remaining_len ) );
2886 }
2887#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2888
2889 default:
2890 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2891 }
2892}
2893
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002894/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002895 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002896 */
2897int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2898 const unsigned char *buf,
2899 size_t len )
2900{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002901 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002902
2903 if( ret != 0 )
2904 mbedtls_ssl_session_free( session );
2905
2906 return( ret );
2907}
2908
2909/*
Paul Bakker1961b702013-01-25 14:49:24 +01002910 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002911 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002912static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2913{
2914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2915
Ronald Cron66dbf912022-02-02 15:33:46 +01002916 /*
2917 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002918 * that were written into the output buffer by the previous handshake step,
2919 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002920 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2921 * We proceed to the next handshake step only when all data from the
2922 * previous one have been sent to the peer, thus we make sure that this is
2923 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2924 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2925 * we have to wait before to go ahead.
2926 * In the case of TLS 1.3, handshake step handlers do not send data to the
2927 * peer. Data are only sent here and through
2928 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002929 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002930 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002931 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2932 return( ret );
2933
2934#if defined(MBEDTLS_SSL_PROTO_DTLS)
2935 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2936 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2937 {
2938 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2939 return( ret );
2940 }
2941#endif /* MBEDTLS_SSL_PROTO_DTLS */
2942
2943 return( ret );
2944}
2945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002947{
Hanno Becker41934dd2021-08-07 19:13:43 +01002948 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002949
Hanno Becker41934dd2021-08-07 19:13:43 +01002950 if( ssl == NULL ||
2951 ssl->conf == NULL ||
2952 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002953 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002954 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002955 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002956 }
2957
2958 ret = ssl_prepare_handshake_step( ssl );
2959 if( ret != 0 )
2960 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002961
Jerry Yue7047812021-09-13 19:26:39 +08002962 ret = mbedtls_ssl_handle_pending_alert( ssl );
2963 if( ret != 0 )
2964 goto cleanup;
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002967 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002968 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002969 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2970 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002971
Ronald Cron9f0fba32022-02-10 16:45:15 +01002972 switch( ssl->state )
2973 {
2974 case MBEDTLS_SSL_HELLO_REQUEST:
2975 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2976 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002977
Ronald Cron9f0fba32022-02-10 16:45:15 +01002978 case MBEDTLS_SSL_CLIENT_HELLO:
2979 ret = mbedtls_ssl_write_client_hello( ssl );
2980 break;
2981
2982 default:
2983#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002984 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002985 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2986 else
2987 ret = mbedtls_ssl_handshake_client_step( ssl );
2988#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2989 ret = mbedtls_ssl_handshake_client_step( ssl );
2990#else
2991 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2992#endif
2993 }
Jerry Yub9930e72021-08-06 17:11:51 +08002994 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002995#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002997 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002998 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002999#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3f71ca02022-06-21 14:42:03 +08003000
Jerry Yub9930e72021-08-06 17:11:51 +08003001 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu3f71ca02022-06-21 14:42:03 +08003002 {
3003#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
3004 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3005 /* Remove below lines if server side hybrid mode implemented. */
3006 if( ssl->state == MBEDTLS_SSL_HELLO_REQUEST )
3007 {
3008 ssl_fix_server_side_negotiation_fail( ssl );
3009 }
3010#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
3011 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu27561932021-08-27 17:07:38 +08003012 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Jerry Yu3f71ca02022-06-21 14:42:03 +08003013 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003014#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003015
3016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3017 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3018 ret = mbedtls_ssl_handshake_server_step( ssl );
3019#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3020 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003021#endif
3022
Jerry Yue7047812021-09-13 19:26:39 +08003023 if( ret != 0 )
3024 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003025 /* handshake_step return error. And it is same
3026 * with alert_reason.
3027 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003028 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003029 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003030 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003031 goto cleanup;
3032 }
3033 }
3034
3035cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003036 return( ret );
3037}
3038
3039/*
3040 * Perform the SSL handshake
3041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003043{
3044 int ret = 0;
3045
Hanno Beckera817ea42020-10-20 15:20:23 +01003046 /* Sanity checks */
3047
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003048 if( ssl == NULL || ssl->conf == NULL )
3049 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3050
Hanno Beckera817ea42020-10-20 15:20:23 +01003051#if defined(MBEDTLS_SSL_PROTO_DTLS)
3052 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3053 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3054 {
3055 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3056 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3058 }
3059#endif /* MBEDTLS_SSL_PROTO_DTLS */
3060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003062
Hanno Beckera817ea42020-10-20 15:20:23 +01003063 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003064 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003067
3068 if( ret != 0 )
3069 break;
3070 }
3071
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003073
3074 return( ret );
3075}
3076
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077#if defined(MBEDTLS_SSL_RENEGOTIATION)
3078#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003079/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003080 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003083{
Janos Follath865b3eb2019-12-16 11:46:15 +00003084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003087
3088 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3090 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003091
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003092 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003093 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003094 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003095 return( ret );
3096 }
3097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003099
3100 return( 0 );
3101}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003103
3104/*
3105 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106 * - any side: calling mbedtls_ssl_renegotiate(),
3107 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3108 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003109 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003110 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003112 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003113int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003114{
Janos Follath865b3eb2019-12-16 11:46:15 +00003115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003118
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003119 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3120 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003121
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003122 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3123 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003125 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003127 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003128 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003129 ssl->handshake->out_msg_seq = 1;
3130 else
3131 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003132 }
3133#endif
3134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3136 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003139 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003141 return( ret );
3142 }
3143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003145
3146 return( 0 );
3147}
3148
3149/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003150 * Renegotiate current connection on client,
3151 * or request renegotiation on server
3152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003154{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003156
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003157 if( ssl == NULL || ssl->conf == NULL )
3158 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003161 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003162 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003163 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003164 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003168
3169 /* Did we already try/start sending HelloRequest? */
3170 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003172
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003173 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003174 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003178 /*
3179 * On client, either start the renegotiation process or,
3180 * if already in progress, continue the handshake
3181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003183 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003184 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003186
Hanno Becker40cdaa12020-02-05 10:48:27 +00003187 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003188 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003189 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003190 return( ret );
3191 }
3192 }
3193 else
3194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003196 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003198 return( ret );
3199 }
3200 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003202
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003203 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003204}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003206
Gilles Peskine9b562d52018-04-25 20:32:43 +02003207void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003208{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003209 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3210
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003211 if( handshake == NULL )
3212 return;
3213
Brett Warrene0edc842021-08-17 09:53:13 +01003214#if defined(MBEDTLS_ECP_C)
3215#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3216 if ( ssl->handshake->group_list_heap_allocated )
3217 mbedtls_free( (void*) handshake->group_list );
3218 handshake->group_list = NULL;
3219#endif /* MBEDTLS_DEPRECATED_REMOVED */
3220#endif /* MBEDTLS_ECP_C */
3221
Jerry Yuf017ee42022-01-12 15:49:48 +08003222#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3223#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3224 if ( ssl->handshake->sig_algs_heap_allocated )
3225 mbedtls_free( (void*) handshake->sig_algs );
3226 handshake->sig_algs = NULL;
3227#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003228#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3229 if( ssl->handshake->certificate_request_context )
3230 {
3231 mbedtls_free( (void*) handshake->certificate_request_context );
3232 }
3233#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003234#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3235
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003236#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3237 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3238 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003239 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003240 handshake->async_in_progress = 0;
3241 }
3242#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3243
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003244#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003245#if defined(MBEDTLS_USE_PSA_CRYPTO)
3246 psa_hash_abort( &handshake->fin_sha256_psa );
3247#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003248 mbedtls_sha256_free( &handshake->fin_sha256 );
3249#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003250#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003251#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003252#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003253 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003254#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003255 mbedtls_sha512_free( &handshake->fin_sha512 );
3256#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003257#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#if defined(MBEDTLS_DHM_C)
3260 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003261#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003262#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003264#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003265#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003266 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003267#if defined(MBEDTLS_SSL_CLI_C)
3268 mbedtls_free( handshake->ecjpake_cache );
3269 handshake->ecjpake_cache = NULL;
3270 handshake->ecjpake_cache_len = 0;
3271#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003272#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003273
Janos Follath4ae5c292016-02-10 11:27:43 +00003274#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3275 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003276 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003278#endif
3279
Gilles Peskineeccd8882020-03-10 12:19:08 +01003280#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003281#if defined(MBEDTLS_USE_PSA_CRYPTO)
3282 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3283 {
3284 /* The maintenance of the external PSK key slot is the
3285 * user's responsibility. */
3286 if( ssl->handshake->psk_opaque_is_internal )
3287 {
3288 psa_destroy_key( ssl->handshake->psk_opaque );
3289 ssl->handshake->psk_opaque_is_internal = 0;
3290 }
3291 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3292 }
Neil Armstronge952a302022-05-03 10:22:14 +02003293#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003294 if( handshake->psk != NULL )
3295 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003296 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003297 mbedtls_free( handshake->psk );
3298 }
Neil Armstronge952a302022-05-03 10:22:14 +02003299#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003300#endif
3301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3303 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003304 /*
3305 * Free only the linked list wrapper, not the keys themselves
3306 * since the belong to the SNI callback
3307 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003308 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003310
Gilles Peskineeccd8882020-03-10 12:19:08 +01003311#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003312 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003313 if( handshake->ecrs_peer_cert != NULL )
3314 {
3315 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3316 mbedtls_free( handshake->ecrs_peer_cert );
3317 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003318#endif
3319
Hanno Becker75173122019-02-06 16:18:31 +00003320#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3321 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3322 mbedtls_pk_free( &handshake->peer_pubkey );
3323#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3324
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003325#if defined(MBEDTLS_SSL_CLI_C) && \
3326 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3327 mbedtls_free( handshake->cookie );
3328#endif /* MBEDTLS_SSL_CLI_C &&
3329 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003330
3331#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003332 mbedtls_ssl_flight_free( handshake->flight );
3333 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003334#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003335
Ronald Cronf12b81d2022-03-15 10:42:41 +01003336#if defined(MBEDTLS_ECDH_C) && \
3337 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003338 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003339 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003340#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3341
Ronald Cron6f135e12021-12-08 16:57:54 +01003342#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003343 mbedtls_ssl_transform_free( handshake->transform_handshake );
3344 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003345 mbedtls_free( handshake->transform_earlydata );
3346 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003347#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003348
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003349
3350#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3351 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3352 * processes datagrams and the fact that a datagram is allowed to have
3353 * several records in it, it is possible that the I/O buffers are not
3354 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003355 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3356 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003357#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003358
Jerry Yuba9c7272021-10-30 11:54:10 +08003359 /* mbedtls_platform_zeroize MUST be last one in this function */
3360 mbedtls_platform_zeroize( handshake,
3361 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003362}
3363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003364void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003365{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003366 if( session == NULL )
3367 return;
3368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003370 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003371#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003372
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003373#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003375#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003376
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003377 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003378}
3379
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003380#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003381
3382#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3383#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3384#else
3385#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3386#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3387
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003388#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003389
3390#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3391#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3392#else
3393#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3394#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3395
3396#if defined(MBEDTLS_SSL_ALPN)
3397#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3398#else
3399#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3400#endif /* MBEDTLS_SSL_ALPN */
3401
3402#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3403#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3404#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3405#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3406
3407#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3408 ( (uint32_t) ( \
3409 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3410 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3411 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3412 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3413 0u ) )
3414
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003415static unsigned char ssl_serialized_context_header[] = {
3416 MBEDTLS_VERSION_MAJOR,
3417 MBEDTLS_VERSION_MINOR,
3418 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003419 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3420 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3421 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3422 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3423 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003424};
3425
Paul Bakker5121ce52009-01-03 21:22:43 +00003426/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003427 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003428 *
3429 * The format of the serialized data is:
3430 * (in the presentation language of TLS, RFC 8446 section 3)
3431 *
3432 * // header
3433 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003434 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003435 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003436 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003437 * Note: When updating the format, remember to keep these
3438 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003439 *
3440 * // session sub-structure
3441 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3442 * // transform sub-structure
3443 * uint8 random[64]; // ServerHello.random+ClientHello.random
3444 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3445 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3446 * // fields from ssl_context
3447 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3448 * uint64 in_window_top; // DTLS: last validated record seq_num
3449 * uint64 in_window; // DTLS: bitmask for replay protection
3450 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3451 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3452 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3453 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3454 *
3455 * Note that many fields of the ssl_context or sub-structures are not
3456 * serialized, as they fall in one of the following categories:
3457 *
3458 * 1. forced value (eg in_left must be 0)
3459 * 2. pointer to dynamically-allocated memory (eg session, transform)
3460 * 3. value can be re-derived from other data (eg session keys from MS)
3461 * 4. value was temporary (eg content of input buffer)
3462 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003463 */
3464int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3465 unsigned char *buf,
3466 size_t buf_len,
3467 size_t *olen )
3468{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003469 unsigned char *p = buf;
3470 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003471 size_t session_len;
3472 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003473
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003474 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003475 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3476 * this function's documentation.
3477 *
3478 * These are due to assumptions/limitations in the implementation. Some of
3479 * them are likely to stay (no handshake in progress) some might go away
3480 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003481 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003482 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003483 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003484 {
3485 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003486 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003487 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003488 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003489 {
3490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003491 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003492 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003493 /* Double-check that sub-structures are indeed ready */
3494 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003495 {
3496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003498 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003499 /* There must be no pending incoming or outgoing data */
3500 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003501 {
3502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003503 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003504 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003505 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003506 {
3507 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003508 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003509 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003510 /* Protocol must be DLTS, not TLS */
3511 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003512 {
3513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003514 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003515 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003516 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003517 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003518 {
3519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003520 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003521 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003522 /* We must be using an AEAD ciphersuite */
3523 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003524 {
3525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003526 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003527 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003528 /* Renegotiation must not be enabled */
3529#if defined(MBEDTLS_SSL_RENEGOTIATION)
3530 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003531 {
3532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
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#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003536
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003537 /*
3538 * Version and format identifier
3539 */
3540 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003541
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003542 if( used <= buf_len )
3543 {
3544 memcpy( p, ssl_serialized_context_header,
3545 sizeof( ssl_serialized_context_header ) );
3546 p += sizeof( ssl_serialized_context_header );
3547 }
3548
3549 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003550 * Session (length + data)
3551 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003552 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003553 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3554 return( ret );
3555
3556 used += 4 + session_len;
3557 if( used <= buf_len )
3558 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003559 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3560 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003561
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003562 ret = ssl_session_save( ssl->session, 1,
3563 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003564 if( ret != 0 )
3565 return( ret );
3566
3567 p += session_len;
3568 }
3569
3570 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003571 * Transform
3572 */
3573 used += sizeof( ssl->transform->randbytes );
3574 if( used <= buf_len )
3575 {
3576 memcpy( p, ssl->transform->randbytes,
3577 sizeof( ssl->transform->randbytes ) );
3578 p += sizeof( ssl->transform->randbytes );
3579 }
3580
3581#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3582 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3583 if( used <= buf_len )
3584 {
3585 *p++ = ssl->transform->in_cid_len;
3586 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3587 p += ssl->transform->in_cid_len;
3588
3589 *p++ = ssl->transform->out_cid_len;
3590 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3591 p += ssl->transform->out_cid_len;
3592 }
3593#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3594
3595 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003596 * Saved fields from top-level ssl_context structure
3597 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003598 used += 4;
3599 if( used <= buf_len )
3600 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003601 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3602 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003603 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003604
3605#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3606 used += 16;
3607 if( used <= buf_len )
3608 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003609 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3610 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003611
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003612 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3613 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003614 }
3615#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3616
3617#if defined(MBEDTLS_SSL_PROTO_DTLS)
3618 used += 1;
3619 if( used <= buf_len )
3620 {
3621 *p++ = ssl->disable_datagram_packing;
3622 }
3623#endif /* MBEDTLS_SSL_PROTO_DTLS */
3624
Jerry Yuae0b2e22021-10-08 15:21:19 +08003625 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003626 if( used <= buf_len )
3627 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003628 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3629 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003630 }
3631
3632#if defined(MBEDTLS_SSL_PROTO_DTLS)
3633 used += 2;
3634 if( used <= buf_len )
3635 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003636 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3637 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003638 }
3639#endif /* MBEDTLS_SSL_PROTO_DTLS */
3640
3641#if defined(MBEDTLS_SSL_ALPN)
3642 {
3643 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003644 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003645 : 0;
3646
3647 used += 1 + alpn_len;
3648 if( used <= buf_len )
3649 {
3650 *p++ = alpn_len;
3651
3652 if( ssl->alpn_chosen != NULL )
3653 {
3654 memcpy( p, ssl->alpn_chosen, alpn_len );
3655 p += alpn_len;
3656 }
3657 }
3658 }
3659#endif /* MBEDTLS_SSL_ALPN */
3660
3661 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003662 * Done
3663 */
3664 *olen = used;
3665
3666 if( used > buf_len )
3667 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003668
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003669 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3670
Hanno Becker43aefe22020-02-05 10:44:56 +00003671 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003672}
3673
3674/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003675 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003676 *
3677 * This internal version is wrapped by a public function that cleans up in
3678 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003679 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003680static int ssl_context_load( mbedtls_ssl_context *ssl,
3681 const unsigned char *buf,
3682 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003683{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003684 const unsigned char *p = buf;
3685 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003686 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003688
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003689 /*
3690 * The context should have been freshly setup or reset.
3691 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003692 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003693 * renegotiating, or if the user mistakenly loaded a session first.)
3694 */
3695 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3696 ssl->session != NULL )
3697 {
3698 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3699 }
3700
3701 /*
3702 * We can't check that the config matches the initial one, but we can at
3703 * least check it matches the requirements for serializing.
3704 */
3705 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003706 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3707 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003708#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003709 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003710#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003711 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003712 {
3713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3714 }
3715
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003716 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3717
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003718 /*
3719 * Check version identifier
3720 */
3721 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3722 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3723
3724 if( memcmp( p, ssl_serialized_context_header,
3725 sizeof( ssl_serialized_context_header ) ) != 0 )
3726 {
3727 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3728 }
3729 p += sizeof( ssl_serialized_context_header );
3730
3731 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003732 * Session
3733 */
3734 if( (size_t)( end - p ) < 4 )
3735 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3736
3737 session_len = ( (size_t) p[0] << 24 ) |
3738 ( (size_t) p[1] << 16 ) |
3739 ( (size_t) p[2] << 8 ) |
3740 ( (size_t) p[3] );
3741 p += 4;
3742
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003743 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003744 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003745 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003746 ssl->session_in = ssl->session;
3747 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003748 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003749
3750 if( (size_t)( end - p ) < session_len )
3751 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3752
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003753 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003754 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003755 {
3756 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003757 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003758 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003759
3760 p += session_len;
3761
3762 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003763 * Transform
3764 */
3765
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003766 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003767 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003768 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003769 ssl->transform_in = ssl->transform;
3770 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003771 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003772
3773 /* Read random bytes and populate structure */
3774 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3775 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003776#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003777 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003778 ssl->session->ciphersuite,
3779 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003780#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003781 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003782#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003783 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3784 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003785 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003786 ssl->conf->endpoint,
3787 ssl );
3788 if( ret != 0 )
3789 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003790#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003791 p += sizeof( ssl->transform->randbytes );
3792
3793#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3794 /* Read connection IDs and store them */
3795 if( (size_t)( end - p ) < 1 )
3796 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3797
3798 ssl->transform->in_cid_len = *p++;
3799
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003800 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003801 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3802
3803 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3804 p += ssl->transform->in_cid_len;
3805
3806 ssl->transform->out_cid_len = *p++;
3807
3808 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3809 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3810
3811 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3812 p += ssl->transform->out_cid_len;
3813#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3814
3815 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003816 * Saved fields from top-level ssl_context structure
3817 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003818 if( (size_t)( end - p ) < 4 )
3819 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3820
3821 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3822 ( (uint32_t) p[1] << 16 ) |
3823 ( (uint32_t) p[2] << 8 ) |
3824 ( (uint32_t) p[3] );
3825 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003826
3827#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3828 if( (size_t)( end - p ) < 16 )
3829 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3830
3831 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3832 ( (uint64_t) p[1] << 48 ) |
3833 ( (uint64_t) p[2] << 40 ) |
3834 ( (uint64_t) p[3] << 32 ) |
3835 ( (uint64_t) p[4] << 24 ) |
3836 ( (uint64_t) p[5] << 16 ) |
3837 ( (uint64_t) p[6] << 8 ) |
3838 ( (uint64_t) p[7] );
3839 p += 8;
3840
3841 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3842 ( (uint64_t) p[1] << 48 ) |
3843 ( (uint64_t) p[2] << 40 ) |
3844 ( (uint64_t) p[3] << 32 ) |
3845 ( (uint64_t) p[4] << 24 ) |
3846 ( (uint64_t) p[5] << 16 ) |
3847 ( (uint64_t) p[6] << 8 ) |
3848 ( (uint64_t) p[7] );
3849 p += 8;
3850#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3851
3852#if defined(MBEDTLS_SSL_PROTO_DTLS)
3853 if( (size_t)( end - p ) < 1 )
3854 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3855
3856 ssl->disable_datagram_packing = *p++;
3857#endif /* MBEDTLS_SSL_PROTO_DTLS */
3858
Jerry Yud9a94fe2021-09-28 18:58:59 +08003859 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003860 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003861 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3862 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003863
3864#if defined(MBEDTLS_SSL_PROTO_DTLS)
3865 if( (size_t)( end - p ) < 2 )
3866 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3867
3868 ssl->mtu = ( p[0] << 8 ) | p[1];
3869 p += 2;
3870#endif /* MBEDTLS_SSL_PROTO_DTLS */
3871
3872#if defined(MBEDTLS_SSL_ALPN)
3873 {
3874 uint8_t alpn_len;
3875 const char **cur;
3876
3877 if( (size_t)( end - p ) < 1 )
3878 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3879
3880 alpn_len = *p++;
3881
3882 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3883 {
3884 /* alpn_chosen should point to an item in the configured list */
3885 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3886 {
3887 if( strlen( *cur ) == alpn_len &&
3888 memcmp( p, cur, alpn_len ) == 0 )
3889 {
3890 ssl->alpn_chosen = *cur;
3891 break;
3892 }
3893 }
3894 }
3895
3896 /* can only happen on conf mismatch */
3897 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3898 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3899
3900 p += alpn_len;
3901 }
3902#endif /* MBEDTLS_SSL_ALPN */
3903
3904 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003905 * Forced fields from top-level ssl_context structure
3906 *
3907 * Most of them already set to the correct value by mbedtls_ssl_init() and
3908 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3909 */
3910 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003911 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003912
Hanno Becker361b10d2019-08-30 10:42:49 +01003913 /* Adjust pointers for header fields of outgoing records to
3914 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003915 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003916
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003917#if defined(MBEDTLS_SSL_PROTO_DTLS)
3918 ssl->in_epoch = 1;
3919#endif
3920
3921 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3922 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003923 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3924 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003925 if( ssl->handshake != NULL )
3926 {
3927 mbedtls_ssl_handshake_free( ssl );
3928 mbedtls_free( ssl->handshake );
3929 ssl->handshake = NULL;
3930 }
3931
3932 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003933 * Done - should have consumed entire buffer
3934 */
3935 if( p != end )
3936 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003937
3938 return( 0 );
3939}
3940
3941/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003942 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003943 */
3944int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3945 const unsigned char *buf,
3946 size_t len )
3947{
3948 int ret = ssl_context_load( context, buf, len );
3949
3950 if( ret != 0 )
3951 mbedtls_ssl_free( context );
3952
3953 return( ret );
3954}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003955#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003956
3957/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003958 * Free an SSL context
3959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003960void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003961{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003962 if( ssl == NULL )
3963 return;
3964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003966
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003967 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003968 {
sander-visserb8aa2072020-05-06 22:05:13 +02003969#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3970 size_t out_buf_len = ssl->out_buf_len;
3971#else
3972 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3973#endif
3974
Darryl Greenb33cc762019-11-28 14:29:44 +00003975 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003976 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003977 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003978 }
3979
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003980 if( ssl->in_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 in_buf_len = ssl->in_buf_len;
3984#else
3985 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3986#endif
3987
Darryl Greenb33cc762019-11-28 14:29:44 +00003988 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003989 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003990 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003991 }
3992
Paul Bakker48916f92012-09-16 19:57:18 +00003993 if( ssl->transform )
3994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995 mbedtls_ssl_transform_free( ssl->transform );
3996 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003997 }
3998
3999 if( ssl->handshake )
4000 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004001 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4003 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005 mbedtls_free( ssl->handshake );
4006 mbedtls_free( ssl->transform_negotiate );
4007 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004008 }
4009
Ronald Cron6f135e12021-12-08 16:57:54 +01004010#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004011 mbedtls_ssl_transform_free( ssl->transform_application );
4012 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004013#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004014
Paul Bakkerc0463502013-02-14 11:19:38 +01004015 if( ssl->session )
4016 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004017 mbedtls_ssl_session_free( ssl->session );
4018 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004019 }
4020
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004021#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004022 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004023 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004024 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004026 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004027#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004028
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004029#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004030 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004031#endif
4032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004033 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004034
Paul Bakker86f04f42013-02-14 11:20:09 +01004035 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004036 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004037}
4038
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004039/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004040 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004041 */
4042void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4043{
4044 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4045}
4046
Gilles Peskineae270bf2021-06-02 00:05:29 +02004047/* The selection should be the same as mbedtls_x509_crt_profile_default in
4048 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004049 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004050 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004051 * about this list.
4052 */
Brett Warrene0edc842021-08-17 09:53:13 +01004053static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004054#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004055 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004056#endif
4057#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004058 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004059#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004060#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004061 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004062#endif
4063#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004064 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004065#endif
4066#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004067 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004068#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004069#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004070 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004071#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004072#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004073 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004074#endif
4075#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004076 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004077#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004078 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004079};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004080
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004081static int ssl_preset_suiteb_ciphersuites[] = {
4082 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4083 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4084 0
4085};
4086
Gilles Peskineeccd8882020-03-10 12:19:08 +01004087#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004088
Jerry Yu909df7b2022-01-22 11:56:27 +08004089/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004090 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004091 * rules SHOULD be upheld.
4092 * - No duplicate entries.
4093 * - But if there is a good reason, do not change the order of the algorithms.
4094 * - ssl_tls12_present* is for TLS 1.2 use only.
4095 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004096 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004097static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004098
Jerry Yued5e9f42022-01-26 11:21:34 +08004099#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4100 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4101 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4102#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4103 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004104
Jerry Yu909df7b2022-01-22 11:56:27 +08004105#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4106 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4107 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4108#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4109 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4110
Jerry Yued5e9f42022-01-26 11:21:34 +08004111#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4112 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4113 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4114#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4115 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu3896ac62022-06-19 17:16:38 +08004116/*
4117 * To fix version negotiation fail with RSA server key.
4118 * - With TLS1.3 server, `rsa_pss_rsae_*` must be sent.
4119 * - With TLS1.2 server, `rsa_pkcs1_*` must be sent before `rsa_pss_rsae_*`
4120 * - This point is only tested with OpenSSL now.
4121 */
4122#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4123 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4124#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4125
4126#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4127 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4128#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4129
4130#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4131 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4132#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4133
Jerry Yu909df7b2022-01-22 11:56:27 +08004134
Jerry Yuf0cda412022-06-17 14:29:46 +08004135#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4136 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4137#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4138
4139#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4140 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4141#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4142
Jerry Yu909df7b2022-01-22 11:56:27 +08004143#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4144 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4145#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4146
Gabor Mezei15b95a62022-05-09 16:37:58 +02004147 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004148};
4149
4150/* NOTICE: see above */
4151#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4152static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004153#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004154#if defined(MBEDTLS_ECDSA_C)
4155 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004156#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004157#if defined(MBEDTLS_RSA_C)
4158 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4159#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004160#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004161#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004162#if defined(MBEDTLS_ECDSA_C)
4163 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004164#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004165#if defined(MBEDTLS_RSA_C)
4166 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4167#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004168#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004169#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004170#if defined(MBEDTLS_ECDSA_C)
4171 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004172#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004173#if defined(MBEDTLS_RSA_C)
4174 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4175#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004176#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004177 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004178};
4179#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4180/* NOTICE: see above */
4181static uint16_t ssl_preset_suiteb_sig_algs[] = {
4182
Jerry Yu909df7b2022-01-22 11:56:27 +08004183#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4184 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4185 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4186#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4187 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4188
Jerry Yu53037892022-01-25 11:02:06 +08004189#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4190 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4191 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4192#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4193 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004194
4195#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4196 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4197#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004198
Jerry Yu53037892022-01-25 11:02:06 +08004199#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4200 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4201#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4202
Gabor Mezei15b95a62022-05-09 16:37:58 +02004203 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004204};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004205
Jerry Yu909df7b2022-01-22 11:56:27 +08004206/* NOTICE: see above */
4207#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4208static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004209#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004210#if defined(MBEDTLS_ECDSA_C)
4211 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004212#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004213#if defined(MBEDTLS_RSA_C)
4214 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4215#endif
4216#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004217#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004218#if defined(MBEDTLS_ECDSA_C)
4219 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004220#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004221#if defined(MBEDTLS_RSA_C)
4222 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4223#endif
4224#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004225 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004226};
Jerry Yu909df7b2022-01-22 11:56:27 +08004227#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4228
Jerry Yu1a8b4812022-01-20 17:56:50 +08004229#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004230
Brett Warrene0edc842021-08-17 09:53:13 +01004231static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004232#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004233 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004234#endif
4235#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004236 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004237#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004238 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004239};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004240
Jerry Yu1a8b4812022-01-20 17:56:50 +08004241#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004242/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004243 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004244static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004245{
4246 size_t i, j;
4247 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004248
Gabor Mezei15b95a62022-05-09 16:37:58 +02004249 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004250 {
Jerry Yuf377d642022-01-25 10:43:59 +08004251 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004252 {
Jerry Yuf377d642022-01-25 10:43:59 +08004253 if( sig_algs[i] != sig_algs[j] )
4254 continue;
4255 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4256 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4257 sig_algs[i], j, i );
4258 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004259 }
4260 }
4261 return( ret );
4262}
4263
4264#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4265
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004266/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004267 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004268 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004269int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004270 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004271{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004272#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004273 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004274#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004275
Jerry Yu1a8b4812022-01-20 17:56:50 +08004276#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004277 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004278 {
4279 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4280 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4281 }
4282
Jerry Yuf377d642022-01-25 10:43:59 +08004283 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004284 {
4285 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4286 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4287 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004288
4289#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004290 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004291 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004292 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004293 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4294 }
4295
Jerry Yuf377d642022-01-25 10:43:59 +08004296 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004297 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004298 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004299 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4300 }
4301#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004302#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4303
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004304 /* Use the functions here so that they are covered in tests,
4305 * but otherwise access member directly for efficiency */
4306 mbedtls_ssl_conf_endpoint( conf, endpoint );
4307 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004308
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004309 /*
4310 * Things that are common to all presets
4311 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004312#if defined(MBEDTLS_SSL_CLI_C)
4313 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4314 {
4315 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4316#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4317 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4318#endif
4319 }
4320#endif
4321
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004322#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4323 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4324#endif
4325
4326#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4327 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4328#endif
4329
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004330#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004331 conf->f_cookie_write = ssl_cookie_write_dummy;
4332 conf->f_cookie_check = ssl_cookie_check_dummy;
4333#endif
4334
4335#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4336 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4337#endif
4338
Janos Follath088ce432017-04-10 12:42:31 +01004339#if defined(MBEDTLS_SSL_SRV_C)
4340 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004341 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004342#endif
4343
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004344#if defined(MBEDTLS_SSL_PROTO_DTLS)
4345 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4346 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4347#endif
4348
4349#if defined(MBEDTLS_SSL_RENEGOTIATION)
4350 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004351 memset( conf->renego_period, 0x00, 2 );
4352 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004353#endif
4354
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004355#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004356 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4357 {
4358 const unsigned char dhm_p[] =
4359 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4360 const unsigned char dhm_g[] =
4361 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004362
Hanno Beckere2defad2021-07-24 05:59:17 +01004363 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4364 dhm_p, sizeof( dhm_p ),
4365 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4366 {
4367 return( ret );
4368 }
4369 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004370#endif
4371
Ronald Cron6f135e12021-12-08 16:57:54 +01004372#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004373 /*
4374 * Allow all TLS 1.3 key exchange modes by default.
4375 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004376 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004377#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004378
XiaokangQian4d3a6042022-04-21 13:46:17 +00004379 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4380 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004382 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004383 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004384#else
XiaokangQian060d8672022-04-21 09:24:56 +00004385 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004386#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004387 }
4388 else
4389 {
4390#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4391 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4392 {
4393 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4394 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4395 }
4396 else
4397 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4398 {
4399 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4400 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4401 }
4402#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4403 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4404 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4405#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4406 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4407 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4408#else
4409 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4410#endif
4411 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004412
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004413 /*
4414 * Preset-specific defaults
4415 */
4416 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004417 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004418 /*
4419 * NSA Suite B
4420 */
4421 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004422
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004423 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004424
4425#if defined(MBEDTLS_X509_CRT_PARSE_C)
4426 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004427#endif
4428
Gilles Peskineeccd8882020-03-10 12:19:08 +01004429#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004430#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4431 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4432 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4433 else
4434#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4435 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004436#endif
4437
Brett Warrene0edc842021-08-17 09:53:13 +01004438#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4439 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004440#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004441 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004442 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004443
4444 /*
4445 * Default
4446 */
4447 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004448
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004449 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004450
4451#if defined(MBEDTLS_X509_CRT_PARSE_C)
4452 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4453#endif
4454
Gilles Peskineeccd8882020-03-10 12:19:08 +01004455#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004456#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4457 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4458 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4459 else
4460#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4461 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004462#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004463
Brett Warrene0edc842021-08-17 09:53:13 +01004464#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4465 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004466#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004467 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004468
4469#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4470 conf->dhm_min_bitlen = 1024;
4471#endif
4472 }
4473
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004474 return( 0 );
4475}
4476
4477/*
4478 * Free mbedtls_ssl_config
4479 */
4480void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4481{
4482#if defined(MBEDTLS_DHM_C)
4483 mbedtls_mpi_free( &conf->dhm_P );
4484 mbedtls_mpi_free( &conf->dhm_G );
4485#endif
4486
Gilles Peskineeccd8882020-03-10 12:19:08 +01004487#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004488#if defined(MBEDTLS_USE_PSA_CRYPTO)
4489 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4490 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004491 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4492 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004493#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004494 if( conf->psk != NULL )
4495 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004496 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004497 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004498 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004499 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004500 }
4501
4502 if( conf->psk_identity != NULL )
4503 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004504 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004505 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004506 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004507 conf->psk_identity_len = 0;
4508 }
4509#endif
4510
4511#if defined(MBEDTLS_X509_CRT_PARSE_C)
4512 ssl_key_cert_free( conf->key_cert );
4513#endif
4514
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004515 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004516}
4517
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004518#if defined(MBEDTLS_PK_C) && \
4519 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004520/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004521 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004524{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004525#if defined(MBEDTLS_RSA_C)
4526 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4527 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004528#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004529#if defined(MBEDTLS_ECDSA_C)
4530 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4531 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004532#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004534}
4535
Hanno Becker7e5437a2017-04-28 17:15:26 +01004536unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4537{
4538 switch( type ) {
4539 case MBEDTLS_PK_RSA:
4540 return( MBEDTLS_SSL_SIG_RSA );
4541 case MBEDTLS_PK_ECDSA:
4542 case MBEDTLS_PK_ECKEY:
4543 return( MBEDTLS_SSL_SIG_ECDSA );
4544 default:
4545 return( MBEDTLS_SSL_SIG_ANON );
4546 }
4547}
4548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004550{
4551 switch( sig )
4552 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553#if defined(MBEDTLS_RSA_C)
4554 case MBEDTLS_SSL_SIG_RSA:
4555 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004556#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557#if defined(MBEDTLS_ECDSA_C)
4558 case MBEDTLS_SSL_SIG_ECDSA:
4559 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004560#endif
4561 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004562 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004563 }
4564}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004565#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004566
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004567/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004568 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004571{
4572 switch( hash )
4573 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574#if defined(MBEDTLS_MD5_C)
4575 case MBEDTLS_SSL_HASH_MD5:
4576 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004577#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578#if defined(MBEDTLS_SHA1_C)
4579 case MBEDTLS_SSL_HASH_SHA1:
4580 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004581#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004582#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004583 case MBEDTLS_SSL_HASH_SHA224:
4584 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004585#endif
4586#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004587 case MBEDTLS_SSL_HASH_SHA256:
4588 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004589#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004590#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 case MBEDTLS_SSL_HASH_SHA384:
4592 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004593#endif
4594#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595 case MBEDTLS_SSL_HASH_SHA512:
4596 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004597#endif
4598 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004599 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004600 }
4601}
4602
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004603/*
4604 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4605 */
4606unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4607{
4608 switch( md )
4609 {
4610#if defined(MBEDTLS_MD5_C)
4611 case MBEDTLS_MD_MD5:
4612 return( MBEDTLS_SSL_HASH_MD5 );
4613#endif
4614#if defined(MBEDTLS_SHA1_C)
4615 case MBEDTLS_MD_SHA1:
4616 return( MBEDTLS_SSL_HASH_SHA1 );
4617#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004618#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004619 case MBEDTLS_MD_SHA224:
4620 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004621#endif
4622#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004623 case MBEDTLS_MD_SHA256:
4624 return( MBEDTLS_SSL_HASH_SHA256 );
4625#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004626#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004627 case MBEDTLS_MD_SHA384:
4628 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004629#endif
4630#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004631 case MBEDTLS_MD_SHA512:
4632 return( MBEDTLS_SSL_HASH_SHA512 );
4633#endif
4634 default:
4635 return( MBEDTLS_SSL_HASH_NONE );
4636 }
4637}
4638
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004639/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004640 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004641 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004642 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004643int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004644{
Brett Warrene0edc842021-08-17 09:53:13 +01004645 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004646
Brett Warrene0edc842021-08-17 09:53:13 +01004647 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004648 return( -1 );
4649
Brett Warrene0edc842021-08-17 09:53:13 +01004650 for( ; *group_list != 0; group_list++ )
4651 {
4652 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004653 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004654 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004655
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004656 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004657}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004658
4659#if defined(MBEDTLS_ECP_C)
4660/*
4661 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4662 */
4663int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4664{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004665 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004666 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4667}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004668#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670#if defined(MBEDTLS_X509_CRT_PARSE_C)
4671int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4672 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004673 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004674 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004675{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004676 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004677 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004678 const char *ext_oid;
4679 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004680
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004681 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004682 {
4683 /* Server part of the key exchange */
4684 switch( ciphersuite->key_exchange )
4685 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686 case MBEDTLS_KEY_EXCHANGE_RSA:
4687 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004688 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004689 break;
4690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004691 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4692 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4693 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4694 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004695 break;
4696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4698 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004699 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004700 break;
4701
4702 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004703 case MBEDTLS_KEY_EXCHANGE_NONE:
4704 case MBEDTLS_KEY_EXCHANGE_PSK:
4705 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4706 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004707 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004708 usage = 0;
4709 }
4710 }
4711 else
4712 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4714 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004715 }
4716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004718 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004719 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004720 ret = -1;
4721 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004724 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4726 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004727 }
4728 else
4729 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4731 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004732 }
4733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004735 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004736 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004737 ret = -1;
4738 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004739
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004740 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004741}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004743
Jerry Yu148165c2021-09-24 23:20:59 +08004744#if defined(MBEDTLS_USE_PSA_CRYPTO)
4745int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4746 const mbedtls_md_type_t md,
4747 unsigned char *dst,
4748 size_t dst_len,
4749 size_t *olen )
4750{
Ronald Cronf6893e12022-01-07 22:09:01 +01004751 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4752 psa_hash_operation_t *hash_operation_to_clone;
4753 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4754
Jerry Yu148165c2021-09-24 23:20:59 +08004755 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004756
4757 switch( md )
4758 {
4759#if defined(MBEDTLS_SHA384_C)
4760 case MBEDTLS_MD_SHA384:
4761 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4762 break;
4763#endif
4764
4765#if defined(MBEDTLS_SHA256_C)
4766 case MBEDTLS_MD_SHA256:
4767 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4768 break;
4769#endif
4770
4771 default:
4772 goto exit;
4773 }
4774
4775 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4776 if( status != PSA_SUCCESS )
4777 goto exit;
4778
4779 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4780 if( status != PSA_SUCCESS )
4781 goto exit;
4782
4783exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004784 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004785}
4786#else /* MBEDTLS_USE_PSA_CRYPTO */
4787
Jerry Yu24c0ec32021-09-09 14:21:07 +08004788#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004789static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4790 unsigned char *dst,
4791 size_t dst_len,
4792 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004793{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004794 int ret;
4795 mbedtls_sha512_context sha512;
4796
4797 if( dst_len < 48 )
4798 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4799
4800 mbedtls_sha512_init( &sha512 );
4801 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4802
4803 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4804 {
4805 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4806 goto exit;
4807 }
4808
4809 *olen = 48;
4810
4811exit:
4812
4813 mbedtls_sha512_free( &sha512 );
4814 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004815}
4816#endif /* MBEDTLS_SHA384_C */
4817
4818#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004819static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4820 unsigned char *dst,
4821 size_t dst_len,
4822 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004823{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004824 int ret;
4825 mbedtls_sha256_context sha256;
4826
4827 if( dst_len < 32 )
4828 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4829
4830 mbedtls_sha256_init( &sha256 );
4831 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004832
Jerry Yu24c0ec32021-09-09 14:21:07 +08004833 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4834 {
4835 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4836 goto exit;
4837 }
4838
4839 *olen = 32;
4840
4841exit:
4842
4843 mbedtls_sha256_free( &sha256 );
4844 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004845}
4846#endif /* MBEDTLS_SHA256_C */
4847
Jerry Yu000f9762021-09-14 11:12:51 +08004848int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4849 const mbedtls_md_type_t md,
4850 unsigned char *dst,
4851 size_t dst_len,
4852 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004853{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004854 switch( md )
4855 {
4856
Jerry Yu24c0ec32021-09-09 14:21:07 +08004857#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004858 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004859 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004860#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004861
Jerry Yu24c0ec32021-09-09 14:21:07 +08004862#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004863 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004864 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004865#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004866
4867 default:
4868 break;
4869 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004870 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004871}
XiaokangQian647719a2021-12-07 09:16:29 +00004872
Jerry Yu148165c2021-09-24 23:20:59 +08004873#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004874
Gabor Mezei078e8032022-04-27 21:17:56 +02004875#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4876/* mbedtls_ssl_parse_sig_alg_ext()
4877 *
4878 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4879 * value (TLS 1.3 RFC8446):
4880 * enum {
4881 * ....
4882 * ecdsa_secp256r1_sha256( 0x0403 ),
4883 * ecdsa_secp384r1_sha384( 0x0503 ),
4884 * ecdsa_secp521r1_sha512( 0x0603 ),
4885 * ....
4886 * } SignatureScheme;
4887 *
4888 * struct {
4889 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4890 * } SignatureSchemeList;
4891 *
4892 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4893 * value (TLS 1.2 RFC5246):
4894 * enum {
4895 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4896 * sha512(6), (255)
4897 * } HashAlgorithm;
4898 *
4899 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4900 * SignatureAlgorithm;
4901 *
4902 * struct {
4903 * HashAlgorithm hash;
4904 * SignatureAlgorithm signature;
4905 * } SignatureAndHashAlgorithm;
4906 *
4907 * SignatureAndHashAlgorithm
4908 * supported_signature_algorithms<2..2^16-2>;
4909 *
4910 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4911 * generalization of the TLS 1.2 signature algorithm extension.
4912 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4913 * `SignatureScheme` field of TLS 1.3
4914 *
4915 */
4916int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4917 const unsigned char *buf,
4918 const unsigned char *end )
4919{
4920 const unsigned char *p = buf;
4921 size_t supported_sig_algs_len = 0;
4922 const unsigned char *supported_sig_algs_end;
4923 uint16_t sig_alg;
4924 uint32_t common_idx = 0;
4925
4926 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4927 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4928 p += 2;
4929
4930 memset( ssl->handshake->received_sig_algs, 0,
4931 sizeof(ssl->handshake->received_sig_algs) );
4932
4933 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4934 supported_sig_algs_end = p + supported_sig_algs_len;
4935 while( p < supported_sig_algs_end )
4936 {
4937 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4938 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4939 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004940 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4941 sig_alg,
4942 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02004943
4944 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) ||
4945 ! mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) )
4946 continue;
4947
Jerry Yuf3b46b52022-06-19 16:52:27 +08004948 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
4949 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
4950
Gabor Mezei078e8032022-04-27 21:17:56 +02004951 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4952 {
4953 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4954 common_idx += 1;
4955 }
4956 }
4957 /* Check that we consumed all the message. */
4958 if( p != end )
4959 {
4960 MBEDTLS_SSL_DEBUG_MSG( 1,
4961 ( "Signature algorithms extension length misaligned" ) );
4962 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4963 MBEDTLS_ERR_SSL_DECODE_ERROR );
4964 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4965 }
4966
4967 if( common_idx == 0 )
4968 {
4969 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
4970 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
4971 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4972 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4973 }
4974
Gabor Mezei15b95a62022-05-09 16:37:58 +02004975 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02004976 return( 0 );
4977}
4978
4979#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4980
Jerry Yudc7bd172022-02-17 13:44:15 +08004981#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4982
4983#if defined(MBEDTLS_USE_PSA_CRYPTO)
4984
4985static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4986 mbedtls_svc_key_id_t key,
4987 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004988 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004989 const unsigned char* seed, size_t seed_length,
4990 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004991 const unsigned char* other_secret,
4992 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004993 size_t capacity )
4994{
4995 psa_status_t status;
4996
4997 status = psa_key_derivation_setup( derivation, alg );
4998 if( status != PSA_SUCCESS )
4999 return( status );
5000
5001 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5002 {
5003 status = psa_key_derivation_input_bytes( derivation,
5004 PSA_KEY_DERIVATION_INPUT_SEED,
5005 seed, seed_length );
5006 if( status != PSA_SUCCESS )
5007 return( status );
5008
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005009 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005010 {
5011 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005012 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5013 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005014 if( status != PSA_SUCCESS )
5015 return( status );
5016 }
5017
Jerry Yudc7bd172022-02-17 13:44:15 +08005018 if( mbedtls_svc_key_id_is_null( key ) )
5019 {
5020 status = psa_key_derivation_input_bytes(
5021 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005022 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005023 }
5024 else
5025 {
5026 status = psa_key_derivation_input_key(
5027 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5028 }
5029 if( status != PSA_SUCCESS )
5030 return( status );
5031
5032 status = psa_key_derivation_input_bytes( derivation,
5033 PSA_KEY_DERIVATION_INPUT_LABEL,
5034 label, label_length );
5035 if( status != PSA_SUCCESS )
5036 return( status );
5037 }
5038 else
5039 {
5040 return( PSA_ERROR_NOT_SUPPORTED );
5041 }
5042
5043 status = psa_key_derivation_set_capacity( derivation, capacity );
5044 if( status != PSA_SUCCESS )
5045 return( status );
5046
5047 return( PSA_SUCCESS );
5048}
5049
5050static int tls_prf_generic( mbedtls_md_type_t md_type,
5051 const unsigned char *secret, size_t slen,
5052 const char *label,
5053 const unsigned char *random, size_t rlen,
5054 unsigned char *dstbuf, size_t dlen )
5055{
5056 psa_status_t status;
5057 psa_algorithm_t alg;
5058 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5059 psa_key_derivation_operation_t derivation =
5060 PSA_KEY_DERIVATION_OPERATION_INIT;
5061
5062 if( md_type == MBEDTLS_MD_SHA384 )
5063 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5064 else
5065 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5066
5067 /* Normally a "secret" should be long enough to be impossible to
5068 * find by brute force, and in particular should not be empty. But
5069 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5070 * and for this use case it makes sense to have a 0-length "secret".
5071 * Since the key API doesn't allow importing a key of length 0,
5072 * keep master_key=0, which setup_psa_key_derivation() understands
5073 * to mean a 0-length "secret" input. */
5074 if( slen != 0 )
5075 {
5076 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5077 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5078 psa_set_key_algorithm( &key_attributes, alg );
5079 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5080
5081 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5082 if( status != PSA_SUCCESS )
5083 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5084 }
5085
5086 status = setup_psa_key_derivation( &derivation,
5087 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005088 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005089 random, rlen,
5090 (unsigned char const *) label,
5091 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005092 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005093 dlen );
5094 if( status != PSA_SUCCESS )
5095 {
5096 psa_key_derivation_abort( &derivation );
5097 psa_destroy_key( master_key );
5098 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5099 }
5100
5101 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5102 if( status != PSA_SUCCESS )
5103 {
5104 psa_key_derivation_abort( &derivation );
5105 psa_destroy_key( master_key );
5106 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5107 }
5108
5109 status = psa_key_derivation_abort( &derivation );
5110 if( status != PSA_SUCCESS )
5111 {
5112 psa_destroy_key( master_key );
5113 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5114 }
5115
5116 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5117 status = psa_destroy_key( master_key );
5118 if( status != PSA_SUCCESS )
5119 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5120
5121 return( 0 );
5122}
5123
5124#else /* MBEDTLS_USE_PSA_CRYPTO */
5125
5126static int tls_prf_generic( mbedtls_md_type_t md_type,
5127 const unsigned char *secret, size_t slen,
5128 const char *label,
5129 const unsigned char *random, size_t rlen,
5130 unsigned char *dstbuf, size_t dlen )
5131{
5132 size_t nb;
5133 size_t i, j, k, md_len;
5134 unsigned char *tmp;
5135 size_t tmp_len = 0;
5136 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5137 const mbedtls_md_info_t *md_info;
5138 mbedtls_md_context_t md_ctx;
5139 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5140
5141 mbedtls_md_init( &md_ctx );
5142
5143 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5145
5146 md_len = mbedtls_md_get_size( md_info );
5147
5148 tmp_len = md_len + strlen( label ) + rlen;
5149 tmp = mbedtls_calloc( 1, tmp_len );
5150 if( tmp == NULL )
5151 {
5152 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5153 goto exit;
5154 }
5155
5156 nb = strlen( label );
5157 memcpy( tmp + md_len, label, nb );
5158 memcpy( tmp + md_len + nb, random, rlen );
5159 nb += rlen;
5160
5161 /*
5162 * Compute P_<hash>(secret, label + random)[0..dlen]
5163 */
5164 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5165 goto exit;
5166
5167 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5168 if( ret != 0 )
5169 goto exit;
5170 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5171 if( ret != 0 )
5172 goto exit;
5173 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5174 if( ret != 0 )
5175 goto exit;
5176
5177 for( i = 0; i < dlen; i += md_len )
5178 {
5179 ret = mbedtls_md_hmac_reset ( &md_ctx );
5180 if( ret != 0 )
5181 goto exit;
5182 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5183 if( ret != 0 )
5184 goto exit;
5185 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5186 if( ret != 0 )
5187 goto exit;
5188
5189 ret = mbedtls_md_hmac_reset ( &md_ctx );
5190 if( ret != 0 )
5191 goto exit;
5192 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5193 if( ret != 0 )
5194 goto exit;
5195 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5196 if( ret != 0 )
5197 goto exit;
5198
5199 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5200
5201 for( j = 0; j < k; j++ )
5202 dstbuf[i + j] = h_i[j];
5203 }
5204
5205exit:
5206 mbedtls_md_free( &md_ctx );
5207
5208 mbedtls_platform_zeroize( tmp, tmp_len );
5209 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5210
5211 mbedtls_free( tmp );
5212
5213 return( ret );
5214}
5215#endif /* MBEDTLS_USE_PSA_CRYPTO */
5216
5217#if defined(MBEDTLS_SHA256_C)
5218static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5219 const char *label,
5220 const unsigned char *random, size_t rlen,
5221 unsigned char *dstbuf, size_t dlen )
5222{
5223 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5224 label, random, rlen, dstbuf, dlen ) );
5225}
5226#endif /* MBEDTLS_SHA256_C */
5227
5228#if defined(MBEDTLS_SHA384_C)
5229static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5230 const char *label,
5231 const unsigned char *random, size_t rlen,
5232 unsigned char *dstbuf, size_t dlen )
5233{
5234 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5235 label, random, rlen, dstbuf, dlen ) );
5236}
5237#endif /* MBEDTLS_SHA384_C */
5238
Jerry Yuf009d862022-02-17 14:01:37 +08005239/*
5240 * Set appropriate PRF function and other SSL / TLS1.2 functions
5241 *
5242 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005243 * - hash associated with the ciphersuite (only used by TLS 1.2)
5244 *
5245 * Outputs:
5246 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5247 */
5248static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005249 mbedtls_md_type_t hash )
5250{
Jerry Yuf009d862022-02-17 14:01:37 +08005251#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005252 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005253 {
5254 handshake->tls_prf = tls_prf_sha384;
5255 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5256 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5257 }
5258 else
5259#endif
5260#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005261 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005262 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005263 handshake->tls_prf = tls_prf_sha256;
5264 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5265 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5266 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005267#else
Jerry Yuf009d862022-02-17 14:01:37 +08005268 {
Jerry Yuf009d862022-02-17 14:01:37 +08005269 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005270 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005271 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5272 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005273#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005274
5275 return( 0 );
5276}
Jerry Yud6ab2352022-02-17 14:03:43 +08005277
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005278/*
5279 * Compute master secret if needed
5280 *
5281 * Parameters:
5282 * [in/out] handshake
5283 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5284 * (PSA-PSK) ciphersuite_info, psk_opaque
5285 * [out] premaster (cleared)
5286 * [out] master
5287 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5288 * debug: conf->f_dbg, conf->p_dbg
5289 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005290 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005291 */
5292static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5293 unsigned char *master,
5294 const mbedtls_ssl_context *ssl )
5295{
5296 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5297
5298 /* cf. RFC 5246, Section 8.1:
5299 * "The master secret is always exactly 48 bytes in length." */
5300 size_t const master_secret_len = 48;
5301
5302#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5303 unsigned char session_hash[48];
5304#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5305
5306 /* The label for the KDF used for key expansion.
5307 * This is either "master secret" or "extended master secret"
5308 * depending on whether the Extended Master Secret extension
5309 * is used. */
5310 char const *lbl = "master secret";
5311
Przemek Stekielae4ed302022-04-05 17:15:55 +02005312 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005313 * - If the Extended Master Secret extension is not used,
5314 * this is ClientHello.Random + ServerHello.Random
5315 * (see Sect. 8.1 in RFC 5246).
5316 * - If the Extended Master Secret extension is used,
5317 * this is the transcript of the handshake so far.
5318 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005319 unsigned char const *seed = handshake->randbytes;
5320 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005321
5322#if !defined(MBEDTLS_DEBUG_C) && \
5323 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5324 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5325 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5326 ssl = NULL; /* make sure we don't use it except for those cases */
5327 (void) ssl;
5328#endif
5329
5330 if( handshake->resume != 0 )
5331 {
5332 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5333 return( 0 );
5334 }
5335
5336#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5337 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5338 {
5339 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005340 seed = session_hash;
5341 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005342
5343 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005344 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005345 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005346#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005347
Przemek Stekiel99114f32022-04-22 11:20:09 +02005348#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005349 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005350 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005351 {
5352 /* Perform PSK-to-MS expansion in a single step. */
5353 psa_status_t status;
5354 psa_algorithm_t alg;
5355 mbedtls_svc_key_id_t psk;
5356 psa_key_derivation_operation_t derivation =
5357 PSA_KEY_DERIVATION_OPERATION_INIT;
5358 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5359
5360 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5361
5362 psk = mbedtls_ssl_get_opaque_psk( ssl );
5363
5364 if( hash_alg == MBEDTLS_MD_SHA384 )
5365 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5366 else
5367 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5368
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005369 size_t other_secret_len = 0;
5370 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005371
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005372 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005373 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005374 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005375 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005376 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005377 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005378 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005379 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005380 other_secret_len = 48;
5381 other_secret = handshake->premaster + 2;
5382 break;
5383 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005384 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005385 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5386 other_secret = handshake->premaster + 2;
5387 break;
5388 default:
5389 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005390 }
5391
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005392 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005393 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005394 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005395 (unsigned char const *) lbl,
5396 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005397 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005398 master_secret_len );
5399 if( status != PSA_SUCCESS )
5400 {
5401 psa_key_derivation_abort( &derivation );
5402 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5403 }
5404
5405 status = psa_key_derivation_output_bytes( &derivation,
5406 master,
5407 master_secret_len );
5408 if( status != PSA_SUCCESS )
5409 {
5410 psa_key_derivation_abort( &derivation );
5411 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5412 }
5413
5414 status = psa_key_derivation_abort( &derivation );
5415 if( status != PSA_SUCCESS )
5416 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5417 }
5418 else
5419#endif
5420 {
5421 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005422 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005423 master,
5424 master_secret_len );
5425 if( ret != 0 )
5426 {
5427 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5428 return( ret );
5429 }
5430
5431 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5432 handshake->premaster,
5433 handshake->pmslen );
5434
5435 mbedtls_platform_zeroize( handshake->premaster,
5436 sizeof(handshake->premaster) );
5437 }
5438
5439 return( 0 );
5440}
5441
Jerry Yud62f87e2022-02-17 14:09:02 +08005442int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5443{
5444 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5445 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5446 ssl->handshake->ciphersuite_info;
5447
5448 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5449
5450 /* Set PRF, calc_verify and calc_finished function pointers */
5451 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005452 ciphersuite_info->mac );
5453 if( ret != 0 )
5454 {
5455 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5456 return( ret );
5457 }
5458
5459 /* Compute master secret if needed */
5460 ret = ssl_compute_master( ssl->handshake,
5461 ssl->session_negotiate->master,
5462 ssl );
5463 if( ret != 0 )
5464 {
5465 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5466 return( ret );
5467 }
5468
5469 /* Swap the client and server random values:
5470 * - MS derivation wanted client+server (RFC 5246 8.1)
5471 * - key derivation wants server+client (RFC 5246 6.3) */
5472 {
5473 unsigned char tmp[64];
5474 memcpy( tmp, ssl->handshake->randbytes, 64 );
5475 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5476 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5477 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5478 }
5479
5480 /* Populate transform structure */
5481 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5482 ssl->session_negotiate->ciphersuite,
5483 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005484#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005485 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005486#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005487 ssl->handshake->tls_prf,
5488 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005489 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005490 ssl->conf->endpoint,
5491 ssl );
5492 if( ret != 0 )
5493 {
5494 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5495 return( ret );
5496 }
5497
5498 /* We no longer need Server/ClientHello.random values */
5499 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5500 sizeof( ssl->handshake->randbytes ) );
5501
5502 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5503
5504 return( 0 );
5505}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005506
Ronald Cron4dcbca92022-03-07 10:21:40 +01005507int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5508{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005509 switch( md )
5510 {
5511#if defined(MBEDTLS_SHA384_C)
5512 case MBEDTLS_SSL_HASH_SHA384:
5513 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5514 break;
5515#endif
5516#if defined(MBEDTLS_SHA256_C)
5517 case MBEDTLS_SSL_HASH_SHA256:
5518 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5519 break;
5520#endif
5521 default:
5522 return( -1 );
5523 }
5524
Ronald Cronc2f13a02022-03-07 10:25:24 +01005525 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005526}
5527
Jerry Yu8392e0d2022-02-17 14:10:24 +08005528#if defined(MBEDTLS_SHA256_C)
5529void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5530 unsigned char *hash,
5531 size_t *hlen )
5532{
5533#if defined(MBEDTLS_USE_PSA_CRYPTO)
5534 size_t hash_size;
5535 psa_status_t status;
5536 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5537
5538 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5539 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5540 if( status != PSA_SUCCESS )
5541 {
5542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5543 return;
5544 }
5545
5546 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5547 if( status != PSA_SUCCESS )
5548 {
5549 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5550 return;
5551 }
5552
5553 *hlen = 32;
5554 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5556#else
5557 mbedtls_sha256_context sha256;
5558
5559 mbedtls_sha256_init( &sha256 );
5560
5561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5562
5563 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5564 mbedtls_sha256_finish( &sha256, hash );
5565
5566 *hlen = 32;
5567
5568 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5569 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5570
5571 mbedtls_sha256_free( &sha256 );
5572#endif /* MBEDTLS_USE_PSA_CRYPTO */
5573 return;
5574}
5575#endif /* MBEDTLS_SHA256_C */
5576
Jerry Yuc1cb3842022-02-17 14:13:48 +08005577#if defined(MBEDTLS_SHA384_C)
5578void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5579 unsigned char *hash,
5580 size_t *hlen )
5581{
5582#if defined(MBEDTLS_USE_PSA_CRYPTO)
5583 size_t hash_size;
5584 psa_status_t status;
5585 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5586
5587 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5588 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5589 if( status != PSA_SUCCESS )
5590 {
5591 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5592 return;
5593 }
5594
5595 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5596 if( status != PSA_SUCCESS )
5597 {
5598 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5599 return;
5600 }
5601
5602 *hlen = 48;
5603 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5604 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5605#else
5606 mbedtls_sha512_context sha512;
5607
5608 mbedtls_sha512_init( &sha512 );
5609
5610 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5611
5612 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5613 mbedtls_sha512_finish( &sha512, hash );
5614
5615 *hlen = 48;
5616
5617 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5618 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5619
5620 mbedtls_sha512_free( &sha512 );
5621#endif /* MBEDTLS_USE_PSA_CRYPTO */
5622 return;
5623}
5624#endif /* MBEDTLS_SHA384_C */
5625
Neil Armstrong80f6f322022-05-03 17:56:38 +02005626#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5627 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005628int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5629{
5630 unsigned char *p = ssl->handshake->premaster;
5631 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5632 const unsigned char *psk = NULL;
5633 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005634 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005635
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005636 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005637 {
5638 /*
5639 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005640 * checked before calling this function.
5641 *
5642 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005643 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005644 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005645 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5646 {
5647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5648 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5649 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005650 }
5651
5652 /*
5653 * PMS = struct {
5654 * opaque other_secret<0..2^16-1>;
5655 * opaque psk<0..2^16-1>;
5656 * };
5657 * with "other_secret" depending on the particular key exchange
5658 */
5659#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5660 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5661 {
5662 if( end - p < 2 )
5663 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5664
5665 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5666 p += 2;
5667
5668 if( end < p || (size_t)( end - p ) < psk_len )
5669 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5670
5671 memset( p, 0, psk_len );
5672 p += psk_len;
5673 }
5674 else
5675#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5676#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5677 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5678 {
5679 /*
5680 * other_secret already set by the ClientKeyExchange message,
5681 * and is 48 bytes long
5682 */
5683 if( end - p < 2 )
5684 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5685
5686 *p++ = 0;
5687 *p++ = 48;
5688 p += 48;
5689 }
5690 else
5691#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5692#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5693 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5694 {
5695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5696 size_t len;
5697
5698 /* Write length only when we know the actual value */
5699 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5700 p + 2, end - ( p + 2 ), &len,
5701 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5702 {
5703 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5704 return( ret );
5705 }
5706 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5707 p += 2 + len;
5708
5709 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5710 }
5711 else
5712#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005713#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005714 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5715 {
5716 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5717 size_t zlen;
5718
5719 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5720 p + 2, end - ( p + 2 ),
5721 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5722 {
5723 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5724 return( ret );
5725 }
5726
5727 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5728 p += 2 + zlen;
5729
5730 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5731 MBEDTLS_DEBUG_ECDH_Z );
5732 }
5733 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005734#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005735 {
5736 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5737 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5738 }
5739
5740 /* opaque psk<0..2^16-1>; */
5741 if( end - p < 2 )
5742 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5743
5744 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5745 p += 2;
5746
5747 if( end < p || (size_t)( end - p ) < psk_len )
5748 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5749
5750 memcpy( p, psk, psk_len );
5751 p += psk_len;
5752
5753 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5754
5755 return( 0 );
5756}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005757#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005758
5759#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5760static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5761
5762#if defined(MBEDTLS_SSL_PROTO_DTLS)
5763int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5764{
5765 /* If renegotiation is not enforced, retransmit until we would reach max
5766 * timeout if we were using the usual handshake doubling scheme */
5767 if( ssl->conf->renego_max_records < 0 )
5768 {
5769 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5770 unsigned char doublings = 1;
5771
5772 while( ratio != 0 )
5773 {
5774 ++doublings;
5775 ratio >>= 1;
5776 }
5777
5778 if( ++ssl->renego_records_seen > doublings )
5779 {
5780 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5781 return( 0 );
5782 }
5783 }
5784
5785 return( ssl_write_hello_request( ssl ) );
5786}
5787#endif
5788#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005789
Jerry Yud9526692022-02-17 14:23:47 +08005790/*
5791 * Handshake functions
5792 */
5793#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5794/* No certificate support -> dummy functions */
5795int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5796{
5797 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5798 ssl->handshake->ciphersuite_info;
5799
5800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5801
5802 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5803 {
5804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5805 ssl->state++;
5806 return( 0 );
5807 }
5808
5809 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5810 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5811}
5812
5813int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5814{
5815 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5816 ssl->handshake->ciphersuite_info;
5817
5818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5819
5820 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5821 {
5822 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5823 ssl->state++;
5824 return( 0 );
5825 }
5826
5827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5828 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5829}
5830
5831#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5832/* Some certificate support -> implement write and parse */
5833
5834int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5835{
5836 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5837 size_t i, n;
5838 const mbedtls_x509_crt *crt;
5839 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5840 ssl->handshake->ciphersuite_info;
5841
5842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5843
5844 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5845 {
5846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5847 ssl->state++;
5848 return( 0 );
5849 }
5850
5851#if defined(MBEDTLS_SSL_CLI_C)
5852 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5853 {
5854 if( ssl->handshake->client_auth == 0 )
5855 {
5856 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5857 ssl->state++;
5858 return( 0 );
5859 }
5860 }
5861#endif /* MBEDTLS_SSL_CLI_C */
5862#if defined(MBEDTLS_SSL_SRV_C)
5863 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5864 {
5865 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5866 {
5867 /* Should never happen because we shouldn't have picked the
5868 * ciphersuite if we don't have a certificate. */
5869 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5870 }
5871 }
5872#endif
5873
5874 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5875
5876 /*
5877 * 0 . 0 handshake type
5878 * 1 . 3 handshake length
5879 * 4 . 6 length of all certs
5880 * 7 . 9 length of cert. 1
5881 * 10 . n-1 peer certificate
5882 * n . n+2 length of cert. 2
5883 * n+3 . ... upper level cert, etc.
5884 */
5885 i = 7;
5886 crt = mbedtls_ssl_own_cert( ssl );
5887
5888 while( crt != NULL )
5889 {
5890 n = crt->raw.len;
5891 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5892 {
5893 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5894 " > %" MBEDTLS_PRINTF_SIZET,
5895 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5896 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5897 }
5898
5899 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5900 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5901 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5902
5903 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5904 i += n; crt = crt->next;
5905 }
5906
5907 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5908 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5909 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5910
5911 ssl->out_msglen = i;
5912 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5913 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5914
5915 ssl->state++;
5916
5917 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5918 {
5919 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5920 return( ret );
5921 }
5922
5923 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5924
5925 return( ret );
5926}
5927
5928#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5929
5930#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5931static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5932 unsigned char *crt_buf,
5933 size_t crt_buf_len )
5934{
5935 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5936
5937 if( peer_crt == NULL )
5938 return( -1 );
5939
5940 if( peer_crt->raw.len != crt_buf_len )
5941 return( -1 );
5942
5943 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5944}
5945#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5946static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5947 unsigned char *crt_buf,
5948 size_t crt_buf_len )
5949{
5950 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5951 unsigned char const * const peer_cert_digest =
5952 ssl->session->peer_cert_digest;
5953 mbedtls_md_type_t const peer_cert_digest_type =
5954 ssl->session->peer_cert_digest_type;
5955 mbedtls_md_info_t const * const digest_info =
5956 mbedtls_md_info_from_type( peer_cert_digest_type );
5957 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5958 size_t digest_len;
5959
5960 if( peer_cert_digest == NULL || digest_info == NULL )
5961 return( -1 );
5962
5963 digest_len = mbedtls_md_get_size( digest_info );
5964 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5965 return( -1 );
5966
5967 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5968 if( ret != 0 )
5969 return( -1 );
5970
5971 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5972}
5973#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5974#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5975
5976/*
5977 * Once the certificate message is read, parse it into a cert chain and
5978 * perform basic checks, but leave actual verification to the caller
5979 */
5980static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5981 mbedtls_x509_crt *chain )
5982{
5983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5984#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5985 int crt_cnt=0;
5986#endif
5987 size_t i, n;
5988 uint8_t alert;
5989
5990 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5991 {
5992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5993 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5994 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5995 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5996 }
5997
5998 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5999 {
6000 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6001 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6002 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6003 }
6004
6005 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6006 {
6007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6008 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6009 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6010 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6011 }
6012
6013 i = mbedtls_ssl_hs_hdr_len( ssl );
6014
6015 /*
6016 * Same message structure as in mbedtls_ssl_write_certificate()
6017 */
6018 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6019
6020 if( ssl->in_msg[i] != 0 ||
6021 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6022 {
6023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6024 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6025 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6026 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6027 }
6028
6029 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6030 i += 3;
6031
6032 /* Iterate through and parse the CRTs in the provided chain. */
6033 while( i < ssl->in_hslen )
6034 {
6035 /* Check that there's room for the next CRT's length fields. */
6036 if ( i + 3 > ssl->in_hslen ) {
6037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6038 mbedtls_ssl_send_alert_message( ssl,
6039 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6040 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6041 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6042 }
6043 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6044 * anything beyond 2**16 ~ 64K. */
6045 if( ssl->in_msg[i] != 0 )
6046 {
6047 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6048 mbedtls_ssl_send_alert_message( ssl,
6049 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6050 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6051 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6052 }
6053
6054 /* Read length of the next CRT in the chain. */
6055 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6056 | (unsigned int) ssl->in_msg[i + 2];
6057 i += 3;
6058
6059 if( n < 128 || i + n > ssl->in_hslen )
6060 {
6061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6062 mbedtls_ssl_send_alert_message( ssl,
6063 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6064 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6065 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6066 }
6067
6068 /* Check if we're handling the first CRT in the chain. */
6069#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6070 if( crt_cnt++ == 0 &&
6071 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6072 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6073 {
6074 /* During client-side renegotiation, check that the server's
6075 * end-CRTs hasn't changed compared to the initial handshake,
6076 * mitigating the triple handshake attack. On success, reuse
6077 * the original end-CRT instead of parsing it again. */
6078 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6079 if( ssl_check_peer_crt_unchanged( ssl,
6080 &ssl->in_msg[i],
6081 n ) != 0 )
6082 {
6083 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6084 mbedtls_ssl_send_alert_message( ssl,
6085 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6086 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6087 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6088 }
6089
6090 /* Now we can safely free the original chain. */
6091 ssl_clear_peer_cert( ssl->session );
6092 }
6093#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6094
6095 /* Parse the next certificate in the chain. */
6096#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6097 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6098#else
6099 /* If we don't need to store the CRT chain permanently, parse
6100 * it in-place from the input buffer instead of making a copy. */
6101 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6102#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6103 switch( ret )
6104 {
6105 case 0: /*ok*/
6106 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6107 /* Ignore certificate with an unknown algorithm: maybe a
6108 prior certificate was already trusted. */
6109 break;
6110
6111 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6112 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6113 goto crt_parse_der_failed;
6114
6115 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6116 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6117 goto crt_parse_der_failed;
6118
6119 default:
6120 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6121 crt_parse_der_failed:
6122 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6123 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6124 return( ret );
6125 }
6126
6127 i += n;
6128 }
6129
6130 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6131 return( 0 );
6132}
6133
6134#if defined(MBEDTLS_SSL_SRV_C)
6135static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6136{
6137 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6138 return( -1 );
6139
6140 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6141 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6142 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6143 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6144 {
Ronald Cron19385882022-06-15 16:26:13 +02006145 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006146 return( 0 );
6147 }
6148 return( -1 );
6149}
6150#endif /* MBEDTLS_SSL_SRV_C */
6151
6152/* Check if a certificate message is expected.
6153 * Return either
6154 * - SSL_CERTIFICATE_EXPECTED, or
6155 * - SSL_CERTIFICATE_SKIP
6156 * indicating whether a Certificate message is expected or not.
6157 */
6158#define SSL_CERTIFICATE_EXPECTED 0
6159#define SSL_CERTIFICATE_SKIP 1
6160static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6161 int authmode )
6162{
6163 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6164 ssl->handshake->ciphersuite_info;
6165
6166 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6167 return( SSL_CERTIFICATE_SKIP );
6168
6169#if defined(MBEDTLS_SSL_SRV_C)
6170 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6171 {
6172 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6173 return( SSL_CERTIFICATE_SKIP );
6174
6175 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6176 {
6177 ssl->session_negotiate->verify_result =
6178 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6179 return( SSL_CERTIFICATE_SKIP );
6180 }
6181 }
6182#else
6183 ((void) authmode);
6184#endif /* MBEDTLS_SSL_SRV_C */
6185
6186 return( SSL_CERTIFICATE_EXPECTED );
6187}
6188
6189static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6190 int authmode,
6191 mbedtls_x509_crt *chain,
6192 void *rs_ctx )
6193{
6194 int ret = 0;
6195 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6196 ssl->handshake->ciphersuite_info;
6197 int have_ca_chain = 0;
6198
6199 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6200 void *p_vrfy;
6201
6202 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6203 return( 0 );
6204
6205 if( ssl->f_vrfy != NULL )
6206 {
6207 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6208 f_vrfy = ssl->f_vrfy;
6209 p_vrfy = ssl->p_vrfy;
6210 }
6211 else
6212 {
6213 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6214 f_vrfy = ssl->conf->f_vrfy;
6215 p_vrfy = ssl->conf->p_vrfy;
6216 }
6217
6218 /*
6219 * Main check: verify certificate
6220 */
6221#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6222 if( ssl->conf->f_ca_cb != NULL )
6223 {
6224 ((void) rs_ctx);
6225 have_ca_chain = 1;
6226
6227 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6228 ret = mbedtls_x509_crt_verify_with_ca_cb(
6229 chain,
6230 ssl->conf->f_ca_cb,
6231 ssl->conf->p_ca_cb,
6232 ssl->conf->cert_profile,
6233 ssl->hostname,
6234 &ssl->session_negotiate->verify_result,
6235 f_vrfy, p_vrfy );
6236 }
6237 else
6238#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6239 {
6240 mbedtls_x509_crt *ca_chain;
6241 mbedtls_x509_crl *ca_crl;
6242
6243#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6244 if( ssl->handshake->sni_ca_chain != NULL )
6245 {
6246 ca_chain = ssl->handshake->sni_ca_chain;
6247 ca_crl = ssl->handshake->sni_ca_crl;
6248 }
6249 else
6250#endif
6251 {
6252 ca_chain = ssl->conf->ca_chain;
6253 ca_crl = ssl->conf->ca_crl;
6254 }
6255
6256 if( ca_chain != NULL )
6257 have_ca_chain = 1;
6258
6259 ret = mbedtls_x509_crt_verify_restartable(
6260 chain,
6261 ca_chain, ca_crl,
6262 ssl->conf->cert_profile,
6263 ssl->hostname,
6264 &ssl->session_negotiate->verify_result,
6265 f_vrfy, p_vrfy, rs_ctx );
6266 }
6267
6268 if( ret != 0 )
6269 {
6270 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6271 }
6272
6273#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6274 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6275 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6276#endif
6277
6278 /*
6279 * Secondary checks: always done, but change 'ret' only if it was 0
6280 */
6281
6282#if defined(MBEDTLS_ECP_C)
6283 {
6284 const mbedtls_pk_context *pk = &chain->pk;
6285
6286 /* If certificate uses an EC key, make sure the curve is OK */
6287 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6288 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6289 {
6290 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6291
6292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6293 if( ret == 0 )
6294 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6295 }
6296 }
6297#endif /* MBEDTLS_ECP_C */
6298
6299 if( mbedtls_ssl_check_cert_usage( chain,
6300 ciphersuite_info,
6301 ! ssl->conf->endpoint,
6302 &ssl->session_negotiate->verify_result ) != 0 )
6303 {
6304 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6305 if( ret == 0 )
6306 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6307 }
6308
6309 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6310 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6311 * with details encoded in the verification flags. All other kinds
6312 * of error codes, including those from the user provided f_vrfy
6313 * functions, are treated as fatal and lead to a failure of
6314 * ssl_parse_certificate even if verification was optional. */
6315 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6316 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6317 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6318 {
6319 ret = 0;
6320 }
6321
6322 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6323 {
6324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6325 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6326 }
6327
6328 if( ret != 0 )
6329 {
6330 uint8_t alert;
6331
6332 /* The certificate may have been rejected for several reasons.
6333 Pick one and send the corresponding alert. Which alert to send
6334 may be a subject of debate in some cases. */
6335 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6336 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6337 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6338 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6339 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6340 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6341 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6342 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6343 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6344 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6345 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6346 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6347 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6348 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6349 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6350 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6351 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6352 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6353 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6354 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6355 else
6356 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6357 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6358 alert );
6359 }
6360
6361#if defined(MBEDTLS_DEBUG_C)
6362 if( ssl->session_negotiate->verify_result != 0 )
6363 {
6364 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6365 (unsigned int) ssl->session_negotiate->verify_result ) );
6366 }
6367 else
6368 {
6369 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6370 }
6371#endif /* MBEDTLS_DEBUG_C */
6372
6373 return( ret );
6374}
6375
6376#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6377static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6378 unsigned char *start, size_t len )
6379{
6380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6381 /* Remember digest of the peer's end-CRT. */
6382 ssl->session_negotiate->peer_cert_digest =
6383 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6384 if( ssl->session_negotiate->peer_cert_digest == NULL )
6385 {
6386 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6387 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6388 mbedtls_ssl_send_alert_message( ssl,
6389 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6390 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6391
6392 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6393 }
6394
6395 ret = mbedtls_md( mbedtls_md_info_from_type(
6396 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6397 start, len,
6398 ssl->session_negotiate->peer_cert_digest );
6399
6400 ssl->session_negotiate->peer_cert_digest_type =
6401 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6402 ssl->session_negotiate->peer_cert_digest_len =
6403 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6404
6405 return( ret );
6406}
6407
6408static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6409 unsigned char *start, size_t len )
6410{
6411 unsigned char *end = start + len;
6412 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6413
6414 /* Make a copy of the peer's raw public key. */
6415 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6416 ret = mbedtls_pk_parse_subpubkey( &start, end,
6417 &ssl->handshake->peer_pubkey );
6418 if( ret != 0 )
6419 {
6420 /* We should have parsed the public key before. */
6421 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6422 }
6423
6424 return( 0 );
6425}
6426#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6427
6428int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6429{
6430 int ret = 0;
6431 int crt_expected;
6432#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6433 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6434 ? ssl->handshake->sni_authmode
6435 : ssl->conf->authmode;
6436#else
6437 const int authmode = ssl->conf->authmode;
6438#endif
6439 void *rs_ctx = NULL;
6440 mbedtls_x509_crt *chain = NULL;
6441
6442 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6443
6444 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6445 if( crt_expected == SSL_CERTIFICATE_SKIP )
6446 {
6447 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6448 goto exit;
6449 }
6450
6451#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6452 if( ssl->handshake->ecrs_enabled &&
6453 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6454 {
6455 chain = ssl->handshake->ecrs_peer_cert;
6456 ssl->handshake->ecrs_peer_cert = NULL;
6457 goto crt_verify;
6458 }
6459#endif
6460
6461 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6462 {
6463 /* mbedtls_ssl_read_record may have sent an alert already. We
6464 let it decide whether to alert. */
6465 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6466 goto exit;
6467 }
6468
6469#if defined(MBEDTLS_SSL_SRV_C)
6470 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6471 {
6472 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6473
6474 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6475 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6476
6477 goto exit;
6478 }
6479#endif /* MBEDTLS_SSL_SRV_C */
6480
6481 /* Clear existing peer CRT structure in case we tried to
6482 * reuse a session but it failed, and allocate a new one. */
6483 ssl_clear_peer_cert( ssl->session_negotiate );
6484
6485 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6486 if( chain == NULL )
6487 {
6488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6489 sizeof( mbedtls_x509_crt ) ) );
6490 mbedtls_ssl_send_alert_message( ssl,
6491 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6492 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6493
6494 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6495 goto exit;
6496 }
6497 mbedtls_x509_crt_init( chain );
6498
6499 ret = ssl_parse_certificate_chain( ssl, chain );
6500 if( ret != 0 )
6501 goto exit;
6502
6503#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6504 if( ssl->handshake->ecrs_enabled)
6505 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6506
6507crt_verify:
6508 if( ssl->handshake->ecrs_enabled)
6509 rs_ctx = &ssl->handshake->ecrs_ctx;
6510#endif
6511
6512 ret = ssl_parse_certificate_verify( ssl, authmode,
6513 chain, rs_ctx );
6514 if( ret != 0 )
6515 goto exit;
6516
6517#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6518 {
6519 unsigned char *crt_start, *pk_start;
6520 size_t crt_len, pk_len;
6521
6522 /* We parse the CRT chain without copying, so
6523 * these pointers point into the input buffer,
6524 * and are hence still valid after freeing the
6525 * CRT chain. */
6526
6527 crt_start = chain->raw.p;
6528 crt_len = chain->raw.len;
6529
6530 pk_start = chain->pk_raw.p;
6531 pk_len = chain->pk_raw.len;
6532
6533 /* Free the CRT structures before computing
6534 * digest and copying the peer's public key. */
6535 mbedtls_x509_crt_free( chain );
6536 mbedtls_free( chain );
6537 chain = NULL;
6538
6539 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6540 if( ret != 0 )
6541 goto exit;
6542
6543 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6544 if( ret != 0 )
6545 goto exit;
6546 }
6547#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6548 /* Pass ownership to session structure. */
6549 ssl->session_negotiate->peer_cert = chain;
6550 chain = NULL;
6551#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6552
6553 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6554
6555exit:
6556
6557 if( ret == 0 )
6558 ssl->state++;
6559
6560#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6561 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6562 {
6563 ssl->handshake->ecrs_peer_cert = chain;
6564 chain = NULL;
6565 }
6566#endif
6567
6568 if( chain != NULL )
6569 {
6570 mbedtls_x509_crt_free( chain );
6571 mbedtls_free( chain );
6572 }
6573
6574 return( ret );
6575}
6576#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6577
Jerry Yu615bd6f2022-02-17 14:25:15 +08006578#if defined(MBEDTLS_SHA256_C)
6579static void ssl_calc_finished_tls_sha256(
6580 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6581{
6582 int len = 12;
6583 const char *sender;
6584 unsigned char padbuf[32];
6585#if defined(MBEDTLS_USE_PSA_CRYPTO)
6586 size_t hash_size;
6587 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6588 psa_status_t status;
6589#else
6590 mbedtls_sha256_context sha256;
6591#endif
6592
6593 mbedtls_ssl_session *session = ssl->session_negotiate;
6594 if( !session )
6595 session = ssl->session;
6596
6597 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6598 ? "client finished"
6599 : "server finished";
6600
6601#if defined(MBEDTLS_USE_PSA_CRYPTO)
6602 sha256_psa = psa_hash_operation_init();
6603
6604 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6605
6606 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6607 if( status != PSA_SUCCESS )
6608 {
6609 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6610 return;
6611 }
6612
6613 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6614 if( status != PSA_SUCCESS )
6615 {
6616 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6617 return;
6618 }
6619 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6620#else
6621
6622 mbedtls_sha256_init( &sha256 );
6623
6624 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6625
6626 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6627
6628 /*
6629 * TLSv1.2:
6630 * hash = PRF( master, finished_label,
6631 * Hash( handshake ) )[0.11]
6632 */
6633
6634#if !defined(MBEDTLS_SHA256_ALT)
6635 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6636 sha256.state, sizeof( sha256.state ) );
6637#endif
6638
6639 mbedtls_sha256_finish( &sha256, padbuf );
6640 mbedtls_sha256_free( &sha256 );
6641#endif /* MBEDTLS_USE_PSA_CRYPTO */
6642
6643 ssl->handshake->tls_prf( session->master, 48, sender,
6644 padbuf, 32, buf, len );
6645
6646 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6647
6648 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6649
6650 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6651}
6652#endif /* MBEDTLS_SHA256_C */
6653
Jerry Yub7ba49e2022-02-17 14:25:53 +08006654
6655#if defined(MBEDTLS_SHA384_C)
6656
6657static void ssl_calc_finished_tls_sha384(
6658 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6659{
6660 int len = 12;
6661 const char *sender;
6662 unsigned char padbuf[48];
6663#if defined(MBEDTLS_USE_PSA_CRYPTO)
6664 size_t hash_size;
6665 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6666 psa_status_t status;
6667#else
6668 mbedtls_sha512_context sha512;
6669#endif
6670
6671 mbedtls_ssl_session *session = ssl->session_negotiate;
6672 if( !session )
6673 session = ssl->session;
6674
6675 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6676 ? "client finished"
6677 : "server finished";
6678
6679#if defined(MBEDTLS_USE_PSA_CRYPTO)
6680 sha384_psa = psa_hash_operation_init();
6681
6682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6683
6684 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6685 if( status != PSA_SUCCESS )
6686 {
6687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6688 return;
6689 }
6690
6691 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6692 if( status != PSA_SUCCESS )
6693 {
6694 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6695 return;
6696 }
6697 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6698#else
6699 mbedtls_sha512_init( &sha512 );
6700
6701 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6702
6703 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6704
6705 /*
6706 * TLSv1.2:
6707 * hash = PRF( master, finished_label,
6708 * Hash( handshake ) )[0.11]
6709 */
6710
6711#if !defined(MBEDTLS_SHA512_ALT)
6712 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6713 sha512.state, sizeof( sha512.state ) );
6714#endif
6715 mbedtls_sha512_finish( &sha512, padbuf );
6716
6717 mbedtls_sha512_free( &sha512 );
6718#endif
6719
6720 ssl->handshake->tls_prf( session->master, 48, sender,
6721 padbuf, 48, buf, len );
6722
6723 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6724
6725 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6726
6727 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6728}
6729#endif /* MBEDTLS_SHA384_C */
6730
Jerry Yuaef00152022-02-17 14:27:31 +08006731void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6732{
6733 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6734
6735 /*
6736 * Free our handshake params
6737 */
6738 mbedtls_ssl_handshake_free( ssl );
6739 mbedtls_free( ssl->handshake );
6740 ssl->handshake = NULL;
6741
6742 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006743 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006744 */
6745 if( ssl->transform )
6746 {
6747 mbedtls_ssl_transform_free( ssl->transform );
6748 mbedtls_free( ssl->transform );
6749 }
6750 ssl->transform = ssl->transform_negotiate;
6751 ssl->transform_negotiate = NULL;
6752
6753 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6754}
6755
Jerry Yu2a9fff52022-02-17 14:28:51 +08006756void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6757{
6758 int resume = ssl->handshake->resume;
6759
6760 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6761
6762#if defined(MBEDTLS_SSL_RENEGOTIATION)
6763 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6764 {
6765 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6766 ssl->renego_records_seen = 0;
6767 }
6768#endif
6769
6770 /*
6771 * Free the previous session and switch in the current one
6772 */
6773 if( ssl->session )
6774 {
6775#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6776 /* RFC 7366 3.1: keep the EtM state */
6777 ssl->session_negotiate->encrypt_then_mac =
6778 ssl->session->encrypt_then_mac;
6779#endif
6780
6781 mbedtls_ssl_session_free( ssl->session );
6782 mbedtls_free( ssl->session );
6783 }
6784 ssl->session = ssl->session_negotiate;
6785 ssl->session_negotiate = NULL;
6786
6787 /*
6788 * Add cache entry
6789 */
6790 if( ssl->conf->f_set_cache != NULL &&
6791 ssl->session->id_len != 0 &&
6792 resume == 0 )
6793 {
6794 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6795 ssl->session->id,
6796 ssl->session->id_len,
6797 ssl->session ) != 0 )
6798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6799 }
6800
6801#if defined(MBEDTLS_SSL_PROTO_DTLS)
6802 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6803 ssl->handshake->flight != NULL )
6804 {
6805 /* Cancel handshake timer */
6806 mbedtls_ssl_set_timer( ssl, 0 );
6807
6808 /* Keep last flight around in case we need to resend it:
6809 * we need the handshake and transform structures for that */
6810 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6811 }
6812 else
6813#endif
6814 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6815
6816 ssl->state++;
6817
6818 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6819}
6820
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006821int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6822{
6823 int ret, hash_len;
6824
6825 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6826
6827 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6828
6829 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6830
6831 /*
6832 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6833 * may define some other value. Currently (early 2016), no defined
6834 * ciphersuite does this (and this is unlikely to change as activity has
6835 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6836 */
6837 hash_len = 12;
6838
6839#if defined(MBEDTLS_SSL_RENEGOTIATION)
6840 ssl->verify_data_len = hash_len;
6841 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6842#endif
6843
6844 ssl->out_msglen = 4 + hash_len;
6845 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6846 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6847
6848 /*
6849 * In case of session resuming, invert the client and server
6850 * ChangeCipherSpec messages order.
6851 */
6852 if( ssl->handshake->resume != 0 )
6853 {
6854#if defined(MBEDTLS_SSL_CLI_C)
6855 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6856 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6857#endif
6858#if defined(MBEDTLS_SSL_SRV_C)
6859 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6860 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6861#endif
6862 }
6863 else
6864 ssl->state++;
6865
6866 /*
6867 * Switch to our negotiated transform and session parameters for outbound
6868 * data.
6869 */
6870 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6871
6872#if defined(MBEDTLS_SSL_PROTO_DTLS)
6873 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6874 {
6875 unsigned char i;
6876
6877 /* Remember current epoch settings for resending */
6878 ssl->handshake->alt_transform_out = ssl->transform_out;
6879 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6880 sizeof( ssl->handshake->alt_out_ctr ) );
6881
6882 /* Set sequence_number to zero */
6883 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6884
6885
6886 /* Increment epoch */
6887 for( i = 2; i > 0; i-- )
6888 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6889 break;
6890
6891 /* The loop goes to its end iff the counter is wrapping */
6892 if( i == 0 )
6893 {
6894 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6895 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6896 }
6897 }
6898 else
6899#endif /* MBEDTLS_SSL_PROTO_DTLS */
6900 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6901
6902 ssl->transform_out = ssl->transform_negotiate;
6903 ssl->session_out = ssl->session_negotiate;
6904
6905#if defined(MBEDTLS_SSL_PROTO_DTLS)
6906 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6907 mbedtls_ssl_send_flight_completed( ssl );
6908#endif
6909
6910 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6911 {
6912 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6913 return( ret );
6914 }
6915
6916#if defined(MBEDTLS_SSL_PROTO_DTLS)
6917 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6918 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6919 {
6920 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6921 return( ret );
6922 }
6923#endif
6924
6925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6926
6927 return( 0 );
6928}
6929
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006930#define SSL_MAX_HASH_LEN 12
6931
6932int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6933{
6934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6935 unsigned int hash_len = 12;
6936 unsigned char buf[SSL_MAX_HASH_LEN];
6937
6938 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6939
6940 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6941
6942 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6943 {
6944 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6945 goto exit;
6946 }
6947
6948 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6949 {
6950 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6951 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6952 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6953 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6954 goto exit;
6955 }
6956
6957 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6958 {
6959 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6960 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6961 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6962 goto exit;
6963 }
6964
6965 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6966 {
6967 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6968 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6969 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6970 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6971 goto exit;
6972 }
6973
6974 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6975 buf, hash_len ) != 0 )
6976 {
6977 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6978 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6979 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6980 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6981 goto exit;
6982 }
6983
6984#if defined(MBEDTLS_SSL_RENEGOTIATION)
6985 ssl->verify_data_len = hash_len;
6986 memcpy( ssl->peer_verify_data, buf, hash_len );
6987#endif
6988
6989 if( ssl->handshake->resume != 0 )
6990 {
6991#if defined(MBEDTLS_SSL_CLI_C)
6992 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6993 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6994#endif
6995#if defined(MBEDTLS_SSL_SRV_C)
6996 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6997 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6998#endif
6999 }
7000 else
7001 ssl->state++;
7002
7003#if defined(MBEDTLS_SSL_PROTO_DTLS)
7004 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7005 mbedtls_ssl_recv_flight_completed( ssl );
7006#endif
7007
7008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7009
7010exit:
7011 mbedtls_platform_zeroize( buf, hash_len );
7012 return( ret );
7013}
7014
Jerry Yu392112c2022-02-17 14:34:10 +08007015#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7016/*
7017 * Helper to get TLS 1.2 PRF from ciphersuite
7018 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7019 */
7020static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7021{
7022#if defined(MBEDTLS_SHA384_C)
7023 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7024 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7025
7026 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7027 return( tls_prf_sha384 );
7028#else
7029 (void) ciphersuite_id;
7030#endif
7031 return( tls_prf_sha256 );
7032}
7033#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007034
7035static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7036{
7037 ((void) tls_prf);
7038#if defined(MBEDTLS_SHA384_C)
7039 if( tls_prf == tls_prf_sha384 )
7040 {
7041 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7042 }
7043 else
7044#endif
7045#if defined(MBEDTLS_SHA256_C)
7046 if( tls_prf == tls_prf_sha256 )
7047 {
7048 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7049 }
7050 else
7051#endif
7052 return( MBEDTLS_SSL_TLS_PRF_NONE );
7053}
7054
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007055/*
7056 * Populate a transform structure with session keys and all the other
7057 * necessary information.
7058 *
7059 * Parameters:
7060 * - [in/out]: transform: structure to populate
7061 * [in] must be just initialised with mbedtls_ssl_transform_init()
7062 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7063 * - [in] ciphersuite
7064 * - [in] master
7065 * - [in] encrypt_then_mac
7066 * - [in] compression
7067 * - [in] tls_prf: pointer to PRF to use for key derivation
7068 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007069 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007070 * - [in] endpoint: client or server
7071 * - [in] ssl: used for:
7072 * - ssl->conf->{f,p}_export_keys
7073 * [in] optionally used for:
7074 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7075 */
7076static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7077 int ciphersuite,
7078 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007079#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007080 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007081#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007082 ssl_tls_prf_t tls_prf,
7083 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007084 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007085 unsigned endpoint,
7086 const mbedtls_ssl_context *ssl )
7087{
7088 int ret = 0;
7089 unsigned char keyblk[256];
7090 unsigned char *key1;
7091 unsigned char *key2;
7092 unsigned char *mac_enc;
7093 unsigned char *mac_dec;
7094 size_t mac_key_len = 0;
7095 size_t iv_copy_len;
7096 size_t keylen;
7097 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007098 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007099#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007100 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007101 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007102#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007103
7104#if defined(MBEDTLS_USE_PSA_CRYPTO)
7105 psa_key_type_t key_type;
7106 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7107 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007108 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007109 size_t key_bits;
7110 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7111#endif
7112
7113#if !defined(MBEDTLS_DEBUG_C) && \
7114 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7115 if( ssl->f_export_keys == NULL )
7116 {
7117 ssl = NULL; /* make sure we don't use it except for these cases */
7118 (void) ssl;
7119 }
7120#endif
7121
7122 /*
7123 * Some data just needs copying into the structure
7124 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007125#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007126 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007127#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007128 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007129
7130#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7131 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7132#endif
7133
7134#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007135 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007136 {
7137 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7138 * generation separate. This should never happen. */
7139 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7140 }
7141#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7142
7143 /*
7144 * Get various info structures
7145 */
7146 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7147 if( ciphersuite_info == NULL )
7148 {
7149 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7150 ciphersuite ) );
7151 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7152 }
7153
Neil Armstrongab555e02022-04-04 11:07:59 +02007154 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007155#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007156 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007157#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007158 ciphersuite_info );
7159
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007160 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7161 transform->taglen =
7162 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7163
7164#if defined(MBEDTLS_USE_PSA_CRYPTO)
7165 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7166 transform->taglen,
7167 &alg,
7168 &key_type,
7169 &key_bits ) ) != PSA_SUCCESS )
7170 {
7171 ret = psa_ssl_status_to_mbedtls( status );
7172 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7173 goto end;
7174 }
7175#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007176 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7177 if( cipher_info == NULL )
7178 {
7179 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7180 ciphersuite_info->cipher ) );
7181 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7182 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007183#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007184
Neil Armstronge4512952022-03-08 09:08:22 +01007185#if defined(MBEDTLS_USE_PSA_CRYPTO)
7186 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7187 if( mac_alg == 0 )
7188 {
7189 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7190 (unsigned) ciphersuite_info->mac ) );
7191 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7192 }
7193#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007194 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7195 if( md_info == NULL )
7196 {
7197 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7198 (unsigned) ciphersuite_info->mac ) );
7199 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7200 }
Neil Armstronge4512952022-03-08 09:08:22 +01007201#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007202
7203#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7204 /* Copy own and peer's CID if the use of the CID
7205 * extension has been negotiated. */
7206 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7207 {
7208 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7209
7210 transform->in_cid_len = ssl->own_cid_len;
7211 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7212 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7213 transform->in_cid_len );
7214
7215 transform->out_cid_len = ssl->handshake->peer_cid_len;
7216 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7217 ssl->handshake->peer_cid_len );
7218 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7219 transform->out_cid_len );
7220 }
7221#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7222
7223 /*
7224 * Compute key block using the PRF
7225 */
7226 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7227 if( ret != 0 )
7228 {
7229 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7230 return( ret );
7231 }
7232
7233 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7234 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7235 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7236 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7237 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7238
7239 /*
7240 * Determine the appropriate key, IV and MAC length.
7241 */
7242
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007243#if defined(MBEDTLS_USE_PSA_CRYPTO)
7244 keylen = PSA_BITS_TO_BYTES(key_bits);
7245#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007246 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007247#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007248
7249#if defined(MBEDTLS_GCM_C) || \
7250 defined(MBEDTLS_CCM_C) || \
7251 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007252 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007253 {
7254 size_t explicit_ivlen;
7255
7256 transform->maclen = 0;
7257 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007258
7259 /* All modes haves 96-bit IVs, but the length of the static parts vary
7260 * with mode and version:
7261 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7262 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7263 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7264 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7265 * sequence number).
7266 */
7267 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007268#if defined(MBEDTLS_USE_PSA_CRYPTO)
7269 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7270#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007271 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007272#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007273 transform->fixed_ivlen = 12;
7274 else
7275 transform->fixed_ivlen = 4;
7276
7277 /* Minimum length of encrypted record */
7278 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7279 transform->minlen = explicit_ivlen + transform->taglen;
7280 }
7281 else
7282#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7283#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007284 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7285 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7286 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007287 {
Neil Armstronge4512952022-03-08 09:08:22 +01007288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007289 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007290#else
7291 size_t block_size = cipher_info->block_size;
7292#endif /* MBEDTLS_USE_PSA_CRYPTO */
7293
7294#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007295 /* Get MAC length */
7296 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7297#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007298 /* Initialize HMAC contexts */
7299 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7300 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7301 {
7302 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7303 goto end;
7304 }
7305
7306 /* Get MAC length */
7307 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007308#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007309 transform->maclen = mac_key_len;
7310
7311 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007313 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007314#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007315 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007316#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007317
7318 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007319 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007320 transform->minlen = transform->maclen;
7321 else
7322 {
7323 /*
7324 * GenericBlockCipher:
7325 * 1. if EtM is in use: one block plus MAC
7326 * otherwise: * first multiple of blocklen greater than maclen
7327 * 2. IV
7328 */
7329#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007330 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007331 {
7332 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007333 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007334 }
7335 else
7336#endif
7337 {
7338 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007339 + block_size
7340 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007341 }
7342
Glenn Strauss07c64162022-03-14 12:34:51 -04007343 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007344 {
7345 transform->minlen += transform->ivlen;
7346 }
7347 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007348 {
7349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7350 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7351 goto end;
7352 }
7353 }
7354 }
7355 else
7356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7357 {
7358 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7359 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7360 }
7361
7362 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7363 (unsigned) keylen,
7364 (unsigned) transform->minlen,
7365 (unsigned) transform->ivlen,
7366 (unsigned) transform->maclen ) );
7367
7368 /*
7369 * Finally setup the cipher contexts, IVs and MAC secrets.
7370 */
7371#if defined(MBEDTLS_SSL_CLI_C)
7372 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7373 {
7374 key1 = keyblk + mac_key_len * 2;
7375 key2 = keyblk + mac_key_len * 2 + keylen;
7376
7377 mac_enc = keyblk;
7378 mac_dec = keyblk + mac_key_len;
7379
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007380 iv_copy_len = ( transform->fixed_ivlen ) ?
7381 transform->fixed_ivlen : transform->ivlen;
7382 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7383 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7384 iv_copy_len );
7385 }
7386 else
7387#endif /* MBEDTLS_SSL_CLI_C */
7388#if defined(MBEDTLS_SSL_SRV_C)
7389 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7390 {
7391 key1 = keyblk + mac_key_len * 2 + keylen;
7392 key2 = keyblk + mac_key_len * 2;
7393
7394 mac_enc = keyblk + mac_key_len;
7395 mac_dec = keyblk;
7396
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007397 iv_copy_len = ( transform->fixed_ivlen ) ?
7398 transform->fixed_ivlen : transform->ivlen;
7399 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7400 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7401 iv_copy_len );
7402 }
7403 else
7404#endif /* MBEDTLS_SSL_SRV_C */
7405 {
7406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7407 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7408 goto end;
7409 }
7410
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007411 if( ssl != NULL && ssl->f_export_keys != NULL )
7412 {
7413 ssl->f_export_keys( ssl->p_export_keys,
7414 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7415 master, 48,
7416 randbytes + 32,
7417 randbytes,
7418 tls_prf_get_type( tls_prf ) );
7419 }
7420
7421#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007422 transform->psa_alg = alg;
7423
7424 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7425 {
7426 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7427 psa_set_key_algorithm( &attributes, alg );
7428 psa_set_key_type( &attributes, key_type );
7429
7430 if( ( status = psa_import_key( &attributes,
7431 key1,
7432 PSA_BITS_TO_BYTES( key_bits ),
7433 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7434 {
7435 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7436 ret = psa_ssl_status_to_mbedtls( status );
7437 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7438 goto end;
7439 }
7440
7441 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7442
7443 if( ( status = psa_import_key( &attributes,
7444 key2,
7445 PSA_BITS_TO_BYTES( key_bits ),
7446 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7447 {
7448 ret = psa_ssl_status_to_mbedtls( status );
7449 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7450 goto end;
7451 }
7452 }
7453#else
7454 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7455 cipher_info ) ) != 0 )
7456 {
7457 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7458 goto end;
7459 }
7460
7461 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7462 cipher_info ) ) != 0 )
7463 {
7464 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7465 goto end;
7466 }
7467
7468 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7469 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7470 MBEDTLS_ENCRYPT ) ) != 0 )
7471 {
7472 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7473 goto end;
7474 }
7475
7476 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7477 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7478 MBEDTLS_DECRYPT ) ) != 0 )
7479 {
7480 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7481 goto end;
7482 }
7483
7484#if defined(MBEDTLS_CIPHER_MODE_CBC)
7485 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7486 {
7487 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7488 MBEDTLS_PADDING_NONE ) ) != 0 )
7489 {
7490 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7491 goto end;
7492 }
7493
7494 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7495 MBEDTLS_PADDING_NONE ) ) != 0 )
7496 {
7497 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7498 goto end;
7499 }
7500 }
7501#endif /* MBEDTLS_CIPHER_MODE_CBC */
7502#endif /* MBEDTLS_USE_PSA_CRYPTO */
7503
Neil Armstrong29c0c042022-03-17 17:47:28 +01007504#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7505 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7506 For AEAD-based ciphersuites, there is nothing to do here. */
7507 if( mac_key_len != 0 )
7508 {
7509#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007510 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007511
7512 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007513 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007514 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7515
7516 if( ( status = psa_import_key( &attributes,
7517 mac_enc, mac_key_len,
7518 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7519 {
7520 ret = psa_ssl_status_to_mbedtls( status );
7521 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7522 goto end;
7523 }
7524
Ronald Cronfb39f152022-03-25 14:36:28 +01007525 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7526 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7527 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007528 /* mbedtls_ct_hmac() requires the key to be exportable */
7529 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7530 PSA_KEY_USAGE_VERIFY_HASH );
7531 else
7532 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7533
7534 if( ( status = psa_import_key( &attributes,
7535 mac_dec, mac_key_len,
7536 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7537 {
7538 ret = psa_ssl_status_to_mbedtls( status );
7539 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7540 goto end;
7541 }
7542#else
7543 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7544 if( ret != 0 )
7545 goto end;
7546 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7547 if( ret != 0 )
7548 goto end;
7549#endif /* MBEDTLS_USE_PSA_CRYPTO */
7550 }
7551#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7552
7553 ((void) mac_dec);
7554 ((void) mac_enc);
7555
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007556end:
7557 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7558 return( ret );
7559}
7560
Jerry Yuee40f9d2022-02-17 14:55:16 +08007561#if defined(MBEDTLS_USE_PSA_CRYPTO)
7562int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7563 unsigned char *hash, size_t *hashlen,
7564 unsigned char *data, size_t data_len,
7565 mbedtls_md_type_t md_alg )
7566{
7567 psa_status_t status;
7568 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7569 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7570
7571 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7572
7573 if( ( status = psa_hash_setup( &hash_operation,
7574 hash_alg ) ) != PSA_SUCCESS )
7575 {
7576 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7577 goto exit;
7578 }
7579
7580 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7581 64 ) ) != PSA_SUCCESS )
7582 {
7583 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7584 goto exit;
7585 }
7586
7587 if( ( status = psa_hash_update( &hash_operation,
7588 data, data_len ) ) != PSA_SUCCESS )
7589 {
7590 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7591 goto exit;
7592 }
7593
7594 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7595 hashlen ) ) != PSA_SUCCESS )
7596 {
7597 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7598 goto exit;
7599 }
7600
7601exit:
7602 if( status != PSA_SUCCESS )
7603 {
7604 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7605 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7606 switch( status )
7607 {
7608 case PSA_ERROR_NOT_SUPPORTED:
7609 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7610 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7611 case PSA_ERROR_BUFFER_TOO_SMALL:
7612 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7613 case PSA_ERROR_INSUFFICIENT_MEMORY:
7614 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7615 default:
7616 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7617 }
7618 }
7619 return( 0 );
7620}
7621
7622#else
7623
7624int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7625 unsigned char *hash, size_t *hashlen,
7626 unsigned char *data, size_t data_len,
7627 mbedtls_md_type_t md_alg )
7628{
7629 int ret = 0;
7630 mbedtls_md_context_t ctx;
7631 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7632 *hashlen = mbedtls_md_get_size( md_info );
7633
7634 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7635
7636 mbedtls_md_init( &ctx );
7637
7638 /*
7639 * digitally-signed struct {
7640 * opaque client_random[32];
7641 * opaque server_random[32];
7642 * ServerDHParams params;
7643 * };
7644 */
7645 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7646 {
7647 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7648 goto exit;
7649 }
7650 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7651 {
7652 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7653 goto exit;
7654 }
7655 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7656 {
7657 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7658 goto exit;
7659 }
7660 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7661 {
7662 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7663 goto exit;
7664 }
7665 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7666 {
7667 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7668 goto exit;
7669 }
7670
7671exit:
7672 mbedtls_md_free( &ctx );
7673
7674 if( ret != 0 )
7675 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7676 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7677
7678 return( ret );
7679}
7680#endif /* MBEDTLS_USE_PSA_CRYPTO */
7681
Jerry Yud9d91da2022-02-17 14:57:06 +08007682#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7683
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007684/* Find the preferred hash for a given signature algorithm. */
7685unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7686 mbedtls_ssl_context *ssl,
7687 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007688{
Gabor Mezei078e8032022-04-27 21:17:56 +02007689 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007690 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007691
7692 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007693 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007694
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007695 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007696 {
Gabor Mezei3631cf62022-05-10 12:59:00 +02007697 if( sig_alg == MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7698 received_sig_algs[i] ) )
Gabor Mezei696956d2022-05-13 16:27:29 +02007699 return( MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7700 received_sig_algs[i] ) );
Jerry Yud9d91da2022-02-17 14:57:06 +08007701 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007702
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007703 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007704}
7705
7706#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7707
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007708/* Serialization of TLS 1.2 sessions:
7709 *
7710 * struct {
7711 * uint64 start_time;
7712 * uint8 ciphersuite[2]; // defined by the standard
7713 * uint8 compression; // 0 or 1
7714 * uint8 session_id_len; // at most 32
7715 * opaque session_id[32];
7716 * opaque master[48]; // fixed length in the standard
7717 * uint32 verify_result;
7718 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7719 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7720 * uint32 ticket_lifetime;
7721 * uint8 mfl_code; // up to 255 according to standard
7722 * uint8 encrypt_then_mac; // 0 or 1
7723 * } serialized_session_tls12;
7724 *
7725 */
7726static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7727 unsigned char *buf,
7728 size_t buf_len )
7729{
7730 unsigned char *p = buf;
7731 size_t used = 0;
7732
7733#if defined(MBEDTLS_HAVE_TIME)
7734 uint64_t start;
7735#endif
7736#if defined(MBEDTLS_X509_CRT_PARSE_C)
7737#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7738 size_t cert_len;
7739#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7740#endif /* MBEDTLS_X509_CRT_PARSE_C */
7741
7742 /*
7743 * Time
7744 */
7745#if defined(MBEDTLS_HAVE_TIME)
7746 used += 8;
7747
7748 if( used <= buf_len )
7749 {
7750 start = (uint64_t) session->start;
7751
7752 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7753 p += 8;
7754 }
7755#endif /* MBEDTLS_HAVE_TIME */
7756
7757 /*
7758 * Basic mandatory fields
7759 */
7760 used += 2 /* ciphersuite */
7761 + 1 /* compression */
7762 + 1 /* id_len */
7763 + sizeof( session->id )
7764 + sizeof( session->master )
7765 + 4; /* verify_result */
7766
7767 if( used <= buf_len )
7768 {
7769 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7770 p += 2;
7771
7772 *p++ = MBEDTLS_BYTE_0( session->compression );
7773
7774 *p++ = MBEDTLS_BYTE_0( session->id_len );
7775 memcpy( p, session->id, 32 );
7776 p += 32;
7777
7778 memcpy( p, session->master, 48 );
7779 p += 48;
7780
7781 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7782 p += 4;
7783 }
7784
7785 /*
7786 * Peer's end-entity certificate
7787 */
7788#if defined(MBEDTLS_X509_CRT_PARSE_C)
7789#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7790 if( session->peer_cert == NULL )
7791 cert_len = 0;
7792 else
7793 cert_len = session->peer_cert->raw.len;
7794
7795 used += 3 + cert_len;
7796
7797 if( used <= buf_len )
7798 {
7799 *p++ = MBEDTLS_BYTE_2( cert_len );
7800 *p++ = MBEDTLS_BYTE_1( cert_len );
7801 *p++ = MBEDTLS_BYTE_0( cert_len );
7802
7803 if( session->peer_cert != NULL )
7804 {
7805 memcpy( p, session->peer_cert->raw.p, cert_len );
7806 p += cert_len;
7807 }
7808 }
7809#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7810 if( session->peer_cert_digest != NULL )
7811 {
7812 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7813 if( used <= buf_len )
7814 {
7815 *p++ = (unsigned char) session->peer_cert_digest_type;
7816 *p++ = (unsigned char) session->peer_cert_digest_len;
7817 memcpy( p, session->peer_cert_digest,
7818 session->peer_cert_digest_len );
7819 p += session->peer_cert_digest_len;
7820 }
7821 }
7822 else
7823 {
7824 used += 2;
7825 if( used <= buf_len )
7826 {
7827 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7828 *p++ = 0;
7829 }
7830 }
7831#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7832#endif /* MBEDTLS_X509_CRT_PARSE_C */
7833
7834 /*
7835 * Session ticket if any, plus associated data
7836 */
7837#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7838 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7839
7840 if( used <= buf_len )
7841 {
7842 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7843 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7844 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7845
7846 if( session->ticket != NULL )
7847 {
7848 memcpy( p, session->ticket, session->ticket_len );
7849 p += session->ticket_len;
7850 }
7851
7852 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7853 p += 4;
7854 }
7855#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7856
7857 /*
7858 * Misc extension-related info
7859 */
7860#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7861 used += 1;
7862
7863 if( used <= buf_len )
7864 *p++ = session->mfl_code;
7865#endif
7866
7867#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7868 used += 1;
7869
7870 if( used <= buf_len )
7871 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7872#endif
7873
7874 return( used );
7875}
7876
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007877static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7878 const unsigned char *buf,
7879 size_t len )
7880{
7881#if defined(MBEDTLS_HAVE_TIME)
7882 uint64_t start;
7883#endif
7884#if defined(MBEDTLS_X509_CRT_PARSE_C)
7885#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7886 size_t cert_len;
7887#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7888#endif /* MBEDTLS_X509_CRT_PARSE_C */
7889
7890 const unsigned char *p = buf;
7891 const unsigned char * const end = buf + len;
7892
7893 /*
7894 * Time
7895 */
7896#if defined(MBEDTLS_HAVE_TIME)
7897 if( 8 > (size_t)( end - p ) )
7898 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7899
7900 start = ( (uint64_t) p[0] << 56 ) |
7901 ( (uint64_t) p[1] << 48 ) |
7902 ( (uint64_t) p[2] << 40 ) |
7903 ( (uint64_t) p[3] << 32 ) |
7904 ( (uint64_t) p[4] << 24 ) |
7905 ( (uint64_t) p[5] << 16 ) |
7906 ( (uint64_t) p[6] << 8 ) |
7907 ( (uint64_t) p[7] );
7908 p += 8;
7909
7910 session->start = (time_t) start;
7911#endif /* MBEDTLS_HAVE_TIME */
7912
7913 /*
7914 * Basic mandatory fields
7915 */
7916 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7917 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7918
7919 session->ciphersuite = ( p[0] << 8 ) | p[1];
7920 p += 2;
7921
7922 session->compression = *p++;
7923
7924 session->id_len = *p++;
7925 memcpy( session->id, p, 32 );
7926 p += 32;
7927
7928 memcpy( session->master, p, 48 );
7929 p += 48;
7930
7931 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7932 ( (uint32_t) p[1] << 16 ) |
7933 ( (uint32_t) p[2] << 8 ) |
7934 ( (uint32_t) p[3] );
7935 p += 4;
7936
7937 /* Immediately clear invalid pointer values that have been read, in case
7938 * we exit early before we replaced them with valid ones. */
7939#if defined(MBEDTLS_X509_CRT_PARSE_C)
7940#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7941 session->peer_cert = NULL;
7942#else
7943 session->peer_cert_digest = NULL;
7944#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7945#endif /* MBEDTLS_X509_CRT_PARSE_C */
7946#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7947 session->ticket = NULL;
7948#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7949
7950 /*
7951 * Peer certificate
7952 */
7953#if defined(MBEDTLS_X509_CRT_PARSE_C)
7954#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7955 /* Deserialize CRT from the end of the ticket. */
7956 if( 3 > (size_t)( end - p ) )
7957 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7958
7959 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7960 p += 3;
7961
7962 if( cert_len != 0 )
7963 {
7964 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7965
7966 if( cert_len > (size_t)( end - p ) )
7967 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7968
7969 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7970
7971 if( session->peer_cert == NULL )
7972 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7973
7974 mbedtls_x509_crt_init( session->peer_cert );
7975
7976 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7977 p, cert_len ) ) != 0 )
7978 {
7979 mbedtls_x509_crt_free( session->peer_cert );
7980 mbedtls_free( session->peer_cert );
7981 session->peer_cert = NULL;
7982 return( ret );
7983 }
7984
7985 p += cert_len;
7986 }
7987#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7988 /* Deserialize CRT digest from the end of the ticket. */
7989 if( 2 > (size_t)( end - p ) )
7990 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7991
7992 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7993 session->peer_cert_digest_len = (size_t) *p++;
7994
7995 if( session->peer_cert_digest_len != 0 )
7996 {
7997 const mbedtls_md_info_t *md_info =
7998 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7999 if( md_info == NULL )
8000 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8001 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8002 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8003
8004 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8005 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8006
8007 session->peer_cert_digest =
8008 mbedtls_calloc( 1, session->peer_cert_digest_len );
8009 if( session->peer_cert_digest == NULL )
8010 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8011
8012 memcpy( session->peer_cert_digest, p,
8013 session->peer_cert_digest_len );
8014 p += session->peer_cert_digest_len;
8015 }
8016#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8017#endif /* MBEDTLS_X509_CRT_PARSE_C */
8018
8019 /*
8020 * Session ticket and associated data
8021 */
8022#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8023 if( 3 > (size_t)( end - p ) )
8024 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8025
8026 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8027 p += 3;
8028
8029 if( session->ticket_len != 0 )
8030 {
8031 if( session->ticket_len > (size_t)( end - p ) )
8032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8033
8034 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8035 if( session->ticket == NULL )
8036 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8037
8038 memcpy( session->ticket, p, session->ticket_len );
8039 p += session->ticket_len;
8040 }
8041
8042 if( 4 > (size_t)( end - p ) )
8043 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8044
8045 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8046 ( (uint32_t) p[1] << 16 ) |
8047 ( (uint32_t) p[2] << 8 ) |
8048 ( (uint32_t) p[3] );
8049 p += 4;
8050#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8051
8052 /*
8053 * Misc extension-related info
8054 */
8055#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8056 if( 1 > (size_t)( end - p ) )
8057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8058
8059 session->mfl_code = *p++;
8060#endif
8061
8062#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8063 if( 1 > (size_t)( end - p ) )
8064 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8065
8066 session->encrypt_then_mac = *p++;
8067#endif
8068
8069 /* Done, should have consumed entire buffer */
8070 if( p != end )
8071 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8072
8073 return( 0 );
8074}
Jerry Yudc7bd172022-02-17 13:44:15 +08008075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8076
XiaokangQian75d40ef2022-04-20 11:05:24 +00008077int mbedtls_ssl_validate_ciphersuite(
8078 const mbedtls_ssl_context *ssl,
8079 const mbedtls_ssl_ciphersuite_t *suite_info,
8080 mbedtls_ssl_protocol_version min_tls_version,
8081 mbedtls_ssl_protocol_version max_tls_version )
8082{
8083 (void) ssl;
8084
8085 if( suite_info == NULL )
8086 return( -1 );
8087
8088 if( ( suite_info->min_tls_version > max_tls_version ) ||
8089 ( suite_info->max_tls_version < min_tls_version ) )
8090 {
8091 return( -1 );
8092 }
8093
XiaokangQian060d8672022-04-21 09:24:56 +00008094#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008095#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8096 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8097 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8098 {
8099 return( -1 );
8100 }
8101#endif
8102
8103 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8104#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8105 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8106 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8107 {
8108 return( -1 );
8109 }
8110#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8111#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8112
8113 return( 0 );
8114}
8115
XiaokangQianeaf36512022-04-24 09:07:44 +00008116#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8117/*
8118 * Function for writing a signature algorithm extension.
8119 *
8120 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8121 * value (TLS 1.3 RFC8446):
8122 * enum {
8123 * ....
8124 * ecdsa_secp256r1_sha256( 0x0403 ),
8125 * ecdsa_secp384r1_sha384( 0x0503 ),
8126 * ecdsa_secp521r1_sha512( 0x0603 ),
8127 * ....
8128 * } SignatureScheme;
8129 *
8130 * struct {
8131 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8132 * } SignatureSchemeList;
8133 *
8134 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8135 * value (TLS 1.2 RFC5246):
8136 * enum {
8137 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8138 * sha512(6), (255)
8139 * } HashAlgorithm;
8140 *
8141 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8142 * SignatureAlgorithm;
8143 *
8144 * struct {
8145 * HashAlgorithm hash;
8146 * SignatureAlgorithm signature;
8147 * } SignatureAndHashAlgorithm;
8148 *
8149 * SignatureAndHashAlgorithm
8150 * supported_signature_algorithms<2..2^16-2>;
8151 *
8152 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8153 * generalization of the TLS 1.2 signature algorithm extension.
8154 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8155 * `SignatureScheme` field of TLS 1.3
8156 *
8157 */
8158int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8159 const unsigned char *end, size_t *out_len )
8160{
8161 unsigned char *p = buf;
8162 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8163 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8164
8165 *out_len = 0;
8166
8167 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8168
8169 /* Check if we have space for header and length field:
8170 * - extension_type (2 bytes)
8171 * - extension_data_length (2 bytes)
8172 * - supported_signature_algorithms_length (2 bytes)
8173 */
8174 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8175 p += 6;
8176
8177 /*
8178 * Write supported_signature_algorithms
8179 */
8180 supported_sig_alg = p;
8181 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8182 if( sig_alg == NULL )
8183 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8184
8185 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8186 {
8187 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8188 continue;
Jerry Yu3f71ca02022-06-21 14:42:03 +08008189
XiaokangQianeaf36512022-04-24 09:07:44 +00008190 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8191 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8192 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08008193 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x] %s",
8194 *sig_alg,
8195 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008196 }
8197
8198 /* Length of supported_signature_algorithms */
8199 supported_sig_alg_len = p - supported_sig_alg;
8200 if( supported_sig_alg_len == 0 )
8201 {
8202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8203 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8204 }
8205
XiaokangQianeaf36512022-04-24 09:07:44 +00008206 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008207 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008208 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8209
XiaokangQianeaf36512022-04-24 09:07:44 +00008210 *out_len = p - buf;
8211
8212#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8213 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8214#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8215 return( 0 );
8216}
8217#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8218
XiaokangQian40a35232022-05-07 09:02:40 +00008219#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008220/*
8221 * mbedtls_ssl_parse_server_name_ext
8222 *
8223 * Structure of server_name extension:
8224 *
8225 * enum {
8226 * host_name(0), (255)
8227 * } NameType;
8228 * opaque HostName<1..2^16-1>;
8229 *
8230 * struct {
8231 * NameType name_type;
8232 * select (name_type) {
8233 * case host_name: HostName;
8234 * } name;
8235 * } ServerName;
8236 * struct {
8237 * ServerName server_name_list<1..2^16-1>
8238 * } ServerNameList;
8239 */
8240int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8241 const unsigned char *buf,
8242 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008243{
8244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8245 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008246 size_t server_name_list_len, hostname_len;
8247 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008248
XiaokangQianf2a94202022-05-20 06:44:24 +00008249 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008250
8251 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008252 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008253 p += 2;
8254
XiaokangQian9b2b7712022-05-17 02:57:00 +00008255 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8256 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008257 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008258 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008259 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008260 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008261 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8262 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008263
8264 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8265 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008266 /* sni_name is intended to be used only during the parsing of the
8267 * ClientHello message (it is reset to NULL before the end of
8268 * the message parsing). Thus it is ok to just point to the
8269 * reception buffer and not make a copy of it.
8270 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008271 ssl->handshake->sni_name = p + 3;
8272 ssl->handshake->sni_name_len = hostname_len;
8273 if( ssl->conf->f_sni == NULL )
8274 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008275 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008276 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008277 if( ret != 0 )
8278 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008279 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008280 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8281 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008282 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8283 }
8284 return( 0 );
8285 }
8286
8287 p += hostname_len + 3;
8288 }
8289
8290 return( 0 );
8291}
8292#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8293
XiaokangQianacb39922022-06-17 10:18:48 +00008294#if defined(MBEDTLS_SSL_ALPN)
8295int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8296 const unsigned char *buf,
8297 const unsigned char *end )
8298{
8299 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008300 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008301 const unsigned char *protocol_name_list;
8302 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008303 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008304
8305 /* If ALPN not configured, just ignore the extension */
8306 if( ssl->conf->alpn_list == NULL )
8307 return( 0 );
8308
8309 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008310 * RFC7301, section 3.1
8311 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008312 *
XiaokangQianc7403452022-06-23 03:24:12 +00008313 * struct {
8314 * ProtocolName protocol_name_list<2..2^16-1>
8315 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008316 */
8317
XiaokangQianc7403452022-06-23 03:24:12 +00008318 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008319 * protocol_name_list_len 2 bytes
8320 * protocol_name_len 1 bytes
8321 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008322 */
XiaokangQianacb39922022-06-17 10:18:48 +00008323 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8324
XiaokangQianc7403452022-06-23 03:24:12 +00008325 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008326 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008327 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008328 protocol_name_list = p;
8329 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008330
8331 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008332 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008333 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008334 protocol_name_len = *p++;
8335 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8336 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008337 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008338 {
8339 MBEDTLS_SSL_PEND_FATAL_ALERT(
8340 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8341 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008342 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008343 }
8344
8345 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008346 }
8347
8348 /* Use our order of preference */
8349 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8350 {
8351 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008352 p = protocol_name_list;
8353 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008354 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008355 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008356 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008357 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008358 {
8359 ssl->alpn_chosen = *alpn;
8360 return( 0 );
8361 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008362
8363 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008364 }
8365 }
8366
XiaokangQian95d5f542022-06-24 02:29:26 +00008367 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008368 MBEDTLS_SSL_PEND_FATAL_ALERT(
8369 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8370 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8371 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8372}
8373
8374int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8375 unsigned char *buf,
8376 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008377 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008378{
8379 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008380 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008381 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008382
8383 if( ssl->alpn_chosen == NULL )
8384 {
8385 return( 0 );
8386 }
8387
XiaokangQian95d5f542022-06-24 02:29:26 +00008388 protocol_name_len = strlen( ssl->alpn_chosen );
8389 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008390
8391 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8392 /*
8393 * 0 . 1 ext identifier
8394 * 2 . 3 ext length
8395 * 4 . 5 protocol list length
8396 * 6 . 6 protocol name length
8397 * 7 . 7+n protocol name
8398 */
8399 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8400
XiaokangQian95d5f542022-06-24 02:29:26 +00008401 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008402
XiaokangQian95d5f542022-06-24 02:29:26 +00008403 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8404 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008405 /* Note: the length of the chosen protocol has been checked to be less
8406 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8407 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008408 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008409
XiaokangQian95d5f542022-06-24 02:29:26 +00008410 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008411 return ( 0 );
8412}
8413#endif /* MBEDTLS_SSL_ALPN */
8414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008415#endif /* MBEDTLS_SSL_TLS_C */