blob: 2bec6b18b65c72c33e523c8ddadcbdfa953612e4 [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 */
Jerry Yu6272c4d2022-06-22 13:46:55 +0800981
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200982int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200983 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000984{
Janos Follath865b3eb2019-12-16 11:46:15 +0000985 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000986 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
987 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000988
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200989 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000990
Jerry Yu60835a82021-08-04 10:13:52 +0800991 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
992 return( ret );
993
Paul Bakker62f2dee2012-09-28 07:31:51 +0000994 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100995 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000996 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200997
998 /* Set to NULL in case of an error condition */
999 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001000
Darryl Greenb33cc762019-11-28 14:29:44 +00001001#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1002 ssl->in_buf_len = in_buf_len;
1003#endif
1004 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001005 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001006 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001008 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001009 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001010 }
1011
Darryl Greenb33cc762019-11-28 14:29:44 +00001012#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1013 ssl->out_buf_len = out_buf_len;
1014#endif
1015 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001016 if( ssl->out_buf == NULL )
1017 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001018 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001019 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001020 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001021 }
1022
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001023 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001024
Johan Pascalb62bb512015-12-03 21:56:45 +01001025#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001026 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001027#endif
1028
Paul Bakker48916f92012-09-16 19:57:18 +00001029 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001030 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001031
1032 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001033
1034error:
1035 mbedtls_free( ssl->in_buf );
1036 mbedtls_free( ssl->out_buf );
1037
1038 ssl->conf = NULL;
1039
Darryl Greenb33cc762019-11-28 14:29:44 +00001040#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1041 ssl->in_buf_len = 0;
1042 ssl->out_buf_len = 0;
1043#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001044 ssl->in_buf = NULL;
1045 ssl->out_buf = NULL;
1046
1047 ssl->in_hdr = NULL;
1048 ssl->in_ctr = NULL;
1049 ssl->in_len = NULL;
1050 ssl->in_iv = NULL;
1051 ssl->in_msg = NULL;
1052
1053 ssl->out_hdr = NULL;
1054 ssl->out_ctr = NULL;
1055 ssl->out_len = NULL;
1056 ssl->out_iv = NULL;
1057 ssl->out_msg = NULL;
1058
k-stachowiak9f7798e2018-07-31 16:52:32 +02001059 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001060}
1061
1062/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001063 * Reset an initialized and used SSL context for re-use while retaining
1064 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001065 *
1066 * If partial is non-zero, keep data in the input buffer and client ID.
1067 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001068 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001069void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1070 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001071{
Darryl Greenb33cc762019-11-28 14:29:44 +00001072#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1073 size_t in_buf_len = ssl->in_buf_len;
1074 size_t out_buf_len = ssl->out_buf_len;
1075#else
1076 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1077 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1078#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Hanno Beckerb0302c42021-08-03 09:39:42 +01001080#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1081 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001082#endif
1083
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001084 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001085 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001086
Hanno Beckerb0302c42021-08-03 09:39:42 +01001087 mbedtls_ssl_reset_in_out_pointers( ssl );
1088
1089 /* Reset incoming message parsing */
1090 ssl->in_offt = NULL;
1091 ssl->nb_zero = 0;
1092 ssl->in_msgtype = 0;
1093 ssl->in_msglen = 0;
1094 ssl->in_hslen = 0;
1095 ssl->keep_current_message = 0;
1096 ssl->transform_in = NULL;
1097
1098#if defined(MBEDTLS_SSL_PROTO_DTLS)
1099 ssl->next_record_offset = 0;
1100 ssl->in_epoch = 0;
1101#endif
1102
1103 /* Keep current datagram if partial == 1 */
1104 if( partial == 0 )
1105 {
1106 ssl->in_left = 0;
1107 memset( ssl->in_buf, 0, in_buf_len );
1108 }
1109
1110 /* Reset outgoing message writing */
1111 ssl->out_msgtype = 0;
1112 ssl->out_msglen = 0;
1113 ssl->out_left = 0;
1114 memset( ssl->out_buf, 0, out_buf_len );
1115 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1116 ssl->transform_out = NULL;
1117
1118#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1119 mbedtls_ssl_dtls_replay_reset( ssl );
1120#endif
1121
XiaokangQian2b01dc32022-01-21 02:53:13 +00001122#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001123 if( ssl->transform )
1124 {
1125 mbedtls_ssl_transform_free( ssl->transform );
1126 mbedtls_free( ssl->transform );
1127 ssl->transform = NULL;
1128 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1130
XiaokangQian2b01dc32022-01-21 02:53:13 +00001131#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1132 mbedtls_ssl_transform_free( ssl->transform_application );
1133 mbedtls_free( ssl->transform_application );
1134 ssl->transform_application = NULL;
1135
1136 if( ssl->handshake != NULL )
1137 {
1138 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1139 mbedtls_free( ssl->handshake->transform_earlydata );
1140 ssl->handshake->transform_earlydata = NULL;
1141
1142 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1143 mbedtls_free( ssl->handshake->transform_handshake );
1144 ssl->handshake->transform_handshake = NULL;
1145 }
1146
XiaokangQian2b01dc32022-01-21 02:53:13 +00001147#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001148}
1149
1150int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1151{
1152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1153
1154 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1155
XiaokangQian78b1fa72022-01-19 06:56:30 +00001156 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001157
1158 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159#if defined(MBEDTLS_SSL_RENEGOTIATION)
1160 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001161 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001162
1163 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1165 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001166#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001168
Hanno Beckerb0302c42021-08-03 09:39:42 +01001169 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001170 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001171 if( ssl->session )
1172 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 mbedtls_ssl_session_free( ssl->session );
1174 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001175 ssl->session = NULL;
1176 }
1177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001179 ssl->alpn_chosen = NULL;
1180#endif
1181
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001182#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001183#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001184 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001185#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001186 {
1187 mbedtls_free( ssl->cli_id );
1188 ssl->cli_id = NULL;
1189 ssl->cli_id_len = 0;
1190 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001191#endif
1192
Paul Bakker48916f92012-09-16 19:57:18 +00001193 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1194 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001195
1196 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001197}
1198
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001199/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001200 * Reset an initialized and used SSL context for re-use while retaining
1201 * all application-set variables, function pointers and data.
1202 */
1203int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1204{
Hanno Becker43aefe22020-02-05 10:44:56 +00001205 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001206}
1207
1208/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001209 * SSL set accessors
1210 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001211void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001212{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001213 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001214}
1215
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001216void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001217{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001218 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001219}
1220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001222void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001223{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001224 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001225}
1226#endif
1227
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001228void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001229{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001230 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001231}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001234
Hanno Becker1841b0a2018-08-24 11:13:57 +01001235void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1236 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001237{
1238 ssl->disable_datagram_packing = !allow_packing;
1239}
1240
1241void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1242 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001243{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001244 conf->hs_timeout_min = min;
1245 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001246}
1247#endif
1248
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001249void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001250{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001251 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001252}
1253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001255void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001256 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001257 void *p_vrfy )
1258{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001259 conf->f_vrfy = f_vrfy;
1260 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001261}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001263
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001264void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001265 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001266 void *p_rng )
1267{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001268 conf->f_rng = f_rng;
1269 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001270}
1271
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001272void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001273 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001274 void *p_dbg )
1275{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001276 conf->f_dbg = f_dbg;
1277 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001278}
1279
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001280void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001281 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001282 mbedtls_ssl_send_t *f_send,
1283 mbedtls_ssl_recv_t *f_recv,
1284 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001285{
1286 ssl->p_bio = p_bio;
1287 ssl->f_send = f_send;
1288 ssl->f_recv = f_recv;
1289 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001290}
1291
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001292#if defined(MBEDTLS_SSL_PROTO_DTLS)
1293void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1294{
1295 ssl->mtu = mtu;
1296}
1297#endif
1298
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001299void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001300{
1301 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001302}
1303
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001304void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1305 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001306 mbedtls_ssl_set_timer_t *f_set_timer,
1307 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001308{
1309 ssl->p_timer = p_timer;
1310 ssl->f_set_timer = f_set_timer;
1311 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001312
1313 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001314 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001315}
1316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001318void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001319 void *p_cache,
1320 mbedtls_ssl_cache_get_t *f_get_cache,
1321 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001322{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001323 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001324 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001325 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001326}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329#if defined(MBEDTLS_SSL_CLI_C)
1330int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001331{
Janos Follath865b3eb2019-12-16 11:46:15 +00001332 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001333
1334 if( ssl == NULL ||
1335 session == NULL ||
1336 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001337 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001340 }
1341
Hanno Beckere810bbc2021-05-14 16:01:05 +01001342 if( ssl->handshake->resume == 1 )
1343 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1344
Hanno Becker52055ae2019-02-06 14:30:46 +00001345 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1346 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001347 return( ret );
1348
Paul Bakker0a597072012-09-25 21:55:46 +00001349 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001350
1351 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001352}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001354
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001355void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1356 const int *ciphersuites )
1357{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001358 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001359}
1360
Ronald Cron6f135e12021-12-08 16:57:54 +01001361#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001362void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001363 const int kex_modes )
1364{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001365 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001366}
Ronald Cron6f135e12021-12-08 16:57:54 +01001367#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001369#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001370void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001371 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001372{
1373 conf->cert_profile = profile;
1374}
1375
Glenn Strauss36872db2022-01-22 05:06:31 -05001376static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1377{
1378 mbedtls_ssl_key_cert *cur = key_cert, *next;
1379
1380 while( cur != NULL )
1381 {
1382 next = cur->next;
1383 mbedtls_free( cur );
1384 cur = next;
1385 }
1386}
1387
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001388/* Append a new keycert entry to a (possibly empty) list */
1389static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1390 mbedtls_x509_crt *cert,
1391 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001392{
niisato8ee24222018-06-25 19:05:48 +09001393 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001394
Glenn Strauss36872db2022-01-22 05:06:31 -05001395 if( cert == NULL )
1396 {
1397 /* Free list if cert is null */
1398 ssl_key_cert_free( *head );
1399 *head = NULL;
1400 return( 0 );
1401 }
1402
niisato8ee24222018-06-25 19:05:48 +09001403 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1404 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001405 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001406
niisato8ee24222018-06-25 19:05:48 +09001407 new_cert->cert = cert;
1408 new_cert->key = key;
1409 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001410
Glenn Strauss36872db2022-01-22 05:06:31 -05001411 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001412 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001413 {
niisato8ee24222018-06-25 19:05:48 +09001414 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001415 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001416 else
1417 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001418 mbedtls_ssl_key_cert *cur = *head;
1419 while( cur->next != NULL )
1420 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001421 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001422 }
1423
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001424 return( 0 );
1425}
1426
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001427int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001428 mbedtls_x509_crt *own_cert,
1429 mbedtls_pk_context *pk_key )
1430{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001431 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001432}
1433
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001434void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001435 mbedtls_x509_crt *ca_chain,
1436 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001437{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001438 conf->ca_chain = ca_chain;
1439 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001440
1441#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1442 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1443 * cannot be used together. */
1444 conf->f_ca_cb = NULL;
1445 conf->p_ca_cb = NULL;
1446#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001447}
Hanno Becker5adaad92019-03-27 16:54:37 +00001448
1449#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1450void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001451 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001452 void *p_ca_cb )
1453{
1454 conf->f_ca_cb = f_ca_cb;
1455 conf->p_ca_cb = p_ca_cb;
1456
1457 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1458 * cannot be used together. */
1459 conf->ca_chain = NULL;
1460 conf->ca_crl = NULL;
1461}
1462#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001464
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001465#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001466const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1467 size_t *name_len )
1468{
1469 *name_len = ssl->handshake->sni_name_len;
1470 return( ssl->handshake->sni_name );
1471}
1472
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001473int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1474 mbedtls_x509_crt *own_cert,
1475 mbedtls_pk_context *pk_key )
1476{
1477 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1478 own_cert, pk_key ) );
1479}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001480
1481void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1482 mbedtls_x509_crt *ca_chain,
1483 mbedtls_x509_crl *ca_crl )
1484{
1485 ssl->handshake->sni_ca_chain = ca_chain;
1486 ssl->handshake->sni_ca_crl = ca_crl;
1487}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001488
1489void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1490 int authmode )
1491{
1492 ssl->handshake->sni_authmode = authmode;
1493}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001494#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1495
Hanno Becker8927c832019-04-03 12:52:50 +01001496#if defined(MBEDTLS_X509_CRT_PARSE_C)
1497void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1498 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1499 void *p_vrfy )
1500{
1501 ssl->f_vrfy = f_vrfy;
1502 ssl->p_vrfy = p_vrfy;
1503}
1504#endif
1505
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001506#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001507/*
1508 * Set EC J-PAKE password for current handshake
1509 */
1510int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1511 const unsigned char *pw,
1512 size_t pw_len )
1513{
1514 mbedtls_ecjpake_role role;
1515
Janos Follath8eb64132016-06-03 15:40:57 +01001516 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001517 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1518
1519 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1520 role = MBEDTLS_ECJPAKE_SERVER;
1521 else
1522 role = MBEDTLS_ECJPAKE_CLIENT;
1523
1524 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1525 role,
1526 MBEDTLS_MD_SHA256,
1527 MBEDTLS_ECP_DP_SECP256R1,
1528 pw, pw_len ) );
1529}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001530#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001531
Gilles Peskineeccd8882020-03-10 12:19:08 +01001532#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001533
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001534static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1535{
1536#if defined(MBEDTLS_USE_PSA_CRYPTO)
1537 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1538 return( 1 );
1539#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001540 if( conf->psk != NULL )
1541 return( 1 );
1542
1543 return( 0 );
1544}
1545
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001546static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1547{
1548 /* Remove reference to existing PSK, if any. */
1549#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001550 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001551 {
1552 /* The maintenance of the PSK key slot is the
1553 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001554 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001555 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001556#endif /* MBEDTLS_USE_PSA_CRYPTO */
1557 if( conf->psk != NULL )
1558 {
1559 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1560
1561 mbedtls_free( conf->psk );
1562 conf->psk = NULL;
1563 conf->psk_len = 0;
1564 }
1565
1566 /* Remove reference to PSK identity, if any. */
1567 if( conf->psk_identity != NULL )
1568 {
1569 mbedtls_free( conf->psk_identity );
1570 conf->psk_identity = NULL;
1571 conf->psk_identity_len = 0;
1572 }
1573}
1574
Hanno Becker7390c712018-11-15 13:33:04 +00001575/* This function assumes that PSK identity in the SSL config is unset.
1576 * It checks that the provided identity is well-formed and attempts
1577 * to make a copy of it in the SSL config.
1578 * On failure, the PSK identity in the config remains unset. */
1579static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1580 unsigned char const *psk_identity,
1581 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001582{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001583 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001584 if( psk_identity == NULL ||
1585 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001586 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001587 {
1588 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1589 }
1590
Hanno Becker7390c712018-11-15 13:33:04 +00001591 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1592 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001593 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001594
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001595 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001596 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001597
1598 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001599}
1600
Hanno Becker7390c712018-11-15 13:33:04 +00001601int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1602 const unsigned char *psk, size_t psk_len,
1603 const unsigned char *psk_identity, size_t psk_identity_len )
1604{
Janos Follath865b3eb2019-12-16 11:46:15 +00001605 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001606
1607 /* We currently only support one PSK, raw or opaque. */
1608 if( ssl_conf_psk_is_configured( conf ) )
1609 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001610
1611 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001612 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001613 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001614 if( psk_len == 0 )
1615 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1616 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1617 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1618
Hanno Becker7390c712018-11-15 13:33:04 +00001619 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1620 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1621 conf->psk_len = psk_len;
1622 memcpy( conf->psk, psk, conf->psk_len );
1623
1624 /* Check and set PSK Identity */
1625 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1626 if( ret != 0 )
1627 ssl_conf_remove_psk( conf );
1628
1629 return( ret );
1630}
1631
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001632static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1633{
1634#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001635 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001636 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001637 /* The maintenance of the external PSK key slot is the
1638 * user's responsibility. */
1639 if( ssl->handshake->psk_opaque_is_internal )
1640 {
1641 psa_destroy_key( ssl->handshake->psk_opaque );
1642 ssl->handshake->psk_opaque_is_internal = 0;
1643 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001644 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001645 }
Neil Armstronge952a302022-05-03 10:22:14 +02001646#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001647 if( ssl->handshake->psk != NULL )
1648 {
1649 mbedtls_platform_zeroize( ssl->handshake->psk,
1650 ssl->handshake->psk_len );
1651 mbedtls_free( ssl->handshake->psk );
1652 ssl->handshake->psk_len = 0;
1653 }
Neil Armstronge952a302022-05-03 10:22:14 +02001654#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001655}
1656
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001657int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1658 const unsigned char *psk, size_t psk_len )
1659{
Neil Armstrong501c9322022-05-03 09:35:09 +02001660#if defined(MBEDTLS_USE_PSA_CRYPTO)
1661 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1662 psa_status_t status;
1663 psa_algorithm_t alg;
1664 mbedtls_svc_key_id_t key;
1665#endif /* MBEDTLS_USE_PSA_CRYPTO */
1666
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001667 if( psk == NULL || ssl->handshake == NULL )
1668 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1669
1670 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1671 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1672
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001673 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001674
Neil Armstrong501c9322022-05-03 09:35:09 +02001675#if defined(MBEDTLS_USE_PSA_CRYPTO)
1676 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1677 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1678 else
1679 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1680
1681 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1682 psa_set_key_algorithm( &key_attributes, alg );
1683 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1684
1685 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1686 if( status != PSA_SUCCESS )
1687 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1688
1689 /* Allow calling psa_destroy_key() on psk remove */
1690 ssl->handshake->psk_opaque_is_internal = 1;
1691 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1692#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001693 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001694 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001695
1696 ssl->handshake->psk_len = psk_len;
1697 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1698
1699 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001700#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001701}
1702
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001703#if defined(MBEDTLS_USE_PSA_CRYPTO)
1704int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001705 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706 const unsigned char *psk_identity,
1707 size_t psk_identity_len )
1708{
Janos Follath865b3eb2019-12-16 11:46:15 +00001709 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001710
1711 /* We currently only support one PSK, raw or opaque. */
1712 if( ssl_conf_psk_is_configured( conf ) )
1713 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001714
Hanno Becker7390c712018-11-15 13:33:04 +00001715 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001716 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001717 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001718 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001719
1720 /* Check and set PSK Identity */
1721 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1722 psk_identity_len );
1723 if( ret != 0 )
1724 ssl_conf_remove_psk( conf );
1725
1726 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001727}
1728
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001729int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1730 mbedtls_svc_key_id_t psk )
1731{
1732 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1733 ( ssl->handshake == NULL ) )
1734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1735
1736 ssl_remove_psk( ssl );
1737 ssl->handshake->psk_opaque = psk;
1738 return( 0 );
1739}
1740#endif /* MBEDTLS_USE_PSA_CRYPTO */
1741
1742void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1743 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1744 size_t),
1745 void *p_psk )
1746{
1747 conf->f_psk = f_psk;
1748 conf->p_psk = p_psk;
1749}
1750#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1751
1752#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001753static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1754 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001755{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001756#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001757 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001758 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001759#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001760 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001761 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001762 return( MBEDTLS_SSL_MODE_STREAM );
1763}
1764
1765#else /* MBEDTLS_USE_PSA_CRYPTO */
1766
1767static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1768 mbedtls_cipher_mode_t mode )
1769{
1770#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1771 if( mode == MBEDTLS_MODE_CBC )
1772 return( MBEDTLS_SSL_MODE_CBC );
1773#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1774
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001775#if defined(MBEDTLS_GCM_C) || \
1776 defined(MBEDTLS_CCM_C) || \
1777 defined(MBEDTLS_CHACHAPOLY_C)
1778 if( mode == MBEDTLS_MODE_GCM ||
1779 mode == MBEDTLS_MODE_CCM ||
1780 mode == MBEDTLS_MODE_CHACHAPOLY )
1781 return( MBEDTLS_SSL_MODE_AEAD );
1782#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001783
1784 return( MBEDTLS_SSL_MODE_STREAM );
1785}
Gilles Peskine301711e2022-04-26 16:57:05 +02001786#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001787
Gilles Peskinee108d982022-04-26 16:50:40 +02001788static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1789 mbedtls_ssl_mode_t base_mode,
1790 int encrypt_then_mac )
1791{
1792#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1793 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1794 base_mode == MBEDTLS_SSL_MODE_CBC )
1795 {
1796 return( MBEDTLS_SSL_MODE_CBC_ETM );
1797 }
1798#else
1799 (void) encrypt_then_mac;
1800#endif
1801 return( base_mode );
1802}
1803
Neil Armstrongab555e02022-04-04 11:07:59 +02001804mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001805 const mbedtls_ssl_transform *transform )
1806{
Gilles Peskinee108d982022-04-26 16:50:40 +02001807 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001808#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001809 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001810#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001811 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1812#endif
1813 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001814
Gilles Peskinee108d982022-04-26 16:50:40 +02001815 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001816#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001817 encrypt_then_mac = transform->encrypt_then_mac;
1818#endif
1819 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001820}
1821
Neil Armstrongab555e02022-04-04 11:07:59 +02001822mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001823#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001824 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001825#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001826 const mbedtls_ssl_ciphersuite_t *suite )
1827{
Gilles Peskinee108d982022-04-26 16:50:40 +02001828 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1829
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001830#if defined(MBEDTLS_USE_PSA_CRYPTO)
1831 psa_status_t status;
1832 psa_algorithm_t alg;
1833 psa_key_type_t type;
1834 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001835 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1836 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001837 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001838#else
1839 const mbedtls_cipher_info_t *cipher =
1840 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001841 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001842 {
1843 base_mode =
1844 mbedtls_ssl_get_base_mode(
1845 mbedtls_cipher_info_get_mode( cipher ) );
1846 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001847#endif /* MBEDTLS_USE_PSA_CRYPTO */
1848
Gilles Peskinee108d982022-04-26 16:50:40 +02001849#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1850 int encrypt_then_mac = 0;
1851#endif
1852 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001853}
1854
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001855#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001856psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001857 size_t taglen,
1858 psa_algorithm_t *alg,
1859 psa_key_type_t *key_type,
1860 size_t *key_size )
1861{
1862 switch ( mbedtls_cipher_type )
1863 {
1864 case MBEDTLS_CIPHER_AES_128_CBC:
1865 *alg = PSA_ALG_CBC_NO_PADDING;
1866 *key_type = PSA_KEY_TYPE_AES;
1867 *key_size = 128;
1868 break;
1869 case MBEDTLS_CIPHER_AES_128_CCM:
1870 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1871 *key_type = PSA_KEY_TYPE_AES;
1872 *key_size = 128;
1873 break;
1874 case MBEDTLS_CIPHER_AES_128_GCM:
1875 *alg = PSA_ALG_GCM;
1876 *key_type = PSA_KEY_TYPE_AES;
1877 *key_size = 128;
1878 break;
1879 case MBEDTLS_CIPHER_AES_192_CCM:
1880 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1881 *key_type = PSA_KEY_TYPE_AES;
1882 *key_size = 192;
1883 break;
1884 case MBEDTLS_CIPHER_AES_192_GCM:
1885 *alg = PSA_ALG_GCM;
1886 *key_type = PSA_KEY_TYPE_AES;
1887 *key_size = 192;
1888 break;
1889 case MBEDTLS_CIPHER_AES_256_CBC:
1890 *alg = PSA_ALG_CBC_NO_PADDING;
1891 *key_type = PSA_KEY_TYPE_AES;
1892 *key_size = 256;
1893 break;
1894 case MBEDTLS_CIPHER_AES_256_CCM:
1895 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1896 *key_type = PSA_KEY_TYPE_AES;
1897 *key_size = 256;
1898 break;
1899 case MBEDTLS_CIPHER_AES_256_GCM:
1900 *alg = PSA_ALG_GCM;
1901 *key_type = PSA_KEY_TYPE_AES;
1902 *key_size = 256;
1903 break;
1904 case MBEDTLS_CIPHER_ARIA_128_CBC:
1905 *alg = PSA_ALG_CBC_NO_PADDING;
1906 *key_type = PSA_KEY_TYPE_ARIA;
1907 *key_size = 128;
1908 break;
1909 case MBEDTLS_CIPHER_ARIA_128_CCM:
1910 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1911 *key_type = PSA_KEY_TYPE_ARIA;
1912 *key_size = 128;
1913 break;
1914 case MBEDTLS_CIPHER_ARIA_128_GCM:
1915 *alg = PSA_ALG_GCM;
1916 *key_type = PSA_KEY_TYPE_ARIA;
1917 *key_size = 128;
1918 break;
1919 case MBEDTLS_CIPHER_ARIA_192_CCM:
1920 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1921 *key_type = PSA_KEY_TYPE_ARIA;
1922 *key_size = 192;
1923 break;
1924 case MBEDTLS_CIPHER_ARIA_192_GCM:
1925 *alg = PSA_ALG_GCM;
1926 *key_type = PSA_KEY_TYPE_ARIA;
1927 *key_size = 192;
1928 break;
1929 case MBEDTLS_CIPHER_ARIA_256_CBC:
1930 *alg = PSA_ALG_CBC_NO_PADDING;
1931 *key_type = PSA_KEY_TYPE_ARIA;
1932 *key_size = 256;
1933 break;
1934 case MBEDTLS_CIPHER_ARIA_256_CCM:
1935 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1936 *key_type = PSA_KEY_TYPE_ARIA;
1937 *key_size = 256;
1938 break;
1939 case MBEDTLS_CIPHER_ARIA_256_GCM:
1940 *alg = PSA_ALG_GCM;
1941 *key_type = PSA_KEY_TYPE_ARIA;
1942 *key_size = 256;
1943 break;
1944 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1945 *alg = PSA_ALG_CBC_NO_PADDING;
1946 *key_type = PSA_KEY_TYPE_CAMELLIA;
1947 *key_size = 128;
1948 break;
1949 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1950 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1951 *key_type = PSA_KEY_TYPE_CAMELLIA;
1952 *key_size = 128;
1953 break;
1954 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1955 *alg = PSA_ALG_GCM;
1956 *key_type = PSA_KEY_TYPE_CAMELLIA;
1957 *key_size = 128;
1958 break;
1959 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1960 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1961 *key_type = PSA_KEY_TYPE_CAMELLIA;
1962 *key_size = 192;
1963 break;
1964 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1965 *alg = PSA_ALG_GCM;
1966 *key_type = PSA_KEY_TYPE_CAMELLIA;
1967 *key_size = 192;
1968 break;
1969 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1970 *alg = PSA_ALG_CBC_NO_PADDING;
1971 *key_type = PSA_KEY_TYPE_CAMELLIA;
1972 *key_size = 256;
1973 break;
1974 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1975 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1976 *key_type = PSA_KEY_TYPE_CAMELLIA;
1977 *key_size = 256;
1978 break;
1979 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1980 *alg = PSA_ALG_GCM;
1981 *key_type = PSA_KEY_TYPE_CAMELLIA;
1982 *key_size = 256;
1983 break;
1984 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1985 *alg = PSA_ALG_CHACHA20_POLY1305;
1986 *key_type = PSA_KEY_TYPE_CHACHA20;
1987 *key_size = 256;
1988 break;
1989 case MBEDTLS_CIPHER_NULL:
1990 *alg = MBEDTLS_SSL_NULL_CIPHER;
1991 *key_type = 0;
1992 *key_size = 0;
1993 break;
1994 default:
1995 return PSA_ERROR_NOT_SUPPORTED;
1996 }
1997
1998 return PSA_SUCCESS;
1999}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002000#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002001
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002002#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002003int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2004 const unsigned char *dhm_P, size_t P_len,
2005 const unsigned char *dhm_G, size_t G_len )
2006{
Janos Follath865b3eb2019-12-16 11:46:15 +00002007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002008
Glenn Strausscee11292021-12-20 01:43:17 -05002009 mbedtls_mpi_free( &conf->dhm_P );
2010 mbedtls_mpi_free( &conf->dhm_G );
2011
Hanno Beckera90658f2017-10-04 15:29:08 +01002012 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2013 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2014 {
2015 mbedtls_mpi_free( &conf->dhm_P );
2016 mbedtls_mpi_free( &conf->dhm_G );
2017 return( ret );
2018 }
2019
2020 return( 0 );
2021}
Paul Bakker5121ce52009-01-03 21:22:43 +00002022
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002023int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002024{
Janos Follath865b3eb2019-12-16 11:46:15 +00002025 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002026
Glenn Strausscee11292021-12-20 01:43:17 -05002027 mbedtls_mpi_free( &conf->dhm_P );
2028 mbedtls_mpi_free( &conf->dhm_G );
2029
Gilles Peskinee5702482021-06-11 21:59:08 +02002030 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2031 &conf->dhm_P ) ) != 0 ||
2032 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2033 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002034 {
2035 mbedtls_mpi_free( &conf->dhm_P );
2036 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002037 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002038 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002039
2040 return( 0 );
2041}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002042#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002043
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002044#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2045/*
2046 * Set the minimum length for Diffie-Hellman parameters
2047 */
2048void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2049 unsigned int bitlen )
2050{
2051 conf->dhm_min_bitlen = bitlen;
2052}
2053#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2054
Gilles Peskineeccd8882020-03-10 12:19:08 +01002055#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002056#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002057/*
2058 * Set allowed/preferred hashes for handshake signatures
2059 */
2060void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2061 const int *hashes )
2062{
2063 conf->sig_hashes = hashes;
2064}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002065#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002066
Jerry Yuf017ee42022-01-12 15:49:48 +08002067/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002068void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2069 const uint16_t* sig_algs )
2070{
Jerry Yuf017ee42022-01-12 15:49:48 +08002071#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2072 conf->sig_hashes = NULL;
2073#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2074 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002075}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002076#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002077
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002078#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002079#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002080/*
2081 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002082 *
2083 * mbedtls_ssl_setup() takes the provided list
2084 * and translates it to a list of IANA TLS group identifiers,
2085 * stored in ssl->handshake->group_list.
2086 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002087 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002088void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002089 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002090{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002091 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002092 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002093}
Brett Warrene0edc842021-08-17 09:53:13 +01002094#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002095#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002096
Brett Warrene0edc842021-08-17 09:53:13 +01002097/*
2098 * Set the allowed groups
2099 */
2100void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2101 const uint16_t *group_list )
2102{
2103#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2104 conf->curve_list = NULL;
2105#endif
2106 conf->group_list = group_list;
2107}
2108
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002109#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002111{
Hanno Becker947194e2017-04-07 13:25:49 +01002112 /* Initialize to suppress unnecessary compiler warning */
2113 size_t hostname_len = 0;
2114
2115 /* Check if new hostname is valid before
2116 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002117 if( hostname != NULL )
2118 {
2119 hostname_len = strlen( hostname );
2120
2121 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2122 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2123 }
2124
2125 /* Now it's clear that we will overwrite the old hostname,
2126 * so we can free it safely */
2127
2128 if( ssl->hostname != NULL )
2129 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002130 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002131 mbedtls_free( ssl->hostname );
2132 }
2133
2134 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002135
Paul Bakker5121ce52009-01-03 21:22:43 +00002136 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002137 {
2138 ssl->hostname = NULL;
2139 }
2140 else
2141 {
2142 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002143 if( ssl->hostname == NULL )
2144 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002145
Hanno Becker947194e2017-04-07 13:25:49 +01002146 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002147
Hanno Becker947194e2017-04-07 13:25:49 +01002148 ssl->hostname[hostname_len] = '\0';
2149 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002150
2151 return( 0 );
2152}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002153#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002155#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002156void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002158 const unsigned char *, size_t),
2159 void *p_sni )
2160{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002161 conf->f_sni = f_sni;
2162 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002163}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002164#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002167int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002168{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002169 size_t cur_len, tot_len;
2170 const char **p;
2171
2172 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002173 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2174 * MUST NOT be truncated."
2175 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002176 */
2177 tot_len = 0;
2178 for( p = protos; *p != NULL; p++ )
2179 {
2180 cur_len = strlen( *p );
2181 tot_len += cur_len;
2182
Ronald Cron8216dd32020-04-23 16:41:44 +02002183 if( ( cur_len == 0 ) ||
2184 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2185 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002187 }
2188
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002189 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002190
2191 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002192}
2193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002195{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002196 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002197}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002199
Johan Pascalb62bb512015-12-03 21:56:45 +01002200#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002201void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2202 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002203{
2204 conf->dtls_srtp_mki_support = support_mki_value;
2205}
2206
Ron Eldoref72faf2018-07-12 11:54:20 +03002207int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2208 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002209 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002210{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002211 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002212 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002213 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002214 }
Ron Eldor591f1622018-01-22 12:30:04 +02002215
2216 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002217 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002218 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002219 }
Ron Eldor591f1622018-01-22 12:30:04 +02002220
2221 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2222 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002223 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002224}
2225
Ron Eldoref72faf2018-07-12 11:54:20 +03002226int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002227 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002228{
Johan Pascal253d0262020-09-22 13:04:45 +02002229 const mbedtls_ssl_srtp_profile *p;
2230 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002231
Johan Pascal253d0262020-09-22 13:04:45 +02002232 /* check the profiles list: all entry must be valid,
2233 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002234 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2235 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2236 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002237 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002238 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002239 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002240 list_size++;
2241 }
2242 else
2243 {
2244 /* unsupported value, stop parsing and set the size to an error value */
2245 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002246 }
2247 }
2248
Johan Pascal5ef72d22020-10-28 17:05:47 +01002249 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002250 {
Johan Pascal253d0262020-09-22 13:04:45 +02002251 conf->dtls_srtp_profile_list = NULL;
2252 conf->dtls_srtp_profile_list_len = 0;
2253 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2254 }
2255
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002256 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002257 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002258
2259 return( 0 );
2260}
2261
Johan Pascal5ef72d22020-10-28 17:05:47 +01002262void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2263 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002264{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002265 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2266 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002267 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002268 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002269 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002270 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002271 else
2272 {
2273 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002274 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2275 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002276 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002277}
Johan Pascalb62bb512015-12-03 21:56:45 +01002278#endif /* MBEDTLS_SSL_DTLS_SRTP */
2279
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002280void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002281{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002282 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002283}
2284
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002285void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002286{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002287 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002288}
2289
Janos Follath088ce432017-04-10 12:42:31 +01002290#if defined(MBEDTLS_SSL_SRV_C)
2291void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2292 char cert_req_ca_list )
2293{
2294 conf->cert_req_ca_list = cert_req_ca_list;
2295}
2296#endif
2297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002299void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002300{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002301 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002302}
2303#endif
2304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002306void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002307{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002308 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002309}
2310#endif
2311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002313int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002314{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002315 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002316 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002317 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002319 }
2320
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002321 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002322
2323 return( 0 );
2324}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002326
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002327void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002328{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002329 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002330}
2331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002333void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002334{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002335 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002336}
2337
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002338void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002339{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002340 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002341}
2342
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002343void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002344 const unsigned char period[8] )
2345{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002346 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002347}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002351#if defined(MBEDTLS_SSL_CLI_C)
2352void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002353{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002354 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002355}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002356#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002357
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002358#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002359void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2360 mbedtls_ssl_ticket_write_t *f_ticket_write,
2361 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2362 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002363{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002364 conf->f_ticket_write = f_ticket_write;
2365 conf->f_ticket_parse = f_ticket_parse;
2366 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002367}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002368#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002370
Hanno Becker7e6c1782021-06-08 09:24:55 +01002371void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2372 mbedtls_ssl_export_keys_t *f_export_keys,
2373 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002374{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002375 ssl->f_export_keys = f_export_keys;
2376 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002377}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002378
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002379#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002380void mbedtls_ssl_conf_async_private_cb(
2381 mbedtls_ssl_config *conf,
2382 mbedtls_ssl_async_sign_t *f_async_sign,
2383 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2384 mbedtls_ssl_async_resume_t *f_async_resume,
2385 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002386 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002387{
2388 conf->f_async_sign_start = f_async_sign;
2389 conf->f_async_decrypt_start = f_async_decrypt;
2390 conf->f_async_resume = f_async_resume;
2391 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002392 conf->p_async_config_data = async_config_data;
2393}
2394
Gilles Peskine8f97af72018-04-26 11:46:10 +02002395void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2396{
2397 return( conf->p_async_config_data );
2398}
2399
Gilles Peskine1febfef2018-04-30 11:54:39 +02002400void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002401{
2402 if( ssl->handshake == NULL )
2403 return( NULL );
2404 else
2405 return( ssl->handshake->user_async_ctx );
2406}
2407
Gilles Peskine1febfef2018-04-30 11:54:39 +02002408void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002409 void *ctx )
2410{
2411 if( ssl->handshake != NULL )
2412 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002413}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002414#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002415
Paul Bakker5121ce52009-01-03 21:22:43 +00002416/*
2417 * SSL get accessors
2418 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002419uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002420{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002421 if( ssl->session != NULL )
2422 return( ssl->session->verify_result );
2423
2424 if( ssl->session_negotiate != NULL )
2425 return( ssl->session_negotiate->verify_result );
2426
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002427 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002428}
2429
Glenn Strauss8f526902022-01-13 00:04:49 -05002430int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2431{
2432 if( ssl == NULL || ssl->session == NULL )
2433 return( 0 );
2434
2435 return( ssl->session->ciphersuite );
2436}
2437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002439{
Paul Bakker926c8e42013-03-06 10:23:34 +01002440 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002441 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002444}
2445
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002447{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002449 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002450 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002451 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002452 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002453 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002454 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002455 default:
2456 return( "unknown (DTLS)" );
2457 }
2458 }
2459#endif
2460
Glenn Strauss60bfe602022-03-14 19:04:24 -04002461 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002462 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002463 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002464 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002465 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002466 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002467 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002468 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002469 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002470}
2471
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002472#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002473size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2474{
David Horstmann95d516f2021-05-04 18:36:56 +01002475 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002476 size_t read_mfl;
2477
2478 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2479 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2480 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2481 {
2482 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2483 }
2484
2485 /* Check if a smaller max length was negotiated */
2486 if( ssl->session_out != NULL )
2487 {
2488 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2489 if( read_mfl < max_len )
2490 {
2491 max_len = read_mfl;
2492 }
2493 }
2494
2495 // During a handshake, use the value being negotiated
2496 if( ssl->session_negotiate != NULL )
2497 {
2498 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2499 if( read_mfl < max_len )
2500 {
2501 max_len = read_mfl;
2502 }
2503 }
2504
2505 return( max_len );
2506}
2507
2508size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002509{
2510 size_t max_len;
2511
2512 /*
2513 * Assume mfl_code is correct since it was checked when set
2514 */
Angus Grattond8213d02016-05-25 20:56:48 +10002515 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002516
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002517 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002518 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002519 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002520 {
Angus Grattond8213d02016-05-25 20:56:48 +10002521 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002522 }
2523
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002524 /* During a handshake, use the value being negotiated */
2525 if( ssl->session_negotiate != NULL &&
2526 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2527 {
2528 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2529 }
2530
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002531 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002532}
2533#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2534
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002535#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002536size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002537{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002538 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2539 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2540 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2541 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2542 return ( 0 );
2543
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002544 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2545 return( ssl->mtu );
2546
2547 if( ssl->mtu == 0 )
2548 return( ssl->handshake->mtu );
2549
2550 return( ssl->mtu < ssl->handshake->mtu ?
2551 ssl->mtu : ssl->handshake->mtu );
2552}
2553#endif /* MBEDTLS_SSL_PROTO_DTLS */
2554
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002555int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2556{
2557 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2558
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002559#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2560 !defined(MBEDTLS_SSL_PROTO_DTLS)
2561 (void) ssl;
2562#endif
2563
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002564#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002565 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002566
2567 if( max_len > mfl )
2568 max_len = mfl;
2569#endif
2570
2571#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002572 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002573 {
Hanno Becker89490712020-02-05 10:50:12 +00002574 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002575 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2576 const size_t overhead = (size_t) ret;
2577
2578 if( ret < 0 )
2579 return( ret );
2580
2581 if( mtu <= overhead )
2582 {
2583 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2584 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2585 }
2586
2587 if( max_len > mtu - overhead )
2588 max_len = mtu - overhead;
2589 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002590#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002591
Hanno Becker0defedb2018-08-10 12:35:02 +01002592#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2593 !defined(MBEDTLS_SSL_PROTO_DTLS)
2594 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002595#endif
2596
2597 return( (int) max_len );
2598}
2599
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002600int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2601{
2602 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2603
2604#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2605 (void) ssl;
2606#endif
2607
2608#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2609 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2610
2611 if( max_len > mfl )
2612 max_len = mfl;
2613#endif
2614
2615 return( (int) max_len );
2616}
2617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618#if defined(MBEDTLS_X509_CRT_PARSE_C)
2619const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002620{
2621 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002622 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002623
Hanno Beckere6824572019-02-07 13:18:46 +00002624#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002625 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002626#else
2627 return( NULL );
2628#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002629}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002633int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2634 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002635{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002636 int ret;
2637
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002638 if( ssl == NULL ||
2639 dst == NULL ||
2640 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002641 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002642 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002644 }
2645
Hanno Beckere810bbc2021-05-14 16:01:05 +01002646 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2647 * idempotent: Each session can only be exported once.
2648 *
2649 * (This is in preparation for TLS 1.3 support where we will
2650 * need the ability to export multiple sessions (aka tickets),
2651 * which will be achieved by calling mbedtls_ssl_get_session()
2652 * multiple times until it fails.)
2653 *
2654 * Check whether we have already exported the current session,
2655 * and fail if so.
2656 */
2657 if( ssl->session->exported == 1 )
2658 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2659
2660 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2661 if( ret != 0 )
2662 return( ret );
2663
2664 /* Remember that we've exported the session. */
2665 ssl->session->exported = 1;
2666 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002667}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002669
Paul Bakker5121ce52009-01-03 21:22:43 +00002670/*
Hanno Beckera835da52019-05-16 12:39:07 +01002671 * Define ticket header determining Mbed TLS version
2672 * and structure of the ticket.
2673 */
2674
Hanno Becker94ef3b32019-05-16 12:50:45 +01002675/*
Hanno Becker50b59662019-05-28 14:30:45 +01002676 * Define bitflag determining compile-time settings influencing
2677 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002678 */
2679
Hanno Becker50b59662019-05-28 14:30:45 +01002680#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002681#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002682#else
Hanno Becker3e088662019-05-29 11:10:18 +01002683#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002684#endif /* MBEDTLS_HAVE_TIME */
2685
2686#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002687#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002688#else
Hanno Becker3e088662019-05-29 11:10:18 +01002689#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002690#endif /* MBEDTLS_X509_CRT_PARSE_C */
2691
2692#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002693#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002694#else
Hanno Becker3e088662019-05-29 11:10:18 +01002695#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002696#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2697
2698#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002699#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002700#else
Hanno Becker3e088662019-05-29 11:10:18 +01002701#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002702#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2703
Hanno Becker94ef3b32019-05-16 12:50:45 +01002704#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002705#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002706#else
Hanno Becker3e088662019-05-29 11:10:18 +01002707#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002708#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2709
Hanno Becker94ef3b32019-05-16 12:50:45 +01002710#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2711#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2712#else
2713#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2714#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2715
Hanno Becker3e088662019-05-29 11:10:18 +01002716#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2717#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2718#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2719#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002720#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2721#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002722
Hanno Becker50b59662019-05-28 14:30:45 +01002723#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002724 ( (uint16_t) ( \
2725 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2726 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2727 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2728 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002729 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002730 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002731
Hanno Beckerf8787072019-05-16 12:41:07 +01002732static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002733 MBEDTLS_VERSION_MAJOR,
2734 MBEDTLS_VERSION_MINOR,
2735 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002736 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2737 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002738};
Hanno Beckera835da52019-05-16 12:39:07 +01002739
2740/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002741 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002742 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002743 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002744 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002745 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002746 * opaque mbedtls_version[3]; // library version: major, minor, patch
2747 * opaque session_format[2]; // library-version specific 16-bit field
2748 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002749 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002750 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002751 * Note: When updating the format, remember to keep
2752 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002753 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002754 * // In this version, `session_format` determines
2755 * // the setting of those compile-time
2756 * // configuration options which influence
2757 * // the structure of mbedtls_ssl_session.
2758 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002759 * uint8_t minor_ver; // Protocol minor version. Possible values:
2760 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002761 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002762 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002763 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002764 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002765 * serialized_session_tls12 data;
2766 *
2767 * };
2768 *
2769 * } serialized_session;
2770 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002771 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002772
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002773static int ssl_session_save( const mbedtls_ssl_session *session,
2774 unsigned char omit_header,
2775 unsigned char *buf,
2776 size_t buf_len,
2777 size_t *olen )
2778{
2779 unsigned char *p = buf;
2780 size_t used = 0;
2781
2782 if( !omit_header )
2783 {
2784 /*
2785 * Add Mbed TLS version identifier
2786 */
2787
2788 used += sizeof( ssl_serialized_session_header );
2789
2790 if( used <= buf_len )
2791 {
2792 memcpy( p, ssl_serialized_session_header,
2793 sizeof( ssl_serialized_session_header ) );
2794 p += sizeof( ssl_serialized_session_header );
2795 }
2796 }
2797
2798 /*
2799 * TLS version identifier
2800 */
2801 used += 1;
2802 if( used <= buf_len )
2803 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002804 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002805 }
2806
2807 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002808 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002809 {
2810#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002811 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002812 {
2813 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2814 used += ssl_session_save_tls12( session, p, remaining_len );
2815 break;
2816 }
2817#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2818
2819 default:
2820 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2821 }
2822
2823 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002824 if( used > buf_len )
2825 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002826
2827 return( 0 );
2828}
2829
2830/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002831 * Public wrapper for ssl_session_save()
2832 */
2833int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2834 unsigned char *buf,
2835 size_t buf_len,
2836 size_t *olen )
2837{
2838 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2839}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002840
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002841/*
2842 * Deserialize session, see mbedtls_ssl_session_save() for format.
2843 *
2844 * This internal version is wrapped by a public function that cleans up in
2845 * case of error, and has an extra option omit_header.
2846 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002847static int ssl_session_load( mbedtls_ssl_session *session,
2848 unsigned char omit_header,
2849 const unsigned char *buf,
2850 size_t len )
2851{
2852 const unsigned char *p = buf;
2853 const unsigned char * const end = buf + len;
2854
2855 if( !omit_header )
2856 {
2857 /*
2858 * Check Mbed TLS version identifier
2859 */
2860
2861 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2862 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2863
2864 if( memcmp( p, ssl_serialized_session_header,
2865 sizeof( ssl_serialized_session_header ) ) != 0 )
2866 {
2867 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2868 }
2869 p += sizeof( ssl_serialized_session_header );
2870 }
2871
2872 /*
2873 * TLS version identifier
2874 */
2875 if( 1 > (size_t)( end - p ) )
2876 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002877 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002878
2879 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002880 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002881 {
2882#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002883 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002884 {
2885 size_t remaining_len = ( end - p );
2886 return( ssl_session_load_tls12( session, p, remaining_len ) );
2887 }
2888#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2889
2890 default:
2891 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2892 }
2893}
2894
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002895/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002896 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002897 */
2898int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2899 const unsigned char *buf,
2900 size_t len )
2901{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002902 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002903
2904 if( ret != 0 )
2905 mbedtls_ssl_session_free( session );
2906
2907 return( ret );
2908}
2909
2910/*
Paul Bakker1961b702013-01-25 14:49:24 +01002911 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002912 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002913static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2914{
2915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2916
Ronald Cron66dbf912022-02-02 15:33:46 +01002917 /*
2918 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002919 * that were written into the output buffer by the previous handshake step,
2920 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002921 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2922 * We proceed to the next handshake step only when all data from the
2923 * previous one have been sent to the peer, thus we make sure that this is
2924 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2925 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2926 * we have to wait before to go ahead.
2927 * In the case of TLS 1.3, handshake step handlers do not send data to the
2928 * peer. Data are only sent here and through
2929 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002930 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002931 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002932 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2933 return( ret );
2934
2935#if defined(MBEDTLS_SSL_PROTO_DTLS)
2936 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2937 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2938 {
2939 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2940 return( ret );
2941 }
2942#endif /* MBEDTLS_SSL_PROTO_DTLS */
2943
2944 return( ret );
2945}
2946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002948{
Hanno Becker41934dd2021-08-07 19:13:43 +01002949 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002950
Hanno Becker41934dd2021-08-07 19:13:43 +01002951 if( ssl == NULL ||
2952 ssl->conf == NULL ||
2953 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002954 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002955 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002956 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002957 }
2958
2959 ret = ssl_prepare_handshake_step( ssl );
2960 if( ret != 0 )
2961 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002962
Jerry Yue7047812021-09-13 19:26:39 +08002963 ret = mbedtls_ssl_handle_pending_alert( ssl );
2964 if( ret != 0 )
2965 goto cleanup;
2966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002968 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002969 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2971 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002972
Ronald Cron9f0fba32022-02-10 16:45:15 +01002973 switch( ssl->state )
2974 {
2975 case MBEDTLS_SSL_HELLO_REQUEST:
2976 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2977 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002978
Ronald Cron9f0fba32022-02-10 16:45:15 +01002979 case MBEDTLS_SSL_CLIENT_HELLO:
2980 ret = mbedtls_ssl_write_client_hello( ssl );
2981 break;
2982
2983 default:
2984#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002985 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002986 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2987 else
2988 ret = mbedtls_ssl_handshake_client_step( ssl );
2989#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2990 ret = mbedtls_ssl_handshake_client_step( ssl );
2991#else
2992 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2993#endif
2994 }
Jerry Yub9930e72021-08-06 17:11:51 +08002995 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002996#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002998 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002999 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003000#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3f71ca02022-06-21 14:42:03 +08003001
Jerry Yub9930e72021-08-06 17:11:51 +08003002 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu3f71ca02022-06-21 14:42:03 +08003003 {
3004#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
3005 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3006 /* Remove below lines if server side hybrid mode implemented. */
3007 if( ssl->state == MBEDTLS_SSL_HELLO_REQUEST )
3008 {
3009 ssl_fix_server_side_negotiation_fail( ssl );
3010 }
3011#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
3012 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu27561932021-08-27 17:07:38 +08003013 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Jerry Yu3f71ca02022-06-21 14:42:03 +08003014 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003015#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003016
3017#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3018 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3019 ret = mbedtls_ssl_handshake_server_step( ssl );
3020#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3021 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003022#endif
3023
Jerry Yue7047812021-09-13 19:26:39 +08003024 if( ret != 0 )
3025 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003026 /* handshake_step return error. And it is same
3027 * with alert_reason.
3028 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003029 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003030 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003031 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003032 goto cleanup;
3033 }
3034 }
3035
3036cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003037 return( ret );
3038}
3039
3040/*
3041 * Perform the SSL handshake
3042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003044{
3045 int ret = 0;
3046
Hanno Beckera817ea42020-10-20 15:20:23 +01003047 /* Sanity checks */
3048
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003049 if( ssl == NULL || ssl->conf == NULL )
3050 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3051
Hanno Beckera817ea42020-10-20 15:20:23 +01003052#if defined(MBEDTLS_SSL_PROTO_DTLS)
3053 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3054 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3055 {
3056 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3057 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3058 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3059 }
3060#endif /* MBEDTLS_SSL_PROTO_DTLS */
3061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003063
Hanno Beckera817ea42020-10-20 15:20:23 +01003064 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003065 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003066 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003068
3069 if( ret != 0 )
3070 break;
3071 }
3072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003074
3075 return( ret );
3076}
3077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078#if defined(MBEDTLS_SSL_RENEGOTIATION)
3079#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003080/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003081 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003084{
Janos Follath865b3eb2019-12-16 11:46:15 +00003085 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003088
3089 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3091 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003092
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003093 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003094 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003095 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003096 return( ret );
3097 }
3098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003100
3101 return( 0 );
3102}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003104
3105/*
3106 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 * - any side: calling mbedtls_ssl_renegotiate(),
3108 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3109 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003110 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003111 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003113 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003114int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003115{
Janos Follath865b3eb2019-12-16 11:46:15 +00003116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003119
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003120 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3121 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003122
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003123 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3124 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003126 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003128 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003129 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003130 ssl->handshake->out_msg_seq = 1;
3131 else
3132 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003133 }
3134#endif
3135
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3137 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003140 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003141 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003142 return( ret );
3143 }
3144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003146
3147 return( 0 );
3148}
3149
3150/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003151 * Renegotiate current connection on client,
3152 * or request renegotiation on server
3153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003155{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003157
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003158 if( ssl == NULL || ssl->conf == NULL )
3159 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003162 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003163 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003164 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003165 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003169
3170 /* Did we already try/start sending HelloRequest? */
3171 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003173
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003174 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003175 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003179 /*
3180 * On client, either start the renegotiation process or,
3181 * if already in progress, continue the handshake
3182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003184 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003185 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003187
Hanno Becker40cdaa12020-02-05 10:48:27 +00003188 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003189 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003190 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003191 return( ret );
3192 }
3193 }
3194 else
3195 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003197 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003199 return( ret );
3200 }
3201 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003203
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003204 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003205}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003207
Gilles Peskine9b562d52018-04-25 20:32:43 +02003208void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003209{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003210 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3211
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003212 if( handshake == NULL )
3213 return;
3214
Brett Warrene0edc842021-08-17 09:53:13 +01003215#if defined(MBEDTLS_ECP_C)
3216#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3217 if ( ssl->handshake->group_list_heap_allocated )
3218 mbedtls_free( (void*) handshake->group_list );
3219 handshake->group_list = NULL;
3220#endif /* MBEDTLS_DEPRECATED_REMOVED */
3221#endif /* MBEDTLS_ECP_C */
3222
Jerry Yuf017ee42022-01-12 15:49:48 +08003223#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3224#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3225 if ( ssl->handshake->sig_algs_heap_allocated )
3226 mbedtls_free( (void*) handshake->sig_algs );
3227 handshake->sig_algs = NULL;
3228#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003229#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3230 if( ssl->handshake->certificate_request_context )
3231 {
3232 mbedtls_free( (void*) handshake->certificate_request_context );
3233 }
3234#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003235#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3236
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003237#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3238 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3239 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003240 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003241 handshake->async_in_progress = 0;
3242 }
3243#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3244
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003245#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003246#if defined(MBEDTLS_USE_PSA_CRYPTO)
3247 psa_hash_abort( &handshake->fin_sha256_psa );
3248#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003249 mbedtls_sha256_free( &handshake->fin_sha256 );
3250#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003251#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003252#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003253#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003254 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003255#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003256 mbedtls_sha512_free( &handshake->fin_sha512 );
3257#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003258#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260#if defined(MBEDTLS_DHM_C)
3261 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003262#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003263#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003265#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003266#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003267 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003268#if defined(MBEDTLS_SSL_CLI_C)
3269 mbedtls_free( handshake->ecjpake_cache );
3270 handshake->ecjpake_cache = NULL;
3271 handshake->ecjpake_cache_len = 0;
3272#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003273#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003274
Janos Follath4ae5c292016-02-10 11:27:43 +00003275#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3276 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003277 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003278 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003279#endif
3280
Gilles Peskineeccd8882020-03-10 12:19:08 +01003281#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003282#if defined(MBEDTLS_USE_PSA_CRYPTO)
3283 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3284 {
3285 /* The maintenance of the external PSK key slot is the
3286 * user's responsibility. */
3287 if( ssl->handshake->psk_opaque_is_internal )
3288 {
3289 psa_destroy_key( ssl->handshake->psk_opaque );
3290 ssl->handshake->psk_opaque_is_internal = 0;
3291 }
3292 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3293 }
Neil Armstronge952a302022-05-03 10:22:14 +02003294#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003295 if( handshake->psk != NULL )
3296 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003297 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003298 mbedtls_free( handshake->psk );
3299 }
Neil Armstronge952a302022-05-03 10:22:14 +02003300#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003301#endif
3302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3304 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003305 /*
3306 * Free only the linked list wrapper, not the keys themselves
3307 * since the belong to the SNI callback
3308 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003309 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003311
Gilles Peskineeccd8882020-03-10 12:19:08 +01003312#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003313 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003314 if( handshake->ecrs_peer_cert != NULL )
3315 {
3316 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3317 mbedtls_free( handshake->ecrs_peer_cert );
3318 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003319#endif
3320
Hanno Becker75173122019-02-06 16:18:31 +00003321#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3322 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3323 mbedtls_pk_free( &handshake->peer_pubkey );
3324#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3325
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003326#if defined(MBEDTLS_SSL_CLI_C) && \
3327 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3328 mbedtls_free( handshake->cookie );
3329#endif /* MBEDTLS_SSL_CLI_C &&
3330 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003331
3332#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003333 mbedtls_ssl_flight_free( handshake->flight );
3334 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003335#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003336
Ronald Cronf12b81d2022-03-15 10:42:41 +01003337#if defined(MBEDTLS_ECDH_C) && \
3338 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003339 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003340 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003341#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3342
Ronald Cron6f135e12021-12-08 16:57:54 +01003343#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003344 mbedtls_ssl_transform_free( handshake->transform_handshake );
3345 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003346 mbedtls_free( handshake->transform_earlydata );
3347 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003348#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003349
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003350
3351#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3352 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3353 * processes datagrams and the fact that a datagram is allowed to have
3354 * several records in it, it is possible that the I/O buffers are not
3355 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003356 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3357 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003358#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003359
Jerry Yuba9c7272021-10-30 11:54:10 +08003360 /* mbedtls_platform_zeroize MUST be last one in this function */
3361 mbedtls_platform_zeroize( handshake,
3362 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003363}
3364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003366{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003367 if( session == NULL )
3368 return;
3369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003371 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003372#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003373
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003374#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003376#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003377
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003378 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003379}
3380
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003381#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003382
3383#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3384#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3385#else
3386#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3387#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3388
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003389#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003390
3391#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3392#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3393#else
3394#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3395#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3396
3397#if defined(MBEDTLS_SSL_ALPN)
3398#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3399#else
3400#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3401#endif /* MBEDTLS_SSL_ALPN */
3402
3403#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3404#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3405#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3406#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3407
3408#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3409 ( (uint32_t) ( \
3410 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3411 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3412 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3413 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3414 0u ) )
3415
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003416static unsigned char ssl_serialized_context_header[] = {
3417 MBEDTLS_VERSION_MAJOR,
3418 MBEDTLS_VERSION_MINOR,
3419 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003420 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3421 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3422 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3423 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3424 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003425};
3426
Paul Bakker5121ce52009-01-03 21:22:43 +00003427/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003428 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003429 *
3430 * The format of the serialized data is:
3431 * (in the presentation language of TLS, RFC 8446 section 3)
3432 *
3433 * // header
3434 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003435 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003436 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003437 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003438 * Note: When updating the format, remember to keep these
3439 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003440 *
3441 * // session sub-structure
3442 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3443 * // transform sub-structure
3444 * uint8 random[64]; // ServerHello.random+ClientHello.random
3445 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3446 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3447 * // fields from ssl_context
3448 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3449 * uint64 in_window_top; // DTLS: last validated record seq_num
3450 * uint64 in_window; // DTLS: bitmask for replay protection
3451 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3452 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3453 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3454 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3455 *
3456 * Note that many fields of the ssl_context or sub-structures are not
3457 * serialized, as they fall in one of the following categories:
3458 *
3459 * 1. forced value (eg in_left must be 0)
3460 * 2. pointer to dynamically-allocated memory (eg session, transform)
3461 * 3. value can be re-derived from other data (eg session keys from MS)
3462 * 4. value was temporary (eg content of input buffer)
3463 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003464 */
3465int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3466 unsigned char *buf,
3467 size_t buf_len,
3468 size_t *olen )
3469{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003470 unsigned char *p = buf;
3471 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003472 size_t session_len;
3473 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003474
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003475 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003476 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3477 * this function's documentation.
3478 *
3479 * These are due to assumptions/limitations in the implementation. Some of
3480 * them are likely to stay (no handshake in progress) some might go away
3481 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003482 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003483 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003484 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003485 {
3486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003487 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003488 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003489 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003490 {
3491 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003492 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003493 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003494 /* Double-check that sub-structures are indeed ready */
3495 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003496 {
3497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003498 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003499 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003500 /* There must be no pending incoming or outgoing data */
3501 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003502 {
3503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003504 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003505 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003506 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003507 {
3508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003509 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003510 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003511 /* Protocol must be DLTS, not TLS */
3512 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003513 {
3514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003515 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003516 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003517 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003518 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003519 {
3520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003522 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003523 /* We must be using an AEAD ciphersuite */
3524 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003525 {
3526 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003527 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003528 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003529 /* Renegotiation must not be enabled */
3530#if defined(MBEDTLS_SSL_RENEGOTIATION)
3531 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003532 {
3533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003534 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003535 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003536#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003537
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003538 /*
3539 * Version and format identifier
3540 */
3541 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003542
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003543 if( used <= buf_len )
3544 {
3545 memcpy( p, ssl_serialized_context_header,
3546 sizeof( ssl_serialized_context_header ) );
3547 p += sizeof( ssl_serialized_context_header );
3548 }
3549
3550 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003551 * Session (length + data)
3552 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003553 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003554 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3555 return( ret );
3556
3557 used += 4 + session_len;
3558 if( used <= buf_len )
3559 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003560 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3561 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003562
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003563 ret = ssl_session_save( ssl->session, 1,
3564 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003565 if( ret != 0 )
3566 return( ret );
3567
3568 p += session_len;
3569 }
3570
3571 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003572 * Transform
3573 */
3574 used += sizeof( ssl->transform->randbytes );
3575 if( used <= buf_len )
3576 {
3577 memcpy( p, ssl->transform->randbytes,
3578 sizeof( ssl->transform->randbytes ) );
3579 p += sizeof( ssl->transform->randbytes );
3580 }
3581
3582#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3583 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3584 if( used <= buf_len )
3585 {
3586 *p++ = ssl->transform->in_cid_len;
3587 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3588 p += ssl->transform->in_cid_len;
3589
3590 *p++ = ssl->transform->out_cid_len;
3591 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3592 p += ssl->transform->out_cid_len;
3593 }
3594#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3595
3596 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003597 * Saved fields from top-level ssl_context structure
3598 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003599 used += 4;
3600 if( used <= buf_len )
3601 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003602 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3603 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003604 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003605
3606#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3607 used += 16;
3608 if( used <= buf_len )
3609 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003610 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3611 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003612
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003613 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3614 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003615 }
3616#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3617
3618#if defined(MBEDTLS_SSL_PROTO_DTLS)
3619 used += 1;
3620 if( used <= buf_len )
3621 {
3622 *p++ = ssl->disable_datagram_packing;
3623 }
3624#endif /* MBEDTLS_SSL_PROTO_DTLS */
3625
Jerry Yuae0b2e22021-10-08 15:21:19 +08003626 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003627 if( used <= buf_len )
3628 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003629 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3630 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003631 }
3632
3633#if defined(MBEDTLS_SSL_PROTO_DTLS)
3634 used += 2;
3635 if( used <= buf_len )
3636 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003637 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3638 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003639 }
3640#endif /* MBEDTLS_SSL_PROTO_DTLS */
3641
3642#if defined(MBEDTLS_SSL_ALPN)
3643 {
3644 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003645 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003646 : 0;
3647
3648 used += 1 + alpn_len;
3649 if( used <= buf_len )
3650 {
3651 *p++ = alpn_len;
3652
3653 if( ssl->alpn_chosen != NULL )
3654 {
3655 memcpy( p, ssl->alpn_chosen, alpn_len );
3656 p += alpn_len;
3657 }
3658 }
3659 }
3660#endif /* MBEDTLS_SSL_ALPN */
3661
3662 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003663 * Done
3664 */
3665 *olen = used;
3666
3667 if( used > buf_len )
3668 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003669
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003670 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3671
Hanno Becker43aefe22020-02-05 10:44:56 +00003672 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003673}
3674
3675/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003676 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003677 *
3678 * This internal version is wrapped by a public function that cleans up in
3679 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003680 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003681static int ssl_context_load( mbedtls_ssl_context *ssl,
3682 const unsigned char *buf,
3683 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003684{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003685 const unsigned char *p = buf;
3686 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003687 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003689
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003690 /*
3691 * The context should have been freshly setup or reset.
3692 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003693 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003694 * renegotiating, or if the user mistakenly loaded a session first.)
3695 */
3696 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3697 ssl->session != NULL )
3698 {
3699 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3700 }
3701
3702 /*
3703 * We can't check that the config matches the initial one, but we can at
3704 * least check it matches the requirements for serializing.
3705 */
3706 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003707 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3708 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003709#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003710 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003711#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003712 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003713 {
3714 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3715 }
3716
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003717 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3718
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003719 /*
3720 * Check version identifier
3721 */
3722 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3723 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3724
3725 if( memcmp( p, ssl_serialized_context_header,
3726 sizeof( ssl_serialized_context_header ) ) != 0 )
3727 {
3728 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3729 }
3730 p += sizeof( ssl_serialized_context_header );
3731
3732 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003733 * Session
3734 */
3735 if( (size_t)( end - p ) < 4 )
3736 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3737
3738 session_len = ( (size_t) p[0] << 24 ) |
3739 ( (size_t) p[1] << 16 ) |
3740 ( (size_t) p[2] << 8 ) |
3741 ( (size_t) p[3] );
3742 p += 4;
3743
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003744 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003745 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003746 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003747 ssl->session_in = ssl->session;
3748 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003749 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003750
3751 if( (size_t)( end - p ) < session_len )
3752 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3753
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003754 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003755 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003756 {
3757 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003758 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003759 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003760
3761 p += session_len;
3762
3763 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003764 * Transform
3765 */
3766
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003767 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003768 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003769 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003770 ssl->transform_in = ssl->transform;
3771 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003772 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003773
3774 /* Read random bytes and populate structure */
3775 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003777#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003778 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003779 ssl->session->ciphersuite,
3780 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003781#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003782 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003783#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003784 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3785 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003786 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003787 ssl->conf->endpoint,
3788 ssl );
3789 if( ret != 0 )
3790 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003791#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003792 p += sizeof( ssl->transform->randbytes );
3793
3794#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3795 /* Read connection IDs and store them */
3796 if( (size_t)( end - p ) < 1 )
3797 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3798
3799 ssl->transform->in_cid_len = *p++;
3800
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003801 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003802 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3803
3804 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3805 p += ssl->transform->in_cid_len;
3806
3807 ssl->transform->out_cid_len = *p++;
3808
3809 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3810 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3811
3812 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3813 p += ssl->transform->out_cid_len;
3814#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3815
3816 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003817 * Saved fields from top-level ssl_context structure
3818 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003819 if( (size_t)( end - p ) < 4 )
3820 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3821
3822 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3823 ( (uint32_t) p[1] << 16 ) |
3824 ( (uint32_t) p[2] << 8 ) |
3825 ( (uint32_t) p[3] );
3826 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003827
3828#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3829 if( (size_t)( end - p ) < 16 )
3830 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3831
3832 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3833 ( (uint64_t) p[1] << 48 ) |
3834 ( (uint64_t) p[2] << 40 ) |
3835 ( (uint64_t) p[3] << 32 ) |
3836 ( (uint64_t) p[4] << 24 ) |
3837 ( (uint64_t) p[5] << 16 ) |
3838 ( (uint64_t) p[6] << 8 ) |
3839 ( (uint64_t) p[7] );
3840 p += 8;
3841
3842 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3843 ( (uint64_t) p[1] << 48 ) |
3844 ( (uint64_t) p[2] << 40 ) |
3845 ( (uint64_t) p[3] << 32 ) |
3846 ( (uint64_t) p[4] << 24 ) |
3847 ( (uint64_t) p[5] << 16 ) |
3848 ( (uint64_t) p[6] << 8 ) |
3849 ( (uint64_t) p[7] );
3850 p += 8;
3851#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3852
3853#if defined(MBEDTLS_SSL_PROTO_DTLS)
3854 if( (size_t)( end - p ) < 1 )
3855 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3856
3857 ssl->disable_datagram_packing = *p++;
3858#endif /* MBEDTLS_SSL_PROTO_DTLS */
3859
Jerry Yud9a94fe2021-09-28 18:58:59 +08003860 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003861 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003862 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3863 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003864
3865#if defined(MBEDTLS_SSL_PROTO_DTLS)
3866 if( (size_t)( end - p ) < 2 )
3867 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3868
3869 ssl->mtu = ( p[0] << 8 ) | p[1];
3870 p += 2;
3871#endif /* MBEDTLS_SSL_PROTO_DTLS */
3872
3873#if defined(MBEDTLS_SSL_ALPN)
3874 {
3875 uint8_t alpn_len;
3876 const char **cur;
3877
3878 if( (size_t)( end - p ) < 1 )
3879 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3880
3881 alpn_len = *p++;
3882
3883 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3884 {
3885 /* alpn_chosen should point to an item in the configured list */
3886 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3887 {
3888 if( strlen( *cur ) == alpn_len &&
3889 memcmp( p, cur, alpn_len ) == 0 )
3890 {
3891 ssl->alpn_chosen = *cur;
3892 break;
3893 }
3894 }
3895 }
3896
3897 /* can only happen on conf mismatch */
3898 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3899 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3900
3901 p += alpn_len;
3902 }
3903#endif /* MBEDTLS_SSL_ALPN */
3904
3905 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003906 * Forced fields from top-level ssl_context structure
3907 *
3908 * Most of them already set to the correct value by mbedtls_ssl_init() and
3909 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3910 */
3911 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003912 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003913
Hanno Becker361b10d2019-08-30 10:42:49 +01003914 /* Adjust pointers for header fields of outgoing records to
3915 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003916 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003917
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003918#if defined(MBEDTLS_SSL_PROTO_DTLS)
3919 ssl->in_epoch = 1;
3920#endif
3921
3922 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3923 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003924 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3925 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003926 if( ssl->handshake != NULL )
3927 {
3928 mbedtls_ssl_handshake_free( ssl );
3929 mbedtls_free( ssl->handshake );
3930 ssl->handshake = NULL;
3931 }
3932
3933 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003934 * Done - should have consumed entire buffer
3935 */
3936 if( p != end )
3937 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003938
3939 return( 0 );
3940}
3941
3942/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003943 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003944 */
3945int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3946 const unsigned char *buf,
3947 size_t len )
3948{
3949 int ret = ssl_context_load( context, buf, len );
3950
3951 if( ret != 0 )
3952 mbedtls_ssl_free( context );
3953
3954 return( ret );
3955}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003956#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003957
3958/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003959 * Free an SSL context
3960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003961void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003962{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003963 if( ssl == NULL )
3964 return;
3965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003966 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003967
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003968 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003969 {
sander-visserb8aa2072020-05-06 22:05:13 +02003970#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3971 size_t out_buf_len = ssl->out_buf_len;
3972#else
3973 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3974#endif
3975
Darryl Greenb33cc762019-11-28 14:29:44 +00003976 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003978 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003979 }
3980
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003981 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003982 {
sander-visserb8aa2072020-05-06 22:05:13 +02003983#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3984 size_t in_buf_len = ssl->in_buf_len;
3985#else
3986 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3987#endif
3988
Darryl Greenb33cc762019-11-28 14:29:44 +00003989 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003990 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003991 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003992 }
3993
Paul Bakker48916f92012-09-16 19:57:18 +00003994 if( ssl->transform )
3995 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003996 mbedtls_ssl_transform_free( ssl->transform );
3997 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003998 }
3999
4000 if( ssl->handshake )
4001 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004002 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004003 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4004 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004006 mbedtls_free( ssl->handshake );
4007 mbedtls_free( ssl->transform_negotiate );
4008 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004009 }
4010
Ronald Cron6f135e12021-12-08 16:57:54 +01004011#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004012 mbedtls_ssl_transform_free( ssl->transform_application );
4013 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004014#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004015
Paul Bakkerc0463502013-02-14 11:19:38 +01004016 if( ssl->session )
4017 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018 mbedtls_ssl_session_free( ssl->session );
4019 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004020 }
4021
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004022#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004023 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004024 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004025 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004026 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004027 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004028#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004029
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004030#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004031 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004032#endif
4033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004035
Paul Bakker86f04f42013-02-14 11:20:09 +01004036 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004037 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004038}
4039
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004040/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004041 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004042 */
4043void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4044{
4045 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4046}
4047
Gilles Peskineae270bf2021-06-02 00:05:29 +02004048/* The selection should be the same as mbedtls_x509_crt_profile_default in
4049 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004050 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004051 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004052 * about this list.
4053 */
Brett Warrene0edc842021-08-17 09:53:13 +01004054static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004055#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004056 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004057#endif
4058#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004059 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004060#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004061#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004062 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004063#endif
4064#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004065 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004066#endif
4067#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004068 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004069#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004070#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004071 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004072#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004073#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004074 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004075#endif
4076#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004077 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004078#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004079 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004080};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004081
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004082static int ssl_preset_suiteb_ciphersuites[] = {
4083 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4084 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4085 0
4086};
4087
Gilles Peskineeccd8882020-03-10 12:19:08 +01004088#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004089
Jerry Yu909df7b2022-01-22 11:56:27 +08004090/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004091 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004092 * rules SHOULD be upheld.
4093 * - No duplicate entries.
4094 * - But if there is a good reason, do not change the order of the algorithms.
4095 * - ssl_tls12_present* is for TLS 1.2 use only.
4096 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004097 *
Jerry Yua1255e62022-06-24 10:10:47 +08004098 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4099 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4100 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
4101 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4102 * for its signature in the key exchange message and as Mbed TLS 1.2 does not
4103 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004104 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004105static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004106
Jerry Yued5e9f42022-01-26 11:21:34 +08004107#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4108 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4109 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4110#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4111 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004112
Jerry Yu909df7b2022-01-22 11:56:27 +08004113#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4114 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4115 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4116#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4117 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4118
Jerry Yued5e9f42022-01-26 11:21:34 +08004119#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4120 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4121 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4122#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4123 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004124
Jerry Yuba5e3792022-06-21 15:26:05 +08004125#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4126 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4127#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4128
4129#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4130 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4131#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4132
4133#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4134 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4135#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4136
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004137#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4138 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4139#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4140
4141#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4142 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4143#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4144
4145#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4146 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4147#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4148
Gabor Mezei15b95a62022-05-09 16:37:58 +02004149 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004150};
4151
4152/* NOTICE: see above */
4153#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4154static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004155#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004156#if defined(MBEDTLS_ECDSA_C)
4157 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004158#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004159#if defined(MBEDTLS_RSA_C)
4160 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4161#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004162#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004163#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004164#if defined(MBEDTLS_ECDSA_C)
4165 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004166#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004167#if defined(MBEDTLS_RSA_C)
4168 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4169#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004170#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004171#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004172#if defined(MBEDTLS_ECDSA_C)
4173 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004174#endif
Jerry Yu3896ac62022-06-19 17:16:38 +08004175#if defined(MBEDTLS_RSA_C)
4176 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4177#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004178#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004179 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004180};
4181#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4182/* NOTICE: see above */
4183static uint16_t ssl_preset_suiteb_sig_algs[] = {
4184
Jerry Yu909df7b2022-01-22 11:56:27 +08004185#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4186 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4187 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4188#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4189 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4190
Jerry Yu53037892022-01-25 11:02:06 +08004191#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4192 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4193 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4194#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4195 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004196
4197#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4198 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4199#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004200
Jerry Yu53037892022-01-25 11:02:06 +08004201#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4202 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4203#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4204
Gabor Mezei15b95a62022-05-09 16:37:58 +02004205 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004206};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004207
Jerry Yu909df7b2022-01-22 11:56:27 +08004208/* NOTICE: see above */
4209#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4210static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004211#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004212#if defined(MBEDTLS_ECDSA_C)
4213 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004214#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004215#if defined(MBEDTLS_RSA_C)
4216 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4217#endif
4218#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004219#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004220#if defined(MBEDTLS_ECDSA_C)
4221 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004222#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004223#if defined(MBEDTLS_RSA_C)
4224 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4225#endif
4226#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004227 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004228};
Jerry Yu909df7b2022-01-22 11:56:27 +08004229#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4230
Jerry Yu1a8b4812022-01-20 17:56:50 +08004231#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004232
Brett Warrene0edc842021-08-17 09:53:13 +01004233static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004234#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004235 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004236#endif
4237#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004238 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004239#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004240 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004241};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004242
Jerry Yu1a8b4812022-01-20 17:56:50 +08004243#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004244/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004245 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004246static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004247{
4248 size_t i, j;
4249 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004250
Gabor Mezei15b95a62022-05-09 16:37:58 +02004251 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004252 {
Jerry Yuf377d642022-01-25 10:43:59 +08004253 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004254 {
Jerry Yuf377d642022-01-25 10:43:59 +08004255 if( sig_algs[i] != sig_algs[j] )
4256 continue;
4257 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4258 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4259 sig_algs[i], j, i );
4260 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004261 }
4262 }
4263 return( ret );
4264}
4265
4266#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4267
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004268/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004269 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004270 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004271int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004272 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004273{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004274#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004275 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004276#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004277
Jerry Yu1a8b4812022-01-20 17:56:50 +08004278#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004279 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004280 {
4281 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4282 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4283 }
4284
Jerry Yuf377d642022-01-25 10:43:59 +08004285 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004286 {
4287 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4288 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4289 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004290
4291#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004292 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004293 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004294 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004295 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4296 }
4297
Jerry Yuf377d642022-01-25 10:43:59 +08004298 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004299 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004300 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004301 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4302 }
4303#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004304#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4305
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004306 /* Use the functions here so that they are covered in tests,
4307 * but otherwise access member directly for efficiency */
4308 mbedtls_ssl_conf_endpoint( conf, endpoint );
4309 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004310
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004311 /*
4312 * Things that are common to all presets
4313 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004314#if defined(MBEDTLS_SSL_CLI_C)
4315 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4316 {
4317 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4318#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4319 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4320#endif
4321 }
4322#endif
4323
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004324#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4325 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4326#endif
4327
4328#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4329 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4330#endif
4331
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004332#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004333 conf->f_cookie_write = ssl_cookie_write_dummy;
4334 conf->f_cookie_check = ssl_cookie_check_dummy;
4335#endif
4336
4337#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4338 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4339#endif
4340
Janos Follath088ce432017-04-10 12:42:31 +01004341#if defined(MBEDTLS_SSL_SRV_C)
4342 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004343 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004344#endif
4345
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004346#if defined(MBEDTLS_SSL_PROTO_DTLS)
4347 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4348 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4349#endif
4350
4351#if defined(MBEDTLS_SSL_RENEGOTIATION)
4352 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004353 memset( conf->renego_period, 0x00, 2 );
4354 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004355#endif
4356
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004357#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004358 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4359 {
4360 const unsigned char dhm_p[] =
4361 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4362 const unsigned char dhm_g[] =
4363 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004364
Hanno Beckere2defad2021-07-24 05:59:17 +01004365 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4366 dhm_p, sizeof( dhm_p ),
4367 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4368 {
4369 return( ret );
4370 }
4371 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004372#endif
4373
Ronald Cron6f135e12021-12-08 16:57:54 +01004374#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004375 /*
4376 * Allow all TLS 1.3 key exchange modes by default.
4377 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004378 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004379#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004380
XiaokangQian4d3a6042022-04-21 13:46:17 +00004381 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4382 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004384 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004385 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004386#else
XiaokangQian060d8672022-04-21 09:24:56 +00004387 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004388#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004389 }
4390 else
4391 {
4392#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4393 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4394 {
4395 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4396 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4397 }
4398 else
4399 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4400 {
4401 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4402 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4403 }
4404#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4405 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4406 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4407#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4408 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4409 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4410#else
4411 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4412#endif
4413 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004414
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004415 /*
4416 * Preset-specific defaults
4417 */
4418 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004419 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004420 /*
4421 * NSA Suite B
4422 */
4423 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004424
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004425 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004426
4427#if defined(MBEDTLS_X509_CRT_PARSE_C)
4428 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004429#endif
4430
Gilles Peskineeccd8882020-03-10 12:19:08 +01004431#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004432#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4433 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4434 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4435 else
4436#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4437 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004438#endif
4439
Brett Warrene0edc842021-08-17 09:53:13 +01004440#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4441 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004442#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004443 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004444 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004445
4446 /*
4447 * Default
4448 */
4449 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004450
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004451 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004452
4453#if defined(MBEDTLS_X509_CRT_PARSE_C)
4454 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4455#endif
4456
Gilles Peskineeccd8882020-03-10 12:19:08 +01004457#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004458#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4459 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4460 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4461 else
4462#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4463 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004464#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004465
Brett Warrene0edc842021-08-17 09:53:13 +01004466#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4467 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004468#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004469 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004470
4471#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4472 conf->dhm_min_bitlen = 1024;
4473#endif
4474 }
4475
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004476 return( 0 );
4477}
4478
4479/*
4480 * Free mbedtls_ssl_config
4481 */
4482void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4483{
4484#if defined(MBEDTLS_DHM_C)
4485 mbedtls_mpi_free( &conf->dhm_P );
4486 mbedtls_mpi_free( &conf->dhm_G );
4487#endif
4488
Gilles Peskineeccd8882020-03-10 12:19:08 +01004489#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004490#if defined(MBEDTLS_USE_PSA_CRYPTO)
4491 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4492 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004493 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4494 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004495#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004496 if( conf->psk != NULL )
4497 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004498 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004499 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004500 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004501 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004502 }
4503
4504 if( conf->psk_identity != NULL )
4505 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004506 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004507 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004508 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004509 conf->psk_identity_len = 0;
4510 }
4511#endif
4512
4513#if defined(MBEDTLS_X509_CRT_PARSE_C)
4514 ssl_key_cert_free( conf->key_cert );
4515#endif
4516
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004517 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004518}
4519
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004520#if defined(MBEDTLS_PK_C) && \
4521 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004522/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004525unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004526{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004527#if defined(MBEDTLS_RSA_C)
4528 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4529 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004530#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531#if defined(MBEDTLS_ECDSA_C)
4532 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4533 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004534#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004535 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004536}
4537
Hanno Becker7e5437a2017-04-28 17:15:26 +01004538unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4539{
4540 switch( type ) {
4541 case MBEDTLS_PK_RSA:
4542 return( MBEDTLS_SSL_SIG_RSA );
4543 case MBEDTLS_PK_ECDSA:
4544 case MBEDTLS_PK_ECKEY:
4545 return( MBEDTLS_SSL_SIG_ECDSA );
4546 default:
4547 return( MBEDTLS_SSL_SIG_ANON );
4548 }
4549}
4550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004552{
4553 switch( sig )
4554 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004555#if defined(MBEDTLS_RSA_C)
4556 case MBEDTLS_SSL_SIG_RSA:
4557 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004558#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004559#if defined(MBEDTLS_ECDSA_C)
4560 case MBEDTLS_SSL_SIG_ECDSA:
4561 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004562#endif
4563 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004565 }
4566}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004567#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004568
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004569/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004570 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004572mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004573{
4574 switch( hash )
4575 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004576#if defined(MBEDTLS_MD5_C)
4577 case MBEDTLS_SSL_HASH_MD5:
4578 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004579#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004580#if defined(MBEDTLS_SHA1_C)
4581 case MBEDTLS_SSL_HASH_SHA1:
4582 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004583#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004584#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004585 case MBEDTLS_SSL_HASH_SHA224:
4586 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004587#endif
4588#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004589 case MBEDTLS_SSL_HASH_SHA256:
4590 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004591#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004592#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004593 case MBEDTLS_SSL_HASH_SHA384:
4594 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004595#endif
4596#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004597 case MBEDTLS_SSL_HASH_SHA512:
4598 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004599#endif
4600 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004601 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004602 }
4603}
4604
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004605/*
4606 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4607 */
4608unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4609{
4610 switch( md )
4611 {
4612#if defined(MBEDTLS_MD5_C)
4613 case MBEDTLS_MD_MD5:
4614 return( MBEDTLS_SSL_HASH_MD5 );
4615#endif
4616#if defined(MBEDTLS_SHA1_C)
4617 case MBEDTLS_MD_SHA1:
4618 return( MBEDTLS_SSL_HASH_SHA1 );
4619#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004620#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004621 case MBEDTLS_MD_SHA224:
4622 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004623#endif
4624#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004625 case MBEDTLS_MD_SHA256:
4626 return( MBEDTLS_SSL_HASH_SHA256 );
4627#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004628#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004629 case MBEDTLS_MD_SHA384:
4630 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004631#endif
4632#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004633 case MBEDTLS_MD_SHA512:
4634 return( MBEDTLS_SSL_HASH_SHA512 );
4635#endif
4636 default:
4637 return( MBEDTLS_SSL_HASH_NONE );
4638 }
4639}
4640
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004641/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004642 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004643 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004644 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004645int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004646{
Brett Warrene0edc842021-08-17 09:53:13 +01004647 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004648
Brett Warrene0edc842021-08-17 09:53:13 +01004649 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004650 return( -1 );
4651
Brett Warrene0edc842021-08-17 09:53:13 +01004652 for( ; *group_list != 0; group_list++ )
4653 {
4654 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004655 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004656 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004657
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004658 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004659}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004660
4661#if defined(MBEDTLS_ECP_C)
4662/*
4663 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4664 */
4665int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4666{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004667 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004668 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4669}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004670#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004672#if defined(MBEDTLS_X509_CRT_PARSE_C)
4673int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4674 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004675 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004676 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004677{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004678 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004679 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004680 const char *ext_oid;
4681 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004683 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004684 {
4685 /* Server part of the key exchange */
4686 switch( ciphersuite->key_exchange )
4687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688 case MBEDTLS_KEY_EXCHANGE_RSA:
4689 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004690 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004691 break;
4692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4694 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4695 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4696 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004697 break;
4698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4700 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004701 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004702 break;
4703
4704 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705 case MBEDTLS_KEY_EXCHANGE_NONE:
4706 case MBEDTLS_KEY_EXCHANGE_PSK:
4707 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4708 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004709 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004710 usage = 0;
4711 }
4712 }
4713 else
4714 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4716 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004717 }
4718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004720 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004721 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004722 ret = -1;
4723 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004726 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004727 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4728 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004729 }
4730 else
4731 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4733 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004734 }
4735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004737 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004738 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004739 ret = -1;
4740 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004741
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004742 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004743}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004744#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004745
Jerry Yu148165c2021-09-24 23:20:59 +08004746#if defined(MBEDTLS_USE_PSA_CRYPTO)
4747int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4748 const mbedtls_md_type_t md,
4749 unsigned char *dst,
4750 size_t dst_len,
4751 size_t *olen )
4752{
Ronald Cronf6893e12022-01-07 22:09:01 +01004753 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4754 psa_hash_operation_t *hash_operation_to_clone;
4755 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4756
Jerry Yu148165c2021-09-24 23:20:59 +08004757 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004758
4759 switch( md )
4760 {
4761#if defined(MBEDTLS_SHA384_C)
4762 case MBEDTLS_MD_SHA384:
4763 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4764 break;
4765#endif
4766
4767#if defined(MBEDTLS_SHA256_C)
4768 case MBEDTLS_MD_SHA256:
4769 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4770 break;
4771#endif
4772
4773 default:
4774 goto exit;
4775 }
4776
4777 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4778 if( status != PSA_SUCCESS )
4779 goto exit;
4780
4781 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4782 if( status != PSA_SUCCESS )
4783 goto exit;
4784
4785exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004786 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004787}
4788#else /* MBEDTLS_USE_PSA_CRYPTO */
4789
Jerry Yu24c0ec32021-09-09 14:21:07 +08004790#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004791static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4792 unsigned char *dst,
4793 size_t dst_len,
4794 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004795{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004796 int ret;
4797 mbedtls_sha512_context sha512;
4798
4799 if( dst_len < 48 )
4800 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4801
4802 mbedtls_sha512_init( &sha512 );
4803 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4804
4805 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4806 {
4807 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4808 goto exit;
4809 }
4810
4811 *olen = 48;
4812
4813exit:
4814
4815 mbedtls_sha512_free( &sha512 );
4816 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004817}
4818#endif /* MBEDTLS_SHA384_C */
4819
4820#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004821static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4822 unsigned char *dst,
4823 size_t dst_len,
4824 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004825{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004826 int ret;
4827 mbedtls_sha256_context sha256;
4828
4829 if( dst_len < 32 )
4830 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4831
4832 mbedtls_sha256_init( &sha256 );
4833 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004834
Jerry Yu24c0ec32021-09-09 14:21:07 +08004835 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4836 {
4837 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4838 goto exit;
4839 }
4840
4841 *olen = 32;
4842
4843exit:
4844
4845 mbedtls_sha256_free( &sha256 );
4846 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004847}
4848#endif /* MBEDTLS_SHA256_C */
4849
Jerry Yu000f9762021-09-14 11:12:51 +08004850int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4851 const mbedtls_md_type_t md,
4852 unsigned char *dst,
4853 size_t dst_len,
4854 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004855{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004856 switch( md )
4857 {
4858
Jerry Yu24c0ec32021-09-09 14:21:07 +08004859#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004860 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004861 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004862#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004863
Jerry Yu24c0ec32021-09-09 14:21:07 +08004864#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004865 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004866 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004867#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004868
4869 default:
4870 break;
4871 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004872 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004873}
XiaokangQian647719a2021-12-07 09:16:29 +00004874
Jerry Yu148165c2021-09-24 23:20:59 +08004875#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004876
Gabor Mezei078e8032022-04-27 21:17:56 +02004877#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4878/* mbedtls_ssl_parse_sig_alg_ext()
4879 *
4880 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4881 * value (TLS 1.3 RFC8446):
4882 * enum {
4883 * ....
4884 * ecdsa_secp256r1_sha256( 0x0403 ),
4885 * ecdsa_secp384r1_sha384( 0x0503 ),
4886 * ecdsa_secp521r1_sha512( 0x0603 ),
4887 * ....
4888 * } SignatureScheme;
4889 *
4890 * struct {
4891 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4892 * } SignatureSchemeList;
4893 *
4894 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4895 * value (TLS 1.2 RFC5246):
4896 * enum {
4897 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4898 * sha512(6), (255)
4899 * } HashAlgorithm;
4900 *
4901 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4902 * SignatureAlgorithm;
4903 *
4904 * struct {
4905 * HashAlgorithm hash;
4906 * SignatureAlgorithm signature;
4907 * } SignatureAndHashAlgorithm;
4908 *
4909 * SignatureAndHashAlgorithm
4910 * supported_signature_algorithms<2..2^16-2>;
4911 *
4912 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4913 * generalization of the TLS 1.2 signature algorithm extension.
4914 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4915 * `SignatureScheme` field of TLS 1.3
4916 *
4917 */
4918int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4919 const unsigned char *buf,
4920 const unsigned char *end )
4921{
4922 const unsigned char *p = buf;
4923 size_t supported_sig_algs_len = 0;
4924 const unsigned char *supported_sig_algs_end;
4925 uint16_t sig_alg;
4926 uint32_t common_idx = 0;
4927
4928 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4929 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4930 p += 2;
4931
4932 memset( ssl->handshake->received_sig_algs, 0,
4933 sizeof(ssl->handshake->received_sig_algs) );
4934
4935 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4936 supported_sig_algs_end = p + supported_sig_algs_len;
4937 while( p < supported_sig_algs_end )
4938 {
4939 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4940 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4941 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004942 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4943 sig_alg,
4944 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02004945
4946 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) ||
4947 ! mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) )
4948 continue;
4949
Jerry Yuf3b46b52022-06-19 16:52:27 +08004950 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
4951 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
4952
Gabor Mezei078e8032022-04-27 21:17:56 +02004953 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4954 {
4955 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4956 common_idx += 1;
4957 }
4958 }
4959 /* Check that we consumed all the message. */
4960 if( p != end )
4961 {
4962 MBEDTLS_SSL_DEBUG_MSG( 1,
4963 ( "Signature algorithms extension length misaligned" ) );
4964 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4965 MBEDTLS_ERR_SSL_DECODE_ERROR );
4966 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4967 }
4968
4969 if( common_idx == 0 )
4970 {
4971 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
4972 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
4973 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4974 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4975 }
4976
Gabor Mezei15b95a62022-05-09 16:37:58 +02004977 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02004978 return( 0 );
4979}
4980
4981#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4982
Jerry Yudc7bd172022-02-17 13:44:15 +08004983#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4984
4985#if defined(MBEDTLS_USE_PSA_CRYPTO)
4986
4987static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4988 mbedtls_svc_key_id_t key,
4989 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004990 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004991 const unsigned char* seed, size_t seed_length,
4992 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004993 const unsigned char* other_secret,
4994 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004995 size_t capacity )
4996{
4997 psa_status_t status;
4998
4999 status = psa_key_derivation_setup( derivation, alg );
5000 if( status != PSA_SUCCESS )
5001 return( status );
5002
5003 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5004 {
5005 status = psa_key_derivation_input_bytes( derivation,
5006 PSA_KEY_DERIVATION_INPUT_SEED,
5007 seed, seed_length );
5008 if( status != PSA_SUCCESS )
5009 return( status );
5010
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005011 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005012 {
5013 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005014 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5015 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005016 if( status != PSA_SUCCESS )
5017 return( status );
5018 }
5019
Jerry Yudc7bd172022-02-17 13:44:15 +08005020 if( mbedtls_svc_key_id_is_null( key ) )
5021 {
5022 status = psa_key_derivation_input_bytes(
5023 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005024 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005025 }
5026 else
5027 {
5028 status = psa_key_derivation_input_key(
5029 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5030 }
5031 if( status != PSA_SUCCESS )
5032 return( status );
5033
5034 status = psa_key_derivation_input_bytes( derivation,
5035 PSA_KEY_DERIVATION_INPUT_LABEL,
5036 label, label_length );
5037 if( status != PSA_SUCCESS )
5038 return( status );
5039 }
5040 else
5041 {
5042 return( PSA_ERROR_NOT_SUPPORTED );
5043 }
5044
5045 status = psa_key_derivation_set_capacity( derivation, capacity );
5046 if( status != PSA_SUCCESS )
5047 return( status );
5048
5049 return( PSA_SUCCESS );
5050}
5051
5052static int tls_prf_generic( mbedtls_md_type_t md_type,
5053 const unsigned char *secret, size_t slen,
5054 const char *label,
5055 const unsigned char *random, size_t rlen,
5056 unsigned char *dstbuf, size_t dlen )
5057{
5058 psa_status_t status;
5059 psa_algorithm_t alg;
5060 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5061 psa_key_derivation_operation_t derivation =
5062 PSA_KEY_DERIVATION_OPERATION_INIT;
5063
5064 if( md_type == MBEDTLS_MD_SHA384 )
5065 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5066 else
5067 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5068
5069 /* Normally a "secret" should be long enough to be impossible to
5070 * find by brute force, and in particular should not be empty. But
5071 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5072 * and for this use case it makes sense to have a 0-length "secret".
5073 * Since the key API doesn't allow importing a key of length 0,
5074 * keep master_key=0, which setup_psa_key_derivation() understands
5075 * to mean a 0-length "secret" input. */
5076 if( slen != 0 )
5077 {
5078 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5079 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5080 psa_set_key_algorithm( &key_attributes, alg );
5081 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5082
5083 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5084 if( status != PSA_SUCCESS )
5085 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5086 }
5087
5088 status = setup_psa_key_derivation( &derivation,
5089 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005090 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005091 random, rlen,
5092 (unsigned char const *) label,
5093 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005094 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005095 dlen );
5096 if( status != PSA_SUCCESS )
5097 {
5098 psa_key_derivation_abort( &derivation );
5099 psa_destroy_key( master_key );
5100 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5101 }
5102
5103 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5104 if( status != PSA_SUCCESS )
5105 {
5106 psa_key_derivation_abort( &derivation );
5107 psa_destroy_key( master_key );
5108 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5109 }
5110
5111 status = psa_key_derivation_abort( &derivation );
5112 if( status != PSA_SUCCESS )
5113 {
5114 psa_destroy_key( master_key );
5115 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5116 }
5117
5118 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5119 status = psa_destroy_key( master_key );
5120 if( status != PSA_SUCCESS )
5121 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5122
5123 return( 0 );
5124}
5125
5126#else /* MBEDTLS_USE_PSA_CRYPTO */
5127
5128static int tls_prf_generic( mbedtls_md_type_t md_type,
5129 const unsigned char *secret, size_t slen,
5130 const char *label,
5131 const unsigned char *random, size_t rlen,
5132 unsigned char *dstbuf, size_t dlen )
5133{
5134 size_t nb;
5135 size_t i, j, k, md_len;
5136 unsigned char *tmp;
5137 size_t tmp_len = 0;
5138 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5139 const mbedtls_md_info_t *md_info;
5140 mbedtls_md_context_t md_ctx;
5141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5142
5143 mbedtls_md_init( &md_ctx );
5144
5145 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5146 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5147
5148 md_len = mbedtls_md_get_size( md_info );
5149
5150 tmp_len = md_len + strlen( label ) + rlen;
5151 tmp = mbedtls_calloc( 1, tmp_len );
5152 if( tmp == NULL )
5153 {
5154 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5155 goto exit;
5156 }
5157
5158 nb = strlen( label );
5159 memcpy( tmp + md_len, label, nb );
5160 memcpy( tmp + md_len + nb, random, rlen );
5161 nb += rlen;
5162
5163 /*
5164 * Compute P_<hash>(secret, label + random)[0..dlen]
5165 */
5166 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5167 goto exit;
5168
5169 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5170 if( ret != 0 )
5171 goto exit;
5172 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5173 if( ret != 0 )
5174 goto exit;
5175 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5176 if( ret != 0 )
5177 goto exit;
5178
5179 for( i = 0; i < dlen; i += md_len )
5180 {
5181 ret = mbedtls_md_hmac_reset ( &md_ctx );
5182 if( ret != 0 )
5183 goto exit;
5184 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5185 if( ret != 0 )
5186 goto exit;
5187 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5188 if( ret != 0 )
5189 goto exit;
5190
5191 ret = mbedtls_md_hmac_reset ( &md_ctx );
5192 if( ret != 0 )
5193 goto exit;
5194 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5195 if( ret != 0 )
5196 goto exit;
5197 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5198 if( ret != 0 )
5199 goto exit;
5200
5201 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5202
5203 for( j = 0; j < k; j++ )
5204 dstbuf[i + j] = h_i[j];
5205 }
5206
5207exit:
5208 mbedtls_md_free( &md_ctx );
5209
5210 mbedtls_platform_zeroize( tmp, tmp_len );
5211 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5212
5213 mbedtls_free( tmp );
5214
5215 return( ret );
5216}
5217#endif /* MBEDTLS_USE_PSA_CRYPTO */
5218
5219#if defined(MBEDTLS_SHA256_C)
5220static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5221 const char *label,
5222 const unsigned char *random, size_t rlen,
5223 unsigned char *dstbuf, size_t dlen )
5224{
5225 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5226 label, random, rlen, dstbuf, dlen ) );
5227}
5228#endif /* MBEDTLS_SHA256_C */
5229
5230#if defined(MBEDTLS_SHA384_C)
5231static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5232 const char *label,
5233 const unsigned char *random, size_t rlen,
5234 unsigned char *dstbuf, size_t dlen )
5235{
5236 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5237 label, random, rlen, dstbuf, dlen ) );
5238}
5239#endif /* MBEDTLS_SHA384_C */
5240
Jerry Yuf009d862022-02-17 14:01:37 +08005241/*
5242 * Set appropriate PRF function and other SSL / TLS1.2 functions
5243 *
5244 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005245 * - hash associated with the ciphersuite (only used by TLS 1.2)
5246 *
5247 * Outputs:
5248 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5249 */
5250static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005251 mbedtls_md_type_t hash )
5252{
Jerry Yuf009d862022-02-17 14:01:37 +08005253#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005254 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005255 {
5256 handshake->tls_prf = tls_prf_sha384;
5257 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5258 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5259 }
5260 else
5261#endif
5262#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005263 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005264 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005265 handshake->tls_prf = tls_prf_sha256;
5266 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5267 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5268 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005269#else
Jerry Yuf009d862022-02-17 14:01:37 +08005270 {
Jerry Yuf009d862022-02-17 14:01:37 +08005271 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005272 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005273 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5274 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005275#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005276
5277 return( 0 );
5278}
Jerry Yud6ab2352022-02-17 14:03:43 +08005279
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005280/*
5281 * Compute master secret if needed
5282 *
5283 * Parameters:
5284 * [in/out] handshake
5285 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5286 * (PSA-PSK) ciphersuite_info, psk_opaque
5287 * [out] premaster (cleared)
5288 * [out] master
5289 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5290 * debug: conf->f_dbg, conf->p_dbg
5291 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005292 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005293 */
5294static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5295 unsigned char *master,
5296 const mbedtls_ssl_context *ssl )
5297{
5298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5299
5300 /* cf. RFC 5246, Section 8.1:
5301 * "The master secret is always exactly 48 bytes in length." */
5302 size_t const master_secret_len = 48;
5303
5304#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5305 unsigned char session_hash[48];
5306#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5307
5308 /* The label for the KDF used for key expansion.
5309 * This is either "master secret" or "extended master secret"
5310 * depending on whether the Extended Master Secret extension
5311 * is used. */
5312 char const *lbl = "master secret";
5313
Przemek Stekielae4ed302022-04-05 17:15:55 +02005314 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005315 * - If the Extended Master Secret extension is not used,
5316 * this is ClientHello.Random + ServerHello.Random
5317 * (see Sect. 8.1 in RFC 5246).
5318 * - If the Extended Master Secret extension is used,
5319 * this is the transcript of the handshake so far.
5320 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005321 unsigned char const *seed = handshake->randbytes;
5322 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005323
5324#if !defined(MBEDTLS_DEBUG_C) && \
5325 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5326 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5327 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5328 ssl = NULL; /* make sure we don't use it except for those cases */
5329 (void) ssl;
5330#endif
5331
5332 if( handshake->resume != 0 )
5333 {
5334 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5335 return( 0 );
5336 }
5337
5338#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5339 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5340 {
5341 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005342 seed = session_hash;
5343 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005344
5345 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005346 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005347 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005348#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005349
Przemek Stekiel99114f32022-04-22 11:20:09 +02005350#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005351 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005352 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005353 {
5354 /* Perform PSK-to-MS expansion in a single step. */
5355 psa_status_t status;
5356 psa_algorithm_t alg;
5357 mbedtls_svc_key_id_t psk;
5358 psa_key_derivation_operation_t derivation =
5359 PSA_KEY_DERIVATION_OPERATION_INIT;
5360 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5361
5362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5363
5364 psk = mbedtls_ssl_get_opaque_psk( ssl );
5365
5366 if( hash_alg == MBEDTLS_MD_SHA384 )
5367 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5368 else
5369 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5370
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005371 size_t other_secret_len = 0;
5372 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005373
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005374 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005375 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005376 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005377 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005378 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005379 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005380 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005381 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005382 other_secret_len = 48;
5383 other_secret = handshake->premaster + 2;
5384 break;
5385 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005386 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005387 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5388 other_secret = handshake->premaster + 2;
5389 break;
5390 default:
5391 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005392 }
5393
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005394 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005395 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005396 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005397 (unsigned char const *) lbl,
5398 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005399 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005400 master_secret_len );
5401 if( status != PSA_SUCCESS )
5402 {
5403 psa_key_derivation_abort( &derivation );
5404 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5405 }
5406
5407 status = psa_key_derivation_output_bytes( &derivation,
5408 master,
5409 master_secret_len );
5410 if( status != PSA_SUCCESS )
5411 {
5412 psa_key_derivation_abort( &derivation );
5413 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5414 }
5415
5416 status = psa_key_derivation_abort( &derivation );
5417 if( status != PSA_SUCCESS )
5418 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5419 }
5420 else
5421#endif
5422 {
5423 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005424 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005425 master,
5426 master_secret_len );
5427 if( ret != 0 )
5428 {
5429 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5430 return( ret );
5431 }
5432
5433 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5434 handshake->premaster,
5435 handshake->pmslen );
5436
5437 mbedtls_platform_zeroize( handshake->premaster,
5438 sizeof(handshake->premaster) );
5439 }
5440
5441 return( 0 );
5442}
5443
Jerry Yud62f87e2022-02-17 14:09:02 +08005444int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5445{
5446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5447 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5448 ssl->handshake->ciphersuite_info;
5449
5450 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5451
5452 /* Set PRF, calc_verify and calc_finished function pointers */
5453 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005454 ciphersuite_info->mac );
5455 if( ret != 0 )
5456 {
5457 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5458 return( ret );
5459 }
5460
5461 /* Compute master secret if needed */
5462 ret = ssl_compute_master( ssl->handshake,
5463 ssl->session_negotiate->master,
5464 ssl );
5465 if( ret != 0 )
5466 {
5467 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5468 return( ret );
5469 }
5470
5471 /* Swap the client and server random values:
5472 * - MS derivation wanted client+server (RFC 5246 8.1)
5473 * - key derivation wants server+client (RFC 5246 6.3) */
5474 {
5475 unsigned char tmp[64];
5476 memcpy( tmp, ssl->handshake->randbytes, 64 );
5477 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5478 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5479 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5480 }
5481
5482 /* Populate transform structure */
5483 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5484 ssl->session_negotiate->ciphersuite,
5485 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005486#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005487 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005488#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005489 ssl->handshake->tls_prf,
5490 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005491 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005492 ssl->conf->endpoint,
5493 ssl );
5494 if( ret != 0 )
5495 {
5496 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5497 return( ret );
5498 }
5499
5500 /* We no longer need Server/ClientHello.random values */
5501 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5502 sizeof( ssl->handshake->randbytes ) );
5503
5504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5505
5506 return( 0 );
5507}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005508
Ronald Cron4dcbca92022-03-07 10:21:40 +01005509int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5510{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005511 switch( md )
5512 {
5513#if defined(MBEDTLS_SHA384_C)
5514 case MBEDTLS_SSL_HASH_SHA384:
5515 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5516 break;
5517#endif
5518#if defined(MBEDTLS_SHA256_C)
5519 case MBEDTLS_SSL_HASH_SHA256:
5520 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5521 break;
5522#endif
5523 default:
5524 return( -1 );
5525 }
5526
Ronald Cronc2f13a02022-03-07 10:25:24 +01005527 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005528}
5529
Jerry Yu8392e0d2022-02-17 14:10:24 +08005530#if defined(MBEDTLS_SHA256_C)
5531void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5532 unsigned char *hash,
5533 size_t *hlen )
5534{
5535#if defined(MBEDTLS_USE_PSA_CRYPTO)
5536 size_t hash_size;
5537 psa_status_t status;
5538 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5539
5540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5541 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5542 if( status != PSA_SUCCESS )
5543 {
5544 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5545 return;
5546 }
5547
5548 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5549 if( status != PSA_SUCCESS )
5550 {
5551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5552 return;
5553 }
5554
5555 *hlen = 32;
5556 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5558#else
5559 mbedtls_sha256_context sha256;
5560
5561 mbedtls_sha256_init( &sha256 );
5562
5563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5564
5565 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5566 mbedtls_sha256_finish( &sha256, hash );
5567
5568 *hlen = 32;
5569
5570 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5571 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5572
5573 mbedtls_sha256_free( &sha256 );
5574#endif /* MBEDTLS_USE_PSA_CRYPTO */
5575 return;
5576}
5577#endif /* MBEDTLS_SHA256_C */
5578
Jerry Yuc1cb3842022-02-17 14:13:48 +08005579#if defined(MBEDTLS_SHA384_C)
5580void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5581 unsigned char *hash,
5582 size_t *hlen )
5583{
5584#if defined(MBEDTLS_USE_PSA_CRYPTO)
5585 size_t hash_size;
5586 psa_status_t status;
5587 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5588
5589 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5590 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5591 if( status != PSA_SUCCESS )
5592 {
5593 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5594 return;
5595 }
5596
5597 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5598 if( status != PSA_SUCCESS )
5599 {
5600 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5601 return;
5602 }
5603
5604 *hlen = 48;
5605 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5607#else
5608 mbedtls_sha512_context sha512;
5609
5610 mbedtls_sha512_init( &sha512 );
5611
5612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5613
5614 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5615 mbedtls_sha512_finish( &sha512, hash );
5616
5617 *hlen = 48;
5618
5619 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5620 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5621
5622 mbedtls_sha512_free( &sha512 );
5623#endif /* MBEDTLS_USE_PSA_CRYPTO */
5624 return;
5625}
5626#endif /* MBEDTLS_SHA384_C */
5627
Neil Armstrong80f6f322022-05-03 17:56:38 +02005628#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5629 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005630int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5631{
5632 unsigned char *p = ssl->handshake->premaster;
5633 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5634 const unsigned char *psk = NULL;
5635 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005636 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005637
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005638 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005639 {
5640 /*
5641 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005642 * checked before calling this function.
5643 *
5644 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005645 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005646 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005647 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5648 {
5649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5650 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5651 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005652 }
5653
5654 /*
5655 * PMS = struct {
5656 * opaque other_secret<0..2^16-1>;
5657 * opaque psk<0..2^16-1>;
5658 * };
5659 * with "other_secret" depending on the particular key exchange
5660 */
5661#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5662 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5663 {
5664 if( end - p < 2 )
5665 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5666
5667 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5668 p += 2;
5669
5670 if( end < p || (size_t)( end - p ) < psk_len )
5671 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5672
5673 memset( p, 0, psk_len );
5674 p += psk_len;
5675 }
5676 else
5677#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5678#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5679 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5680 {
5681 /*
5682 * other_secret already set by the ClientKeyExchange message,
5683 * and is 48 bytes long
5684 */
5685 if( end - p < 2 )
5686 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5687
5688 *p++ = 0;
5689 *p++ = 48;
5690 p += 48;
5691 }
5692 else
5693#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5694#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5695 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5696 {
5697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5698 size_t len;
5699
5700 /* Write length only when we know the actual value */
5701 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5702 p + 2, end - ( p + 2 ), &len,
5703 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5704 {
5705 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5706 return( ret );
5707 }
5708 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5709 p += 2 + len;
5710
5711 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5712 }
5713 else
5714#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005715#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005716 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5717 {
5718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5719 size_t zlen;
5720
5721 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5722 p + 2, end - ( p + 2 ),
5723 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5724 {
5725 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5726 return( ret );
5727 }
5728
5729 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5730 p += 2 + zlen;
5731
5732 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5733 MBEDTLS_DEBUG_ECDH_Z );
5734 }
5735 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005736#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005737 {
5738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5739 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5740 }
5741
5742 /* opaque psk<0..2^16-1>; */
5743 if( end - p < 2 )
5744 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5745
5746 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5747 p += 2;
5748
5749 if( end < p || (size_t)( end - p ) < psk_len )
5750 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5751
5752 memcpy( p, psk, psk_len );
5753 p += psk_len;
5754
5755 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5756
5757 return( 0 );
5758}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005759#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005760
5761#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5762static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5763
5764#if defined(MBEDTLS_SSL_PROTO_DTLS)
5765int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5766{
5767 /* If renegotiation is not enforced, retransmit until we would reach max
5768 * timeout if we were using the usual handshake doubling scheme */
5769 if( ssl->conf->renego_max_records < 0 )
5770 {
5771 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5772 unsigned char doublings = 1;
5773
5774 while( ratio != 0 )
5775 {
5776 ++doublings;
5777 ratio >>= 1;
5778 }
5779
5780 if( ++ssl->renego_records_seen > doublings )
5781 {
5782 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5783 return( 0 );
5784 }
5785 }
5786
5787 return( ssl_write_hello_request( ssl ) );
5788}
5789#endif
5790#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005791
Jerry Yud9526692022-02-17 14:23:47 +08005792/*
5793 * Handshake functions
5794 */
5795#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5796/* No certificate support -> dummy functions */
5797int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5798{
5799 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5800 ssl->handshake->ciphersuite_info;
5801
5802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5803
5804 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5805 {
5806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5807 ssl->state++;
5808 return( 0 );
5809 }
5810
5811 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5812 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5813}
5814
5815int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5816{
5817 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5818 ssl->handshake->ciphersuite_info;
5819
5820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5821
5822 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5823 {
5824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5825 ssl->state++;
5826 return( 0 );
5827 }
5828
5829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5830 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5831}
5832
5833#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5834/* Some certificate support -> implement write and parse */
5835
5836int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5837{
5838 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5839 size_t i, n;
5840 const mbedtls_x509_crt *crt;
5841 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5842 ssl->handshake->ciphersuite_info;
5843
5844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5845
5846 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5847 {
5848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5849 ssl->state++;
5850 return( 0 );
5851 }
5852
5853#if defined(MBEDTLS_SSL_CLI_C)
5854 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5855 {
5856 if( ssl->handshake->client_auth == 0 )
5857 {
5858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5859 ssl->state++;
5860 return( 0 );
5861 }
5862 }
5863#endif /* MBEDTLS_SSL_CLI_C */
5864#if defined(MBEDTLS_SSL_SRV_C)
5865 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5866 {
5867 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5868 {
5869 /* Should never happen because we shouldn't have picked the
5870 * ciphersuite if we don't have a certificate. */
5871 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5872 }
5873 }
5874#endif
5875
5876 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5877
5878 /*
5879 * 0 . 0 handshake type
5880 * 1 . 3 handshake length
5881 * 4 . 6 length of all certs
5882 * 7 . 9 length of cert. 1
5883 * 10 . n-1 peer certificate
5884 * n . n+2 length of cert. 2
5885 * n+3 . ... upper level cert, etc.
5886 */
5887 i = 7;
5888 crt = mbedtls_ssl_own_cert( ssl );
5889
5890 while( crt != NULL )
5891 {
5892 n = crt->raw.len;
5893 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5894 {
5895 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5896 " > %" MBEDTLS_PRINTF_SIZET,
5897 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5898 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5899 }
5900
5901 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5902 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5903 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5904
5905 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5906 i += n; crt = crt->next;
5907 }
5908
5909 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5910 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5911 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5912
5913 ssl->out_msglen = i;
5914 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5915 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5916
5917 ssl->state++;
5918
5919 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5920 {
5921 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5922 return( ret );
5923 }
5924
5925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5926
5927 return( ret );
5928}
5929
5930#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5931
5932#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5933static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5934 unsigned char *crt_buf,
5935 size_t crt_buf_len )
5936{
5937 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5938
5939 if( peer_crt == NULL )
5940 return( -1 );
5941
5942 if( peer_crt->raw.len != crt_buf_len )
5943 return( -1 );
5944
5945 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5946}
5947#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5948static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5949 unsigned char *crt_buf,
5950 size_t crt_buf_len )
5951{
5952 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5953 unsigned char const * const peer_cert_digest =
5954 ssl->session->peer_cert_digest;
5955 mbedtls_md_type_t const peer_cert_digest_type =
5956 ssl->session->peer_cert_digest_type;
5957 mbedtls_md_info_t const * const digest_info =
5958 mbedtls_md_info_from_type( peer_cert_digest_type );
5959 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5960 size_t digest_len;
5961
5962 if( peer_cert_digest == NULL || digest_info == NULL )
5963 return( -1 );
5964
5965 digest_len = mbedtls_md_get_size( digest_info );
5966 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5967 return( -1 );
5968
5969 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5970 if( ret != 0 )
5971 return( -1 );
5972
5973 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5974}
5975#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5976#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5977
5978/*
5979 * Once the certificate message is read, parse it into a cert chain and
5980 * perform basic checks, but leave actual verification to the caller
5981 */
5982static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5983 mbedtls_x509_crt *chain )
5984{
5985 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5986#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5987 int crt_cnt=0;
5988#endif
5989 size_t i, n;
5990 uint8_t alert;
5991
5992 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5993 {
5994 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5995 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5996 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5997 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5998 }
5999
6000 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6001 {
6002 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6003 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6004 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6005 }
6006
6007 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6008 {
6009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6010 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6011 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6012 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6013 }
6014
6015 i = mbedtls_ssl_hs_hdr_len( ssl );
6016
6017 /*
6018 * Same message structure as in mbedtls_ssl_write_certificate()
6019 */
6020 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6021
6022 if( ssl->in_msg[i] != 0 ||
6023 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6024 {
6025 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6026 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6027 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6028 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6029 }
6030
6031 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6032 i += 3;
6033
6034 /* Iterate through and parse the CRTs in the provided chain. */
6035 while( i < ssl->in_hslen )
6036 {
6037 /* Check that there's room for the next CRT's length fields. */
6038 if ( i + 3 > ssl->in_hslen ) {
6039 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6040 mbedtls_ssl_send_alert_message( ssl,
6041 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6042 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6043 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6044 }
6045 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6046 * anything beyond 2**16 ~ 64K. */
6047 if( ssl->in_msg[i] != 0 )
6048 {
6049 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6050 mbedtls_ssl_send_alert_message( ssl,
6051 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6052 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6053 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6054 }
6055
6056 /* Read length of the next CRT in the chain. */
6057 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6058 | (unsigned int) ssl->in_msg[i + 2];
6059 i += 3;
6060
6061 if( n < 128 || i + n > ssl->in_hslen )
6062 {
6063 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6064 mbedtls_ssl_send_alert_message( ssl,
6065 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6066 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6067 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6068 }
6069
6070 /* Check if we're handling the first CRT in the chain. */
6071#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6072 if( crt_cnt++ == 0 &&
6073 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6074 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6075 {
6076 /* During client-side renegotiation, check that the server's
6077 * end-CRTs hasn't changed compared to the initial handshake,
6078 * mitigating the triple handshake attack. On success, reuse
6079 * the original end-CRT instead of parsing it again. */
6080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6081 if( ssl_check_peer_crt_unchanged( ssl,
6082 &ssl->in_msg[i],
6083 n ) != 0 )
6084 {
6085 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6086 mbedtls_ssl_send_alert_message( ssl,
6087 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6088 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6089 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6090 }
6091
6092 /* Now we can safely free the original chain. */
6093 ssl_clear_peer_cert( ssl->session );
6094 }
6095#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6096
6097 /* Parse the next certificate in the chain. */
6098#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6099 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6100#else
6101 /* If we don't need to store the CRT chain permanently, parse
6102 * it in-place from the input buffer instead of making a copy. */
6103 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6104#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6105 switch( ret )
6106 {
6107 case 0: /*ok*/
6108 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6109 /* Ignore certificate with an unknown algorithm: maybe a
6110 prior certificate was already trusted. */
6111 break;
6112
6113 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6114 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6115 goto crt_parse_der_failed;
6116
6117 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6118 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6119 goto crt_parse_der_failed;
6120
6121 default:
6122 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6123 crt_parse_der_failed:
6124 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6125 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6126 return( ret );
6127 }
6128
6129 i += n;
6130 }
6131
6132 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6133 return( 0 );
6134}
6135
6136#if defined(MBEDTLS_SSL_SRV_C)
6137static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6138{
6139 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6140 return( -1 );
6141
6142 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6143 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6144 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6145 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6146 {
Ronald Cron19385882022-06-15 16:26:13 +02006147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006148 return( 0 );
6149 }
6150 return( -1 );
6151}
6152#endif /* MBEDTLS_SSL_SRV_C */
6153
6154/* Check if a certificate message is expected.
6155 * Return either
6156 * - SSL_CERTIFICATE_EXPECTED, or
6157 * - SSL_CERTIFICATE_SKIP
6158 * indicating whether a Certificate message is expected or not.
6159 */
6160#define SSL_CERTIFICATE_EXPECTED 0
6161#define SSL_CERTIFICATE_SKIP 1
6162static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6163 int authmode )
6164{
6165 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6166 ssl->handshake->ciphersuite_info;
6167
6168 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6169 return( SSL_CERTIFICATE_SKIP );
6170
6171#if defined(MBEDTLS_SSL_SRV_C)
6172 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6173 {
6174 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6175 return( SSL_CERTIFICATE_SKIP );
6176
6177 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6178 {
6179 ssl->session_negotiate->verify_result =
6180 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6181 return( SSL_CERTIFICATE_SKIP );
6182 }
6183 }
6184#else
6185 ((void) authmode);
6186#endif /* MBEDTLS_SSL_SRV_C */
6187
6188 return( SSL_CERTIFICATE_EXPECTED );
6189}
6190
6191static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6192 int authmode,
6193 mbedtls_x509_crt *chain,
6194 void *rs_ctx )
6195{
6196 int ret = 0;
6197 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6198 ssl->handshake->ciphersuite_info;
6199 int have_ca_chain = 0;
6200
6201 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6202 void *p_vrfy;
6203
6204 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6205 return( 0 );
6206
6207 if( ssl->f_vrfy != NULL )
6208 {
6209 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6210 f_vrfy = ssl->f_vrfy;
6211 p_vrfy = ssl->p_vrfy;
6212 }
6213 else
6214 {
6215 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6216 f_vrfy = ssl->conf->f_vrfy;
6217 p_vrfy = ssl->conf->p_vrfy;
6218 }
6219
6220 /*
6221 * Main check: verify certificate
6222 */
6223#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6224 if( ssl->conf->f_ca_cb != NULL )
6225 {
6226 ((void) rs_ctx);
6227 have_ca_chain = 1;
6228
6229 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6230 ret = mbedtls_x509_crt_verify_with_ca_cb(
6231 chain,
6232 ssl->conf->f_ca_cb,
6233 ssl->conf->p_ca_cb,
6234 ssl->conf->cert_profile,
6235 ssl->hostname,
6236 &ssl->session_negotiate->verify_result,
6237 f_vrfy, p_vrfy );
6238 }
6239 else
6240#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6241 {
6242 mbedtls_x509_crt *ca_chain;
6243 mbedtls_x509_crl *ca_crl;
6244
6245#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6246 if( ssl->handshake->sni_ca_chain != NULL )
6247 {
6248 ca_chain = ssl->handshake->sni_ca_chain;
6249 ca_crl = ssl->handshake->sni_ca_crl;
6250 }
6251 else
6252#endif
6253 {
6254 ca_chain = ssl->conf->ca_chain;
6255 ca_crl = ssl->conf->ca_crl;
6256 }
6257
6258 if( ca_chain != NULL )
6259 have_ca_chain = 1;
6260
6261 ret = mbedtls_x509_crt_verify_restartable(
6262 chain,
6263 ca_chain, ca_crl,
6264 ssl->conf->cert_profile,
6265 ssl->hostname,
6266 &ssl->session_negotiate->verify_result,
6267 f_vrfy, p_vrfy, rs_ctx );
6268 }
6269
6270 if( ret != 0 )
6271 {
6272 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6273 }
6274
6275#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6276 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6277 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6278#endif
6279
6280 /*
6281 * Secondary checks: always done, but change 'ret' only if it was 0
6282 */
6283
6284#if defined(MBEDTLS_ECP_C)
6285 {
6286 const mbedtls_pk_context *pk = &chain->pk;
6287
6288 /* If certificate uses an EC key, make sure the curve is OK */
6289 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6290 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6291 {
6292 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6293
6294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6295 if( ret == 0 )
6296 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6297 }
6298 }
6299#endif /* MBEDTLS_ECP_C */
6300
6301 if( mbedtls_ssl_check_cert_usage( chain,
6302 ciphersuite_info,
6303 ! ssl->conf->endpoint,
6304 &ssl->session_negotiate->verify_result ) != 0 )
6305 {
6306 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6307 if( ret == 0 )
6308 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6309 }
6310
6311 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6312 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6313 * with details encoded in the verification flags. All other kinds
6314 * of error codes, including those from the user provided f_vrfy
6315 * functions, are treated as fatal and lead to a failure of
6316 * ssl_parse_certificate even if verification was optional. */
6317 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6318 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6319 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6320 {
6321 ret = 0;
6322 }
6323
6324 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6325 {
6326 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6327 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6328 }
6329
6330 if( ret != 0 )
6331 {
6332 uint8_t alert;
6333
6334 /* The certificate may have been rejected for several reasons.
6335 Pick one and send the corresponding alert. Which alert to send
6336 may be a subject of debate in some cases. */
6337 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6338 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6339 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6340 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6341 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6342 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6343 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6344 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6345 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6346 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6347 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6348 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6349 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6350 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6351 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6352 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6353 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6354 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6355 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6356 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6357 else
6358 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6359 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6360 alert );
6361 }
6362
6363#if defined(MBEDTLS_DEBUG_C)
6364 if( ssl->session_negotiate->verify_result != 0 )
6365 {
6366 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6367 (unsigned int) ssl->session_negotiate->verify_result ) );
6368 }
6369 else
6370 {
6371 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6372 }
6373#endif /* MBEDTLS_DEBUG_C */
6374
6375 return( ret );
6376}
6377
6378#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6379static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6380 unsigned char *start, size_t len )
6381{
6382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6383 /* Remember digest of the peer's end-CRT. */
6384 ssl->session_negotiate->peer_cert_digest =
6385 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6386 if( ssl->session_negotiate->peer_cert_digest == NULL )
6387 {
6388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6389 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6390 mbedtls_ssl_send_alert_message( ssl,
6391 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6392 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6393
6394 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6395 }
6396
6397 ret = mbedtls_md( mbedtls_md_info_from_type(
6398 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6399 start, len,
6400 ssl->session_negotiate->peer_cert_digest );
6401
6402 ssl->session_negotiate->peer_cert_digest_type =
6403 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6404 ssl->session_negotiate->peer_cert_digest_len =
6405 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6406
6407 return( ret );
6408}
6409
6410static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6411 unsigned char *start, size_t len )
6412{
6413 unsigned char *end = start + len;
6414 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6415
6416 /* Make a copy of the peer's raw public key. */
6417 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6418 ret = mbedtls_pk_parse_subpubkey( &start, end,
6419 &ssl->handshake->peer_pubkey );
6420 if( ret != 0 )
6421 {
6422 /* We should have parsed the public key before. */
6423 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6424 }
6425
6426 return( 0 );
6427}
6428#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6429
6430int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6431{
6432 int ret = 0;
6433 int crt_expected;
6434#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6435 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6436 ? ssl->handshake->sni_authmode
6437 : ssl->conf->authmode;
6438#else
6439 const int authmode = ssl->conf->authmode;
6440#endif
6441 void *rs_ctx = NULL;
6442 mbedtls_x509_crt *chain = NULL;
6443
6444 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6445
6446 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6447 if( crt_expected == SSL_CERTIFICATE_SKIP )
6448 {
6449 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6450 goto exit;
6451 }
6452
6453#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6454 if( ssl->handshake->ecrs_enabled &&
6455 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6456 {
6457 chain = ssl->handshake->ecrs_peer_cert;
6458 ssl->handshake->ecrs_peer_cert = NULL;
6459 goto crt_verify;
6460 }
6461#endif
6462
6463 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6464 {
6465 /* mbedtls_ssl_read_record may have sent an alert already. We
6466 let it decide whether to alert. */
6467 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6468 goto exit;
6469 }
6470
6471#if defined(MBEDTLS_SSL_SRV_C)
6472 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6473 {
6474 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6475
6476 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6477 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6478
6479 goto exit;
6480 }
6481#endif /* MBEDTLS_SSL_SRV_C */
6482
6483 /* Clear existing peer CRT structure in case we tried to
6484 * reuse a session but it failed, and allocate a new one. */
6485 ssl_clear_peer_cert( ssl->session_negotiate );
6486
6487 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6488 if( chain == NULL )
6489 {
6490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6491 sizeof( mbedtls_x509_crt ) ) );
6492 mbedtls_ssl_send_alert_message( ssl,
6493 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6494 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6495
6496 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6497 goto exit;
6498 }
6499 mbedtls_x509_crt_init( chain );
6500
6501 ret = ssl_parse_certificate_chain( ssl, chain );
6502 if( ret != 0 )
6503 goto exit;
6504
6505#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6506 if( ssl->handshake->ecrs_enabled)
6507 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6508
6509crt_verify:
6510 if( ssl->handshake->ecrs_enabled)
6511 rs_ctx = &ssl->handshake->ecrs_ctx;
6512#endif
6513
6514 ret = ssl_parse_certificate_verify( ssl, authmode,
6515 chain, rs_ctx );
6516 if( ret != 0 )
6517 goto exit;
6518
6519#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6520 {
6521 unsigned char *crt_start, *pk_start;
6522 size_t crt_len, pk_len;
6523
6524 /* We parse the CRT chain without copying, so
6525 * these pointers point into the input buffer,
6526 * and are hence still valid after freeing the
6527 * CRT chain. */
6528
6529 crt_start = chain->raw.p;
6530 crt_len = chain->raw.len;
6531
6532 pk_start = chain->pk_raw.p;
6533 pk_len = chain->pk_raw.len;
6534
6535 /* Free the CRT structures before computing
6536 * digest and copying the peer's public key. */
6537 mbedtls_x509_crt_free( chain );
6538 mbedtls_free( chain );
6539 chain = NULL;
6540
6541 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6542 if( ret != 0 )
6543 goto exit;
6544
6545 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6546 if( ret != 0 )
6547 goto exit;
6548 }
6549#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6550 /* Pass ownership to session structure. */
6551 ssl->session_negotiate->peer_cert = chain;
6552 chain = NULL;
6553#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6554
6555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6556
6557exit:
6558
6559 if( ret == 0 )
6560 ssl->state++;
6561
6562#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6563 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6564 {
6565 ssl->handshake->ecrs_peer_cert = chain;
6566 chain = NULL;
6567 }
6568#endif
6569
6570 if( chain != NULL )
6571 {
6572 mbedtls_x509_crt_free( chain );
6573 mbedtls_free( chain );
6574 }
6575
6576 return( ret );
6577}
6578#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6579
Jerry Yu615bd6f2022-02-17 14:25:15 +08006580#if defined(MBEDTLS_SHA256_C)
6581static void ssl_calc_finished_tls_sha256(
6582 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6583{
6584 int len = 12;
6585 const char *sender;
6586 unsigned char padbuf[32];
6587#if defined(MBEDTLS_USE_PSA_CRYPTO)
6588 size_t hash_size;
6589 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6590 psa_status_t status;
6591#else
6592 mbedtls_sha256_context sha256;
6593#endif
6594
6595 mbedtls_ssl_session *session = ssl->session_negotiate;
6596 if( !session )
6597 session = ssl->session;
6598
6599 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6600 ? "client finished"
6601 : "server finished";
6602
6603#if defined(MBEDTLS_USE_PSA_CRYPTO)
6604 sha256_psa = psa_hash_operation_init();
6605
6606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6607
6608 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6609 if( status != PSA_SUCCESS )
6610 {
6611 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6612 return;
6613 }
6614
6615 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6616 if( status != PSA_SUCCESS )
6617 {
6618 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6619 return;
6620 }
6621 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6622#else
6623
6624 mbedtls_sha256_init( &sha256 );
6625
6626 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6627
6628 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6629
6630 /*
6631 * TLSv1.2:
6632 * hash = PRF( master, finished_label,
6633 * Hash( handshake ) )[0.11]
6634 */
6635
6636#if !defined(MBEDTLS_SHA256_ALT)
6637 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6638 sha256.state, sizeof( sha256.state ) );
6639#endif
6640
6641 mbedtls_sha256_finish( &sha256, padbuf );
6642 mbedtls_sha256_free( &sha256 );
6643#endif /* MBEDTLS_USE_PSA_CRYPTO */
6644
6645 ssl->handshake->tls_prf( session->master, 48, sender,
6646 padbuf, 32, buf, len );
6647
6648 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6649
6650 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6651
6652 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6653}
6654#endif /* MBEDTLS_SHA256_C */
6655
Jerry Yub7ba49e2022-02-17 14:25:53 +08006656
6657#if defined(MBEDTLS_SHA384_C)
6658
6659static void ssl_calc_finished_tls_sha384(
6660 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6661{
6662 int len = 12;
6663 const char *sender;
6664 unsigned char padbuf[48];
6665#if defined(MBEDTLS_USE_PSA_CRYPTO)
6666 size_t hash_size;
6667 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6668 psa_status_t status;
6669#else
6670 mbedtls_sha512_context sha512;
6671#endif
6672
6673 mbedtls_ssl_session *session = ssl->session_negotiate;
6674 if( !session )
6675 session = ssl->session;
6676
6677 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6678 ? "client finished"
6679 : "server finished";
6680
6681#if defined(MBEDTLS_USE_PSA_CRYPTO)
6682 sha384_psa = psa_hash_operation_init();
6683
6684 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6685
6686 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6687 if( status != PSA_SUCCESS )
6688 {
6689 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6690 return;
6691 }
6692
6693 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6694 if( status != PSA_SUCCESS )
6695 {
6696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6697 return;
6698 }
6699 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6700#else
6701 mbedtls_sha512_init( &sha512 );
6702
6703 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6704
6705 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6706
6707 /*
6708 * TLSv1.2:
6709 * hash = PRF( master, finished_label,
6710 * Hash( handshake ) )[0.11]
6711 */
6712
6713#if !defined(MBEDTLS_SHA512_ALT)
6714 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6715 sha512.state, sizeof( sha512.state ) );
6716#endif
6717 mbedtls_sha512_finish( &sha512, padbuf );
6718
6719 mbedtls_sha512_free( &sha512 );
6720#endif
6721
6722 ssl->handshake->tls_prf( session->master, 48, sender,
6723 padbuf, 48, buf, len );
6724
6725 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6726
6727 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6728
6729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6730}
6731#endif /* MBEDTLS_SHA384_C */
6732
Jerry Yuaef00152022-02-17 14:27:31 +08006733void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6734{
6735 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6736
6737 /*
6738 * Free our handshake params
6739 */
6740 mbedtls_ssl_handshake_free( ssl );
6741 mbedtls_free( ssl->handshake );
6742 ssl->handshake = NULL;
6743
6744 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006745 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006746 */
6747 if( ssl->transform )
6748 {
6749 mbedtls_ssl_transform_free( ssl->transform );
6750 mbedtls_free( ssl->transform );
6751 }
6752 ssl->transform = ssl->transform_negotiate;
6753 ssl->transform_negotiate = NULL;
6754
6755 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6756}
6757
Jerry Yu2a9fff52022-02-17 14:28:51 +08006758void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6759{
6760 int resume = ssl->handshake->resume;
6761
6762 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6763
6764#if defined(MBEDTLS_SSL_RENEGOTIATION)
6765 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6766 {
6767 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6768 ssl->renego_records_seen = 0;
6769 }
6770#endif
6771
6772 /*
6773 * Free the previous session and switch in the current one
6774 */
6775 if( ssl->session )
6776 {
6777#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6778 /* RFC 7366 3.1: keep the EtM state */
6779 ssl->session_negotiate->encrypt_then_mac =
6780 ssl->session->encrypt_then_mac;
6781#endif
6782
6783 mbedtls_ssl_session_free( ssl->session );
6784 mbedtls_free( ssl->session );
6785 }
6786 ssl->session = ssl->session_negotiate;
6787 ssl->session_negotiate = NULL;
6788
6789 /*
6790 * Add cache entry
6791 */
6792 if( ssl->conf->f_set_cache != NULL &&
6793 ssl->session->id_len != 0 &&
6794 resume == 0 )
6795 {
6796 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6797 ssl->session->id,
6798 ssl->session->id_len,
6799 ssl->session ) != 0 )
6800 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6801 }
6802
6803#if defined(MBEDTLS_SSL_PROTO_DTLS)
6804 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6805 ssl->handshake->flight != NULL )
6806 {
6807 /* Cancel handshake timer */
6808 mbedtls_ssl_set_timer( ssl, 0 );
6809
6810 /* Keep last flight around in case we need to resend it:
6811 * we need the handshake and transform structures for that */
6812 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6813 }
6814 else
6815#endif
6816 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6817
6818 ssl->state++;
6819
6820 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6821}
6822
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006823int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6824{
6825 int ret, hash_len;
6826
6827 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6828
6829 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6830
6831 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6832
6833 /*
6834 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6835 * may define some other value. Currently (early 2016), no defined
6836 * ciphersuite does this (and this is unlikely to change as activity has
6837 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6838 */
6839 hash_len = 12;
6840
6841#if defined(MBEDTLS_SSL_RENEGOTIATION)
6842 ssl->verify_data_len = hash_len;
6843 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6844#endif
6845
6846 ssl->out_msglen = 4 + hash_len;
6847 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6848 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6849
6850 /*
6851 * In case of session resuming, invert the client and server
6852 * ChangeCipherSpec messages order.
6853 */
6854 if( ssl->handshake->resume != 0 )
6855 {
6856#if defined(MBEDTLS_SSL_CLI_C)
6857 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6858 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6859#endif
6860#if defined(MBEDTLS_SSL_SRV_C)
6861 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6862 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6863#endif
6864 }
6865 else
6866 ssl->state++;
6867
6868 /*
6869 * Switch to our negotiated transform and session parameters for outbound
6870 * data.
6871 */
6872 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6873
6874#if defined(MBEDTLS_SSL_PROTO_DTLS)
6875 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6876 {
6877 unsigned char i;
6878
6879 /* Remember current epoch settings for resending */
6880 ssl->handshake->alt_transform_out = ssl->transform_out;
6881 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6882 sizeof( ssl->handshake->alt_out_ctr ) );
6883
6884 /* Set sequence_number to zero */
6885 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6886
6887
6888 /* Increment epoch */
6889 for( i = 2; i > 0; i-- )
6890 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6891 break;
6892
6893 /* The loop goes to its end iff the counter is wrapping */
6894 if( i == 0 )
6895 {
6896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6897 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6898 }
6899 }
6900 else
6901#endif /* MBEDTLS_SSL_PROTO_DTLS */
6902 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6903
6904 ssl->transform_out = ssl->transform_negotiate;
6905 ssl->session_out = ssl->session_negotiate;
6906
6907#if defined(MBEDTLS_SSL_PROTO_DTLS)
6908 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6909 mbedtls_ssl_send_flight_completed( ssl );
6910#endif
6911
6912 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6913 {
6914 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6915 return( ret );
6916 }
6917
6918#if defined(MBEDTLS_SSL_PROTO_DTLS)
6919 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6920 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6921 {
6922 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6923 return( ret );
6924 }
6925#endif
6926
6927 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6928
6929 return( 0 );
6930}
6931
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006932#define SSL_MAX_HASH_LEN 12
6933
6934int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6935{
6936 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6937 unsigned int hash_len = 12;
6938 unsigned char buf[SSL_MAX_HASH_LEN];
6939
6940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6941
6942 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6943
6944 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6945 {
6946 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6947 goto exit;
6948 }
6949
6950 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6951 {
6952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6953 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6954 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6955 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6956 goto exit;
6957 }
6958
6959 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6960 {
6961 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6962 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6963 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6964 goto exit;
6965 }
6966
6967 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6968 {
6969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6970 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6971 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6972 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6973 goto exit;
6974 }
6975
6976 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6977 buf, hash_len ) != 0 )
6978 {
6979 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6980 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6981 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6982 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6983 goto exit;
6984 }
6985
6986#if defined(MBEDTLS_SSL_RENEGOTIATION)
6987 ssl->verify_data_len = hash_len;
6988 memcpy( ssl->peer_verify_data, buf, hash_len );
6989#endif
6990
6991 if( ssl->handshake->resume != 0 )
6992 {
6993#if defined(MBEDTLS_SSL_CLI_C)
6994 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6995 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6996#endif
6997#if defined(MBEDTLS_SSL_SRV_C)
6998 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6999 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7000#endif
7001 }
7002 else
7003 ssl->state++;
7004
7005#if defined(MBEDTLS_SSL_PROTO_DTLS)
7006 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7007 mbedtls_ssl_recv_flight_completed( ssl );
7008#endif
7009
7010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7011
7012exit:
7013 mbedtls_platform_zeroize( buf, hash_len );
7014 return( ret );
7015}
7016
Jerry Yu392112c2022-02-17 14:34:10 +08007017#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7018/*
7019 * Helper to get TLS 1.2 PRF from ciphersuite
7020 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7021 */
7022static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7023{
7024#if defined(MBEDTLS_SHA384_C)
7025 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7026 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7027
7028 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7029 return( tls_prf_sha384 );
7030#else
7031 (void) ciphersuite_id;
7032#endif
7033 return( tls_prf_sha256 );
7034}
7035#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007036
7037static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7038{
7039 ((void) tls_prf);
7040#if defined(MBEDTLS_SHA384_C)
7041 if( tls_prf == tls_prf_sha384 )
7042 {
7043 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7044 }
7045 else
7046#endif
7047#if defined(MBEDTLS_SHA256_C)
7048 if( tls_prf == tls_prf_sha256 )
7049 {
7050 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7051 }
7052 else
7053#endif
7054 return( MBEDTLS_SSL_TLS_PRF_NONE );
7055}
7056
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007057/*
7058 * Populate a transform structure with session keys and all the other
7059 * necessary information.
7060 *
7061 * Parameters:
7062 * - [in/out]: transform: structure to populate
7063 * [in] must be just initialised with mbedtls_ssl_transform_init()
7064 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7065 * - [in] ciphersuite
7066 * - [in] master
7067 * - [in] encrypt_then_mac
7068 * - [in] compression
7069 * - [in] tls_prf: pointer to PRF to use for key derivation
7070 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007071 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007072 * - [in] endpoint: client or server
7073 * - [in] ssl: used for:
7074 * - ssl->conf->{f,p}_export_keys
7075 * [in] optionally used for:
7076 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7077 */
7078static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7079 int ciphersuite,
7080 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007081#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007082 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007083#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007084 ssl_tls_prf_t tls_prf,
7085 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007086 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007087 unsigned endpoint,
7088 const mbedtls_ssl_context *ssl )
7089{
7090 int ret = 0;
7091 unsigned char keyblk[256];
7092 unsigned char *key1;
7093 unsigned char *key2;
7094 unsigned char *mac_enc;
7095 unsigned char *mac_dec;
7096 size_t mac_key_len = 0;
7097 size_t iv_copy_len;
7098 size_t keylen;
7099 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007100 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007101#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007102 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007103 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007104#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007105
7106#if defined(MBEDTLS_USE_PSA_CRYPTO)
7107 psa_key_type_t key_type;
7108 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7109 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007110 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007111 size_t key_bits;
7112 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7113#endif
7114
7115#if !defined(MBEDTLS_DEBUG_C) && \
7116 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7117 if( ssl->f_export_keys == NULL )
7118 {
7119 ssl = NULL; /* make sure we don't use it except for these cases */
7120 (void) ssl;
7121 }
7122#endif
7123
7124 /*
7125 * Some data just needs copying into the structure
7126 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007127#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007128 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007129#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007130 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007131
7132#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7133 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7134#endif
7135
7136#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007137 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007138 {
7139 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7140 * generation separate. This should never happen. */
7141 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7142 }
7143#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7144
7145 /*
7146 * Get various info structures
7147 */
7148 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7149 if( ciphersuite_info == NULL )
7150 {
7151 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7152 ciphersuite ) );
7153 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7154 }
7155
Neil Armstrongab555e02022-04-04 11:07:59 +02007156 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007157#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007158 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007159#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007160 ciphersuite_info );
7161
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007162 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7163 transform->taglen =
7164 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7165
7166#if defined(MBEDTLS_USE_PSA_CRYPTO)
7167 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7168 transform->taglen,
7169 &alg,
7170 &key_type,
7171 &key_bits ) ) != PSA_SUCCESS )
7172 {
7173 ret = psa_ssl_status_to_mbedtls( status );
7174 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7175 goto end;
7176 }
7177#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007178 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7179 if( cipher_info == NULL )
7180 {
7181 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7182 ciphersuite_info->cipher ) );
7183 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7184 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007185#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007186
Neil Armstronge4512952022-03-08 09:08:22 +01007187#if defined(MBEDTLS_USE_PSA_CRYPTO)
7188 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7189 if( mac_alg == 0 )
7190 {
7191 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7192 (unsigned) ciphersuite_info->mac ) );
7193 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7194 }
7195#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007196 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7197 if( md_info == NULL )
7198 {
7199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7200 (unsigned) ciphersuite_info->mac ) );
7201 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7202 }
Neil Armstronge4512952022-03-08 09:08:22 +01007203#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007204
7205#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7206 /* Copy own and peer's CID if the use of the CID
7207 * extension has been negotiated. */
7208 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7209 {
7210 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7211
7212 transform->in_cid_len = ssl->own_cid_len;
7213 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7214 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7215 transform->in_cid_len );
7216
7217 transform->out_cid_len = ssl->handshake->peer_cid_len;
7218 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7219 ssl->handshake->peer_cid_len );
7220 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7221 transform->out_cid_len );
7222 }
7223#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7224
7225 /*
7226 * Compute key block using the PRF
7227 */
7228 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7229 if( ret != 0 )
7230 {
7231 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7232 return( ret );
7233 }
7234
7235 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7236 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7237 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7238 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7239 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7240
7241 /*
7242 * Determine the appropriate key, IV and MAC length.
7243 */
7244
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007245#if defined(MBEDTLS_USE_PSA_CRYPTO)
7246 keylen = PSA_BITS_TO_BYTES(key_bits);
7247#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007248 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007249#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007250
7251#if defined(MBEDTLS_GCM_C) || \
7252 defined(MBEDTLS_CCM_C) || \
7253 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007254 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007255 {
7256 size_t explicit_ivlen;
7257
7258 transform->maclen = 0;
7259 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007260
7261 /* All modes haves 96-bit IVs, but the length of the static parts vary
7262 * with mode and version:
7263 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7264 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7265 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7266 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7267 * sequence number).
7268 */
7269 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007270#if defined(MBEDTLS_USE_PSA_CRYPTO)
7271 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7272#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007273 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007274#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007275 transform->fixed_ivlen = 12;
7276 else
7277 transform->fixed_ivlen = 4;
7278
7279 /* Minimum length of encrypted record */
7280 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7281 transform->minlen = explicit_ivlen + transform->taglen;
7282 }
7283 else
7284#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7285#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007286 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7287 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7288 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007289 {
Neil Armstronge4512952022-03-08 09:08:22 +01007290#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007291 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007292#else
7293 size_t block_size = cipher_info->block_size;
7294#endif /* MBEDTLS_USE_PSA_CRYPTO */
7295
7296#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007297 /* Get MAC length */
7298 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7299#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007300 /* Initialize HMAC contexts */
7301 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7302 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7303 {
7304 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7305 goto end;
7306 }
7307
7308 /* Get MAC length */
7309 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007310#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007311 transform->maclen = mac_key_len;
7312
7313 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007314#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007315 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007316#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007317 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007318#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007319
7320 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007321 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007322 transform->minlen = transform->maclen;
7323 else
7324 {
7325 /*
7326 * GenericBlockCipher:
7327 * 1. if EtM is in use: one block plus MAC
7328 * otherwise: * first multiple of blocklen greater than maclen
7329 * 2. IV
7330 */
7331#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007332 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007333 {
7334 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007335 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007336 }
7337 else
7338#endif
7339 {
7340 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007341 + block_size
7342 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007343 }
7344
Glenn Strauss07c64162022-03-14 12:34:51 -04007345 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007346 {
7347 transform->minlen += transform->ivlen;
7348 }
7349 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007350 {
7351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7352 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7353 goto end;
7354 }
7355 }
7356 }
7357 else
7358#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7359 {
7360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7361 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7362 }
7363
7364 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7365 (unsigned) keylen,
7366 (unsigned) transform->minlen,
7367 (unsigned) transform->ivlen,
7368 (unsigned) transform->maclen ) );
7369
7370 /*
7371 * Finally setup the cipher contexts, IVs and MAC secrets.
7372 */
7373#if defined(MBEDTLS_SSL_CLI_C)
7374 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7375 {
7376 key1 = keyblk + mac_key_len * 2;
7377 key2 = keyblk + mac_key_len * 2 + keylen;
7378
7379 mac_enc = keyblk;
7380 mac_dec = keyblk + mac_key_len;
7381
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007382 iv_copy_len = ( transform->fixed_ivlen ) ?
7383 transform->fixed_ivlen : transform->ivlen;
7384 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7385 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7386 iv_copy_len );
7387 }
7388 else
7389#endif /* MBEDTLS_SSL_CLI_C */
7390#if defined(MBEDTLS_SSL_SRV_C)
7391 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7392 {
7393 key1 = keyblk + mac_key_len * 2 + keylen;
7394 key2 = keyblk + mac_key_len * 2;
7395
7396 mac_enc = keyblk + mac_key_len;
7397 mac_dec = keyblk;
7398
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007399 iv_copy_len = ( transform->fixed_ivlen ) ?
7400 transform->fixed_ivlen : transform->ivlen;
7401 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7402 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7403 iv_copy_len );
7404 }
7405 else
7406#endif /* MBEDTLS_SSL_SRV_C */
7407 {
7408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7409 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7410 goto end;
7411 }
7412
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007413 if( ssl != NULL && ssl->f_export_keys != NULL )
7414 {
7415 ssl->f_export_keys( ssl->p_export_keys,
7416 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7417 master, 48,
7418 randbytes + 32,
7419 randbytes,
7420 tls_prf_get_type( tls_prf ) );
7421 }
7422
7423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007424 transform->psa_alg = alg;
7425
7426 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7427 {
7428 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7429 psa_set_key_algorithm( &attributes, alg );
7430 psa_set_key_type( &attributes, key_type );
7431
7432 if( ( status = psa_import_key( &attributes,
7433 key1,
7434 PSA_BITS_TO_BYTES( key_bits ),
7435 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7436 {
7437 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7438 ret = psa_ssl_status_to_mbedtls( status );
7439 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7440 goto end;
7441 }
7442
7443 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7444
7445 if( ( status = psa_import_key( &attributes,
7446 key2,
7447 PSA_BITS_TO_BYTES( key_bits ),
7448 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7449 {
7450 ret = psa_ssl_status_to_mbedtls( status );
7451 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7452 goto end;
7453 }
7454 }
7455#else
7456 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7457 cipher_info ) ) != 0 )
7458 {
7459 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7460 goto end;
7461 }
7462
7463 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7464 cipher_info ) ) != 0 )
7465 {
7466 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7467 goto end;
7468 }
7469
7470 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7471 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7472 MBEDTLS_ENCRYPT ) ) != 0 )
7473 {
7474 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7475 goto end;
7476 }
7477
7478 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7479 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7480 MBEDTLS_DECRYPT ) ) != 0 )
7481 {
7482 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7483 goto end;
7484 }
7485
7486#if defined(MBEDTLS_CIPHER_MODE_CBC)
7487 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7488 {
7489 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7490 MBEDTLS_PADDING_NONE ) ) != 0 )
7491 {
7492 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7493 goto end;
7494 }
7495
7496 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7497 MBEDTLS_PADDING_NONE ) ) != 0 )
7498 {
7499 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7500 goto end;
7501 }
7502 }
7503#endif /* MBEDTLS_CIPHER_MODE_CBC */
7504#endif /* MBEDTLS_USE_PSA_CRYPTO */
7505
Neil Armstrong29c0c042022-03-17 17:47:28 +01007506#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7507 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7508 For AEAD-based ciphersuites, there is nothing to do here. */
7509 if( mac_key_len != 0 )
7510 {
7511#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007512 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007513
7514 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007515 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007516 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7517
7518 if( ( status = psa_import_key( &attributes,
7519 mac_enc, mac_key_len,
7520 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7521 {
7522 ret = psa_ssl_status_to_mbedtls( status );
7523 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7524 goto end;
7525 }
7526
Ronald Cronfb39f152022-03-25 14:36:28 +01007527 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7528 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7529 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007530 /* mbedtls_ct_hmac() requires the key to be exportable */
7531 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7532 PSA_KEY_USAGE_VERIFY_HASH );
7533 else
7534 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7535
7536 if( ( status = psa_import_key( &attributes,
7537 mac_dec, mac_key_len,
7538 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7539 {
7540 ret = psa_ssl_status_to_mbedtls( status );
7541 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7542 goto end;
7543 }
7544#else
7545 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7546 if( ret != 0 )
7547 goto end;
7548 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7549 if( ret != 0 )
7550 goto end;
7551#endif /* MBEDTLS_USE_PSA_CRYPTO */
7552 }
7553#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7554
7555 ((void) mac_dec);
7556 ((void) mac_enc);
7557
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007558end:
7559 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7560 return( ret );
7561}
7562
Jerry Yuee40f9d2022-02-17 14:55:16 +08007563#if defined(MBEDTLS_USE_PSA_CRYPTO)
7564int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7565 unsigned char *hash, size_t *hashlen,
7566 unsigned char *data, size_t data_len,
7567 mbedtls_md_type_t md_alg )
7568{
7569 psa_status_t status;
7570 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7571 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7572
7573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7574
7575 if( ( status = psa_hash_setup( &hash_operation,
7576 hash_alg ) ) != PSA_SUCCESS )
7577 {
7578 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7579 goto exit;
7580 }
7581
7582 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7583 64 ) ) != PSA_SUCCESS )
7584 {
7585 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7586 goto exit;
7587 }
7588
7589 if( ( status = psa_hash_update( &hash_operation,
7590 data, data_len ) ) != PSA_SUCCESS )
7591 {
7592 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7593 goto exit;
7594 }
7595
7596 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7597 hashlen ) ) != PSA_SUCCESS )
7598 {
7599 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7600 goto exit;
7601 }
7602
7603exit:
7604 if( status != PSA_SUCCESS )
7605 {
7606 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7607 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7608 switch( status )
7609 {
7610 case PSA_ERROR_NOT_SUPPORTED:
7611 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7612 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7613 case PSA_ERROR_BUFFER_TOO_SMALL:
7614 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7615 case PSA_ERROR_INSUFFICIENT_MEMORY:
7616 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7617 default:
7618 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7619 }
7620 }
7621 return( 0 );
7622}
7623
7624#else
7625
7626int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7627 unsigned char *hash, size_t *hashlen,
7628 unsigned char *data, size_t data_len,
7629 mbedtls_md_type_t md_alg )
7630{
7631 int ret = 0;
7632 mbedtls_md_context_t ctx;
7633 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7634 *hashlen = mbedtls_md_get_size( md_info );
7635
7636 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7637
7638 mbedtls_md_init( &ctx );
7639
7640 /*
7641 * digitally-signed struct {
7642 * opaque client_random[32];
7643 * opaque server_random[32];
7644 * ServerDHParams params;
7645 * };
7646 */
7647 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7648 {
7649 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7650 goto exit;
7651 }
7652 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7653 {
7654 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7655 goto exit;
7656 }
7657 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7658 {
7659 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7660 goto exit;
7661 }
7662 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7663 {
7664 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7665 goto exit;
7666 }
7667 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7668 {
7669 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7670 goto exit;
7671 }
7672
7673exit:
7674 mbedtls_md_free( &ctx );
7675
7676 if( ret != 0 )
7677 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7678 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7679
7680 return( ret );
7681}
7682#endif /* MBEDTLS_USE_PSA_CRYPTO */
7683
Jerry Yud9d91da2022-02-17 14:57:06 +08007684#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7685
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007686/* Find the preferred hash for a given signature algorithm. */
7687unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7688 mbedtls_ssl_context *ssl,
7689 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007690{
Gabor Mezei078e8032022-04-27 21:17:56 +02007691 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007692 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007693
7694 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007695 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007696
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007697 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007698 {
Gabor Mezei3631cf62022-05-10 12:59:00 +02007699 if( sig_alg == MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7700 received_sig_algs[i] ) )
Gabor Mezei696956d2022-05-13 16:27:29 +02007701 return( MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7702 received_sig_algs[i] ) );
Jerry Yud9d91da2022-02-17 14:57:06 +08007703 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007704
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007705 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007706}
7707
7708#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7709
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007710/* Serialization of TLS 1.2 sessions:
7711 *
7712 * struct {
7713 * uint64 start_time;
7714 * uint8 ciphersuite[2]; // defined by the standard
7715 * uint8 compression; // 0 or 1
7716 * uint8 session_id_len; // at most 32
7717 * opaque session_id[32];
7718 * opaque master[48]; // fixed length in the standard
7719 * uint32 verify_result;
7720 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7721 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7722 * uint32 ticket_lifetime;
7723 * uint8 mfl_code; // up to 255 according to standard
7724 * uint8 encrypt_then_mac; // 0 or 1
7725 * } serialized_session_tls12;
7726 *
7727 */
7728static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7729 unsigned char *buf,
7730 size_t buf_len )
7731{
7732 unsigned char *p = buf;
7733 size_t used = 0;
7734
7735#if defined(MBEDTLS_HAVE_TIME)
7736 uint64_t start;
7737#endif
7738#if defined(MBEDTLS_X509_CRT_PARSE_C)
7739#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7740 size_t cert_len;
7741#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7742#endif /* MBEDTLS_X509_CRT_PARSE_C */
7743
7744 /*
7745 * Time
7746 */
7747#if defined(MBEDTLS_HAVE_TIME)
7748 used += 8;
7749
7750 if( used <= buf_len )
7751 {
7752 start = (uint64_t) session->start;
7753
7754 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7755 p += 8;
7756 }
7757#endif /* MBEDTLS_HAVE_TIME */
7758
7759 /*
7760 * Basic mandatory fields
7761 */
7762 used += 2 /* ciphersuite */
7763 + 1 /* compression */
7764 + 1 /* id_len */
7765 + sizeof( session->id )
7766 + sizeof( session->master )
7767 + 4; /* verify_result */
7768
7769 if( used <= buf_len )
7770 {
7771 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7772 p += 2;
7773
7774 *p++ = MBEDTLS_BYTE_0( session->compression );
7775
7776 *p++ = MBEDTLS_BYTE_0( session->id_len );
7777 memcpy( p, session->id, 32 );
7778 p += 32;
7779
7780 memcpy( p, session->master, 48 );
7781 p += 48;
7782
7783 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7784 p += 4;
7785 }
7786
7787 /*
7788 * Peer's end-entity certificate
7789 */
7790#if defined(MBEDTLS_X509_CRT_PARSE_C)
7791#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7792 if( session->peer_cert == NULL )
7793 cert_len = 0;
7794 else
7795 cert_len = session->peer_cert->raw.len;
7796
7797 used += 3 + cert_len;
7798
7799 if( used <= buf_len )
7800 {
7801 *p++ = MBEDTLS_BYTE_2( cert_len );
7802 *p++ = MBEDTLS_BYTE_1( cert_len );
7803 *p++ = MBEDTLS_BYTE_0( cert_len );
7804
7805 if( session->peer_cert != NULL )
7806 {
7807 memcpy( p, session->peer_cert->raw.p, cert_len );
7808 p += cert_len;
7809 }
7810 }
7811#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7812 if( session->peer_cert_digest != NULL )
7813 {
7814 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7815 if( used <= buf_len )
7816 {
7817 *p++ = (unsigned char) session->peer_cert_digest_type;
7818 *p++ = (unsigned char) session->peer_cert_digest_len;
7819 memcpy( p, session->peer_cert_digest,
7820 session->peer_cert_digest_len );
7821 p += session->peer_cert_digest_len;
7822 }
7823 }
7824 else
7825 {
7826 used += 2;
7827 if( used <= buf_len )
7828 {
7829 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7830 *p++ = 0;
7831 }
7832 }
7833#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7834#endif /* MBEDTLS_X509_CRT_PARSE_C */
7835
7836 /*
7837 * Session ticket if any, plus associated data
7838 */
7839#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7840 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7841
7842 if( used <= buf_len )
7843 {
7844 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7845 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7846 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7847
7848 if( session->ticket != NULL )
7849 {
7850 memcpy( p, session->ticket, session->ticket_len );
7851 p += session->ticket_len;
7852 }
7853
7854 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7855 p += 4;
7856 }
7857#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7858
7859 /*
7860 * Misc extension-related info
7861 */
7862#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7863 used += 1;
7864
7865 if( used <= buf_len )
7866 *p++ = session->mfl_code;
7867#endif
7868
7869#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7870 used += 1;
7871
7872 if( used <= buf_len )
7873 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7874#endif
7875
7876 return( used );
7877}
7878
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007879static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7880 const unsigned char *buf,
7881 size_t len )
7882{
7883#if defined(MBEDTLS_HAVE_TIME)
7884 uint64_t start;
7885#endif
7886#if defined(MBEDTLS_X509_CRT_PARSE_C)
7887#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7888 size_t cert_len;
7889#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7890#endif /* MBEDTLS_X509_CRT_PARSE_C */
7891
7892 const unsigned char *p = buf;
7893 const unsigned char * const end = buf + len;
7894
7895 /*
7896 * Time
7897 */
7898#if defined(MBEDTLS_HAVE_TIME)
7899 if( 8 > (size_t)( end - p ) )
7900 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7901
7902 start = ( (uint64_t) p[0] << 56 ) |
7903 ( (uint64_t) p[1] << 48 ) |
7904 ( (uint64_t) p[2] << 40 ) |
7905 ( (uint64_t) p[3] << 32 ) |
7906 ( (uint64_t) p[4] << 24 ) |
7907 ( (uint64_t) p[5] << 16 ) |
7908 ( (uint64_t) p[6] << 8 ) |
7909 ( (uint64_t) p[7] );
7910 p += 8;
7911
7912 session->start = (time_t) start;
7913#endif /* MBEDTLS_HAVE_TIME */
7914
7915 /*
7916 * Basic mandatory fields
7917 */
7918 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7919 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7920
7921 session->ciphersuite = ( p[0] << 8 ) | p[1];
7922 p += 2;
7923
7924 session->compression = *p++;
7925
7926 session->id_len = *p++;
7927 memcpy( session->id, p, 32 );
7928 p += 32;
7929
7930 memcpy( session->master, p, 48 );
7931 p += 48;
7932
7933 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7934 ( (uint32_t) p[1] << 16 ) |
7935 ( (uint32_t) p[2] << 8 ) |
7936 ( (uint32_t) p[3] );
7937 p += 4;
7938
7939 /* Immediately clear invalid pointer values that have been read, in case
7940 * we exit early before we replaced them with valid ones. */
7941#if defined(MBEDTLS_X509_CRT_PARSE_C)
7942#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7943 session->peer_cert = NULL;
7944#else
7945 session->peer_cert_digest = NULL;
7946#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7947#endif /* MBEDTLS_X509_CRT_PARSE_C */
7948#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7949 session->ticket = NULL;
7950#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7951
7952 /*
7953 * Peer certificate
7954 */
7955#if defined(MBEDTLS_X509_CRT_PARSE_C)
7956#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7957 /* Deserialize CRT from the end of the ticket. */
7958 if( 3 > (size_t)( end - p ) )
7959 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7960
7961 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7962 p += 3;
7963
7964 if( cert_len != 0 )
7965 {
7966 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7967
7968 if( cert_len > (size_t)( end - p ) )
7969 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7970
7971 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7972
7973 if( session->peer_cert == NULL )
7974 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7975
7976 mbedtls_x509_crt_init( session->peer_cert );
7977
7978 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7979 p, cert_len ) ) != 0 )
7980 {
7981 mbedtls_x509_crt_free( session->peer_cert );
7982 mbedtls_free( session->peer_cert );
7983 session->peer_cert = NULL;
7984 return( ret );
7985 }
7986
7987 p += cert_len;
7988 }
7989#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7990 /* Deserialize CRT digest from the end of the ticket. */
7991 if( 2 > (size_t)( end - p ) )
7992 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7993
7994 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7995 session->peer_cert_digest_len = (size_t) *p++;
7996
7997 if( session->peer_cert_digest_len != 0 )
7998 {
7999 const mbedtls_md_info_t *md_info =
8000 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8001 if( md_info == NULL )
8002 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8003 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8004 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8005
8006 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8007 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8008
8009 session->peer_cert_digest =
8010 mbedtls_calloc( 1, session->peer_cert_digest_len );
8011 if( session->peer_cert_digest == NULL )
8012 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8013
8014 memcpy( session->peer_cert_digest, p,
8015 session->peer_cert_digest_len );
8016 p += session->peer_cert_digest_len;
8017 }
8018#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8019#endif /* MBEDTLS_X509_CRT_PARSE_C */
8020
8021 /*
8022 * Session ticket and associated data
8023 */
8024#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8025 if( 3 > (size_t)( end - p ) )
8026 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8027
8028 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8029 p += 3;
8030
8031 if( session->ticket_len != 0 )
8032 {
8033 if( session->ticket_len > (size_t)( end - p ) )
8034 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8035
8036 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8037 if( session->ticket == NULL )
8038 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8039
8040 memcpy( session->ticket, p, session->ticket_len );
8041 p += session->ticket_len;
8042 }
8043
8044 if( 4 > (size_t)( end - p ) )
8045 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8046
8047 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8048 ( (uint32_t) p[1] << 16 ) |
8049 ( (uint32_t) p[2] << 8 ) |
8050 ( (uint32_t) p[3] );
8051 p += 4;
8052#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8053
8054 /*
8055 * Misc extension-related info
8056 */
8057#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8058 if( 1 > (size_t)( end - p ) )
8059 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8060
8061 session->mfl_code = *p++;
8062#endif
8063
8064#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8065 if( 1 > (size_t)( end - p ) )
8066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8067
8068 session->encrypt_then_mac = *p++;
8069#endif
8070
8071 /* Done, should have consumed entire buffer */
8072 if( p != end )
8073 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8074
8075 return( 0 );
8076}
Jerry Yudc7bd172022-02-17 13:44:15 +08008077#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8078
XiaokangQian75d40ef2022-04-20 11:05:24 +00008079int mbedtls_ssl_validate_ciphersuite(
8080 const mbedtls_ssl_context *ssl,
8081 const mbedtls_ssl_ciphersuite_t *suite_info,
8082 mbedtls_ssl_protocol_version min_tls_version,
8083 mbedtls_ssl_protocol_version max_tls_version )
8084{
8085 (void) ssl;
8086
8087 if( suite_info == NULL )
8088 return( -1 );
8089
8090 if( ( suite_info->min_tls_version > max_tls_version ) ||
8091 ( suite_info->max_tls_version < min_tls_version ) )
8092 {
8093 return( -1 );
8094 }
8095
XiaokangQian060d8672022-04-21 09:24:56 +00008096#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008097#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8098 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8099 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8100 {
8101 return( -1 );
8102 }
8103#endif
8104
8105 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8106#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8107 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8108 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8109 {
8110 return( -1 );
8111 }
8112#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8113#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8114
8115 return( 0 );
8116}
8117
XiaokangQianeaf36512022-04-24 09:07:44 +00008118#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8119/*
8120 * Function for writing a signature algorithm extension.
8121 *
8122 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8123 * value (TLS 1.3 RFC8446):
8124 * enum {
8125 * ....
8126 * ecdsa_secp256r1_sha256( 0x0403 ),
8127 * ecdsa_secp384r1_sha384( 0x0503 ),
8128 * ecdsa_secp521r1_sha512( 0x0603 ),
8129 * ....
8130 * } SignatureScheme;
8131 *
8132 * struct {
8133 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8134 * } SignatureSchemeList;
8135 *
8136 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8137 * value (TLS 1.2 RFC5246):
8138 * enum {
8139 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8140 * sha512(6), (255)
8141 * } HashAlgorithm;
8142 *
8143 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8144 * SignatureAlgorithm;
8145 *
8146 * struct {
8147 * HashAlgorithm hash;
8148 * SignatureAlgorithm signature;
8149 * } SignatureAndHashAlgorithm;
8150 *
8151 * SignatureAndHashAlgorithm
8152 * supported_signature_algorithms<2..2^16-2>;
8153 *
8154 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8155 * generalization of the TLS 1.2 signature algorithm extension.
8156 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8157 * `SignatureScheme` field of TLS 1.3
8158 *
8159 */
8160int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8161 const unsigned char *end, size_t *out_len )
8162{
8163 unsigned char *p = buf;
8164 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8165 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8166
8167 *out_len = 0;
8168
8169 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8170
8171 /* Check if we have space for header and length field:
8172 * - extension_type (2 bytes)
8173 * - extension_data_length (2 bytes)
8174 * - supported_signature_algorithms_length (2 bytes)
8175 */
8176 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8177 p += 6;
8178
8179 /*
8180 * Write supported_signature_algorithms
8181 */
8182 supported_sig_alg = p;
8183 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8184 if( sig_alg == NULL )
8185 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8186
8187 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8188 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008189 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8190 *sig_alg,
8191 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
Jerry Yu80dd5db2022-06-22 19:30:32 +08008192 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8193 continue;
8194 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8195 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8196 p += 2;
8197 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008198 *sig_alg,
8199 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008200 }
8201
8202 /* Length of supported_signature_algorithms */
8203 supported_sig_alg_len = p - supported_sig_alg;
8204 if( supported_sig_alg_len == 0 )
8205 {
8206 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8207 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8208 }
8209
XiaokangQianeaf36512022-04-24 09:07:44 +00008210 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008211 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008212 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8213
XiaokangQianeaf36512022-04-24 09:07:44 +00008214 *out_len = p - buf;
8215
8216#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8217 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8218#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8219 return( 0 );
8220}
8221#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8222
XiaokangQian40a35232022-05-07 09:02:40 +00008223#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008224/*
8225 * mbedtls_ssl_parse_server_name_ext
8226 *
8227 * Structure of server_name extension:
8228 *
8229 * enum {
8230 * host_name(0), (255)
8231 * } NameType;
8232 * opaque HostName<1..2^16-1>;
8233 *
8234 * struct {
8235 * NameType name_type;
8236 * select (name_type) {
8237 * case host_name: HostName;
8238 * } name;
8239 * } ServerName;
8240 * struct {
8241 * ServerName server_name_list<1..2^16-1>
8242 * } ServerNameList;
8243 */
8244int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8245 const unsigned char *buf,
8246 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008247{
8248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8249 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008250 size_t server_name_list_len, hostname_len;
8251 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008252
XiaokangQianf2a94202022-05-20 06:44:24 +00008253 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008254
8255 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008256 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008257 p += 2;
8258
XiaokangQian9b2b7712022-05-17 02:57:00 +00008259 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8260 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008261 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008262 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008263 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008264 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008265 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8266 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008267
8268 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8269 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008270 /* sni_name is intended to be used only during the parsing of the
8271 * ClientHello message (it is reset to NULL before the end of
8272 * the message parsing). Thus it is ok to just point to the
8273 * reception buffer and not make a copy of it.
8274 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008275 ssl->handshake->sni_name = p + 3;
8276 ssl->handshake->sni_name_len = hostname_len;
8277 if( ssl->conf->f_sni == NULL )
8278 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008279 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008280 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008281 if( ret != 0 )
8282 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008283 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008284 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8285 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008286 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8287 }
8288 return( 0 );
8289 }
8290
8291 p += hostname_len + 3;
8292 }
8293
8294 return( 0 );
8295}
8296#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8297
XiaokangQianacb39922022-06-17 10:18:48 +00008298#if defined(MBEDTLS_SSL_ALPN)
8299int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8300 const unsigned char *buf,
8301 const unsigned char *end )
8302{
8303 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008304 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008305 const unsigned char *protocol_name_list;
8306 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008307 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008308
8309 /* If ALPN not configured, just ignore the extension */
8310 if( ssl->conf->alpn_list == NULL )
8311 return( 0 );
8312
8313 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008314 * RFC7301, section 3.1
8315 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008316 *
XiaokangQianc7403452022-06-23 03:24:12 +00008317 * struct {
8318 * ProtocolName protocol_name_list<2..2^16-1>
8319 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008320 */
8321
XiaokangQianc7403452022-06-23 03:24:12 +00008322 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008323 * protocol_name_list_len 2 bytes
8324 * protocol_name_len 1 bytes
8325 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008326 */
XiaokangQianacb39922022-06-17 10:18:48 +00008327 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8328
XiaokangQianc7403452022-06-23 03:24:12 +00008329 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008330 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008331 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008332 protocol_name_list = p;
8333 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008334
8335 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008336 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008337 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008338 protocol_name_len = *p++;
8339 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8340 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008341 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008342 {
8343 MBEDTLS_SSL_PEND_FATAL_ALERT(
8344 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8345 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008346 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008347 }
8348
8349 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008350 }
8351
8352 /* Use our order of preference */
8353 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8354 {
8355 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008356 p = protocol_name_list;
8357 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008358 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008359 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008360 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008361 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008362 {
8363 ssl->alpn_chosen = *alpn;
8364 return( 0 );
8365 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008366
8367 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008368 }
8369 }
8370
XiaokangQian95d5f542022-06-24 02:29:26 +00008371 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008372 MBEDTLS_SSL_PEND_FATAL_ALERT(
8373 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8374 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8375 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8376}
8377
8378int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8379 unsigned char *buf,
8380 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008381 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008382{
8383 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008384 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008385 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008386
8387 if( ssl->alpn_chosen == NULL )
8388 {
8389 return( 0 );
8390 }
8391
XiaokangQian95d5f542022-06-24 02:29:26 +00008392 protocol_name_len = strlen( ssl->alpn_chosen );
8393 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008394
8395 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8396 /*
8397 * 0 . 1 ext identifier
8398 * 2 . 3 ext length
8399 * 4 . 5 protocol list length
8400 * 6 . 6 protocol name length
8401 * 7 . 7+n protocol name
8402 */
8403 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8404
XiaokangQian95d5f542022-06-24 02:29:26 +00008405 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008406
XiaokangQian95d5f542022-06-24 02:29:26 +00008407 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8408 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008409 /* Note: the length of the chosen protocol has been checked to be less
8410 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8411 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008412 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008413
XiaokangQian95d5f542022-06-24 02:29:26 +00008414 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008415 return ( 0 );
8416}
8417#endif /* MBEDTLS_SSL_ALPN */
8418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008419#endif /* MBEDTLS_SSL_TLS_C */