blob: d3bb291fde3e2a6cf6e81921ae2f38211dc6cdbd [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800387 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200388#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800389 ssl_tls_prf_t tls_prf,
390 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400391 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800392 unsigned endpoint,
393 const mbedtls_ssl_context *ssl );
394
395#if defined(MBEDTLS_SHA256_C)
396static int tls_prf_sha256( const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen );
400static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
401static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
402
403#endif /* MBEDTLS_SHA256_C */
404
405#if defined(MBEDTLS_SHA384_C)
406static int tls_prf_sha384( const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen );
410
411static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
412static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
413#endif /* MBEDTLS_SHA384_C */
414
415static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
416 unsigned char *buf,
417 size_t buf_len );
418static int ssl_session_load_tls12( mbedtls_ssl_session *session,
419 const unsigned char *buf,
420 size_t len );
421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
422
Jerry Yu53d23e22022-02-09 16:25:09 +0800423static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
424
Jerry Yudb8c48a2022-01-27 14:54:54 +0800425#if defined(MBEDTLS_SHA256_C)
426static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800427#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800428
429#if defined(MBEDTLS_SHA384_C)
430static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800431#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000432
Ron Eldor51d3ab52019-05-12 14:54:30 +0300433int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
434 const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen )
438{
439 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
440
441 switch( prf )
442 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300443#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200444#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300445 case MBEDTLS_SSL_TLS_PRF_SHA384:
446 tls_prf = tls_prf_sha384;
447 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200448#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300449#if defined(MBEDTLS_SHA256_C)
450 case MBEDTLS_SSL_TLS_PRF_SHA256:
451 tls_prf = tls_prf_sha256;
452 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300453#endif /* MBEDTLS_SHA256_C */
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300455 default:
456 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
457 }
458
459 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
460}
461
Jerry Yuc73c6182022-02-08 20:29:25 +0800462#if defined(MBEDTLS_X509_CRT_PARSE_C)
463static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
464{
465#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
466 if( session->peer_cert != NULL )
467 {
468 mbedtls_x509_crt_free( session->peer_cert );
469 mbedtls_free( session->peer_cert );
470 session->peer_cert = NULL;
471 }
472#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
473 if( session->peer_cert_digest != NULL )
474 {
475 /* Zeroization is not necessary. */
476 mbedtls_free( session->peer_cert_digest );
477 session->peer_cert_digest = NULL;
478 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
479 session->peer_cert_digest_len = 0;
480 }
481#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
482}
483#endif /* MBEDTLS_X509_CRT_PARSE_C */
484
485void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
487{
488 ((void) ciphersuite_info);
489
490#if defined(MBEDTLS_SHA384_C)
491 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
492 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
493 else
494#endif
495#if defined(MBEDTLS_SHA256_C)
496 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
497 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
498 else
499#endif
500 {
501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
502 return;
503 }
504}
505
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100506static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
507 unsigned hs_type,
508 size_t total_hs_len )
509{
510 unsigned char hs_hdr[4];
511
512 /* Build HS header for checksum update. */
513 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
514 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
515 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
516 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
517
518 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
519}
520
521void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
522 unsigned hs_type,
523 unsigned char const *msg,
524 size_t msg_len )
525{
526 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
527 ssl->handshake->update_checksum( ssl, msg, msg_len );
528}
529
Jerry Yuc73c6182022-02-08 20:29:25 +0800530void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
531{
532 ((void) ssl);
533#if defined(MBEDTLS_SHA256_C)
534#if defined(MBEDTLS_USE_PSA_CRYPTO)
535 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
536 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
537#else
538 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
539#endif
540#endif
541#if defined(MBEDTLS_SHA384_C)
542#if defined(MBEDTLS_USE_PSA_CRYPTO)
543 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
544 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
545#else
546 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
547#endif
548#endif
549}
550
551static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
552 const unsigned char *buf, size_t len )
553{
554#if defined(MBEDTLS_SHA256_C)
555#if defined(MBEDTLS_USE_PSA_CRYPTO)
556 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
557#else
558 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
559#endif
560#endif
561#if defined(MBEDTLS_SHA384_C)
562#if defined(MBEDTLS_USE_PSA_CRYPTO)
563 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
564#else
565 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
566#endif
567#endif
568}
569
570#if defined(MBEDTLS_SHA256_C)
571static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
572 const unsigned char *buf, size_t len )
573{
574#if defined(MBEDTLS_USE_PSA_CRYPTO)
575 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
576#else
577 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
578#endif
579}
580#endif
581
582#if defined(MBEDTLS_SHA384_C)
583static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
584 const unsigned char *buf, size_t len )
585{
586#if defined(MBEDTLS_USE_PSA_CRYPTO)
587 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
588#else
589 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
590#endif
591}
592#endif
593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200595{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500599#if defined(MBEDTLS_USE_PSA_CRYPTO)
600 handshake->fin_sha256_psa = psa_hash_operation_init();
601 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
602#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200604 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200605#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500606#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200607#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500609 handshake->fin_sha384_psa = psa_hash_operation_init();
610 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500611#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200613 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200614#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500615#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616
617 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#if defined(MBEDTLS_DHM_C)
620 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200621#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200622#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200624#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200625#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200626 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200627#if defined(MBEDTLS_SSL_CLI_C)
628 handshake->ecjpake_cache = NULL;
629 handshake->ecjpake_cache_len = 0;
630#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200632
Gilles Peskineeccd8882020-03-10 12:19:08 +0100633#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200634 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200635#endif
636
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200637#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
638 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
639#endif
Hanno Becker75173122019-02-06 16:18:31 +0000640
641#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
642 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
643 mbedtls_pk_init( &handshake->peer_pubkey );
644#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200645}
646
Hanno Beckera18d1322018-01-03 14:27:32 +0000647void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200648{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200650
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100651#if defined(MBEDTLS_USE_PSA_CRYPTO)
652 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
653 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100654#else
655 mbedtls_cipher_init( &transform->cipher_ctx_enc );
656 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100657#endif
658
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000659#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100660#if defined(MBEDTLS_USE_PSA_CRYPTO)
661 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
662 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100663#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 mbedtls_md_init( &transform->md_ctx_enc );
665 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000666#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100667#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200668}
669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200671{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200673}
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000676{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200677 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000678 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200682 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200683 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684
685 /*
686 * Either the pointers are now NULL or cleared properly and can be freed.
687 * Now allocate missing structures.
688 */
689 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200690 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200691 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200692 }
Paul Bakker48916f92012-09-16 19:57:18 +0000693
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200694 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200695 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200696 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 }
Paul Bakker48916f92012-09-16 19:57:18 +0000698
Paul Bakker82788fb2014-10-20 13:59:19 +0200699 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200700 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200701 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500703#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
704 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400705
Andrzej Kurek4a063792020-10-21 15:08:44 +0200706 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
707 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500708#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000709
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200710 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000711 if( ssl->handshake == NULL ||
712 ssl->transform_negotiate == NULL ||
713 ssl->session_negotiate == NULL )
714 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 mbedtls_free( ssl->handshake );
718 mbedtls_free( ssl->transform_negotiate );
719 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200720
721 ssl->handshake = NULL;
722 ssl->transform_negotiate = NULL;
723 ssl->session_negotiate = NULL;
724
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200725 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000726 }
727
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200728 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000730 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200731 ssl_handshake_params_init( ssl->handshake );
732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200734 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
735 {
736 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200737
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200738 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
739 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
740 else
741 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200742
Hanno Becker0f57a652020-02-05 10:37:26 +0000743 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200744 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200745#endif
746
Brett Warrene0edc842021-08-17 09:53:13 +0100747/*
748 * curve_list is translated to IANA TLS group identifiers here because
749 * mbedtls_ssl_conf_curves returns void and so can't return
750 * any error codes.
751 */
752#if defined(MBEDTLS_ECP_C)
753#if !defined(MBEDTLS_DEPRECATED_REMOVED)
754 /* Heap allocate and translate curve_list from internal to IANA group ids */
755 if ( ssl->conf->curve_list != NULL )
756 {
757 size_t length;
758 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
759
760 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
761 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
762
763 /* Leave room for zero termination */
764 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
765 if ( group_list == NULL )
766 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
767
768 for( size_t i = 0; i < length; i++ )
769 {
770 const mbedtls_ecp_curve_info *info =
771 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
772 if ( info == NULL )
773 {
774 mbedtls_free( group_list );
775 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
776 }
777 group_list[i] = info->tls_id;
778 }
779
780 group_list[length] = 0;
781
782 ssl->handshake->group_list = group_list;
783 ssl->handshake->group_list_heap_allocated = 1;
784 }
785 else
786 {
787 ssl->handshake->group_list = ssl->conf->group_list;
788 ssl->handshake->group_list_heap_allocated = 0;
789 }
790#endif /* MBEDTLS_DEPRECATED_REMOVED */
791#endif /* MBEDTLS_ECP_C */
792
Jerry Yuf017ee42022-01-12 15:49:48 +0800793#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
794#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800796 /* Heap allocate and translate sig_hashes from internal hash identifiers to
797 signature algorithms IANA identifiers. */
798 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800799 ssl->conf->sig_hashes != NULL )
800 {
801 const int *md;
802 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800803 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800804 uint16_t *p;
805
Jerry Yub476a442022-01-21 18:14:45 +0800806#if defined(static_assert)
807 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
808 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
809 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800810#endif
811
Jerry Yuf017ee42022-01-12 15:49:48 +0800812 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
813 {
814 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
815 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800816#if defined(MBEDTLS_ECDSA_C)
817 sig_algs_len += sizeof( uint16_t );
818#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800819
Jerry Yub476a442022-01-21 18:14:45 +0800820#if defined(MBEDTLS_RSA_C)
821 sig_algs_len += sizeof( uint16_t );
822#endif
823 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
824 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800825 }
826
Jerry Yub476a442022-01-21 18:14:45 +0800827 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800828 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
829
Jerry Yub476a442022-01-21 18:14:45 +0800830 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
831 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 if( ssl->handshake->sig_algs == NULL )
833 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
834
835 p = (uint16_t *)ssl->handshake->sig_algs;
836 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
837 {
838 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
839 if( hash == MBEDTLS_SSL_HASH_NONE )
840 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800841#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800842 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
843 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800844#endif
845#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800846 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
847 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200850 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800851 ssl->handshake->sig_algs_heap_allocated = 1;
852 }
853 else
Jerry Yua69269a2022-01-17 21:06:01 +0800854#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800855 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 ssl->handshake->sig_algs_heap_allocated = 0;
857 }
Jerry Yucc539102022-06-27 16:27:35 +0800858#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800859#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000860 return( 0 );
861}
862
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200863#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200864/* Dummy cookie callbacks for defaults */
865static int ssl_cookie_write_dummy( void *ctx,
866 unsigned char **p, unsigned char *end,
867 const unsigned char *cli_id, size_t cli_id_len )
868{
869 ((void) ctx);
870 ((void) p);
871 ((void) end);
872 ((void) cli_id);
873 ((void) cli_id_len);
874
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200876}
877
878static int ssl_cookie_check_dummy( void *ctx,
879 const unsigned char *cookie, size_t cookie_len,
880 const unsigned char *cli_id, size_t cli_id_len )
881{
882 ((void) ctx);
883 ((void) cookie);
884 ((void) cookie_len);
885 ((void) cli_id);
886 ((void) cli_id_len);
887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200889}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200890#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200891
Paul Bakker5121ce52009-01-03 21:22:43 +0000892/*
893 * Initialize an SSL context
894 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200895void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
896{
897 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
898}
899
Jerry Yu60835a82021-08-04 10:13:52 +0800900static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
901{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100902 const mbedtls_ssl_config *conf = ssl->conf;
903
Ronald Cron6f135e12021-12-08 16:57:54 +0100904#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100905 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
906 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000907 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
908 {
909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
910 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
911 }
912
Jerry Yu60835a82021-08-04 10:13:52 +0800913 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
914 return( 0 );
915 }
916#endif
917
918#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100919 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800920 {
921 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
922 return( 0 );
923 }
924#endif
925
Ronald Cron6f135e12021-12-08 16:57:54 +0100926#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100927 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800928 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000929 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
930 {
931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
932 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
933 }
934
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000935 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
936 {
937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
938 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
939 }
940
941
Ronald Crone1d3f062022-02-10 14:50:54 +0100942 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
943 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800944 }
945#endif
946
947 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
948 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
949}
950
951static int ssl_conf_check(const mbedtls_ssl_context *ssl)
952{
953 int ret;
954 ret = ssl_conf_version_check( ssl );
955 if( ret != 0 )
956 return( ret );
957
958 /* Space for further checks */
959
960 return( 0 );
961}
962
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200963/*
964 * Setup an SSL context
965 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100966
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200967int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200968 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000969{
Janos Follath865b3eb2019-12-16 11:46:15 +0000970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000971 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
972 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000973
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200974 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000975
Jerry Yu60835a82021-08-04 10:13:52 +0800976 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
977 return( ret );
978
Paul Bakker62f2dee2012-09-28 07:31:51 +0000979 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100980 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000981 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200982
983 /* Set to NULL in case of an error condition */
984 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200985
Darryl Greenb33cc762019-11-28 14:29:44 +0000986#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
987 ssl->in_buf_len = in_buf_len;
988#endif
989 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000990 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000991 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200993 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +0200994 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +1000995 }
996
Darryl Greenb33cc762019-11-28 14:29:44 +0000997#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
998 ssl->out_buf_len = out_buf_len;
999#endif
1000 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001001 if( ssl->out_buf == NULL )
1002 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001003 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001004 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001005 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001006 }
1007
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001008 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001009
Johan Pascalb62bb512015-12-03 21:56:45 +01001010#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001011 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001012#endif
1013
Paul Bakker48916f92012-09-16 19:57:18 +00001014 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001015 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001016
1017 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001018
1019error:
1020 mbedtls_free( ssl->in_buf );
1021 mbedtls_free( ssl->out_buf );
1022
1023 ssl->conf = NULL;
1024
Darryl Greenb33cc762019-11-28 14:29:44 +00001025#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1026 ssl->in_buf_len = 0;
1027 ssl->out_buf_len = 0;
1028#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 ssl->in_buf = NULL;
1030 ssl->out_buf = NULL;
1031
1032 ssl->in_hdr = NULL;
1033 ssl->in_ctr = NULL;
1034 ssl->in_len = NULL;
1035 ssl->in_iv = NULL;
1036 ssl->in_msg = NULL;
1037
1038 ssl->out_hdr = NULL;
1039 ssl->out_ctr = NULL;
1040 ssl->out_len = NULL;
1041 ssl->out_iv = NULL;
1042 ssl->out_msg = NULL;
1043
k-stachowiak9f7798e2018-07-31 16:52:32 +02001044 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001045}
1046
1047/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001048 * Reset an initialized and used SSL context for re-use while retaining
1049 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001050 *
1051 * If partial is non-zero, keep data in the input buffer and client ID.
1052 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001053 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001054void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1055 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001056{
Darryl Greenb33cc762019-11-28 14:29:44 +00001057#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1058 size_t in_buf_len = ssl->in_buf_len;
1059 size_t out_buf_len = ssl->out_buf_len;
1060#else
1061 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1062 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1063#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Hanno Beckerb0302c42021-08-03 09:39:42 +01001065#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1066 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001067#endif
1068
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001069 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001070 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001071
Hanno Beckerb0302c42021-08-03 09:39:42 +01001072 mbedtls_ssl_reset_in_out_pointers( ssl );
1073
1074 /* Reset incoming message parsing */
1075 ssl->in_offt = NULL;
1076 ssl->nb_zero = 0;
1077 ssl->in_msgtype = 0;
1078 ssl->in_msglen = 0;
1079 ssl->in_hslen = 0;
1080 ssl->keep_current_message = 0;
1081 ssl->transform_in = NULL;
1082
1083#if defined(MBEDTLS_SSL_PROTO_DTLS)
1084 ssl->next_record_offset = 0;
1085 ssl->in_epoch = 0;
1086#endif
1087
1088 /* Keep current datagram if partial == 1 */
1089 if( partial == 0 )
1090 {
1091 ssl->in_left = 0;
1092 memset( ssl->in_buf, 0, in_buf_len );
1093 }
1094
1095 /* Reset outgoing message writing */
1096 ssl->out_msgtype = 0;
1097 ssl->out_msglen = 0;
1098 ssl->out_left = 0;
1099 memset( ssl->out_buf, 0, out_buf_len );
1100 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1101 ssl->transform_out = NULL;
1102
1103#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1104 mbedtls_ssl_dtls_replay_reset( ssl );
1105#endif
1106
XiaokangQian2b01dc32022-01-21 02:53:13 +00001107#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001108 if( ssl->transform )
1109 {
1110 mbedtls_ssl_transform_free( ssl->transform );
1111 mbedtls_free( ssl->transform );
1112 ssl->transform = NULL;
1113 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001114#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1115
XiaokangQian2b01dc32022-01-21 02:53:13 +00001116#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1117 mbedtls_ssl_transform_free( ssl->transform_application );
1118 mbedtls_free( ssl->transform_application );
1119 ssl->transform_application = NULL;
1120
1121 if( ssl->handshake != NULL )
1122 {
1123 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1124 mbedtls_free( ssl->handshake->transform_earlydata );
1125 ssl->handshake->transform_earlydata = NULL;
1126
1127 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1128 mbedtls_free( ssl->handshake->transform_handshake );
1129 ssl->handshake->transform_handshake = NULL;
1130 }
1131
XiaokangQian2b01dc32022-01-21 02:53:13 +00001132#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001133}
1134
1135int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1136{
1137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1138
1139 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1140
XiaokangQian78b1fa72022-01-19 06:56:30 +00001141 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001142
1143 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SSL_RENEGOTIATION)
1145 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001146 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001147
1148 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1150 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001151#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001153
Hanno Beckerb0302c42021-08-03 09:39:42 +01001154 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001155 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001156 if( ssl->session )
1157 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 mbedtls_ssl_session_free( ssl->session );
1159 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001160 ssl->session = NULL;
1161 }
1162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001164 ssl->alpn_chosen = NULL;
1165#endif
1166
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001167#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001168#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001169 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001170#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001171 {
1172 mbedtls_free( ssl->cli_id );
1173 ssl->cli_id = NULL;
1174 ssl->cli_id_len = 0;
1175 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001176#endif
1177
Paul Bakker48916f92012-09-16 19:57:18 +00001178 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1179 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001180
1181 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001182}
1183
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001184/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001185 * Reset an initialized and used SSL context for re-use while retaining
1186 * all application-set variables, function pointers and data.
1187 */
1188int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1189{
Hanno Becker43aefe22020-02-05 10:44:56 +00001190 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001191}
1192
1193/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001194 * SSL set accessors
1195 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001196void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001197{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001198 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001199}
1200
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001201void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001202{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001203 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001204}
1205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001207void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001208{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001209 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001210}
1211#endif
1212
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001213void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001215 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001216}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001219
Hanno Becker1841b0a2018-08-24 11:13:57 +01001220void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1221 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001222{
1223 ssl->disable_datagram_packing = !allow_packing;
1224}
1225
1226void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1227 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001228{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001229 conf->hs_timeout_min = min;
1230 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001231}
1232#endif
1233
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001234void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001235{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001236 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001237}
1238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001240void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001241 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001242 void *p_vrfy )
1243{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001244 conf->f_vrfy = f_vrfy;
1245 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001246}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001248
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001249void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001250 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001251 void *p_rng )
1252{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001253 conf->f_rng = f_rng;
1254 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001255}
1256
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001257void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001258 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001259 void *p_dbg )
1260{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001261 conf->f_dbg = f_dbg;
1262 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001263}
1264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001266 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001267 mbedtls_ssl_send_t *f_send,
1268 mbedtls_ssl_recv_t *f_recv,
1269 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001270{
1271 ssl->p_bio = p_bio;
1272 ssl->f_send = f_send;
1273 ssl->f_recv = f_recv;
1274 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001275}
1276
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001277#if defined(MBEDTLS_SSL_PROTO_DTLS)
1278void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1279{
1280 ssl->mtu = mtu;
1281}
1282#endif
1283
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001284void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001285{
1286 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001287}
1288
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001289void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1290 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001291 mbedtls_ssl_set_timer_t *f_set_timer,
1292 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001293{
1294 ssl->p_timer = p_timer;
1295 ssl->f_set_timer = f_set_timer;
1296 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001297
1298 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001299 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001300}
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001303void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001304 void *p_cache,
1305 mbedtls_ssl_cache_get_t *f_get_cache,
1306 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001307{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001308 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001309 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001310 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001311}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314#if defined(MBEDTLS_SSL_CLI_C)
1315int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001316{
Janos Follath865b3eb2019-12-16 11:46:15 +00001317 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001318
1319 if( ssl == NULL ||
1320 session == NULL ||
1321 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001322 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001325 }
1326
Hanno Beckere810bbc2021-05-14 16:01:05 +01001327 if( ssl->handshake->resume == 1 )
1328 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1329
Hanno Becker52055ae2019-02-06 14:30:46 +00001330 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1331 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001332 return( ret );
1333
Paul Bakker0a597072012-09-25 21:55:46 +00001334 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001335
1336 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001337}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001339
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001340void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1341 const int *ciphersuites )
1342{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001343 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001344}
1345
Ronald Cron6f135e12021-12-08 16:57:54 +01001346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001347void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001348 const int kex_modes )
1349{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001350 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001351}
Ronald Cron6f135e12021-12-08 16:57:54 +01001352#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001355void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001356 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001357{
1358 conf->cert_profile = profile;
1359}
1360
Glenn Strauss36872db2022-01-22 05:06:31 -05001361static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1362{
1363 mbedtls_ssl_key_cert *cur = key_cert, *next;
1364
1365 while( cur != NULL )
1366 {
1367 next = cur->next;
1368 mbedtls_free( cur );
1369 cur = next;
1370 }
1371}
1372
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001373/* Append a new keycert entry to a (possibly empty) list */
1374static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1375 mbedtls_x509_crt *cert,
1376 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001377{
niisato8ee24222018-06-25 19:05:48 +09001378 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001379
Glenn Strauss36872db2022-01-22 05:06:31 -05001380 if( cert == NULL )
1381 {
1382 /* Free list if cert is null */
1383 ssl_key_cert_free( *head );
1384 *head = NULL;
1385 return( 0 );
1386 }
1387
niisato8ee24222018-06-25 19:05:48 +09001388 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1389 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001390 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001391
niisato8ee24222018-06-25 19:05:48 +09001392 new_cert->cert = cert;
1393 new_cert->key = key;
1394 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001395
Glenn Strauss36872db2022-01-22 05:06:31 -05001396 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001397 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001398 {
niisato8ee24222018-06-25 19:05:48 +09001399 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001400 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001401 else
1402 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001403 mbedtls_ssl_key_cert *cur = *head;
1404 while( cur->next != NULL )
1405 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001406 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001407 }
1408
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001409 return( 0 );
1410}
1411
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001412int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001413 mbedtls_x509_crt *own_cert,
1414 mbedtls_pk_context *pk_key )
1415{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001416 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417}
1418
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001419void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001420 mbedtls_x509_crt *ca_chain,
1421 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001422{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001423 conf->ca_chain = ca_chain;
1424 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001425
1426#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1427 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1428 * cannot be used together. */
1429 conf->f_ca_cb = NULL;
1430 conf->p_ca_cb = NULL;
1431#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001432}
Hanno Becker5adaad92019-03-27 16:54:37 +00001433
1434#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1435void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001436 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001437 void *p_ca_cb )
1438{
1439 conf->f_ca_cb = f_ca_cb;
1440 conf->p_ca_cb = p_ca_cb;
1441
1442 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1443 * cannot be used together. */
1444 conf->ca_chain = NULL;
1445 conf->ca_crl = NULL;
1446}
1447#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001449
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001450#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001451const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1452 size_t *name_len )
1453{
1454 *name_len = ssl->handshake->sni_name_len;
1455 return( ssl->handshake->sni_name );
1456}
1457
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001458int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1459 mbedtls_x509_crt *own_cert,
1460 mbedtls_pk_context *pk_key )
1461{
1462 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1463 own_cert, pk_key ) );
1464}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001465
1466void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1467 mbedtls_x509_crt *ca_chain,
1468 mbedtls_x509_crl *ca_crl )
1469{
1470 ssl->handshake->sni_ca_chain = ca_chain;
1471 ssl->handshake->sni_ca_crl = ca_crl;
1472}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001473
Glenn Strauss999ef702022-03-11 01:37:23 -05001474#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1475void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1476 const mbedtls_x509_crt *crt)
1477{
1478 ssl->handshake->dn_hints = crt;
1479}
1480#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1481
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001482void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1483 int authmode )
1484{
1485 ssl->handshake->sni_authmode = authmode;
1486}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001487#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1488
Hanno Becker8927c832019-04-03 12:52:50 +01001489#if defined(MBEDTLS_X509_CRT_PARSE_C)
1490void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1491 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1492 void *p_vrfy )
1493{
1494 ssl->f_vrfy = f_vrfy;
1495 ssl->p_vrfy = p_vrfy;
1496}
1497#endif
1498
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001499#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001500/*
1501 * Set EC J-PAKE password for current handshake
1502 */
1503int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1504 const unsigned char *pw,
1505 size_t pw_len )
1506{
1507 mbedtls_ecjpake_role role;
1508
Janos Follath8eb64132016-06-03 15:40:57 +01001509 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001510 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1511
1512 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1513 role = MBEDTLS_ECJPAKE_SERVER;
1514 else
1515 role = MBEDTLS_ECJPAKE_CLIENT;
1516
1517 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1518 role,
1519 MBEDTLS_MD_SHA256,
1520 MBEDTLS_ECP_DP_SECP256R1,
1521 pw, pw_len ) );
1522}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001523#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001524
Gilles Peskineeccd8882020-03-10 12:19:08 +01001525#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001526
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001527static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1528{
1529#if defined(MBEDTLS_USE_PSA_CRYPTO)
1530 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1531 return( 1 );
1532#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001533 if( conf->psk != NULL )
1534 return( 1 );
1535
1536 return( 0 );
1537}
1538
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001539static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1540{
1541 /* Remove reference to existing PSK, if any. */
1542#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001543 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001544 {
1545 /* The maintenance of the PSK key slot is the
1546 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001547 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001548 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001549#endif /* MBEDTLS_USE_PSA_CRYPTO */
1550 if( conf->psk != NULL )
1551 {
1552 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1553
1554 mbedtls_free( conf->psk );
1555 conf->psk = NULL;
1556 conf->psk_len = 0;
1557 }
1558
1559 /* Remove reference to PSK identity, if any. */
1560 if( conf->psk_identity != NULL )
1561 {
1562 mbedtls_free( conf->psk_identity );
1563 conf->psk_identity = NULL;
1564 conf->psk_identity_len = 0;
1565 }
1566}
1567
Hanno Becker7390c712018-11-15 13:33:04 +00001568/* This function assumes that PSK identity in the SSL config is unset.
1569 * It checks that the provided identity is well-formed and attempts
1570 * to make a copy of it in the SSL config.
1571 * On failure, the PSK identity in the config remains unset. */
1572static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1573 unsigned char const *psk_identity,
1574 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001575{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001576 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001577 if( psk_identity == NULL ||
1578 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001579 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001580 {
1581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1582 }
1583
Hanno Becker7390c712018-11-15 13:33:04 +00001584 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1585 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001586 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001587
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001588 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001589 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001590
1591 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001592}
1593
Hanno Becker7390c712018-11-15 13:33:04 +00001594int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1595 const unsigned char *psk, size_t psk_len,
1596 const unsigned char *psk_identity, size_t psk_identity_len )
1597{
Janos Follath865b3eb2019-12-16 11:46:15 +00001598 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001599
1600 /* We currently only support one PSK, raw or opaque. */
1601 if( ssl_conf_psk_is_configured( conf ) )
1602 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001603
1604 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001605 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001606 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001607 if( psk_len == 0 )
1608 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1609 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1610 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1611
Hanno Becker7390c712018-11-15 13:33:04 +00001612 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1613 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1614 conf->psk_len = psk_len;
1615 memcpy( conf->psk, psk, conf->psk_len );
1616
1617 /* Check and set PSK Identity */
1618 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1619 if( ret != 0 )
1620 ssl_conf_remove_psk( conf );
1621
1622 return( ret );
1623}
1624
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001625static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1626{
1627#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001628 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001629 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001630 /* The maintenance of the external PSK key slot is the
1631 * user's responsibility. */
1632 if( ssl->handshake->psk_opaque_is_internal )
1633 {
1634 psa_destroy_key( ssl->handshake->psk_opaque );
1635 ssl->handshake->psk_opaque_is_internal = 0;
1636 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001637 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001638 }
Neil Armstronge952a302022-05-03 10:22:14 +02001639#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001640 if( ssl->handshake->psk != NULL )
1641 {
1642 mbedtls_platform_zeroize( ssl->handshake->psk,
1643 ssl->handshake->psk_len );
1644 mbedtls_free( ssl->handshake->psk );
1645 ssl->handshake->psk_len = 0;
1646 }
Neil Armstronge952a302022-05-03 10:22:14 +02001647#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001648}
1649
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001650int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1651 const unsigned char *psk, size_t psk_len )
1652{
Neil Armstrong501c9322022-05-03 09:35:09 +02001653#if defined(MBEDTLS_USE_PSA_CRYPTO)
1654 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1655 psa_status_t status;
1656 psa_algorithm_t alg;
1657 mbedtls_svc_key_id_t key;
1658#endif /* MBEDTLS_USE_PSA_CRYPTO */
1659
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001660 if( psk == NULL || ssl->handshake == NULL )
1661 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1662
1663 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1664 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1665
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001666 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001667
Neil Armstrong501c9322022-05-03 09:35:09 +02001668#if defined(MBEDTLS_USE_PSA_CRYPTO)
1669 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1670 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1671 else
1672 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1673
1674 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1675 psa_set_key_algorithm( &key_attributes, alg );
1676 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1677
1678 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1679 if( status != PSA_SUCCESS )
1680 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1681
1682 /* Allow calling psa_destroy_key() on psk remove */
1683 ssl->handshake->psk_opaque_is_internal = 1;
1684 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1685#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001686 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001687 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001688
1689 ssl->handshake->psk_len = psk_len;
1690 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1691
1692 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001693#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001694}
1695
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001696#if defined(MBEDTLS_USE_PSA_CRYPTO)
1697int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001698 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001699 const unsigned char *psk_identity,
1700 size_t psk_identity_len )
1701{
Janos Follath865b3eb2019-12-16 11:46:15 +00001702 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001703
1704 /* We currently only support one PSK, raw or opaque. */
1705 if( ssl_conf_psk_is_configured( conf ) )
1706 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001707
Hanno Becker7390c712018-11-15 13:33:04 +00001708 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001709 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001710 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001711 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001712
1713 /* Check and set PSK Identity */
1714 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1715 psk_identity_len );
1716 if( ret != 0 )
1717 ssl_conf_remove_psk( conf );
1718
1719 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001720}
1721
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001722int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1723 mbedtls_svc_key_id_t psk )
1724{
1725 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1726 ( ssl->handshake == NULL ) )
1727 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1728
1729 ssl_remove_psk( ssl );
1730 ssl->handshake->psk_opaque = psk;
1731 return( 0 );
1732}
1733#endif /* MBEDTLS_USE_PSA_CRYPTO */
1734
1735void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1736 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1737 size_t),
1738 void *p_psk )
1739{
1740 conf->f_psk = f_psk;
1741 conf->p_psk = p_psk;
1742}
1743#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1744
1745#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001746static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1747 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001748{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001749#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001750 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001751 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001752#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001753 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001754 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001755 return( MBEDTLS_SSL_MODE_STREAM );
1756}
1757
1758#else /* MBEDTLS_USE_PSA_CRYPTO */
1759
1760static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1761 mbedtls_cipher_mode_t mode )
1762{
1763#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1764 if( mode == MBEDTLS_MODE_CBC )
1765 return( MBEDTLS_SSL_MODE_CBC );
1766#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1767
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001768#if defined(MBEDTLS_GCM_C) || \
1769 defined(MBEDTLS_CCM_C) || \
1770 defined(MBEDTLS_CHACHAPOLY_C)
1771 if( mode == MBEDTLS_MODE_GCM ||
1772 mode == MBEDTLS_MODE_CCM ||
1773 mode == MBEDTLS_MODE_CHACHAPOLY )
1774 return( MBEDTLS_SSL_MODE_AEAD );
1775#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001776
1777 return( MBEDTLS_SSL_MODE_STREAM );
1778}
Gilles Peskine301711e2022-04-26 16:57:05 +02001779#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001780
Gilles Peskinee108d982022-04-26 16:50:40 +02001781static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1782 mbedtls_ssl_mode_t base_mode,
1783 int encrypt_then_mac )
1784{
1785#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1786 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1787 base_mode == MBEDTLS_SSL_MODE_CBC )
1788 {
1789 return( MBEDTLS_SSL_MODE_CBC_ETM );
1790 }
1791#else
1792 (void) encrypt_then_mac;
1793#endif
1794 return( base_mode );
1795}
1796
Neil Armstrongab555e02022-04-04 11:07:59 +02001797mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001798 const mbedtls_ssl_transform *transform )
1799{
Gilles Peskinee108d982022-04-26 16:50:40 +02001800 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001801#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001802 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001803#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001804 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1805#endif
1806 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001807
Gilles Peskinee108d982022-04-26 16:50:40 +02001808 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001809#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001810 encrypt_then_mac = transform->encrypt_then_mac;
1811#endif
1812 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001813}
1814
Neil Armstrongab555e02022-04-04 11:07:59 +02001815mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001816#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001817 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001818#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001819 const mbedtls_ssl_ciphersuite_t *suite )
1820{
Gilles Peskinee108d982022-04-26 16:50:40 +02001821 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1822
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001823#if defined(MBEDTLS_USE_PSA_CRYPTO)
1824 psa_status_t status;
1825 psa_algorithm_t alg;
1826 psa_key_type_t type;
1827 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001828 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1829 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001830 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001831#else
1832 const mbedtls_cipher_info_t *cipher =
1833 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001834 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001835 {
1836 base_mode =
1837 mbedtls_ssl_get_base_mode(
1838 mbedtls_cipher_info_get_mode( cipher ) );
1839 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001840#endif /* MBEDTLS_USE_PSA_CRYPTO */
1841
Gilles Peskinee108d982022-04-26 16:50:40 +02001842#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1843 int encrypt_then_mac = 0;
1844#endif
1845 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001846}
1847
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001848#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001849psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001850 size_t taglen,
1851 psa_algorithm_t *alg,
1852 psa_key_type_t *key_type,
1853 size_t *key_size )
1854{
1855 switch ( mbedtls_cipher_type )
1856 {
1857 case MBEDTLS_CIPHER_AES_128_CBC:
1858 *alg = PSA_ALG_CBC_NO_PADDING;
1859 *key_type = PSA_KEY_TYPE_AES;
1860 *key_size = 128;
1861 break;
1862 case MBEDTLS_CIPHER_AES_128_CCM:
1863 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1864 *key_type = PSA_KEY_TYPE_AES;
1865 *key_size = 128;
1866 break;
1867 case MBEDTLS_CIPHER_AES_128_GCM:
1868 *alg = PSA_ALG_GCM;
1869 *key_type = PSA_KEY_TYPE_AES;
1870 *key_size = 128;
1871 break;
1872 case MBEDTLS_CIPHER_AES_192_CCM:
1873 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1874 *key_type = PSA_KEY_TYPE_AES;
1875 *key_size = 192;
1876 break;
1877 case MBEDTLS_CIPHER_AES_192_GCM:
1878 *alg = PSA_ALG_GCM;
1879 *key_type = PSA_KEY_TYPE_AES;
1880 *key_size = 192;
1881 break;
1882 case MBEDTLS_CIPHER_AES_256_CBC:
1883 *alg = PSA_ALG_CBC_NO_PADDING;
1884 *key_type = PSA_KEY_TYPE_AES;
1885 *key_size = 256;
1886 break;
1887 case MBEDTLS_CIPHER_AES_256_CCM:
1888 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1889 *key_type = PSA_KEY_TYPE_AES;
1890 *key_size = 256;
1891 break;
1892 case MBEDTLS_CIPHER_AES_256_GCM:
1893 *alg = PSA_ALG_GCM;
1894 *key_type = PSA_KEY_TYPE_AES;
1895 *key_size = 256;
1896 break;
1897 case MBEDTLS_CIPHER_ARIA_128_CBC:
1898 *alg = PSA_ALG_CBC_NO_PADDING;
1899 *key_type = PSA_KEY_TYPE_ARIA;
1900 *key_size = 128;
1901 break;
1902 case MBEDTLS_CIPHER_ARIA_128_CCM:
1903 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1904 *key_type = PSA_KEY_TYPE_ARIA;
1905 *key_size = 128;
1906 break;
1907 case MBEDTLS_CIPHER_ARIA_128_GCM:
1908 *alg = PSA_ALG_GCM;
1909 *key_type = PSA_KEY_TYPE_ARIA;
1910 *key_size = 128;
1911 break;
1912 case MBEDTLS_CIPHER_ARIA_192_CCM:
1913 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1914 *key_type = PSA_KEY_TYPE_ARIA;
1915 *key_size = 192;
1916 break;
1917 case MBEDTLS_CIPHER_ARIA_192_GCM:
1918 *alg = PSA_ALG_GCM;
1919 *key_type = PSA_KEY_TYPE_ARIA;
1920 *key_size = 192;
1921 break;
1922 case MBEDTLS_CIPHER_ARIA_256_CBC:
1923 *alg = PSA_ALG_CBC_NO_PADDING;
1924 *key_type = PSA_KEY_TYPE_ARIA;
1925 *key_size = 256;
1926 break;
1927 case MBEDTLS_CIPHER_ARIA_256_CCM:
1928 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1929 *key_type = PSA_KEY_TYPE_ARIA;
1930 *key_size = 256;
1931 break;
1932 case MBEDTLS_CIPHER_ARIA_256_GCM:
1933 *alg = PSA_ALG_GCM;
1934 *key_type = PSA_KEY_TYPE_ARIA;
1935 *key_size = 256;
1936 break;
1937 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1938 *alg = PSA_ALG_CBC_NO_PADDING;
1939 *key_type = PSA_KEY_TYPE_CAMELLIA;
1940 *key_size = 128;
1941 break;
1942 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1943 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1944 *key_type = PSA_KEY_TYPE_CAMELLIA;
1945 *key_size = 128;
1946 break;
1947 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1948 *alg = PSA_ALG_GCM;
1949 *key_type = PSA_KEY_TYPE_CAMELLIA;
1950 *key_size = 128;
1951 break;
1952 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1953 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1954 *key_type = PSA_KEY_TYPE_CAMELLIA;
1955 *key_size = 192;
1956 break;
1957 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1958 *alg = PSA_ALG_GCM;
1959 *key_type = PSA_KEY_TYPE_CAMELLIA;
1960 *key_size = 192;
1961 break;
1962 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1963 *alg = PSA_ALG_CBC_NO_PADDING;
1964 *key_type = PSA_KEY_TYPE_CAMELLIA;
1965 *key_size = 256;
1966 break;
1967 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1968 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1969 *key_type = PSA_KEY_TYPE_CAMELLIA;
1970 *key_size = 256;
1971 break;
1972 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1973 *alg = PSA_ALG_GCM;
1974 *key_type = PSA_KEY_TYPE_CAMELLIA;
1975 *key_size = 256;
1976 break;
1977 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1978 *alg = PSA_ALG_CHACHA20_POLY1305;
1979 *key_type = PSA_KEY_TYPE_CHACHA20;
1980 *key_size = 256;
1981 break;
1982 case MBEDTLS_CIPHER_NULL:
1983 *alg = MBEDTLS_SSL_NULL_CIPHER;
1984 *key_type = 0;
1985 *key_size = 0;
1986 break;
1987 default:
1988 return PSA_ERROR_NOT_SUPPORTED;
1989 }
1990
1991 return PSA_SUCCESS;
1992}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001993#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001994
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001995#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001996int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1997 const unsigned char *dhm_P, size_t P_len,
1998 const unsigned char *dhm_G, size_t G_len )
1999{
Janos Follath865b3eb2019-12-16 11:46:15 +00002000 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002001
Glenn Strausscee11292021-12-20 01:43:17 -05002002 mbedtls_mpi_free( &conf->dhm_P );
2003 mbedtls_mpi_free( &conf->dhm_G );
2004
Hanno Beckera90658f2017-10-04 15:29:08 +01002005 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2006 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2007 {
2008 mbedtls_mpi_free( &conf->dhm_P );
2009 mbedtls_mpi_free( &conf->dhm_G );
2010 return( ret );
2011 }
2012
2013 return( 0 );
2014}
Paul Bakker5121ce52009-01-03 21:22:43 +00002015
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002016int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002017{
Janos Follath865b3eb2019-12-16 11:46:15 +00002018 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002019
Glenn Strausscee11292021-12-20 01:43:17 -05002020 mbedtls_mpi_free( &conf->dhm_P );
2021 mbedtls_mpi_free( &conf->dhm_G );
2022
Gilles Peskinee5702482021-06-11 21:59:08 +02002023 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2024 &conf->dhm_P ) ) != 0 ||
2025 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2026 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002027 {
2028 mbedtls_mpi_free( &conf->dhm_P );
2029 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002030 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002031 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002032
2033 return( 0 );
2034}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002035#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002036
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002037#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2038/*
2039 * Set the minimum length for Diffie-Hellman parameters
2040 */
2041void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2042 unsigned int bitlen )
2043{
2044 conf->dhm_min_bitlen = bitlen;
2045}
2046#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2047
Gilles Peskineeccd8882020-03-10 12:19:08 +01002048#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002049#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002050/*
2051 * Set allowed/preferred hashes for handshake signatures
2052 */
2053void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2054 const int *hashes )
2055{
2056 conf->sig_hashes = hashes;
2057}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002058#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002059
Jerry Yuf017ee42022-01-12 15:49:48 +08002060/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002061void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2062 const uint16_t* sig_algs )
2063{
Jerry Yuf017ee42022-01-12 15:49:48 +08002064#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2065 conf->sig_hashes = NULL;
2066#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2067 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002068}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002069#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002070
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002071#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002072#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002073/*
2074 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002075 *
2076 * mbedtls_ssl_setup() takes the provided list
2077 * and translates it to a list of IANA TLS group identifiers,
2078 * stored in ssl->handshake->group_list.
2079 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002080 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002081void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002082 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002083{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002084 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002085 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002086}
Brett Warrene0edc842021-08-17 09:53:13 +01002087#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002088#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002089
Brett Warrene0edc842021-08-17 09:53:13 +01002090/*
2091 * Set the allowed groups
2092 */
2093void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2094 const uint16_t *group_list )
2095{
2096#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2097 conf->curve_list = NULL;
2098#endif
2099 conf->group_list = group_list;
2100}
2101
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002102#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002104{
Hanno Becker947194e2017-04-07 13:25:49 +01002105 /* Initialize to suppress unnecessary compiler warning */
2106 size_t hostname_len = 0;
2107
2108 /* Check if new hostname is valid before
2109 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002110 if( hostname != NULL )
2111 {
2112 hostname_len = strlen( hostname );
2113
2114 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2115 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2116 }
2117
2118 /* Now it's clear that we will overwrite the old hostname,
2119 * so we can free it safely */
2120
2121 if( ssl->hostname != NULL )
2122 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002123 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002124 mbedtls_free( ssl->hostname );
2125 }
2126
2127 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002128
Paul Bakker5121ce52009-01-03 21:22:43 +00002129 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002130 {
2131 ssl->hostname = NULL;
2132 }
2133 else
2134 {
2135 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002136 if( ssl->hostname == NULL )
2137 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002138
Hanno Becker947194e2017-04-07 13:25:49 +01002139 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002140
Hanno Becker947194e2017-04-07 13:25:49 +01002141 ssl->hostname[hostname_len] = '\0';
2142 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002143
2144 return( 0 );
2145}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002146#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002147
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002148#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002149void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002151 const unsigned char *, size_t),
2152 void *p_sni )
2153{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002154 conf->f_sni = f_sni;
2155 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002156}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002159#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002160int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002161{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002162 size_t cur_len, tot_len;
2163 const char **p;
2164
2165 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002166 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2167 * MUST NOT be truncated."
2168 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002169 */
2170 tot_len = 0;
2171 for( p = protos; *p != NULL; p++ )
2172 {
2173 cur_len = strlen( *p );
2174 tot_len += cur_len;
2175
Ronald Cron8216dd32020-04-23 16:41:44 +02002176 if( ( cur_len == 0 ) ||
2177 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2178 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002180 }
2181
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002182 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002183
2184 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002185}
2186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002188{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002189 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002190}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002192
Johan Pascalb62bb512015-12-03 21:56:45 +01002193#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002194void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2195 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002196{
2197 conf->dtls_srtp_mki_support = support_mki_value;
2198}
2199
Ron Eldoref72faf2018-07-12 11:54:20 +03002200int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2201 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002202 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002203{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002204 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002205 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002206 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002207 }
Ron Eldor591f1622018-01-22 12:30:04 +02002208
2209 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002210 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002211 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002212 }
Ron Eldor591f1622018-01-22 12:30:04 +02002213
2214 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2215 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002216 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002217}
2218
Ron Eldoref72faf2018-07-12 11:54:20 +03002219int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002220 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002221{
Johan Pascal253d0262020-09-22 13:04:45 +02002222 const mbedtls_ssl_srtp_profile *p;
2223 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002224
Johan Pascal253d0262020-09-22 13:04:45 +02002225 /* check the profiles list: all entry must be valid,
2226 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002227 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2228 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2229 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002230 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002231 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002232 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002233 list_size++;
2234 }
2235 else
2236 {
2237 /* unsupported value, stop parsing and set the size to an error value */
2238 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002239 }
2240 }
2241
Johan Pascal5ef72d22020-10-28 17:05:47 +01002242 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002243 {
Johan Pascal253d0262020-09-22 13:04:45 +02002244 conf->dtls_srtp_profile_list = NULL;
2245 conf->dtls_srtp_profile_list_len = 0;
2246 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2247 }
2248
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002249 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002250 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002251
2252 return( 0 );
2253}
2254
Johan Pascal5ef72d22020-10-28 17:05:47 +01002255void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2256 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002257{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002258 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2259 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002260 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002261 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002262 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002263 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002264 else
2265 {
2266 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002267 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2268 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002269 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002270}
Johan Pascalb62bb512015-12-03 21:56:45 +01002271#endif /* MBEDTLS_SSL_DTLS_SRTP */
2272
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002273void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002274{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002275 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002276}
2277
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002278void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002279{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002280 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002281}
2282
Janos Follath088ce432017-04-10 12:42:31 +01002283#if defined(MBEDTLS_SSL_SRV_C)
2284void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2285 char cert_req_ca_list )
2286{
2287 conf->cert_req_ca_list = cert_req_ca_list;
2288}
2289#endif
2290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002291#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002292void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002293{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002294 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002295}
2296#endif
2297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002299void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002300{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002301 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002302}
2303#endif
2304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002306int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002307{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002309 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002310 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002312 }
2313
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002314 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002315
2316 return( 0 );
2317}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002319
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002320void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002321{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002322 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002323}
2324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002326void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002327{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002328 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002329}
2330
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002331void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002332{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002333 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002334}
2335
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002336void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002337 const unsigned char period[8] )
2338{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002339 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002340}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002344#if defined(MBEDTLS_SSL_CLI_C)
2345void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002346{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002347 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002348}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002349#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002350
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002351#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002352void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2353 mbedtls_ssl_ticket_write_t *f_ticket_write,
2354 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2355 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002356{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002357 conf->f_ticket_write = f_ticket_write;
2358 conf->f_ticket_parse = f_ticket_parse;
2359 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002360}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002361#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002363
Hanno Becker7e6c1782021-06-08 09:24:55 +01002364void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2365 mbedtls_ssl_export_keys_t *f_export_keys,
2366 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002367{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002368 ssl->f_export_keys = f_export_keys;
2369 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002370}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002371
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002372#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002373void mbedtls_ssl_conf_async_private_cb(
2374 mbedtls_ssl_config *conf,
2375 mbedtls_ssl_async_sign_t *f_async_sign,
2376 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2377 mbedtls_ssl_async_resume_t *f_async_resume,
2378 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002379 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002380{
2381 conf->f_async_sign_start = f_async_sign;
2382 conf->f_async_decrypt_start = f_async_decrypt;
2383 conf->f_async_resume = f_async_resume;
2384 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002385 conf->p_async_config_data = async_config_data;
2386}
2387
Gilles Peskine8f97af72018-04-26 11:46:10 +02002388void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2389{
2390 return( conf->p_async_config_data );
2391}
2392
Gilles Peskine1febfef2018-04-30 11:54:39 +02002393void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002394{
2395 if( ssl->handshake == NULL )
2396 return( NULL );
2397 else
2398 return( ssl->handshake->user_async_ctx );
2399}
2400
Gilles Peskine1febfef2018-04-30 11:54:39 +02002401void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002402 void *ctx )
2403{
2404 if( ssl->handshake != NULL )
2405 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002406}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002407#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002408
Paul Bakker5121ce52009-01-03 21:22:43 +00002409/*
2410 * SSL get accessors
2411 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002412uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002413{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002414 if( ssl->session != NULL )
2415 return( ssl->session->verify_result );
2416
2417 if( ssl->session_negotiate != NULL )
2418 return( ssl->session_negotiate->verify_result );
2419
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002420 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002421}
2422
Glenn Strauss8f526902022-01-13 00:04:49 -05002423int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2424{
2425 if( ssl == NULL || ssl->session == NULL )
2426 return( 0 );
2427
2428 return( ssl->session->ciphersuite );
2429}
2430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002432{
Paul Bakker926c8e42013-03-06 10:23:34 +01002433 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002434 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002437}
2438
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002440{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002442 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002443 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002444 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002445 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002446 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002447 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002448 default:
2449 return( "unknown (DTLS)" );
2450 }
2451 }
2452#endif
2453
Glenn Strauss60bfe602022-03-14 19:04:24 -04002454 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002455 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002456 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002457 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002458 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002459 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002460 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002461 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002462 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002463}
2464
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002465#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002466size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2467{
David Horstmann95d516f2021-05-04 18:36:56 +01002468 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002469 size_t read_mfl;
2470
2471 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2472 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2473 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2474 {
2475 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2476 }
2477
2478 /* Check if a smaller max length was negotiated */
2479 if( ssl->session_out != NULL )
2480 {
2481 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2482 if( read_mfl < max_len )
2483 {
2484 max_len = read_mfl;
2485 }
2486 }
2487
2488 // During a handshake, use the value being negotiated
2489 if( ssl->session_negotiate != NULL )
2490 {
2491 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2492 if( read_mfl < max_len )
2493 {
2494 max_len = read_mfl;
2495 }
2496 }
2497
2498 return( max_len );
2499}
2500
2501size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002502{
2503 size_t max_len;
2504
2505 /*
2506 * Assume mfl_code is correct since it was checked when set
2507 */
Angus Grattond8213d02016-05-25 20:56:48 +10002508 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002509
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002510 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002511 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002512 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002513 {
Angus Grattond8213d02016-05-25 20:56:48 +10002514 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002515 }
2516
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002517 /* During a handshake, use the value being negotiated */
2518 if( ssl->session_negotiate != NULL &&
2519 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2520 {
2521 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2522 }
2523
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002524 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002525}
2526#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2527
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002528#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002529size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002530{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002531 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2532 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2533 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2534 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2535 return ( 0 );
2536
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002537 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2538 return( ssl->mtu );
2539
2540 if( ssl->mtu == 0 )
2541 return( ssl->handshake->mtu );
2542
2543 return( ssl->mtu < ssl->handshake->mtu ?
2544 ssl->mtu : ssl->handshake->mtu );
2545}
2546#endif /* MBEDTLS_SSL_PROTO_DTLS */
2547
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002548int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2549{
2550 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2551
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002552#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2553 !defined(MBEDTLS_SSL_PROTO_DTLS)
2554 (void) ssl;
2555#endif
2556
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002557#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002558 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002559
2560 if( max_len > mfl )
2561 max_len = mfl;
2562#endif
2563
2564#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002565 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002566 {
Hanno Becker89490712020-02-05 10:50:12 +00002567 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002568 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2569 const size_t overhead = (size_t) ret;
2570
2571 if( ret < 0 )
2572 return( ret );
2573
2574 if( mtu <= overhead )
2575 {
2576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2577 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2578 }
2579
2580 if( max_len > mtu - overhead )
2581 max_len = mtu - overhead;
2582 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002583#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002584
Hanno Becker0defedb2018-08-10 12:35:02 +01002585#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2586 !defined(MBEDTLS_SSL_PROTO_DTLS)
2587 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002588#endif
2589
2590 return( (int) max_len );
2591}
2592
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002593int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2594{
2595 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2596
2597#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2598 (void) ssl;
2599#endif
2600
2601#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2602 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2603
2604 if( max_len > mfl )
2605 max_len = mfl;
2606#endif
2607
2608 return( (int) max_len );
2609}
2610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#if defined(MBEDTLS_X509_CRT_PARSE_C)
2612const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002613{
2614 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002615 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002616
Hanno Beckere6824572019-02-07 13:18:46 +00002617#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002618 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002619#else
2620 return( NULL );
2621#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002622}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002626int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2627 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002628{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002629 int ret;
2630
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002631 if( ssl == NULL ||
2632 dst == NULL ||
2633 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002634 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002635 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002637 }
2638
Hanno Beckere810bbc2021-05-14 16:01:05 +01002639 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2640 * idempotent: Each session can only be exported once.
2641 *
2642 * (This is in preparation for TLS 1.3 support where we will
2643 * need the ability to export multiple sessions (aka tickets),
2644 * which will be achieved by calling mbedtls_ssl_get_session()
2645 * multiple times until it fails.)
2646 *
2647 * Check whether we have already exported the current session,
2648 * and fail if so.
2649 */
2650 if( ssl->session->exported == 1 )
2651 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2652
2653 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2654 if( ret != 0 )
2655 return( ret );
2656
2657 /* Remember that we've exported the session. */
2658 ssl->session->exported = 1;
2659 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002660}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002662
Paul Bakker5121ce52009-01-03 21:22:43 +00002663/*
Hanno Beckera835da52019-05-16 12:39:07 +01002664 * Define ticket header determining Mbed TLS version
2665 * and structure of the ticket.
2666 */
2667
Hanno Becker94ef3b32019-05-16 12:50:45 +01002668/*
Hanno Becker50b59662019-05-28 14:30:45 +01002669 * Define bitflag determining compile-time settings influencing
2670 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002671 */
2672
Hanno Becker50b59662019-05-28 14:30:45 +01002673#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002674#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002675#else
Hanno Becker3e088662019-05-29 11:10:18 +01002676#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002677#endif /* MBEDTLS_HAVE_TIME */
2678
2679#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002680#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002681#else
Hanno Becker3e088662019-05-29 11:10:18 +01002682#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002683#endif /* MBEDTLS_X509_CRT_PARSE_C */
2684
2685#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002686#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002687#else
Hanno Becker3e088662019-05-29 11:10:18 +01002688#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002689#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2690
2691#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002692#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002693#else
Hanno Becker3e088662019-05-29 11:10:18 +01002694#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002695#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2696
Hanno Becker94ef3b32019-05-16 12:50:45 +01002697#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002698#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002699#else
Hanno Becker3e088662019-05-29 11:10:18 +01002700#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002701#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2702
Hanno Becker94ef3b32019-05-16 12:50:45 +01002703#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2704#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2705#else
2706#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2707#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2708
Hanno Becker3e088662019-05-29 11:10:18 +01002709#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2710#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2711#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2712#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002713#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2714#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002715
Hanno Becker50b59662019-05-28 14:30:45 +01002716#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002717 ( (uint16_t) ( \
2718 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2719 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2720 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2721 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002722 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002723 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002724
Hanno Beckerf8787072019-05-16 12:41:07 +01002725static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002726 MBEDTLS_VERSION_MAJOR,
2727 MBEDTLS_VERSION_MINOR,
2728 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002729 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2730 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002731};
Hanno Beckera835da52019-05-16 12:39:07 +01002732
2733/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002734 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002735 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002736 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002737 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002738 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002739 * opaque mbedtls_version[3]; // library version: major, minor, patch
2740 * opaque session_format[2]; // library-version specific 16-bit field
2741 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002742 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002743 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002744 * Note: When updating the format, remember to keep
2745 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002746 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002747 * // In this version, `session_format` determines
2748 * // the setting of those compile-time
2749 * // configuration options which influence
2750 * // the structure of mbedtls_ssl_session.
2751 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002752 * uint8_t minor_ver; // Protocol minor version. Possible values:
2753 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002754 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002755 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002756 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002757 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002758 * serialized_session_tls12 data;
2759 *
2760 * };
2761 *
2762 * } serialized_session;
2763 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002764 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002765
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002766static int ssl_session_save( const mbedtls_ssl_session *session,
2767 unsigned char omit_header,
2768 unsigned char *buf,
2769 size_t buf_len,
2770 size_t *olen )
2771{
2772 unsigned char *p = buf;
2773 size_t used = 0;
2774
2775 if( !omit_header )
2776 {
2777 /*
2778 * Add Mbed TLS version identifier
2779 */
2780
2781 used += sizeof( ssl_serialized_session_header );
2782
2783 if( used <= buf_len )
2784 {
2785 memcpy( p, ssl_serialized_session_header,
2786 sizeof( ssl_serialized_session_header ) );
2787 p += sizeof( ssl_serialized_session_header );
2788 }
2789 }
2790
2791 /*
2792 * TLS version identifier
2793 */
2794 used += 1;
2795 if( used <= buf_len )
2796 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002797 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002798 }
2799
2800 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002801 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002802 {
2803#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002804 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002805 {
2806 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2807 used += ssl_session_save_tls12( session, p, remaining_len );
2808 break;
2809 }
2810#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2811
2812 default:
2813 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2814 }
2815
2816 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002817 if( used > buf_len )
2818 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002819
2820 return( 0 );
2821}
2822
2823/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002824 * Public wrapper for ssl_session_save()
2825 */
2826int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2827 unsigned char *buf,
2828 size_t buf_len,
2829 size_t *olen )
2830{
2831 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2832}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002833
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002834/*
2835 * Deserialize session, see mbedtls_ssl_session_save() for format.
2836 *
2837 * This internal version is wrapped by a public function that cleans up in
2838 * case of error, and has an extra option omit_header.
2839 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002840static int ssl_session_load( mbedtls_ssl_session *session,
2841 unsigned char omit_header,
2842 const unsigned char *buf,
2843 size_t len )
2844{
2845 const unsigned char *p = buf;
2846 const unsigned char * const end = buf + len;
2847
2848 if( !omit_header )
2849 {
2850 /*
2851 * Check Mbed TLS version identifier
2852 */
2853
2854 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2855 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2856
2857 if( memcmp( p, ssl_serialized_session_header,
2858 sizeof( ssl_serialized_session_header ) ) != 0 )
2859 {
2860 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2861 }
2862 p += sizeof( ssl_serialized_session_header );
2863 }
2864
2865 /*
2866 * TLS version identifier
2867 */
2868 if( 1 > (size_t)( end - p ) )
2869 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002870 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002871
2872 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002873 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002874 {
2875#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002876 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002877 {
2878 size_t remaining_len = ( end - p );
2879 return( ssl_session_load_tls12( session, p, remaining_len ) );
2880 }
2881#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2882
2883 default:
2884 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2885 }
2886}
2887
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002888/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002889 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002890 */
2891int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2892 const unsigned char *buf,
2893 size_t len )
2894{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002895 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002896
2897 if( ret != 0 )
2898 mbedtls_ssl_session_free( session );
2899
2900 return( ret );
2901}
2902
2903/*
Paul Bakker1961b702013-01-25 14:49:24 +01002904 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002905 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002906static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2907{
2908 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2909
Ronald Cron66dbf912022-02-02 15:33:46 +01002910 /*
2911 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002912 * that were written into the output buffer by the previous handshake step,
2913 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002914 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2915 * We proceed to the next handshake step only when all data from the
2916 * previous one have been sent to the peer, thus we make sure that this is
2917 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2918 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2919 * we have to wait before to go ahead.
2920 * In the case of TLS 1.3, handshake step handlers do not send data to the
2921 * peer. Data are only sent here and through
2922 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002923 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002924 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002925 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2926 return( ret );
2927
2928#if defined(MBEDTLS_SSL_PROTO_DTLS)
2929 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2930 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2931 {
2932 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2933 return( ret );
2934 }
2935#endif /* MBEDTLS_SSL_PROTO_DTLS */
2936
2937 return( ret );
2938}
2939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002941{
Hanno Becker41934dd2021-08-07 19:13:43 +01002942 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002943
Hanno Becker41934dd2021-08-07 19:13:43 +01002944 if( ssl == NULL ||
2945 ssl->conf == NULL ||
2946 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002947 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002948 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002949 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002950 }
2951
2952 ret = ssl_prepare_handshake_step( ssl );
2953 if( ret != 0 )
2954 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002955
Jerry Yue7047812021-09-13 19:26:39 +08002956 ret = mbedtls_ssl_handle_pending_alert( ssl );
2957 if( ret != 0 )
2958 goto cleanup;
2959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002961 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002962 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2964 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002965
Ronald Cron9f0fba32022-02-10 16:45:15 +01002966 switch( ssl->state )
2967 {
2968 case MBEDTLS_SSL_HELLO_REQUEST:
2969 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2970 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002971
Ronald Cron9f0fba32022-02-10 16:45:15 +01002972 case MBEDTLS_SSL_CLIENT_HELLO:
2973 ret = mbedtls_ssl_write_client_hello( ssl );
2974 break;
2975
2976 default:
2977#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002978 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002979 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2980 else
2981 ret = mbedtls_ssl_handshake_client_step( ssl );
2982#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2983 ret = mbedtls_ssl_handshake_client_step( ssl );
2984#else
2985 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2986#endif
2987 }
Jerry Yub9930e72021-08-06 17:11:51 +08002988 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002989#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002991 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002992 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002993#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002994 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002995 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002996#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002997
2998#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2999 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3000 ret = mbedtls_ssl_handshake_server_step( ssl );
3001#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3002 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003003#endif
3004
Jerry Yue7047812021-09-13 19:26:39 +08003005 if( ret != 0 )
3006 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003007 /* handshake_step return error. And it is same
3008 * with alert_reason.
3009 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003010 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003011 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003012 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003013 goto cleanup;
3014 }
3015 }
3016
3017cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003018 return( ret );
3019}
3020
3021/*
3022 * Perform the SSL handshake
3023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003025{
3026 int ret = 0;
3027
Hanno Beckera817ea42020-10-20 15:20:23 +01003028 /* Sanity checks */
3029
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003030 if( ssl == NULL || ssl->conf == NULL )
3031 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3032
Hanno Beckera817ea42020-10-20 15:20:23 +01003033#if defined(MBEDTLS_SSL_PROTO_DTLS)
3034 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3035 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3036 {
3037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3038 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3039 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3040 }
3041#endif /* MBEDTLS_SSL_PROTO_DTLS */
3042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003044
Hanno Beckera817ea42020-10-20 15:20:23 +01003045 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003046 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003049
3050 if( ret != 0 )
3051 break;
3052 }
3053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003055
3056 return( ret );
3057}
3058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#if defined(MBEDTLS_SSL_RENEGOTIATION)
3060#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003061/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003062 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003065{
Janos Follath865b3eb2019-12-16 11:46:15 +00003066 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003069
3070 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3072 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003073
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003074 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003075 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003076 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003077 return( ret );
3078 }
3079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003081
3082 return( 0 );
3083}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003085
3086/*
3087 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * - any side: calling mbedtls_ssl_renegotiate(),
3089 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3090 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003091 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003092 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003094 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003095int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003096{
Janos Follath865b3eb2019-12-16 11:46:15 +00003097 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003100
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003101 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3102 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003103
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003104 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3105 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003107 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003109 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003110 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003111 ssl->handshake->out_msg_seq = 1;
3112 else
3113 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003114 }
3115#endif
3116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3118 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003121 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003123 return( ret );
3124 }
3125
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003127
3128 return( 0 );
3129}
3130
3131/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003132 * Renegotiate current connection on client,
3133 * or request renegotiation on server
3134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003136{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003138
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003139 if( ssl == NULL || ssl->conf == NULL )
3140 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003143 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003144 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003145 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003146 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003150
3151 /* Did we already try/start sending HelloRequest? */
3152 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003154
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003155 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003156 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003160 /*
3161 * On client, either start the renegotiation process or,
3162 * if already in progress, continue the handshake
3163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003165 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003166 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003168
Hanno Becker40cdaa12020-02-05 10:48:27 +00003169 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003170 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003171 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003172 return( ret );
3173 }
3174 }
3175 else
3176 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003178 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003180 return( ret );
3181 }
3182 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003184
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003185 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003186}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003188
Gilles Peskine9b562d52018-04-25 20:32:43 +02003189void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003190{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003191 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3192
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003193 if( handshake == NULL )
3194 return;
3195
Brett Warrene0edc842021-08-17 09:53:13 +01003196#if defined(MBEDTLS_ECP_C)
3197#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3198 if ( ssl->handshake->group_list_heap_allocated )
3199 mbedtls_free( (void*) handshake->group_list );
3200 handshake->group_list = NULL;
3201#endif /* MBEDTLS_DEPRECATED_REMOVED */
3202#endif /* MBEDTLS_ECP_C */
3203
Jerry Yuf017ee42022-01-12 15:49:48 +08003204#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3205#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3206 if ( ssl->handshake->sig_algs_heap_allocated )
3207 mbedtls_free( (void*) handshake->sig_algs );
3208 handshake->sig_algs = NULL;
3209#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003210#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3211 if( ssl->handshake->certificate_request_context )
3212 {
3213 mbedtls_free( (void*) handshake->certificate_request_context );
3214 }
3215#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003216#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3217
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003218#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3219 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3220 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003221 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003222 handshake->async_in_progress = 0;
3223 }
3224#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3225
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003226#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003227#if defined(MBEDTLS_USE_PSA_CRYPTO)
3228 psa_hash_abort( &handshake->fin_sha256_psa );
3229#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003230 mbedtls_sha256_free( &handshake->fin_sha256 );
3231#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003232#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003233#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003234#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003235 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003236#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003237 mbedtls_sha512_free( &handshake->fin_sha512 );
3238#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003239#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#if defined(MBEDTLS_DHM_C)
3242 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003243#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003244#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003246#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003247#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003248 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003249#if defined(MBEDTLS_SSL_CLI_C)
3250 mbedtls_free( handshake->ecjpake_cache );
3251 handshake->ecjpake_cache = NULL;
3252 handshake->ecjpake_cache_len = 0;
3253#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003254#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003255
Janos Follath4ae5c292016-02-10 11:27:43 +00003256#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3257 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003258 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003260#endif
3261
Gilles Peskineeccd8882020-03-10 12:19:08 +01003262#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003263#if defined(MBEDTLS_USE_PSA_CRYPTO)
3264 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3265 {
3266 /* The maintenance of the external PSK key slot is the
3267 * user's responsibility. */
3268 if( ssl->handshake->psk_opaque_is_internal )
3269 {
3270 psa_destroy_key( ssl->handshake->psk_opaque );
3271 ssl->handshake->psk_opaque_is_internal = 0;
3272 }
3273 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3274 }
Neil Armstronge952a302022-05-03 10:22:14 +02003275#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003276 if( handshake->psk != NULL )
3277 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003278 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003279 mbedtls_free( handshake->psk );
3280 }
Neil Armstronge952a302022-05-03 10:22:14 +02003281#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003282#endif
3283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3285 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003286 /*
3287 * Free only the linked list wrapper, not the keys themselves
3288 * since the belong to the SNI callback
3289 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003290 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003292
Gilles Peskineeccd8882020-03-10 12:19:08 +01003293#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003294 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003295 if( handshake->ecrs_peer_cert != NULL )
3296 {
3297 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3298 mbedtls_free( handshake->ecrs_peer_cert );
3299 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003300#endif
3301
Hanno Becker75173122019-02-06 16:18:31 +00003302#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3303 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3304 mbedtls_pk_free( &handshake->peer_pubkey );
3305#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3306
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003307#if defined(MBEDTLS_SSL_CLI_C) && \
3308 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3309 mbedtls_free( handshake->cookie );
3310#endif /* MBEDTLS_SSL_CLI_C &&
3311 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003312
3313#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003314 mbedtls_ssl_flight_free( handshake->flight );
3315 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003316#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003317
Ronald Cronf12b81d2022-03-15 10:42:41 +01003318#if defined(MBEDTLS_ECDH_C) && \
3319 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003320 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003321 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003322#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3323
Ronald Cron6f135e12021-12-08 16:57:54 +01003324#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003325 mbedtls_ssl_transform_free( handshake->transform_handshake );
3326 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003327 mbedtls_free( handshake->transform_earlydata );
3328 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003329#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003330
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003331
3332#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3333 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3334 * processes datagrams and the fact that a datagram is allowed to have
3335 * several records in it, it is possible that the I/O buffers are not
3336 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003337 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3338 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003339#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003340
Jerry Yuba9c7272021-10-30 11:54:10 +08003341 /* mbedtls_platform_zeroize MUST be last one in this function */
3342 mbedtls_platform_zeroize( handshake,
3343 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003344}
3345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003347{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003348 if( session == NULL )
3349 return;
3350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003352 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003353#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003354
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003355#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003357#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003358
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003359 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003360}
3361
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003362#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003363
3364#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3365#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3366#else
3367#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3368#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3369
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003370#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003371
3372#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3373#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3374#else
3375#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3376#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3377
3378#if defined(MBEDTLS_SSL_ALPN)
3379#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3380#else
3381#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3382#endif /* MBEDTLS_SSL_ALPN */
3383
3384#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3385#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3386#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3387#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3388
3389#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3390 ( (uint32_t) ( \
3391 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3392 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3393 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3394 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3395 0u ) )
3396
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003397static unsigned char ssl_serialized_context_header[] = {
3398 MBEDTLS_VERSION_MAJOR,
3399 MBEDTLS_VERSION_MINOR,
3400 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003401 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3402 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3403 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3404 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3405 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003406};
3407
Paul Bakker5121ce52009-01-03 21:22:43 +00003408/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003409 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003410 *
3411 * The format of the serialized data is:
3412 * (in the presentation language of TLS, RFC 8446 section 3)
3413 *
3414 * // header
3415 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003416 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003417 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003418 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003419 * Note: When updating the format, remember to keep these
3420 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003421 *
3422 * // session sub-structure
3423 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3424 * // transform sub-structure
3425 * uint8 random[64]; // ServerHello.random+ClientHello.random
3426 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3427 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3428 * // fields from ssl_context
3429 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3430 * uint64 in_window_top; // DTLS: last validated record seq_num
3431 * uint64 in_window; // DTLS: bitmask for replay protection
3432 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3433 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3434 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3435 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3436 *
3437 * Note that many fields of the ssl_context or sub-structures are not
3438 * serialized, as they fall in one of the following categories:
3439 *
3440 * 1. forced value (eg in_left must be 0)
3441 * 2. pointer to dynamically-allocated memory (eg session, transform)
3442 * 3. value can be re-derived from other data (eg session keys from MS)
3443 * 4. value was temporary (eg content of input buffer)
3444 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003445 */
3446int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3447 unsigned char *buf,
3448 size_t buf_len,
3449 size_t *olen )
3450{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003451 unsigned char *p = buf;
3452 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003453 size_t session_len;
3454 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003455
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003456 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003457 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3458 * this function's documentation.
3459 *
3460 * These are due to assumptions/limitations in the implementation. Some of
3461 * them are likely to stay (no handshake in progress) some might go away
3462 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003463 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003464 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003465 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003466 {
3467 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003468 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003469 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003470 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003471 {
3472 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003473 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003474 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003475 /* Double-check that sub-structures are indeed ready */
3476 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003477 {
3478 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003479 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003480 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003481 /* There must be no pending incoming or outgoing data */
3482 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003483 {
3484 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003485 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003486 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003487 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003488 {
3489 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003490 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003491 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003492 /* Protocol must be DLTS, not TLS */
3493 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003494 {
3495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003496 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003497 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003498 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003499 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003500 {
3501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003502 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003503 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003504 /* We must be using an AEAD ciphersuite */
3505 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003506 {
3507 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003508 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003509 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003510 /* Renegotiation must not be enabled */
3511#if defined(MBEDTLS_SSL_RENEGOTIATION)
3512 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003513 {
3514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
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#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003518
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003519 /*
3520 * Version and format identifier
3521 */
3522 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003523
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003524 if( used <= buf_len )
3525 {
3526 memcpy( p, ssl_serialized_context_header,
3527 sizeof( ssl_serialized_context_header ) );
3528 p += sizeof( ssl_serialized_context_header );
3529 }
3530
3531 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003532 * Session (length + data)
3533 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003534 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003535 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3536 return( ret );
3537
3538 used += 4 + session_len;
3539 if( used <= buf_len )
3540 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003541 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3542 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003543
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003544 ret = ssl_session_save( ssl->session, 1,
3545 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003546 if( ret != 0 )
3547 return( ret );
3548
3549 p += session_len;
3550 }
3551
3552 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003553 * Transform
3554 */
3555 used += sizeof( ssl->transform->randbytes );
3556 if( used <= buf_len )
3557 {
3558 memcpy( p, ssl->transform->randbytes,
3559 sizeof( ssl->transform->randbytes ) );
3560 p += sizeof( ssl->transform->randbytes );
3561 }
3562
3563#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3564 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3565 if( used <= buf_len )
3566 {
3567 *p++ = ssl->transform->in_cid_len;
3568 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3569 p += ssl->transform->in_cid_len;
3570
3571 *p++ = ssl->transform->out_cid_len;
3572 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3573 p += ssl->transform->out_cid_len;
3574 }
3575#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3576
3577 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003578 * Saved fields from top-level ssl_context structure
3579 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003580 used += 4;
3581 if( used <= buf_len )
3582 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003583 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3584 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003585 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003586
3587#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3588 used += 16;
3589 if( used <= buf_len )
3590 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003591 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3592 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003593
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003594 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3595 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003596 }
3597#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3598
3599#if defined(MBEDTLS_SSL_PROTO_DTLS)
3600 used += 1;
3601 if( used <= buf_len )
3602 {
3603 *p++ = ssl->disable_datagram_packing;
3604 }
3605#endif /* MBEDTLS_SSL_PROTO_DTLS */
3606
Jerry Yuae0b2e22021-10-08 15:21:19 +08003607 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003608 if( used <= buf_len )
3609 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003610 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3611 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003612 }
3613
3614#if defined(MBEDTLS_SSL_PROTO_DTLS)
3615 used += 2;
3616 if( used <= buf_len )
3617 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003618 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3619 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003620 }
3621#endif /* MBEDTLS_SSL_PROTO_DTLS */
3622
3623#if defined(MBEDTLS_SSL_ALPN)
3624 {
3625 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003626 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003627 : 0;
3628
3629 used += 1 + alpn_len;
3630 if( used <= buf_len )
3631 {
3632 *p++ = alpn_len;
3633
3634 if( ssl->alpn_chosen != NULL )
3635 {
3636 memcpy( p, ssl->alpn_chosen, alpn_len );
3637 p += alpn_len;
3638 }
3639 }
3640 }
3641#endif /* MBEDTLS_SSL_ALPN */
3642
3643 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003644 * Done
3645 */
3646 *olen = used;
3647
3648 if( used > buf_len )
3649 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003650
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003651 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3652
Hanno Becker43aefe22020-02-05 10:44:56 +00003653 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003654}
3655
3656/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003657 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003658 *
3659 * This internal version is wrapped by a public function that cleans up in
3660 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003661 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003662static int ssl_context_load( mbedtls_ssl_context *ssl,
3663 const unsigned char *buf,
3664 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003665{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003666 const unsigned char *p = buf;
3667 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003668 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003670
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003671 /*
3672 * The context should have been freshly setup or reset.
3673 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003674 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003675 * renegotiating, or if the user mistakenly loaded a session first.)
3676 */
3677 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3678 ssl->session != NULL )
3679 {
3680 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3681 }
3682
3683 /*
3684 * We can't check that the config matches the initial one, but we can at
3685 * least check it matches the requirements for serializing.
3686 */
3687 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003688 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3689 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003690#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003691 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003692#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003693 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003694 {
3695 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3696 }
3697
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003698 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3699
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003700 /*
3701 * Check version identifier
3702 */
3703 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3705
3706 if( memcmp( p, ssl_serialized_context_header,
3707 sizeof( ssl_serialized_context_header ) ) != 0 )
3708 {
3709 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3710 }
3711 p += sizeof( ssl_serialized_context_header );
3712
3713 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003714 * Session
3715 */
3716 if( (size_t)( end - p ) < 4 )
3717 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3718
3719 session_len = ( (size_t) p[0] << 24 ) |
3720 ( (size_t) p[1] << 16 ) |
3721 ( (size_t) p[2] << 8 ) |
3722 ( (size_t) p[3] );
3723 p += 4;
3724
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003725 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003726 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003727 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003728 ssl->session_in = ssl->session;
3729 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003730 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003731
3732 if( (size_t)( end - p ) < session_len )
3733 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3734
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003735 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003736 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003737 {
3738 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003739 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003740 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003741
3742 p += session_len;
3743
3744 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003745 * Transform
3746 */
3747
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003748 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003749 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003750 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003751 ssl->transform_in = ssl->transform;
3752 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003753 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003754
3755 /* Read random bytes and populate structure */
3756 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003758#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003759 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003760 ssl->session->ciphersuite,
3761 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003762#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003763 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003764#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003765 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3766 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003767 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003768 ssl->conf->endpoint,
3769 ssl );
3770 if( ret != 0 )
3771 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003772#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003773 p += sizeof( ssl->transform->randbytes );
3774
3775#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3776 /* Read connection IDs and store them */
3777 if( (size_t)( end - p ) < 1 )
3778 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3779
3780 ssl->transform->in_cid_len = *p++;
3781
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003782 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003783 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3784
3785 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3786 p += ssl->transform->in_cid_len;
3787
3788 ssl->transform->out_cid_len = *p++;
3789
3790 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3791 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3792
3793 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3794 p += ssl->transform->out_cid_len;
3795#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3796
3797 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003798 * Saved fields from top-level ssl_context structure
3799 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003800 if( (size_t)( end - p ) < 4 )
3801 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3802
3803 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3804 ( (uint32_t) p[1] << 16 ) |
3805 ( (uint32_t) p[2] << 8 ) |
3806 ( (uint32_t) p[3] );
3807 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003808
3809#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3810 if( (size_t)( end - p ) < 16 )
3811 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3812
3813 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3814 ( (uint64_t) p[1] << 48 ) |
3815 ( (uint64_t) p[2] << 40 ) |
3816 ( (uint64_t) p[3] << 32 ) |
3817 ( (uint64_t) p[4] << 24 ) |
3818 ( (uint64_t) p[5] << 16 ) |
3819 ( (uint64_t) p[6] << 8 ) |
3820 ( (uint64_t) p[7] );
3821 p += 8;
3822
3823 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3824 ( (uint64_t) p[1] << 48 ) |
3825 ( (uint64_t) p[2] << 40 ) |
3826 ( (uint64_t) p[3] << 32 ) |
3827 ( (uint64_t) p[4] << 24 ) |
3828 ( (uint64_t) p[5] << 16 ) |
3829 ( (uint64_t) p[6] << 8 ) |
3830 ( (uint64_t) p[7] );
3831 p += 8;
3832#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3833
3834#if defined(MBEDTLS_SSL_PROTO_DTLS)
3835 if( (size_t)( end - p ) < 1 )
3836 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3837
3838 ssl->disable_datagram_packing = *p++;
3839#endif /* MBEDTLS_SSL_PROTO_DTLS */
3840
Jerry Yud9a94fe2021-09-28 18:58:59 +08003841 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003842 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003843 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3844 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003845
3846#if defined(MBEDTLS_SSL_PROTO_DTLS)
3847 if( (size_t)( end - p ) < 2 )
3848 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3849
3850 ssl->mtu = ( p[0] << 8 ) | p[1];
3851 p += 2;
3852#endif /* MBEDTLS_SSL_PROTO_DTLS */
3853
3854#if defined(MBEDTLS_SSL_ALPN)
3855 {
3856 uint8_t alpn_len;
3857 const char **cur;
3858
3859 if( (size_t)( end - p ) < 1 )
3860 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3861
3862 alpn_len = *p++;
3863
3864 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3865 {
3866 /* alpn_chosen should point to an item in the configured list */
3867 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3868 {
3869 if( strlen( *cur ) == alpn_len &&
3870 memcmp( p, cur, alpn_len ) == 0 )
3871 {
3872 ssl->alpn_chosen = *cur;
3873 break;
3874 }
3875 }
3876 }
3877
3878 /* can only happen on conf mismatch */
3879 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3880 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3881
3882 p += alpn_len;
3883 }
3884#endif /* MBEDTLS_SSL_ALPN */
3885
3886 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003887 * Forced fields from top-level ssl_context structure
3888 *
3889 * Most of them already set to the correct value by mbedtls_ssl_init() and
3890 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3891 */
3892 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003893 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003894
Hanno Becker361b10d2019-08-30 10:42:49 +01003895 /* Adjust pointers for header fields of outgoing records to
3896 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003897 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003898
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003899#if defined(MBEDTLS_SSL_PROTO_DTLS)
3900 ssl->in_epoch = 1;
3901#endif
3902
3903 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3904 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003905 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3906 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003907 if( ssl->handshake != NULL )
3908 {
3909 mbedtls_ssl_handshake_free( ssl );
3910 mbedtls_free( ssl->handshake );
3911 ssl->handshake = NULL;
3912 }
3913
3914 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003915 * Done - should have consumed entire buffer
3916 */
3917 if( p != end )
3918 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003919
3920 return( 0 );
3921}
3922
3923/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003924 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003925 */
3926int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3927 const unsigned char *buf,
3928 size_t len )
3929{
3930 int ret = ssl_context_load( context, buf, len );
3931
3932 if( ret != 0 )
3933 mbedtls_ssl_free( context );
3934
3935 return( ret );
3936}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003937#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003938
3939/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003940 * Free an SSL context
3941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003942void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003943{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003944 if( ssl == NULL )
3945 return;
3946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003948
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003949 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003950 {
sander-visserb8aa2072020-05-06 22:05:13 +02003951#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3952 size_t out_buf_len = ssl->out_buf_len;
3953#else
3954 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3955#endif
3956
Darryl Greenb33cc762019-11-28 14:29:44 +00003957 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003958 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003959 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003960 }
3961
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003962 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003963 {
sander-visserb8aa2072020-05-06 22:05:13 +02003964#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3965 size_t in_buf_len = ssl->in_buf_len;
3966#else
3967 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3968#endif
3969
Darryl Greenb33cc762019-11-28 14:29:44 +00003970 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003971 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003972 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003973 }
3974
Paul Bakker48916f92012-09-16 19:57:18 +00003975 if( ssl->transform )
3976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977 mbedtls_ssl_transform_free( ssl->transform );
3978 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003979 }
3980
3981 if( ssl->handshake )
3982 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003983 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003984 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3985 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003987 mbedtls_free( ssl->handshake );
3988 mbedtls_free( ssl->transform_negotiate );
3989 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003990 }
3991
Ronald Cron6f135e12021-12-08 16:57:54 +01003992#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003993 mbedtls_ssl_transform_free( ssl->transform_application );
3994 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003995#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003996
Paul Bakkerc0463502013-02-14 11:19:38 +01003997 if( ssl->session )
3998 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999 mbedtls_ssl_session_free( ssl->session );
4000 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004001 }
4002
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004003#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004004 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004005 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004006 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004008 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004009#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004010
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004011#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004012 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004013#endif
4014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004016
Paul Bakker86f04f42013-02-14 11:20:09 +01004017 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004018 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004019}
4020
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004021/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004022 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004023 */
4024void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4025{
4026 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4027}
4028
Gilles Peskineae270bf2021-06-02 00:05:29 +02004029/* The selection should be the same as mbedtls_x509_crt_profile_default in
4030 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004031 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004032 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004033 * about this list.
4034 */
Brett Warrene0edc842021-08-17 09:53:13 +01004035static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004036#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004037 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004038#endif
4039#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004040 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004041#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004042#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004043 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004044#endif
4045#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004046 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004047#endif
4048#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004049 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004050#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004051#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004052 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004053#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004054#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004055 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004056#endif
4057#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004058 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004059#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004060 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004061};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004062
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004063static int ssl_preset_suiteb_ciphersuites[] = {
4064 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4065 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4066 0
4067};
4068
Gilles Peskineeccd8882020-03-10 12:19:08 +01004069#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004070
Jerry Yu909df7b2022-01-22 11:56:27 +08004071/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004072 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004073 * rules SHOULD be upheld.
4074 * - No duplicate entries.
4075 * - But if there is a good reason, do not change the order of the algorithms.
4076 * - ssl_tls12_present* is for TLS 1.2 use only.
4077 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004078 *
Jerry Yua1255e62022-06-24 10:10:47 +08004079 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4080 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4081 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
Jerry Yucc539102022-06-27 16:27:35 +08004082 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4083 * for its signature in the key exchange message. As Mbed TLS 1.2 does not
Jerry Yua1255e62022-06-24 10:10:47 +08004084 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004085 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004086static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004087
Jerry Yued5e9f42022-01-26 11:21:34 +08004088#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4089 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4090 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4091#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4092 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004093
Jerry Yu909df7b2022-01-22 11:56:27 +08004094#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4095 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4096 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4097#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4098 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4099
Jerry Yued5e9f42022-01-26 11:21:34 +08004100#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4101 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4102 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4103#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4104 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004105
Ronald Cron8540cf62022-03-16 08:01:09 +01004106#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4107 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4108#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4109
4110#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4111 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4112#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4113
Jerry Yu53037892022-01-25 11:02:06 +08004114#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4115 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4116#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4117
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004118#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4119 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4120#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4121
4122#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4123 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4124#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4125
4126#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4127 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4128#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4129
Gabor Mezei15b95a62022-05-09 16:37:58 +02004130 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004131};
4132
4133/* NOTICE: see above */
4134#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4135static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004136#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004137#if defined(MBEDTLS_ECDSA_C)
4138 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004139#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004140#if defined(MBEDTLS_RSA_C)
4141 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4142#endif
4143#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004144#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004145#if defined(MBEDTLS_ECDSA_C)
4146 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004147#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004148#if defined(MBEDTLS_RSA_C)
4149 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4150#endif
4151#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004152#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004153#if defined(MBEDTLS_ECDSA_C)
4154 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004155#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004156#if defined(MBEDTLS_RSA_C)
4157 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4158#endif
4159#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004160 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004161};
4162#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4163/* NOTICE: see above */
4164static uint16_t ssl_preset_suiteb_sig_algs[] = {
4165
Jerry Yu909df7b2022-01-22 11:56:27 +08004166#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4167 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4168 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4169#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4170 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4171
Jerry Yu53037892022-01-25 11:02:06 +08004172#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4173 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4174 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4175#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4176 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004177
4178#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4179 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4180#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004181
Jerry Yu53037892022-01-25 11:02:06 +08004182#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4183 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4184#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4185
Gabor Mezei15b95a62022-05-09 16:37:58 +02004186 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004187};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004188
Jerry Yu909df7b2022-01-22 11:56:27 +08004189/* NOTICE: see above */
4190#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4191static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004192#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004193#if defined(MBEDTLS_ECDSA_C)
4194 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004195#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004196#if defined(MBEDTLS_RSA_C)
4197 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4198#endif
4199#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004200#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004201#if defined(MBEDTLS_ECDSA_C)
4202 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004203#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004204#if defined(MBEDTLS_RSA_C)
4205 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4206#endif
4207#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004208 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004209};
Jerry Yu909df7b2022-01-22 11:56:27 +08004210#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4211
Jerry Yu1a8b4812022-01-20 17:56:50 +08004212#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004213
Brett Warrene0edc842021-08-17 09:53:13 +01004214static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004215#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004216 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004217#endif
4218#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004219 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004220#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004221 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004222};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004223
Jerry Yu1a8b4812022-01-20 17:56:50 +08004224#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004225/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004226 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004227static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004228{
4229 size_t i, j;
4230 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004231
Gabor Mezei15b95a62022-05-09 16:37:58 +02004232 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004233 {
Jerry Yuf377d642022-01-25 10:43:59 +08004234 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004235 {
Jerry Yuf377d642022-01-25 10:43:59 +08004236 if( sig_algs[i] != sig_algs[j] )
4237 continue;
4238 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4239 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4240 sig_algs[i], j, i );
4241 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004242 }
4243 }
4244 return( ret );
4245}
4246
4247#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4248
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004249/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004250 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004251 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004252int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004253 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004254{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004255#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004257#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004258
Jerry Yu1a8b4812022-01-20 17:56:50 +08004259#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004260 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004261 {
4262 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4263 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4264 }
4265
Jerry Yuf377d642022-01-25 10:43:59 +08004266 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004267 {
4268 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4269 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4270 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004271
4272#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004273 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004274 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004275 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004276 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4277 }
4278
Jerry Yuf377d642022-01-25 10:43:59 +08004279 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004280 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004281 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004282 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4283 }
4284#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004285#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4286
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004287 /* Use the functions here so that they are covered in tests,
4288 * but otherwise access member directly for efficiency */
4289 mbedtls_ssl_conf_endpoint( conf, endpoint );
4290 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004291
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004292 /*
4293 * Things that are common to all presets
4294 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004295#if defined(MBEDTLS_SSL_CLI_C)
4296 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4297 {
4298 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4299#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4300 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4301#endif
4302 }
4303#endif
4304
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004305#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4306 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4307#endif
4308
4309#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4310 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4311#endif
4312
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004313#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004314 conf->f_cookie_write = ssl_cookie_write_dummy;
4315 conf->f_cookie_check = ssl_cookie_check_dummy;
4316#endif
4317
4318#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4319 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4320#endif
4321
Janos Follath088ce432017-04-10 12:42:31 +01004322#if defined(MBEDTLS_SSL_SRV_C)
4323 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004324 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004325#endif
4326
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004327#if defined(MBEDTLS_SSL_PROTO_DTLS)
4328 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4329 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4330#endif
4331
4332#if defined(MBEDTLS_SSL_RENEGOTIATION)
4333 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004334 memset( conf->renego_period, 0x00, 2 );
4335 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004336#endif
4337
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004338#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004339 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4340 {
4341 const unsigned char dhm_p[] =
4342 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4343 const unsigned char dhm_g[] =
4344 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004345
Hanno Beckere2defad2021-07-24 05:59:17 +01004346 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4347 dhm_p, sizeof( dhm_p ),
4348 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4349 {
4350 return( ret );
4351 }
4352 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004353#endif
4354
Ronald Cron6f135e12021-12-08 16:57:54 +01004355#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004356 /*
4357 * Allow all TLS 1.3 key exchange modes by default.
4358 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004359 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004360#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004361
XiaokangQian4d3a6042022-04-21 13:46:17 +00004362 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4363 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004364#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004365 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004366 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004367#else
XiaokangQian060d8672022-04-21 09:24:56 +00004368 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004369#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004370 }
4371 else
4372 {
4373#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4374 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4375 {
4376 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4377 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4378 }
4379 else
4380 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4381 {
4382 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4383 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4384 }
4385#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4386 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4387 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4388#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4389 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4390 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4391#else
4392 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4393#endif
4394 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004395
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004396 /*
4397 * Preset-specific defaults
4398 */
4399 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004400 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004401 /*
4402 * NSA Suite B
4403 */
4404 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004405
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004406 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004407
4408#if defined(MBEDTLS_X509_CRT_PARSE_C)
4409 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004410#endif
4411
Gilles Peskineeccd8882020-03-10 12:19:08 +01004412#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004413#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4414 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4415 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4416 else
4417#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4418 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004419#endif
4420
Brett Warrene0edc842021-08-17 09:53:13 +01004421#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4422 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004423#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004424 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004425 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004426
4427 /*
4428 * Default
4429 */
4430 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004431
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004432 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004433
4434#if defined(MBEDTLS_X509_CRT_PARSE_C)
4435 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4436#endif
4437
Gilles Peskineeccd8882020-03-10 12:19:08 +01004438#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004439#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4440 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4441 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4442 else
4443#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4444 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004445#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004446
Brett Warrene0edc842021-08-17 09:53:13 +01004447#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4448 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004449#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004450 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004451
4452#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4453 conf->dhm_min_bitlen = 1024;
4454#endif
4455 }
4456
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004457 return( 0 );
4458}
4459
4460/*
4461 * Free mbedtls_ssl_config
4462 */
4463void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4464{
4465#if defined(MBEDTLS_DHM_C)
4466 mbedtls_mpi_free( &conf->dhm_P );
4467 mbedtls_mpi_free( &conf->dhm_G );
4468#endif
4469
Gilles Peskineeccd8882020-03-10 12:19:08 +01004470#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004471#if defined(MBEDTLS_USE_PSA_CRYPTO)
4472 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4473 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004474 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4475 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004476#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004477 if( conf->psk != NULL )
4478 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004479 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004480 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004481 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004482 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004483 }
4484
4485 if( conf->psk_identity != NULL )
4486 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004487 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004488 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004489 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004490 conf->psk_identity_len = 0;
4491 }
4492#endif
4493
4494#if defined(MBEDTLS_X509_CRT_PARSE_C)
4495 ssl_key_cert_free( conf->key_cert );
4496#endif
4497
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004498 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004499}
4500
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004501#if defined(MBEDTLS_PK_C) && \
4502 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004503/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004504 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004506unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004507{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004508#if defined(MBEDTLS_RSA_C)
4509 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4510 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004511#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004512#if defined(MBEDTLS_ECDSA_C)
4513 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4514 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004515#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004516 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004517}
4518
Hanno Becker7e5437a2017-04-28 17:15:26 +01004519unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4520{
4521 switch( type ) {
4522 case MBEDTLS_PK_RSA:
4523 return( MBEDTLS_SSL_SIG_RSA );
4524 case MBEDTLS_PK_ECDSA:
4525 case MBEDTLS_PK_ECKEY:
4526 return( MBEDTLS_SSL_SIG_ECDSA );
4527 default:
4528 return( MBEDTLS_SSL_SIG_ANON );
4529 }
4530}
4531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004533{
4534 switch( sig )
4535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004536#if defined(MBEDTLS_RSA_C)
4537 case MBEDTLS_SSL_SIG_RSA:
4538 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004539#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_ECDSA_C)
4541 case MBEDTLS_SSL_SIG_ECDSA:
4542 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004543#endif
4544 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004546 }
4547}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004548#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004549
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004550/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004551 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004554{
4555 switch( hash )
4556 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557#if defined(MBEDTLS_MD5_C)
4558 case MBEDTLS_SSL_HASH_MD5:
4559 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004560#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561#if defined(MBEDTLS_SHA1_C)
4562 case MBEDTLS_SSL_HASH_SHA1:
4563 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004564#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004565#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004566 case MBEDTLS_SSL_HASH_SHA224:
4567 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004568#endif
4569#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570 case MBEDTLS_SSL_HASH_SHA256:
4571 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004572#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004573#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574 case MBEDTLS_SSL_HASH_SHA384:
4575 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004576#endif
4577#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578 case MBEDTLS_SSL_HASH_SHA512:
4579 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004580#endif
4581 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004582 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004583 }
4584}
4585
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004586/*
4587 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4588 */
4589unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4590{
4591 switch( md )
4592 {
4593#if defined(MBEDTLS_MD5_C)
4594 case MBEDTLS_MD_MD5:
4595 return( MBEDTLS_SSL_HASH_MD5 );
4596#endif
4597#if defined(MBEDTLS_SHA1_C)
4598 case MBEDTLS_MD_SHA1:
4599 return( MBEDTLS_SSL_HASH_SHA1 );
4600#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004601#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004602 case MBEDTLS_MD_SHA224:
4603 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004604#endif
4605#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004606 case MBEDTLS_MD_SHA256:
4607 return( MBEDTLS_SSL_HASH_SHA256 );
4608#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004609#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004610 case MBEDTLS_MD_SHA384:
4611 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004612#endif
4613#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004614 case MBEDTLS_MD_SHA512:
4615 return( MBEDTLS_SSL_HASH_SHA512 );
4616#endif
4617 default:
4618 return( MBEDTLS_SSL_HASH_NONE );
4619 }
4620}
4621
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004622/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004623 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004624 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004625 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004626int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004627{
Brett Warrene0edc842021-08-17 09:53:13 +01004628 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004629
Brett Warrene0edc842021-08-17 09:53:13 +01004630 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004631 return( -1 );
4632
Brett Warrene0edc842021-08-17 09:53:13 +01004633 for( ; *group_list != 0; group_list++ )
4634 {
4635 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004636 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004637 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004638
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004639 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004640}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004641
4642#if defined(MBEDTLS_ECP_C)
4643/*
4644 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4645 */
4646int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4647{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004648 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004649 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4650}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004651#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004653#if defined(MBEDTLS_X509_CRT_PARSE_C)
4654int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4655 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004656 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004657 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004658{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004659 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004660 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004661 const char *ext_oid;
4662 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004664 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004665 {
4666 /* Server part of the key exchange */
4667 switch( ciphersuite->key_exchange )
4668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004669 case MBEDTLS_KEY_EXCHANGE_RSA:
4670 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004671 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004672 break;
4673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004674 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4675 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4676 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4677 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004678 break;
4679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4681 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004682 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004683 break;
4684
4685 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686 case MBEDTLS_KEY_EXCHANGE_NONE:
4687 case MBEDTLS_KEY_EXCHANGE_PSK:
4688 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4689 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004690 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004691 usage = 0;
4692 }
4693 }
4694 else
4695 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004696 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4697 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004698 }
4699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004701 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004702 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004703 ret = -1;
4704 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4709 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004710 }
4711 else
4712 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4714 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004715 }
4716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004718 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004719 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004720 ret = -1;
4721 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004722
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004723 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004724}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004726
Jerry Yu148165c2021-09-24 23:20:59 +08004727#if defined(MBEDTLS_USE_PSA_CRYPTO)
4728int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4729 const mbedtls_md_type_t md,
4730 unsigned char *dst,
4731 size_t dst_len,
4732 size_t *olen )
4733{
Ronald Cronf6893e12022-01-07 22:09:01 +01004734 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4735 psa_hash_operation_t *hash_operation_to_clone;
4736 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4737
Jerry Yu148165c2021-09-24 23:20:59 +08004738 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004739
4740 switch( md )
4741 {
4742#if defined(MBEDTLS_SHA384_C)
4743 case MBEDTLS_MD_SHA384:
4744 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4745 break;
4746#endif
4747
4748#if defined(MBEDTLS_SHA256_C)
4749 case MBEDTLS_MD_SHA256:
4750 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4751 break;
4752#endif
4753
4754 default:
4755 goto exit;
4756 }
4757
4758 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4759 if( status != PSA_SUCCESS )
4760 goto exit;
4761
4762 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4763 if( status != PSA_SUCCESS )
4764 goto exit;
4765
4766exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004767 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004768}
4769#else /* MBEDTLS_USE_PSA_CRYPTO */
4770
Jerry Yu24c0ec32021-09-09 14:21:07 +08004771#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004772static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4773 unsigned char *dst,
4774 size_t dst_len,
4775 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004776{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004777 int ret;
4778 mbedtls_sha512_context sha512;
4779
4780 if( dst_len < 48 )
4781 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4782
4783 mbedtls_sha512_init( &sha512 );
4784 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4785
4786 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4787 {
4788 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4789 goto exit;
4790 }
4791
4792 *olen = 48;
4793
4794exit:
4795
4796 mbedtls_sha512_free( &sha512 );
4797 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004798}
4799#endif /* MBEDTLS_SHA384_C */
4800
4801#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004802static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4803 unsigned char *dst,
4804 size_t dst_len,
4805 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004806{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004807 int ret;
4808 mbedtls_sha256_context sha256;
4809
4810 if( dst_len < 32 )
4811 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4812
4813 mbedtls_sha256_init( &sha256 );
4814 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004815
Jerry Yu24c0ec32021-09-09 14:21:07 +08004816 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4817 {
4818 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4819 goto exit;
4820 }
4821
4822 *olen = 32;
4823
4824exit:
4825
4826 mbedtls_sha256_free( &sha256 );
4827 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004828}
4829#endif /* MBEDTLS_SHA256_C */
4830
Jerry Yu000f9762021-09-14 11:12:51 +08004831int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4832 const mbedtls_md_type_t md,
4833 unsigned char *dst,
4834 size_t dst_len,
4835 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004836{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004837 switch( md )
4838 {
4839
Jerry Yu24c0ec32021-09-09 14:21:07 +08004840#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004841 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004842 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004843#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004844
Jerry Yu24c0ec32021-09-09 14:21:07 +08004845#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004846 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004847 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004848#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004849
4850 default:
4851 break;
4852 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004853 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004854}
XiaokangQian647719a2021-12-07 09:16:29 +00004855
Jerry Yu148165c2021-09-24 23:20:59 +08004856#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004857
Gabor Mezei078e8032022-04-27 21:17:56 +02004858#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4859/* mbedtls_ssl_parse_sig_alg_ext()
4860 *
4861 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4862 * value (TLS 1.3 RFC8446):
4863 * enum {
4864 * ....
4865 * ecdsa_secp256r1_sha256( 0x0403 ),
4866 * ecdsa_secp384r1_sha384( 0x0503 ),
4867 * ecdsa_secp521r1_sha512( 0x0603 ),
4868 * ....
4869 * } SignatureScheme;
4870 *
4871 * struct {
4872 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4873 * } SignatureSchemeList;
4874 *
4875 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4876 * value (TLS 1.2 RFC5246):
4877 * enum {
4878 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4879 * sha512(6), (255)
4880 * } HashAlgorithm;
4881 *
4882 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4883 * SignatureAlgorithm;
4884 *
4885 * struct {
4886 * HashAlgorithm hash;
4887 * SignatureAlgorithm signature;
4888 * } SignatureAndHashAlgorithm;
4889 *
4890 * SignatureAndHashAlgorithm
4891 * supported_signature_algorithms<2..2^16-2>;
4892 *
4893 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4894 * generalization of the TLS 1.2 signature algorithm extension.
4895 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4896 * `SignatureScheme` field of TLS 1.3
4897 *
4898 */
4899int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4900 const unsigned char *buf,
4901 const unsigned char *end )
4902{
4903 const unsigned char *p = buf;
4904 size_t supported_sig_algs_len = 0;
4905 const unsigned char *supported_sig_algs_end;
4906 uint16_t sig_alg;
4907 uint32_t common_idx = 0;
4908
4909 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4910 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4911 p += 2;
4912
4913 memset( ssl->handshake->received_sig_algs, 0,
4914 sizeof(ssl->handshake->received_sig_algs) );
4915
4916 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4917 supported_sig_algs_end = p + supported_sig_algs_len;
4918 while( p < supported_sig_algs_end )
4919 {
4920 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4921 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4922 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004923 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4924 sig_alg,
4925 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08004926#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08004927 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08004928 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
4929 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
4930 {
Gabor Mezei078e8032022-04-27 21:17:56 +02004931 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08004932 }
4933#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02004934
Jerry Yuf3b46b52022-06-19 16:52:27 +08004935 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
4936 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02004937
4938 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4939 {
4940 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4941 common_idx += 1;
4942 }
4943 }
4944 /* Check that we consumed all the message. */
4945 if( p != end )
4946 {
4947 MBEDTLS_SSL_DEBUG_MSG( 1,
4948 ( "Signature algorithms extension length misaligned" ) );
4949 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4950 MBEDTLS_ERR_SSL_DECODE_ERROR );
4951 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4952 }
4953
4954 if( common_idx == 0 )
4955 {
4956 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
4957 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
4958 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4959 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
4960 }
4961
Gabor Mezei15b95a62022-05-09 16:37:58 +02004962 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02004963 return( 0 );
4964}
4965
4966#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4967
Jerry Yudc7bd172022-02-17 13:44:15 +08004968#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4969
4970#if defined(MBEDTLS_USE_PSA_CRYPTO)
4971
4972static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4973 mbedtls_svc_key_id_t key,
4974 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004975 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004976 const unsigned char* seed, size_t seed_length,
4977 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004978 const unsigned char* other_secret,
4979 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08004980 size_t capacity )
4981{
4982 psa_status_t status;
4983
4984 status = psa_key_derivation_setup( derivation, alg );
4985 if( status != PSA_SUCCESS )
4986 return( status );
4987
4988 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4989 {
4990 status = psa_key_derivation_input_bytes( derivation,
4991 PSA_KEY_DERIVATION_INPUT_SEED,
4992 seed, seed_length );
4993 if( status != PSA_SUCCESS )
4994 return( status );
4995
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004996 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02004997 {
4998 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02004999 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5000 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005001 if( status != PSA_SUCCESS )
5002 return( status );
5003 }
5004
Jerry Yudc7bd172022-02-17 13:44:15 +08005005 if( mbedtls_svc_key_id_is_null( key ) )
5006 {
5007 status = psa_key_derivation_input_bytes(
5008 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005009 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005010 }
5011 else
5012 {
5013 status = psa_key_derivation_input_key(
5014 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5015 }
5016 if( status != PSA_SUCCESS )
5017 return( status );
5018
5019 status = psa_key_derivation_input_bytes( derivation,
5020 PSA_KEY_DERIVATION_INPUT_LABEL,
5021 label, label_length );
5022 if( status != PSA_SUCCESS )
5023 return( status );
5024 }
5025 else
5026 {
5027 return( PSA_ERROR_NOT_SUPPORTED );
5028 }
5029
5030 status = psa_key_derivation_set_capacity( derivation, capacity );
5031 if( status != PSA_SUCCESS )
5032 return( status );
5033
5034 return( PSA_SUCCESS );
5035}
5036
5037static int tls_prf_generic( mbedtls_md_type_t md_type,
5038 const unsigned char *secret, size_t slen,
5039 const char *label,
5040 const unsigned char *random, size_t rlen,
5041 unsigned char *dstbuf, size_t dlen )
5042{
5043 psa_status_t status;
5044 psa_algorithm_t alg;
5045 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5046 psa_key_derivation_operation_t derivation =
5047 PSA_KEY_DERIVATION_OPERATION_INIT;
5048
5049 if( md_type == MBEDTLS_MD_SHA384 )
5050 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5051 else
5052 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5053
5054 /* Normally a "secret" should be long enough to be impossible to
5055 * find by brute force, and in particular should not be empty. But
5056 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5057 * and for this use case it makes sense to have a 0-length "secret".
5058 * Since the key API doesn't allow importing a key of length 0,
5059 * keep master_key=0, which setup_psa_key_derivation() understands
5060 * to mean a 0-length "secret" input. */
5061 if( slen != 0 )
5062 {
5063 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5064 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5065 psa_set_key_algorithm( &key_attributes, alg );
5066 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5067
5068 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5069 if( status != PSA_SUCCESS )
5070 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5071 }
5072
5073 status = setup_psa_key_derivation( &derivation,
5074 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005075 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005076 random, rlen,
5077 (unsigned char const *) label,
5078 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005079 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005080 dlen );
5081 if( status != PSA_SUCCESS )
5082 {
5083 psa_key_derivation_abort( &derivation );
5084 psa_destroy_key( master_key );
5085 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5086 }
5087
5088 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5089 if( status != PSA_SUCCESS )
5090 {
5091 psa_key_derivation_abort( &derivation );
5092 psa_destroy_key( master_key );
5093 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5094 }
5095
5096 status = psa_key_derivation_abort( &derivation );
5097 if( status != PSA_SUCCESS )
5098 {
5099 psa_destroy_key( master_key );
5100 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5101 }
5102
5103 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5104 status = psa_destroy_key( master_key );
5105 if( status != PSA_SUCCESS )
5106 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5107
5108 return( 0 );
5109}
5110
5111#else /* MBEDTLS_USE_PSA_CRYPTO */
5112
5113static int tls_prf_generic( mbedtls_md_type_t md_type,
5114 const unsigned char *secret, size_t slen,
5115 const char *label,
5116 const unsigned char *random, size_t rlen,
5117 unsigned char *dstbuf, size_t dlen )
5118{
5119 size_t nb;
5120 size_t i, j, k, md_len;
5121 unsigned char *tmp;
5122 size_t tmp_len = 0;
5123 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5124 const mbedtls_md_info_t *md_info;
5125 mbedtls_md_context_t md_ctx;
5126 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5127
5128 mbedtls_md_init( &md_ctx );
5129
5130 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5131 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5132
5133 md_len = mbedtls_md_get_size( md_info );
5134
5135 tmp_len = md_len + strlen( label ) + rlen;
5136 tmp = mbedtls_calloc( 1, tmp_len );
5137 if( tmp == NULL )
5138 {
5139 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5140 goto exit;
5141 }
5142
5143 nb = strlen( label );
5144 memcpy( tmp + md_len, label, nb );
5145 memcpy( tmp + md_len + nb, random, rlen );
5146 nb += rlen;
5147
5148 /*
5149 * Compute P_<hash>(secret, label + random)[0..dlen]
5150 */
5151 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5152 goto exit;
5153
5154 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5155 if( ret != 0 )
5156 goto exit;
5157 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5158 if( ret != 0 )
5159 goto exit;
5160 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5161 if( ret != 0 )
5162 goto exit;
5163
5164 for( i = 0; i < dlen; i += md_len )
5165 {
5166 ret = mbedtls_md_hmac_reset ( &md_ctx );
5167 if( ret != 0 )
5168 goto exit;
5169 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5170 if( ret != 0 )
5171 goto exit;
5172 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5173 if( ret != 0 )
5174 goto exit;
5175
5176 ret = mbedtls_md_hmac_reset ( &md_ctx );
5177 if( ret != 0 )
5178 goto exit;
5179 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5180 if( ret != 0 )
5181 goto exit;
5182 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5183 if( ret != 0 )
5184 goto exit;
5185
5186 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5187
5188 for( j = 0; j < k; j++ )
5189 dstbuf[i + j] = h_i[j];
5190 }
5191
5192exit:
5193 mbedtls_md_free( &md_ctx );
5194
5195 mbedtls_platform_zeroize( tmp, tmp_len );
5196 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5197
5198 mbedtls_free( tmp );
5199
5200 return( ret );
5201}
5202#endif /* MBEDTLS_USE_PSA_CRYPTO */
5203
5204#if defined(MBEDTLS_SHA256_C)
5205static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5206 const char *label,
5207 const unsigned char *random, size_t rlen,
5208 unsigned char *dstbuf, size_t dlen )
5209{
5210 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5211 label, random, rlen, dstbuf, dlen ) );
5212}
5213#endif /* MBEDTLS_SHA256_C */
5214
5215#if defined(MBEDTLS_SHA384_C)
5216static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5217 const char *label,
5218 const unsigned char *random, size_t rlen,
5219 unsigned char *dstbuf, size_t dlen )
5220{
5221 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5222 label, random, rlen, dstbuf, dlen ) );
5223}
5224#endif /* MBEDTLS_SHA384_C */
5225
Jerry Yuf009d862022-02-17 14:01:37 +08005226/*
5227 * Set appropriate PRF function and other SSL / TLS1.2 functions
5228 *
5229 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005230 * - hash associated with the ciphersuite (only used by TLS 1.2)
5231 *
5232 * Outputs:
5233 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5234 */
5235static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005236 mbedtls_md_type_t hash )
5237{
Jerry Yuf009d862022-02-17 14:01:37 +08005238#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005239 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005240 {
5241 handshake->tls_prf = tls_prf_sha384;
5242 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5243 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5244 }
5245 else
5246#endif
5247#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005248 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005249 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005250 handshake->tls_prf = tls_prf_sha256;
5251 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5252 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5253 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005254#else
Jerry Yuf009d862022-02-17 14:01:37 +08005255 {
Jerry Yuf009d862022-02-17 14:01:37 +08005256 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005257 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005258 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5259 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005260#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005261
5262 return( 0 );
5263}
Jerry Yud6ab2352022-02-17 14:03:43 +08005264
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005265/*
5266 * Compute master secret if needed
5267 *
5268 * Parameters:
5269 * [in/out] handshake
5270 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5271 * (PSA-PSK) ciphersuite_info, psk_opaque
5272 * [out] premaster (cleared)
5273 * [out] master
5274 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5275 * debug: conf->f_dbg, conf->p_dbg
5276 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005277 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005278 */
5279static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5280 unsigned char *master,
5281 const mbedtls_ssl_context *ssl )
5282{
5283 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5284
5285 /* cf. RFC 5246, Section 8.1:
5286 * "The master secret is always exactly 48 bytes in length." */
5287 size_t const master_secret_len = 48;
5288
5289#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5290 unsigned char session_hash[48];
5291#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5292
5293 /* The label for the KDF used for key expansion.
5294 * This is either "master secret" or "extended master secret"
5295 * depending on whether the Extended Master Secret extension
5296 * is used. */
5297 char const *lbl = "master secret";
5298
Przemek Stekielae4ed302022-04-05 17:15:55 +02005299 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005300 * - If the Extended Master Secret extension is not used,
5301 * this is ClientHello.Random + ServerHello.Random
5302 * (see Sect. 8.1 in RFC 5246).
5303 * - If the Extended Master Secret extension is used,
5304 * this is the transcript of the handshake so far.
5305 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005306 unsigned char const *seed = handshake->randbytes;
5307 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005308
5309#if !defined(MBEDTLS_DEBUG_C) && \
5310 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5311 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5312 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5313 ssl = NULL; /* make sure we don't use it except for those cases */
5314 (void) ssl;
5315#endif
5316
5317 if( handshake->resume != 0 )
5318 {
5319 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5320 return( 0 );
5321 }
5322
5323#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5324 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5325 {
5326 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005327 seed = session_hash;
5328 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005329
5330 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005331 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005332 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005333#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005334
Przemek Stekiel99114f32022-04-22 11:20:09 +02005335#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005336 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005337 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005338 {
5339 /* Perform PSK-to-MS expansion in a single step. */
5340 psa_status_t status;
5341 psa_algorithm_t alg;
5342 mbedtls_svc_key_id_t psk;
5343 psa_key_derivation_operation_t derivation =
5344 PSA_KEY_DERIVATION_OPERATION_INIT;
5345 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5346
5347 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5348
5349 psk = mbedtls_ssl_get_opaque_psk( ssl );
5350
5351 if( hash_alg == MBEDTLS_MD_SHA384 )
5352 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5353 else
5354 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5355
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005356 size_t other_secret_len = 0;
5357 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005358
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005359 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005360 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005361 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005362 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005363 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005364 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005365 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005366 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005367 other_secret_len = 48;
5368 other_secret = handshake->premaster + 2;
5369 break;
5370 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005371 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005372 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5373 other_secret = handshake->premaster + 2;
5374 break;
5375 default:
5376 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005377 }
5378
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005379 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005380 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005381 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005382 (unsigned char const *) lbl,
5383 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005384 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005385 master_secret_len );
5386 if( status != PSA_SUCCESS )
5387 {
5388 psa_key_derivation_abort( &derivation );
5389 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5390 }
5391
5392 status = psa_key_derivation_output_bytes( &derivation,
5393 master,
5394 master_secret_len );
5395 if( status != PSA_SUCCESS )
5396 {
5397 psa_key_derivation_abort( &derivation );
5398 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5399 }
5400
5401 status = psa_key_derivation_abort( &derivation );
5402 if( status != PSA_SUCCESS )
5403 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5404 }
5405 else
5406#endif
5407 {
5408 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005409 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005410 master,
5411 master_secret_len );
5412 if( ret != 0 )
5413 {
5414 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5415 return( ret );
5416 }
5417
5418 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5419 handshake->premaster,
5420 handshake->pmslen );
5421
5422 mbedtls_platform_zeroize( handshake->premaster,
5423 sizeof(handshake->premaster) );
5424 }
5425
5426 return( 0 );
5427}
5428
Jerry Yud62f87e2022-02-17 14:09:02 +08005429int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5430{
5431 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5432 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5433 ssl->handshake->ciphersuite_info;
5434
5435 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5436
5437 /* Set PRF, calc_verify and calc_finished function pointers */
5438 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005439 ciphersuite_info->mac );
5440 if( ret != 0 )
5441 {
5442 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5443 return( ret );
5444 }
5445
5446 /* Compute master secret if needed */
5447 ret = ssl_compute_master( ssl->handshake,
5448 ssl->session_negotiate->master,
5449 ssl );
5450 if( ret != 0 )
5451 {
5452 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5453 return( ret );
5454 }
5455
5456 /* Swap the client and server random values:
5457 * - MS derivation wanted client+server (RFC 5246 8.1)
5458 * - key derivation wants server+client (RFC 5246 6.3) */
5459 {
5460 unsigned char tmp[64];
5461 memcpy( tmp, ssl->handshake->randbytes, 64 );
5462 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5463 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5464 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5465 }
5466
5467 /* Populate transform structure */
5468 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5469 ssl->session_negotiate->ciphersuite,
5470 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005471#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005472 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005473#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005474 ssl->handshake->tls_prf,
5475 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005476 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005477 ssl->conf->endpoint,
5478 ssl );
5479 if( ret != 0 )
5480 {
5481 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5482 return( ret );
5483 }
5484
5485 /* We no longer need Server/ClientHello.random values */
5486 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5487 sizeof( ssl->handshake->randbytes ) );
5488
5489 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5490
5491 return( 0 );
5492}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005493
Ronald Cron4dcbca92022-03-07 10:21:40 +01005494int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5495{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005496 switch( md )
5497 {
5498#if defined(MBEDTLS_SHA384_C)
5499 case MBEDTLS_SSL_HASH_SHA384:
5500 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5501 break;
5502#endif
5503#if defined(MBEDTLS_SHA256_C)
5504 case MBEDTLS_SSL_HASH_SHA256:
5505 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5506 break;
5507#endif
5508 default:
5509 return( -1 );
5510 }
5511
Ronald Cronc2f13a02022-03-07 10:25:24 +01005512 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005513}
5514
Jerry Yu8392e0d2022-02-17 14:10:24 +08005515#if defined(MBEDTLS_SHA256_C)
5516void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5517 unsigned char *hash,
5518 size_t *hlen )
5519{
5520#if defined(MBEDTLS_USE_PSA_CRYPTO)
5521 size_t hash_size;
5522 psa_status_t status;
5523 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5524
5525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5526 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5527 if( status != PSA_SUCCESS )
5528 {
5529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5530 return;
5531 }
5532
5533 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5534 if( status != PSA_SUCCESS )
5535 {
5536 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5537 return;
5538 }
5539
5540 *hlen = 32;
5541 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5543#else
5544 mbedtls_sha256_context sha256;
5545
5546 mbedtls_sha256_init( &sha256 );
5547
5548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5549
5550 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5551 mbedtls_sha256_finish( &sha256, hash );
5552
5553 *hlen = 32;
5554
5555 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5557
5558 mbedtls_sha256_free( &sha256 );
5559#endif /* MBEDTLS_USE_PSA_CRYPTO */
5560 return;
5561}
5562#endif /* MBEDTLS_SHA256_C */
5563
Jerry Yuc1cb3842022-02-17 14:13:48 +08005564#if defined(MBEDTLS_SHA384_C)
5565void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5566 unsigned char *hash,
5567 size_t *hlen )
5568{
5569#if defined(MBEDTLS_USE_PSA_CRYPTO)
5570 size_t hash_size;
5571 psa_status_t status;
5572 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5573
5574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5575 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5576 if( status != PSA_SUCCESS )
5577 {
5578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5579 return;
5580 }
5581
5582 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5583 if( status != PSA_SUCCESS )
5584 {
5585 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5586 return;
5587 }
5588
5589 *hlen = 48;
5590 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5591 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5592#else
5593 mbedtls_sha512_context sha512;
5594
5595 mbedtls_sha512_init( &sha512 );
5596
5597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5598
5599 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5600 mbedtls_sha512_finish( &sha512, hash );
5601
5602 *hlen = 48;
5603
5604 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5605 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5606
5607 mbedtls_sha512_free( &sha512 );
5608#endif /* MBEDTLS_USE_PSA_CRYPTO */
5609 return;
5610}
5611#endif /* MBEDTLS_SHA384_C */
5612
Neil Armstrong80f6f322022-05-03 17:56:38 +02005613#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5614 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005615int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5616{
5617 unsigned char *p = ssl->handshake->premaster;
5618 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5619 const unsigned char *psk = NULL;
5620 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005621 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005622
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005623 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005624 {
5625 /*
5626 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005627 * checked before calling this function.
5628 *
5629 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005630 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005631 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005632 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5633 {
5634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5635 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5636 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005637 }
5638
5639 /*
5640 * PMS = struct {
5641 * opaque other_secret<0..2^16-1>;
5642 * opaque psk<0..2^16-1>;
5643 * };
5644 * with "other_secret" depending on the particular key exchange
5645 */
5646#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5647 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5648 {
5649 if( end - p < 2 )
5650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5651
5652 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5653 p += 2;
5654
5655 if( end < p || (size_t)( end - p ) < psk_len )
5656 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5657
5658 memset( p, 0, psk_len );
5659 p += psk_len;
5660 }
5661 else
5662#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5663#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5664 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5665 {
5666 /*
5667 * other_secret already set by the ClientKeyExchange message,
5668 * and is 48 bytes long
5669 */
5670 if( end - p < 2 )
5671 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5672
5673 *p++ = 0;
5674 *p++ = 48;
5675 p += 48;
5676 }
5677 else
5678#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5679#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5680 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5681 {
5682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5683 size_t len;
5684
5685 /* Write length only when we know the actual value */
5686 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5687 p + 2, end - ( p + 2 ), &len,
5688 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5689 {
5690 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5691 return( ret );
5692 }
5693 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5694 p += 2 + len;
5695
5696 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5697 }
5698 else
5699#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005700#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005701 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5702 {
5703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5704 size_t zlen;
5705
5706 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5707 p + 2, end - ( p + 2 ),
5708 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5709 {
5710 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5711 return( ret );
5712 }
5713
5714 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5715 p += 2 + zlen;
5716
5717 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5718 MBEDTLS_DEBUG_ECDH_Z );
5719 }
5720 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005721#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005722 {
5723 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5724 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5725 }
5726
5727 /* opaque psk<0..2^16-1>; */
5728 if( end - p < 2 )
5729 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5730
5731 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5732 p += 2;
5733
5734 if( end < p || (size_t)( end - p ) < psk_len )
5735 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5736
5737 memcpy( p, psk, psk_len );
5738 p += psk_len;
5739
5740 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5741
5742 return( 0 );
5743}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005744#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005745
5746#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5747static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5748
5749#if defined(MBEDTLS_SSL_PROTO_DTLS)
5750int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5751{
5752 /* If renegotiation is not enforced, retransmit until we would reach max
5753 * timeout if we were using the usual handshake doubling scheme */
5754 if( ssl->conf->renego_max_records < 0 )
5755 {
5756 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5757 unsigned char doublings = 1;
5758
5759 while( ratio != 0 )
5760 {
5761 ++doublings;
5762 ratio >>= 1;
5763 }
5764
5765 if( ++ssl->renego_records_seen > doublings )
5766 {
5767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5768 return( 0 );
5769 }
5770 }
5771
5772 return( ssl_write_hello_request( ssl ) );
5773}
5774#endif
5775#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005776
Jerry Yud9526692022-02-17 14:23:47 +08005777/*
5778 * Handshake functions
5779 */
5780#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5781/* No certificate support -> dummy functions */
5782int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5783{
5784 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5785 ssl->handshake->ciphersuite_info;
5786
5787 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5788
5789 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5790 {
5791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5792 ssl->state++;
5793 return( 0 );
5794 }
5795
5796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5797 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5798}
5799
5800int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5801{
5802 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5803 ssl->handshake->ciphersuite_info;
5804
5805 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5806
5807 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5808 {
5809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5810 ssl->state++;
5811 return( 0 );
5812 }
5813
5814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5815 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5816}
5817
5818#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5819/* Some certificate support -> implement write and parse */
5820
5821int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5822{
5823 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5824 size_t i, n;
5825 const mbedtls_x509_crt *crt;
5826 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5827 ssl->handshake->ciphersuite_info;
5828
5829 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5830
5831 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5832 {
5833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5834 ssl->state++;
5835 return( 0 );
5836 }
5837
5838#if defined(MBEDTLS_SSL_CLI_C)
5839 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5840 {
5841 if( ssl->handshake->client_auth == 0 )
5842 {
5843 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5844 ssl->state++;
5845 return( 0 );
5846 }
5847 }
5848#endif /* MBEDTLS_SSL_CLI_C */
5849#if defined(MBEDTLS_SSL_SRV_C)
5850 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5851 {
5852 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5853 {
5854 /* Should never happen because we shouldn't have picked the
5855 * ciphersuite if we don't have a certificate. */
5856 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5857 }
5858 }
5859#endif
5860
5861 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5862
5863 /*
5864 * 0 . 0 handshake type
5865 * 1 . 3 handshake length
5866 * 4 . 6 length of all certs
5867 * 7 . 9 length of cert. 1
5868 * 10 . n-1 peer certificate
5869 * n . n+2 length of cert. 2
5870 * n+3 . ... upper level cert, etc.
5871 */
5872 i = 7;
5873 crt = mbedtls_ssl_own_cert( ssl );
5874
5875 while( crt != NULL )
5876 {
5877 n = crt->raw.len;
5878 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5879 {
5880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5881 " > %" MBEDTLS_PRINTF_SIZET,
5882 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5883 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5884 }
5885
5886 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5887 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5888 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5889
5890 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5891 i += n; crt = crt->next;
5892 }
5893
5894 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5895 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5896 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5897
5898 ssl->out_msglen = i;
5899 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5900 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5901
5902 ssl->state++;
5903
5904 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5905 {
5906 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5907 return( ret );
5908 }
5909
5910 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5911
5912 return( ret );
5913}
5914
5915#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5916
5917#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5918static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5919 unsigned char *crt_buf,
5920 size_t crt_buf_len )
5921{
5922 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5923
5924 if( peer_crt == NULL )
5925 return( -1 );
5926
5927 if( peer_crt->raw.len != crt_buf_len )
5928 return( -1 );
5929
5930 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5931}
5932#else /* 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 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5938 unsigned char const * const peer_cert_digest =
5939 ssl->session->peer_cert_digest;
5940 mbedtls_md_type_t const peer_cert_digest_type =
5941 ssl->session->peer_cert_digest_type;
5942 mbedtls_md_info_t const * const digest_info =
5943 mbedtls_md_info_from_type( peer_cert_digest_type );
5944 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5945 size_t digest_len;
5946
5947 if( peer_cert_digest == NULL || digest_info == NULL )
5948 return( -1 );
5949
5950 digest_len = mbedtls_md_get_size( digest_info );
5951 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5952 return( -1 );
5953
5954 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5955 if( ret != 0 )
5956 return( -1 );
5957
5958 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5959}
5960#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5961#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5962
5963/*
5964 * Once the certificate message is read, parse it into a cert chain and
5965 * perform basic checks, but leave actual verification to the caller
5966 */
5967static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5968 mbedtls_x509_crt *chain )
5969{
5970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5971#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5972 int crt_cnt=0;
5973#endif
5974 size_t i, n;
5975 uint8_t alert;
5976
5977 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5978 {
5979 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5980 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5981 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5982 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5983 }
5984
5985 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5986 {
5987 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5988 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5989 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5990 }
5991
5992 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
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_DECODE_ERROR );
5997 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5998 }
5999
6000 i = mbedtls_ssl_hs_hdr_len( ssl );
6001
6002 /*
6003 * Same message structure as in mbedtls_ssl_write_certificate()
6004 */
6005 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6006
6007 if( ssl->in_msg[i] != 0 ||
6008 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6009 {
6010 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6011 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6012 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6013 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6014 }
6015
6016 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6017 i += 3;
6018
6019 /* Iterate through and parse the CRTs in the provided chain. */
6020 while( i < ssl->in_hslen )
6021 {
6022 /* Check that there's room for the next CRT's length fields. */
6023 if ( i + 3 > ssl->in_hslen ) {
6024 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6025 mbedtls_ssl_send_alert_message( ssl,
6026 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6027 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6028 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6029 }
6030 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6031 * anything beyond 2**16 ~ 64K. */
6032 if( ssl->in_msg[i] != 0 )
6033 {
6034 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6035 mbedtls_ssl_send_alert_message( ssl,
6036 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6037 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6038 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6039 }
6040
6041 /* Read length of the next CRT in the chain. */
6042 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6043 | (unsigned int) ssl->in_msg[i + 2];
6044 i += 3;
6045
6046 if( n < 128 || i + n > ssl->in_hslen )
6047 {
6048 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6049 mbedtls_ssl_send_alert_message( ssl,
6050 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6051 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6052 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6053 }
6054
6055 /* Check if we're handling the first CRT in the chain. */
6056#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6057 if( crt_cnt++ == 0 &&
6058 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6059 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6060 {
6061 /* During client-side renegotiation, check that the server's
6062 * end-CRTs hasn't changed compared to the initial handshake,
6063 * mitigating the triple handshake attack. On success, reuse
6064 * the original end-CRT instead of parsing it again. */
6065 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6066 if( ssl_check_peer_crt_unchanged( ssl,
6067 &ssl->in_msg[i],
6068 n ) != 0 )
6069 {
6070 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6071 mbedtls_ssl_send_alert_message( ssl,
6072 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6073 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6074 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6075 }
6076
6077 /* Now we can safely free the original chain. */
6078 ssl_clear_peer_cert( ssl->session );
6079 }
6080#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6081
6082 /* Parse the next certificate in the chain. */
6083#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6084 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6085#else
6086 /* If we don't need to store the CRT chain permanently, parse
6087 * it in-place from the input buffer instead of making a copy. */
6088 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6089#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6090 switch( ret )
6091 {
6092 case 0: /*ok*/
6093 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6094 /* Ignore certificate with an unknown algorithm: maybe a
6095 prior certificate was already trusted. */
6096 break;
6097
6098 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6099 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6100 goto crt_parse_der_failed;
6101
6102 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6103 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6104 goto crt_parse_der_failed;
6105
6106 default:
6107 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6108 crt_parse_der_failed:
6109 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6110 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6111 return( ret );
6112 }
6113
6114 i += n;
6115 }
6116
6117 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6118 return( 0 );
6119}
6120
6121#if defined(MBEDTLS_SSL_SRV_C)
6122static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6123{
6124 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6125 return( -1 );
6126
6127 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6128 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6129 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6130 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6131 {
Ronald Cron19385882022-06-15 16:26:13 +02006132 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006133 return( 0 );
6134 }
6135 return( -1 );
6136}
6137#endif /* MBEDTLS_SSL_SRV_C */
6138
6139/* Check if a certificate message is expected.
6140 * Return either
6141 * - SSL_CERTIFICATE_EXPECTED, or
6142 * - SSL_CERTIFICATE_SKIP
6143 * indicating whether a Certificate message is expected or not.
6144 */
6145#define SSL_CERTIFICATE_EXPECTED 0
6146#define SSL_CERTIFICATE_SKIP 1
6147static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6148 int authmode )
6149{
6150 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6151 ssl->handshake->ciphersuite_info;
6152
6153 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6154 return( SSL_CERTIFICATE_SKIP );
6155
6156#if defined(MBEDTLS_SSL_SRV_C)
6157 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6158 {
6159 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6160 return( SSL_CERTIFICATE_SKIP );
6161
6162 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6163 {
6164 ssl->session_negotiate->verify_result =
6165 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6166 return( SSL_CERTIFICATE_SKIP );
6167 }
6168 }
6169#else
6170 ((void) authmode);
6171#endif /* MBEDTLS_SSL_SRV_C */
6172
6173 return( SSL_CERTIFICATE_EXPECTED );
6174}
6175
6176static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6177 int authmode,
6178 mbedtls_x509_crt *chain,
6179 void *rs_ctx )
6180{
6181 int ret = 0;
6182 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6183 ssl->handshake->ciphersuite_info;
6184 int have_ca_chain = 0;
6185
6186 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6187 void *p_vrfy;
6188
6189 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6190 return( 0 );
6191
6192 if( ssl->f_vrfy != NULL )
6193 {
6194 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6195 f_vrfy = ssl->f_vrfy;
6196 p_vrfy = ssl->p_vrfy;
6197 }
6198 else
6199 {
6200 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6201 f_vrfy = ssl->conf->f_vrfy;
6202 p_vrfy = ssl->conf->p_vrfy;
6203 }
6204
6205 /*
6206 * Main check: verify certificate
6207 */
6208#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6209 if( ssl->conf->f_ca_cb != NULL )
6210 {
6211 ((void) rs_ctx);
6212 have_ca_chain = 1;
6213
6214 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6215 ret = mbedtls_x509_crt_verify_with_ca_cb(
6216 chain,
6217 ssl->conf->f_ca_cb,
6218 ssl->conf->p_ca_cb,
6219 ssl->conf->cert_profile,
6220 ssl->hostname,
6221 &ssl->session_negotiate->verify_result,
6222 f_vrfy, p_vrfy );
6223 }
6224 else
6225#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6226 {
6227 mbedtls_x509_crt *ca_chain;
6228 mbedtls_x509_crl *ca_crl;
6229
6230#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6231 if( ssl->handshake->sni_ca_chain != NULL )
6232 {
6233 ca_chain = ssl->handshake->sni_ca_chain;
6234 ca_crl = ssl->handshake->sni_ca_crl;
6235 }
6236 else
6237#endif
6238 {
6239 ca_chain = ssl->conf->ca_chain;
6240 ca_crl = ssl->conf->ca_crl;
6241 }
6242
6243 if( ca_chain != NULL )
6244 have_ca_chain = 1;
6245
6246 ret = mbedtls_x509_crt_verify_restartable(
6247 chain,
6248 ca_chain, ca_crl,
6249 ssl->conf->cert_profile,
6250 ssl->hostname,
6251 &ssl->session_negotiate->verify_result,
6252 f_vrfy, p_vrfy, rs_ctx );
6253 }
6254
6255 if( ret != 0 )
6256 {
6257 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6258 }
6259
6260#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6261 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6262 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6263#endif
6264
6265 /*
6266 * Secondary checks: always done, but change 'ret' only if it was 0
6267 */
6268
6269#if defined(MBEDTLS_ECP_C)
6270 {
6271 const mbedtls_pk_context *pk = &chain->pk;
6272
6273 /* If certificate uses an EC key, make sure the curve is OK */
6274 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6275 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6276 {
6277 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6278
6279 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6280 if( ret == 0 )
6281 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6282 }
6283 }
6284#endif /* MBEDTLS_ECP_C */
6285
6286 if( mbedtls_ssl_check_cert_usage( chain,
6287 ciphersuite_info,
6288 ! ssl->conf->endpoint,
6289 &ssl->session_negotiate->verify_result ) != 0 )
6290 {
6291 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6292 if( ret == 0 )
6293 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6294 }
6295
6296 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6297 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6298 * with details encoded in the verification flags. All other kinds
6299 * of error codes, including those from the user provided f_vrfy
6300 * functions, are treated as fatal and lead to a failure of
6301 * ssl_parse_certificate even if verification was optional. */
6302 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6303 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6304 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6305 {
6306 ret = 0;
6307 }
6308
6309 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6310 {
6311 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6312 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6313 }
6314
6315 if( ret != 0 )
6316 {
6317 uint8_t alert;
6318
6319 /* The certificate may have been rejected for several reasons.
6320 Pick one and send the corresponding alert. Which alert to send
6321 may be a subject of debate in some cases. */
6322 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6323 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6324 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6325 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6326 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6327 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6328 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6329 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6330 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6331 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6332 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6333 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6334 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6335 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6336 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6337 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6338 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6339 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6340 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6341 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6342 else
6343 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6344 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6345 alert );
6346 }
6347
6348#if defined(MBEDTLS_DEBUG_C)
6349 if( ssl->session_negotiate->verify_result != 0 )
6350 {
6351 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6352 (unsigned int) ssl->session_negotiate->verify_result ) );
6353 }
6354 else
6355 {
6356 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6357 }
6358#endif /* MBEDTLS_DEBUG_C */
6359
6360 return( ret );
6361}
6362
6363#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6364static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6365 unsigned char *start, size_t len )
6366{
6367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6368 /* Remember digest of the peer's end-CRT. */
6369 ssl->session_negotiate->peer_cert_digest =
6370 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6371 if( ssl->session_negotiate->peer_cert_digest == NULL )
6372 {
6373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6374 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6375 mbedtls_ssl_send_alert_message( ssl,
6376 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6377 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6378
6379 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6380 }
6381
6382 ret = mbedtls_md( mbedtls_md_info_from_type(
6383 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6384 start, len,
6385 ssl->session_negotiate->peer_cert_digest );
6386
6387 ssl->session_negotiate->peer_cert_digest_type =
6388 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6389 ssl->session_negotiate->peer_cert_digest_len =
6390 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6391
6392 return( ret );
6393}
6394
6395static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6396 unsigned char *start, size_t len )
6397{
6398 unsigned char *end = start + len;
6399 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6400
6401 /* Make a copy of the peer's raw public key. */
6402 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6403 ret = mbedtls_pk_parse_subpubkey( &start, end,
6404 &ssl->handshake->peer_pubkey );
6405 if( ret != 0 )
6406 {
6407 /* We should have parsed the public key before. */
6408 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6409 }
6410
6411 return( 0 );
6412}
6413#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6414
6415int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6416{
6417 int ret = 0;
6418 int crt_expected;
6419#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6420 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6421 ? ssl->handshake->sni_authmode
6422 : ssl->conf->authmode;
6423#else
6424 const int authmode = ssl->conf->authmode;
6425#endif
6426 void *rs_ctx = NULL;
6427 mbedtls_x509_crt *chain = NULL;
6428
6429 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6430
6431 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6432 if( crt_expected == SSL_CERTIFICATE_SKIP )
6433 {
6434 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6435 goto exit;
6436 }
6437
6438#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6439 if( ssl->handshake->ecrs_enabled &&
6440 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6441 {
6442 chain = ssl->handshake->ecrs_peer_cert;
6443 ssl->handshake->ecrs_peer_cert = NULL;
6444 goto crt_verify;
6445 }
6446#endif
6447
6448 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6449 {
6450 /* mbedtls_ssl_read_record may have sent an alert already. We
6451 let it decide whether to alert. */
6452 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6453 goto exit;
6454 }
6455
6456#if defined(MBEDTLS_SSL_SRV_C)
6457 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6458 {
6459 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6460
6461 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6462 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6463
6464 goto exit;
6465 }
6466#endif /* MBEDTLS_SSL_SRV_C */
6467
6468 /* Clear existing peer CRT structure in case we tried to
6469 * reuse a session but it failed, and allocate a new one. */
6470 ssl_clear_peer_cert( ssl->session_negotiate );
6471
6472 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6473 if( chain == NULL )
6474 {
6475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6476 sizeof( mbedtls_x509_crt ) ) );
6477 mbedtls_ssl_send_alert_message( ssl,
6478 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6479 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6480
6481 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6482 goto exit;
6483 }
6484 mbedtls_x509_crt_init( chain );
6485
6486 ret = ssl_parse_certificate_chain( ssl, chain );
6487 if( ret != 0 )
6488 goto exit;
6489
6490#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6491 if( ssl->handshake->ecrs_enabled)
6492 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6493
6494crt_verify:
6495 if( ssl->handshake->ecrs_enabled)
6496 rs_ctx = &ssl->handshake->ecrs_ctx;
6497#endif
6498
6499 ret = ssl_parse_certificate_verify( ssl, authmode,
6500 chain, rs_ctx );
6501 if( ret != 0 )
6502 goto exit;
6503
6504#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6505 {
6506 unsigned char *crt_start, *pk_start;
6507 size_t crt_len, pk_len;
6508
6509 /* We parse the CRT chain without copying, so
6510 * these pointers point into the input buffer,
6511 * and are hence still valid after freeing the
6512 * CRT chain. */
6513
6514 crt_start = chain->raw.p;
6515 crt_len = chain->raw.len;
6516
6517 pk_start = chain->pk_raw.p;
6518 pk_len = chain->pk_raw.len;
6519
6520 /* Free the CRT structures before computing
6521 * digest and copying the peer's public key. */
6522 mbedtls_x509_crt_free( chain );
6523 mbedtls_free( chain );
6524 chain = NULL;
6525
6526 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6527 if( ret != 0 )
6528 goto exit;
6529
6530 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6531 if( ret != 0 )
6532 goto exit;
6533 }
6534#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6535 /* Pass ownership to session structure. */
6536 ssl->session_negotiate->peer_cert = chain;
6537 chain = NULL;
6538#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6539
6540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6541
6542exit:
6543
6544 if( ret == 0 )
6545 ssl->state++;
6546
6547#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6548 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6549 {
6550 ssl->handshake->ecrs_peer_cert = chain;
6551 chain = NULL;
6552 }
6553#endif
6554
6555 if( chain != NULL )
6556 {
6557 mbedtls_x509_crt_free( chain );
6558 mbedtls_free( chain );
6559 }
6560
6561 return( ret );
6562}
6563#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6564
Jerry Yu615bd6f2022-02-17 14:25:15 +08006565#if defined(MBEDTLS_SHA256_C)
6566static void ssl_calc_finished_tls_sha256(
6567 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6568{
6569 int len = 12;
6570 const char *sender;
6571 unsigned char padbuf[32];
6572#if defined(MBEDTLS_USE_PSA_CRYPTO)
6573 size_t hash_size;
6574 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6575 psa_status_t status;
6576#else
6577 mbedtls_sha256_context sha256;
6578#endif
6579
6580 mbedtls_ssl_session *session = ssl->session_negotiate;
6581 if( !session )
6582 session = ssl->session;
6583
6584 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6585 ? "client finished"
6586 : "server finished";
6587
6588#if defined(MBEDTLS_USE_PSA_CRYPTO)
6589 sha256_psa = psa_hash_operation_init();
6590
6591 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6592
6593 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6594 if( status != PSA_SUCCESS )
6595 {
6596 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6597 return;
6598 }
6599
6600 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6601 if( status != PSA_SUCCESS )
6602 {
6603 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6604 return;
6605 }
6606 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6607#else
6608
6609 mbedtls_sha256_init( &sha256 );
6610
6611 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6612
6613 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6614
6615 /*
6616 * TLSv1.2:
6617 * hash = PRF( master, finished_label,
6618 * Hash( handshake ) )[0.11]
6619 */
6620
6621#if !defined(MBEDTLS_SHA256_ALT)
6622 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6623 sha256.state, sizeof( sha256.state ) );
6624#endif
6625
6626 mbedtls_sha256_finish( &sha256, padbuf );
6627 mbedtls_sha256_free( &sha256 );
6628#endif /* MBEDTLS_USE_PSA_CRYPTO */
6629
6630 ssl->handshake->tls_prf( session->master, 48, sender,
6631 padbuf, 32, buf, len );
6632
6633 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6634
6635 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6636
6637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6638}
6639#endif /* MBEDTLS_SHA256_C */
6640
Jerry Yub7ba49e2022-02-17 14:25:53 +08006641
6642#if defined(MBEDTLS_SHA384_C)
6643
6644static void ssl_calc_finished_tls_sha384(
6645 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6646{
6647 int len = 12;
6648 const char *sender;
6649 unsigned char padbuf[48];
6650#if defined(MBEDTLS_USE_PSA_CRYPTO)
6651 size_t hash_size;
6652 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6653 psa_status_t status;
6654#else
6655 mbedtls_sha512_context sha512;
6656#endif
6657
6658 mbedtls_ssl_session *session = ssl->session_negotiate;
6659 if( !session )
6660 session = ssl->session;
6661
6662 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6663 ? "client finished"
6664 : "server finished";
6665
6666#if defined(MBEDTLS_USE_PSA_CRYPTO)
6667 sha384_psa = psa_hash_operation_init();
6668
6669 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6670
6671 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6672 if( status != PSA_SUCCESS )
6673 {
6674 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6675 return;
6676 }
6677
6678 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6679 if( status != PSA_SUCCESS )
6680 {
6681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6682 return;
6683 }
6684 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6685#else
6686 mbedtls_sha512_init( &sha512 );
6687
6688 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6689
6690 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6691
6692 /*
6693 * TLSv1.2:
6694 * hash = PRF( master, finished_label,
6695 * Hash( handshake ) )[0.11]
6696 */
6697
6698#if !defined(MBEDTLS_SHA512_ALT)
6699 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6700 sha512.state, sizeof( sha512.state ) );
6701#endif
6702 mbedtls_sha512_finish( &sha512, padbuf );
6703
6704 mbedtls_sha512_free( &sha512 );
6705#endif
6706
6707 ssl->handshake->tls_prf( session->master, 48, sender,
6708 padbuf, 48, buf, len );
6709
6710 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6711
6712 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6713
6714 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6715}
6716#endif /* MBEDTLS_SHA384_C */
6717
Jerry Yuaef00152022-02-17 14:27:31 +08006718void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6719{
6720 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6721
6722 /*
6723 * Free our handshake params
6724 */
6725 mbedtls_ssl_handshake_free( ssl );
6726 mbedtls_free( ssl->handshake );
6727 ssl->handshake = NULL;
6728
6729 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006730 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006731 */
6732 if( ssl->transform )
6733 {
6734 mbedtls_ssl_transform_free( ssl->transform );
6735 mbedtls_free( ssl->transform );
6736 }
6737 ssl->transform = ssl->transform_negotiate;
6738 ssl->transform_negotiate = NULL;
6739
6740 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6741}
6742
Jerry Yu2a9fff52022-02-17 14:28:51 +08006743void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6744{
6745 int resume = ssl->handshake->resume;
6746
6747 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6748
6749#if defined(MBEDTLS_SSL_RENEGOTIATION)
6750 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6751 {
6752 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6753 ssl->renego_records_seen = 0;
6754 }
6755#endif
6756
6757 /*
6758 * Free the previous session and switch in the current one
6759 */
6760 if( ssl->session )
6761 {
6762#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6763 /* RFC 7366 3.1: keep the EtM state */
6764 ssl->session_negotiate->encrypt_then_mac =
6765 ssl->session->encrypt_then_mac;
6766#endif
6767
6768 mbedtls_ssl_session_free( ssl->session );
6769 mbedtls_free( ssl->session );
6770 }
6771 ssl->session = ssl->session_negotiate;
6772 ssl->session_negotiate = NULL;
6773
6774 /*
6775 * Add cache entry
6776 */
6777 if( ssl->conf->f_set_cache != NULL &&
6778 ssl->session->id_len != 0 &&
6779 resume == 0 )
6780 {
6781 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6782 ssl->session->id,
6783 ssl->session->id_len,
6784 ssl->session ) != 0 )
6785 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6786 }
6787
6788#if defined(MBEDTLS_SSL_PROTO_DTLS)
6789 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6790 ssl->handshake->flight != NULL )
6791 {
6792 /* Cancel handshake timer */
6793 mbedtls_ssl_set_timer( ssl, 0 );
6794
6795 /* Keep last flight around in case we need to resend it:
6796 * we need the handshake and transform structures for that */
6797 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6798 }
6799 else
6800#endif
6801 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6802
6803 ssl->state++;
6804
6805 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6806}
6807
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006808int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6809{
6810 int ret, hash_len;
6811
6812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6813
6814 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6815
6816 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6817
6818 /*
6819 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6820 * may define some other value. Currently (early 2016), no defined
6821 * ciphersuite does this (and this is unlikely to change as activity has
6822 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6823 */
6824 hash_len = 12;
6825
6826#if defined(MBEDTLS_SSL_RENEGOTIATION)
6827 ssl->verify_data_len = hash_len;
6828 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6829#endif
6830
6831 ssl->out_msglen = 4 + hash_len;
6832 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6833 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6834
6835 /*
6836 * In case of session resuming, invert the client and server
6837 * ChangeCipherSpec messages order.
6838 */
6839 if( ssl->handshake->resume != 0 )
6840 {
6841#if defined(MBEDTLS_SSL_CLI_C)
6842 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6843 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6844#endif
6845#if defined(MBEDTLS_SSL_SRV_C)
6846 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6847 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6848#endif
6849 }
6850 else
6851 ssl->state++;
6852
6853 /*
6854 * Switch to our negotiated transform and session parameters for outbound
6855 * data.
6856 */
6857 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6858
6859#if defined(MBEDTLS_SSL_PROTO_DTLS)
6860 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6861 {
6862 unsigned char i;
6863
6864 /* Remember current epoch settings for resending */
6865 ssl->handshake->alt_transform_out = ssl->transform_out;
6866 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6867 sizeof( ssl->handshake->alt_out_ctr ) );
6868
6869 /* Set sequence_number to zero */
6870 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6871
6872
6873 /* Increment epoch */
6874 for( i = 2; i > 0; i-- )
6875 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6876 break;
6877
6878 /* The loop goes to its end iff the counter is wrapping */
6879 if( i == 0 )
6880 {
6881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6882 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6883 }
6884 }
6885 else
6886#endif /* MBEDTLS_SSL_PROTO_DTLS */
6887 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6888
6889 ssl->transform_out = ssl->transform_negotiate;
6890 ssl->session_out = ssl->session_negotiate;
6891
6892#if defined(MBEDTLS_SSL_PROTO_DTLS)
6893 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6894 mbedtls_ssl_send_flight_completed( ssl );
6895#endif
6896
6897 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6898 {
6899 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6900 return( ret );
6901 }
6902
6903#if defined(MBEDTLS_SSL_PROTO_DTLS)
6904 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6905 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6906 {
6907 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6908 return( ret );
6909 }
6910#endif
6911
6912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6913
6914 return( 0 );
6915}
6916
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006917#define SSL_MAX_HASH_LEN 12
6918
6919int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6920{
6921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6922 unsigned int hash_len = 12;
6923 unsigned char buf[SSL_MAX_HASH_LEN];
6924
6925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6926
6927 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6928
6929 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6930 {
6931 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6932 goto exit;
6933 }
6934
6935 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6936 {
6937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6938 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6939 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6940 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6941 goto exit;
6942 }
6943
6944 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6945 {
6946 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6947 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6948 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6949 goto exit;
6950 }
6951
6952 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6953 {
6954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6955 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6956 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6957 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6958 goto exit;
6959 }
6960
6961 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6962 buf, hash_len ) != 0 )
6963 {
6964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6965 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6966 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6967 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6968 goto exit;
6969 }
6970
6971#if defined(MBEDTLS_SSL_RENEGOTIATION)
6972 ssl->verify_data_len = hash_len;
6973 memcpy( ssl->peer_verify_data, buf, hash_len );
6974#endif
6975
6976 if( ssl->handshake->resume != 0 )
6977 {
6978#if defined(MBEDTLS_SSL_CLI_C)
6979 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6980 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6981#endif
6982#if defined(MBEDTLS_SSL_SRV_C)
6983 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6984 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6985#endif
6986 }
6987 else
6988 ssl->state++;
6989
6990#if defined(MBEDTLS_SSL_PROTO_DTLS)
6991 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6992 mbedtls_ssl_recv_flight_completed( ssl );
6993#endif
6994
6995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6996
6997exit:
6998 mbedtls_platform_zeroize( buf, hash_len );
6999 return( ret );
7000}
7001
Jerry Yu392112c2022-02-17 14:34:10 +08007002#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7003/*
7004 * Helper to get TLS 1.2 PRF from ciphersuite
7005 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7006 */
7007static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7008{
7009#if defined(MBEDTLS_SHA384_C)
7010 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7011 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7012
7013 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7014 return( tls_prf_sha384 );
7015#else
7016 (void) ciphersuite_id;
7017#endif
7018 return( tls_prf_sha256 );
7019}
7020#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007021
7022static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7023{
7024 ((void) tls_prf);
7025#if defined(MBEDTLS_SHA384_C)
7026 if( tls_prf == tls_prf_sha384 )
7027 {
7028 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7029 }
7030 else
7031#endif
7032#if defined(MBEDTLS_SHA256_C)
7033 if( tls_prf == tls_prf_sha256 )
7034 {
7035 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7036 }
7037 else
7038#endif
7039 return( MBEDTLS_SSL_TLS_PRF_NONE );
7040}
7041
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007042/*
7043 * Populate a transform structure with session keys and all the other
7044 * necessary information.
7045 *
7046 * Parameters:
7047 * - [in/out]: transform: structure to populate
7048 * [in] must be just initialised with mbedtls_ssl_transform_init()
7049 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7050 * - [in] ciphersuite
7051 * - [in] master
7052 * - [in] encrypt_then_mac
7053 * - [in] compression
7054 * - [in] tls_prf: pointer to PRF to use for key derivation
7055 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007056 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007057 * - [in] endpoint: client or server
7058 * - [in] ssl: used for:
7059 * - ssl->conf->{f,p}_export_keys
7060 * [in] optionally used for:
7061 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7062 */
7063static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7064 int ciphersuite,
7065 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007066#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007067 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007068#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007069 ssl_tls_prf_t tls_prf,
7070 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007071 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007072 unsigned endpoint,
7073 const mbedtls_ssl_context *ssl )
7074{
7075 int ret = 0;
7076 unsigned char keyblk[256];
7077 unsigned char *key1;
7078 unsigned char *key2;
7079 unsigned char *mac_enc;
7080 unsigned char *mac_dec;
7081 size_t mac_key_len = 0;
7082 size_t iv_copy_len;
7083 size_t keylen;
7084 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007085 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007086#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007087 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007088 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007089#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007090
7091#if defined(MBEDTLS_USE_PSA_CRYPTO)
7092 psa_key_type_t key_type;
7093 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7094 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007095 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007096 size_t key_bits;
7097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7098#endif
7099
7100#if !defined(MBEDTLS_DEBUG_C) && \
7101 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7102 if( ssl->f_export_keys == NULL )
7103 {
7104 ssl = NULL; /* make sure we don't use it except for these cases */
7105 (void) ssl;
7106 }
7107#endif
7108
7109 /*
7110 * Some data just needs copying into the structure
7111 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007112#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007113 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007114#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007115 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007116
7117#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7118 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7119#endif
7120
7121#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007122 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007123 {
7124 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7125 * generation separate. This should never happen. */
7126 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7127 }
7128#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7129
7130 /*
7131 * Get various info structures
7132 */
7133 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7134 if( ciphersuite_info == NULL )
7135 {
7136 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7137 ciphersuite ) );
7138 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7139 }
7140
Neil Armstrongab555e02022-04-04 11:07:59 +02007141 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007142#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007143 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007144#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007145 ciphersuite_info );
7146
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007147 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7148 transform->taglen =
7149 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7150
7151#if defined(MBEDTLS_USE_PSA_CRYPTO)
7152 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7153 transform->taglen,
7154 &alg,
7155 &key_type,
7156 &key_bits ) ) != PSA_SUCCESS )
7157 {
7158 ret = psa_ssl_status_to_mbedtls( status );
7159 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7160 goto end;
7161 }
7162#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007163 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7164 if( cipher_info == NULL )
7165 {
7166 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7167 ciphersuite_info->cipher ) );
7168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7169 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007170#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007171
Neil Armstronge4512952022-03-08 09:08:22 +01007172#if defined(MBEDTLS_USE_PSA_CRYPTO)
7173 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7174 if( mac_alg == 0 )
7175 {
7176 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7177 (unsigned) ciphersuite_info->mac ) );
7178 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7179 }
7180#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007181 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7182 if( md_info == NULL )
7183 {
7184 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7185 (unsigned) ciphersuite_info->mac ) );
7186 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7187 }
Neil Armstronge4512952022-03-08 09:08:22 +01007188#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007189
7190#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7191 /* Copy own and peer's CID if the use of the CID
7192 * extension has been negotiated. */
7193 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7194 {
7195 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7196
7197 transform->in_cid_len = ssl->own_cid_len;
7198 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7199 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7200 transform->in_cid_len );
7201
7202 transform->out_cid_len = ssl->handshake->peer_cid_len;
7203 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7204 ssl->handshake->peer_cid_len );
7205 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7206 transform->out_cid_len );
7207 }
7208#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7209
7210 /*
7211 * Compute key block using the PRF
7212 */
7213 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7214 if( ret != 0 )
7215 {
7216 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7217 return( ret );
7218 }
7219
7220 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7221 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7222 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7223 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7224 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7225
7226 /*
7227 * Determine the appropriate key, IV and MAC length.
7228 */
7229
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007230#if defined(MBEDTLS_USE_PSA_CRYPTO)
7231 keylen = PSA_BITS_TO_BYTES(key_bits);
7232#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007233 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007234#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007235
7236#if defined(MBEDTLS_GCM_C) || \
7237 defined(MBEDTLS_CCM_C) || \
7238 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007239 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007240 {
7241 size_t explicit_ivlen;
7242
7243 transform->maclen = 0;
7244 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007245
7246 /* All modes haves 96-bit IVs, but the length of the static parts vary
7247 * with mode and version:
7248 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7249 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7250 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7251 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7252 * sequence number).
7253 */
7254 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007255#if defined(MBEDTLS_USE_PSA_CRYPTO)
7256 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7257#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007258 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007259#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007260 transform->fixed_ivlen = 12;
7261 else
7262 transform->fixed_ivlen = 4;
7263
7264 /* Minimum length of encrypted record */
7265 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7266 transform->minlen = explicit_ivlen + transform->taglen;
7267 }
7268 else
7269#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7270#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007271 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7272 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7273 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007274 {
Neil Armstronge4512952022-03-08 09:08:22 +01007275#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007276 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007277#else
7278 size_t block_size = cipher_info->block_size;
7279#endif /* MBEDTLS_USE_PSA_CRYPTO */
7280
7281#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007282 /* Get MAC length */
7283 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7284#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007285 /* Initialize HMAC contexts */
7286 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7287 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7288 {
7289 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7290 goto end;
7291 }
7292
7293 /* Get MAC length */
7294 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007295#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007296 transform->maclen = mac_key_len;
7297
7298 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007299#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007300 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007301#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007302 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007303#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007304
7305 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007306 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007307 transform->minlen = transform->maclen;
7308 else
7309 {
7310 /*
7311 * GenericBlockCipher:
7312 * 1. if EtM is in use: one block plus MAC
7313 * otherwise: * first multiple of blocklen greater than maclen
7314 * 2. IV
7315 */
7316#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007317 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007318 {
7319 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007320 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007321 }
7322 else
7323#endif
7324 {
7325 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007326 + block_size
7327 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007328 }
7329
Glenn Strauss07c64162022-03-14 12:34:51 -04007330 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007331 {
7332 transform->minlen += transform->ivlen;
7333 }
7334 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007335 {
7336 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7337 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7338 goto end;
7339 }
7340 }
7341 }
7342 else
7343#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7344 {
7345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7346 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7347 }
7348
7349 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7350 (unsigned) keylen,
7351 (unsigned) transform->minlen,
7352 (unsigned) transform->ivlen,
7353 (unsigned) transform->maclen ) );
7354
7355 /*
7356 * Finally setup the cipher contexts, IVs and MAC secrets.
7357 */
7358#if defined(MBEDTLS_SSL_CLI_C)
7359 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7360 {
7361 key1 = keyblk + mac_key_len * 2;
7362 key2 = keyblk + mac_key_len * 2 + keylen;
7363
7364 mac_enc = keyblk;
7365 mac_dec = keyblk + mac_key_len;
7366
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007367 iv_copy_len = ( transform->fixed_ivlen ) ?
7368 transform->fixed_ivlen : transform->ivlen;
7369 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7370 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7371 iv_copy_len );
7372 }
7373 else
7374#endif /* MBEDTLS_SSL_CLI_C */
7375#if defined(MBEDTLS_SSL_SRV_C)
7376 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7377 {
7378 key1 = keyblk + mac_key_len * 2 + keylen;
7379 key2 = keyblk + mac_key_len * 2;
7380
7381 mac_enc = keyblk + mac_key_len;
7382 mac_dec = keyblk;
7383
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007384 iv_copy_len = ( transform->fixed_ivlen ) ?
7385 transform->fixed_ivlen : transform->ivlen;
7386 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7387 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7388 iv_copy_len );
7389 }
7390 else
7391#endif /* MBEDTLS_SSL_SRV_C */
7392 {
7393 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7394 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7395 goto end;
7396 }
7397
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007398 if( ssl != NULL && ssl->f_export_keys != NULL )
7399 {
7400 ssl->f_export_keys( ssl->p_export_keys,
7401 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7402 master, 48,
7403 randbytes + 32,
7404 randbytes,
7405 tls_prf_get_type( tls_prf ) );
7406 }
7407
7408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007409 transform->psa_alg = alg;
7410
7411 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7412 {
7413 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7414 psa_set_key_algorithm( &attributes, alg );
7415 psa_set_key_type( &attributes, key_type );
7416
7417 if( ( status = psa_import_key( &attributes,
7418 key1,
7419 PSA_BITS_TO_BYTES( key_bits ),
7420 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7421 {
7422 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7423 ret = psa_ssl_status_to_mbedtls( status );
7424 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7425 goto end;
7426 }
7427
7428 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7429
7430 if( ( status = psa_import_key( &attributes,
7431 key2,
7432 PSA_BITS_TO_BYTES( key_bits ),
7433 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7434 {
7435 ret = psa_ssl_status_to_mbedtls( status );
7436 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7437 goto end;
7438 }
7439 }
7440#else
7441 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7442 cipher_info ) ) != 0 )
7443 {
7444 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7445 goto end;
7446 }
7447
7448 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7449 cipher_info ) ) != 0 )
7450 {
7451 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7452 goto end;
7453 }
7454
7455 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7456 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7457 MBEDTLS_ENCRYPT ) ) != 0 )
7458 {
7459 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7460 goto end;
7461 }
7462
7463 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7464 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7465 MBEDTLS_DECRYPT ) ) != 0 )
7466 {
7467 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7468 goto end;
7469 }
7470
7471#if defined(MBEDTLS_CIPHER_MODE_CBC)
7472 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7473 {
7474 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7475 MBEDTLS_PADDING_NONE ) ) != 0 )
7476 {
7477 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7478 goto end;
7479 }
7480
7481 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7482 MBEDTLS_PADDING_NONE ) ) != 0 )
7483 {
7484 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7485 goto end;
7486 }
7487 }
7488#endif /* MBEDTLS_CIPHER_MODE_CBC */
7489#endif /* MBEDTLS_USE_PSA_CRYPTO */
7490
Neil Armstrong29c0c042022-03-17 17:47:28 +01007491#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7492 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7493 For AEAD-based ciphersuites, there is nothing to do here. */
7494 if( mac_key_len != 0 )
7495 {
7496#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007497 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007498
7499 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007500 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007501 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7502
7503 if( ( status = psa_import_key( &attributes,
7504 mac_enc, mac_key_len,
7505 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7506 {
7507 ret = psa_ssl_status_to_mbedtls( status );
7508 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7509 goto end;
7510 }
7511
Ronald Cronfb39f152022-03-25 14:36:28 +01007512 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7513 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7514 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007515 /* mbedtls_ct_hmac() requires the key to be exportable */
7516 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7517 PSA_KEY_USAGE_VERIFY_HASH );
7518 else
7519 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7520
7521 if( ( status = psa_import_key( &attributes,
7522 mac_dec, mac_key_len,
7523 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7524 {
7525 ret = psa_ssl_status_to_mbedtls( status );
7526 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7527 goto end;
7528 }
7529#else
7530 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7531 if( ret != 0 )
7532 goto end;
7533 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7534 if( ret != 0 )
7535 goto end;
7536#endif /* MBEDTLS_USE_PSA_CRYPTO */
7537 }
7538#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7539
7540 ((void) mac_dec);
7541 ((void) mac_enc);
7542
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007543end:
7544 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7545 return( ret );
7546}
7547
Jerry Yuee40f9d2022-02-17 14:55:16 +08007548#if defined(MBEDTLS_USE_PSA_CRYPTO)
7549int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7550 unsigned char *hash, size_t *hashlen,
7551 unsigned char *data, size_t data_len,
7552 mbedtls_md_type_t md_alg )
7553{
7554 psa_status_t status;
7555 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7556 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7557
7558 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7559
7560 if( ( status = psa_hash_setup( &hash_operation,
7561 hash_alg ) ) != PSA_SUCCESS )
7562 {
7563 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7564 goto exit;
7565 }
7566
7567 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7568 64 ) ) != PSA_SUCCESS )
7569 {
7570 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7571 goto exit;
7572 }
7573
7574 if( ( status = psa_hash_update( &hash_operation,
7575 data, data_len ) ) != PSA_SUCCESS )
7576 {
7577 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7578 goto exit;
7579 }
7580
7581 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7582 hashlen ) ) != PSA_SUCCESS )
7583 {
7584 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7585 goto exit;
7586 }
7587
7588exit:
7589 if( status != PSA_SUCCESS )
7590 {
7591 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7592 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7593 switch( status )
7594 {
7595 case PSA_ERROR_NOT_SUPPORTED:
7596 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7597 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7598 case PSA_ERROR_BUFFER_TOO_SMALL:
7599 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7600 case PSA_ERROR_INSUFFICIENT_MEMORY:
7601 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7602 default:
7603 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7604 }
7605 }
7606 return( 0 );
7607}
7608
7609#else
7610
7611int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7612 unsigned char *hash, size_t *hashlen,
7613 unsigned char *data, size_t data_len,
7614 mbedtls_md_type_t md_alg )
7615{
7616 int ret = 0;
7617 mbedtls_md_context_t ctx;
7618 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7619 *hashlen = mbedtls_md_get_size( md_info );
7620
7621 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7622
7623 mbedtls_md_init( &ctx );
7624
7625 /*
7626 * digitally-signed struct {
7627 * opaque client_random[32];
7628 * opaque server_random[32];
7629 * ServerDHParams params;
7630 * };
7631 */
7632 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7633 {
7634 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7635 goto exit;
7636 }
7637 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7638 {
7639 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7640 goto exit;
7641 }
7642 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7643 {
7644 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7645 goto exit;
7646 }
7647 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7648 {
7649 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7650 goto exit;
7651 }
7652 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7653 {
7654 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7655 goto exit;
7656 }
7657
7658exit:
7659 mbedtls_md_free( &ctx );
7660
7661 if( ret != 0 )
7662 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7663 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7664
7665 return( ret );
7666}
7667#endif /* MBEDTLS_USE_PSA_CRYPTO */
7668
Jerry Yud9d91da2022-02-17 14:57:06 +08007669#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7670
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007671/* Find the preferred hash for a given signature algorithm. */
7672unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7673 mbedtls_ssl_context *ssl,
7674 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007675{
Gabor Mezei078e8032022-04-27 21:17:56 +02007676 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007677 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007678
7679 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007680 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007681
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007682 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007683 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007684 unsigned int hash_alg_received =
7685 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7686 received_sig_algs[i] );
7687 unsigned int sig_alg_received =
7688 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7689 received_sig_algs[i] );
7690
7691 if( sig_alg == sig_alg_received )
7692 {
7693#if defined(MBEDTLS_USE_PSA_CRYPTO)
7694 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7695 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007696 psa_algorithm_t psa_hash_alg =
7697 mbedtls_psa_translate_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007698
Neil Armstrong96eceb82022-06-30 18:05:05 +02007699 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7700 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7701 PSA_ALG_ECDSA( psa_hash_alg ),
7702 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007703 continue;
7704
Neil Armstrong96eceb82022-06-30 18:05:05 +02007705 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02007706 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7707 PSA_ALG_RSA_PKCS1V15_SIGN(
7708 psa_hash_alg ),
7709 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007710 continue;
7711 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007712#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02007713
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007714 return( hash_alg_received );
7715 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007716 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007717
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007718 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007719}
7720
7721#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7722
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007723/* Serialization of TLS 1.2 sessions:
7724 *
7725 * struct {
7726 * uint64 start_time;
7727 * uint8 ciphersuite[2]; // defined by the standard
7728 * uint8 compression; // 0 or 1
7729 * uint8 session_id_len; // at most 32
7730 * opaque session_id[32];
7731 * opaque master[48]; // fixed length in the standard
7732 * uint32 verify_result;
7733 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7734 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7735 * uint32 ticket_lifetime;
7736 * uint8 mfl_code; // up to 255 according to standard
7737 * uint8 encrypt_then_mac; // 0 or 1
7738 * } serialized_session_tls12;
7739 *
7740 */
7741static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7742 unsigned char *buf,
7743 size_t buf_len )
7744{
7745 unsigned char *p = buf;
7746 size_t used = 0;
7747
7748#if defined(MBEDTLS_HAVE_TIME)
7749 uint64_t start;
7750#endif
7751#if defined(MBEDTLS_X509_CRT_PARSE_C)
7752#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7753 size_t cert_len;
7754#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7755#endif /* MBEDTLS_X509_CRT_PARSE_C */
7756
7757 /*
7758 * Time
7759 */
7760#if defined(MBEDTLS_HAVE_TIME)
7761 used += 8;
7762
7763 if( used <= buf_len )
7764 {
7765 start = (uint64_t) session->start;
7766
7767 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7768 p += 8;
7769 }
7770#endif /* MBEDTLS_HAVE_TIME */
7771
7772 /*
7773 * Basic mandatory fields
7774 */
7775 used += 2 /* ciphersuite */
7776 + 1 /* compression */
7777 + 1 /* id_len */
7778 + sizeof( session->id )
7779 + sizeof( session->master )
7780 + 4; /* verify_result */
7781
7782 if( used <= buf_len )
7783 {
7784 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7785 p += 2;
7786
7787 *p++ = MBEDTLS_BYTE_0( session->compression );
7788
7789 *p++ = MBEDTLS_BYTE_0( session->id_len );
7790 memcpy( p, session->id, 32 );
7791 p += 32;
7792
7793 memcpy( p, session->master, 48 );
7794 p += 48;
7795
7796 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7797 p += 4;
7798 }
7799
7800 /*
7801 * Peer's end-entity certificate
7802 */
7803#if defined(MBEDTLS_X509_CRT_PARSE_C)
7804#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7805 if( session->peer_cert == NULL )
7806 cert_len = 0;
7807 else
7808 cert_len = session->peer_cert->raw.len;
7809
7810 used += 3 + cert_len;
7811
7812 if( used <= buf_len )
7813 {
7814 *p++ = MBEDTLS_BYTE_2( cert_len );
7815 *p++ = MBEDTLS_BYTE_1( cert_len );
7816 *p++ = MBEDTLS_BYTE_0( cert_len );
7817
7818 if( session->peer_cert != NULL )
7819 {
7820 memcpy( p, session->peer_cert->raw.p, cert_len );
7821 p += cert_len;
7822 }
7823 }
7824#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7825 if( session->peer_cert_digest != NULL )
7826 {
7827 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7828 if( used <= buf_len )
7829 {
7830 *p++ = (unsigned char) session->peer_cert_digest_type;
7831 *p++ = (unsigned char) session->peer_cert_digest_len;
7832 memcpy( p, session->peer_cert_digest,
7833 session->peer_cert_digest_len );
7834 p += session->peer_cert_digest_len;
7835 }
7836 }
7837 else
7838 {
7839 used += 2;
7840 if( used <= buf_len )
7841 {
7842 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7843 *p++ = 0;
7844 }
7845 }
7846#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7847#endif /* MBEDTLS_X509_CRT_PARSE_C */
7848
7849 /*
7850 * Session ticket if any, plus associated data
7851 */
7852#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7853 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7854
7855 if( used <= buf_len )
7856 {
7857 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7858 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7859 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7860
7861 if( session->ticket != NULL )
7862 {
7863 memcpy( p, session->ticket, session->ticket_len );
7864 p += session->ticket_len;
7865 }
7866
7867 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7868 p += 4;
7869 }
7870#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7871
7872 /*
7873 * Misc extension-related info
7874 */
7875#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7876 used += 1;
7877
7878 if( used <= buf_len )
7879 *p++ = session->mfl_code;
7880#endif
7881
7882#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7883 used += 1;
7884
7885 if( used <= buf_len )
7886 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7887#endif
7888
7889 return( used );
7890}
7891
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007892static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7893 const unsigned char *buf,
7894 size_t len )
7895{
7896#if defined(MBEDTLS_HAVE_TIME)
7897 uint64_t start;
7898#endif
7899#if defined(MBEDTLS_X509_CRT_PARSE_C)
7900#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7901 size_t cert_len;
7902#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7903#endif /* MBEDTLS_X509_CRT_PARSE_C */
7904
7905 const unsigned char *p = buf;
7906 const unsigned char * const end = buf + len;
7907
7908 /*
7909 * Time
7910 */
7911#if defined(MBEDTLS_HAVE_TIME)
7912 if( 8 > (size_t)( end - p ) )
7913 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7914
7915 start = ( (uint64_t) p[0] << 56 ) |
7916 ( (uint64_t) p[1] << 48 ) |
7917 ( (uint64_t) p[2] << 40 ) |
7918 ( (uint64_t) p[3] << 32 ) |
7919 ( (uint64_t) p[4] << 24 ) |
7920 ( (uint64_t) p[5] << 16 ) |
7921 ( (uint64_t) p[6] << 8 ) |
7922 ( (uint64_t) p[7] );
7923 p += 8;
7924
7925 session->start = (time_t) start;
7926#endif /* MBEDTLS_HAVE_TIME */
7927
7928 /*
7929 * Basic mandatory fields
7930 */
7931 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7932 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7933
7934 session->ciphersuite = ( p[0] << 8 ) | p[1];
7935 p += 2;
7936
7937 session->compression = *p++;
7938
7939 session->id_len = *p++;
7940 memcpy( session->id, p, 32 );
7941 p += 32;
7942
7943 memcpy( session->master, p, 48 );
7944 p += 48;
7945
7946 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7947 ( (uint32_t) p[1] << 16 ) |
7948 ( (uint32_t) p[2] << 8 ) |
7949 ( (uint32_t) p[3] );
7950 p += 4;
7951
7952 /* Immediately clear invalid pointer values that have been read, in case
7953 * we exit early before we replaced them with valid ones. */
7954#if defined(MBEDTLS_X509_CRT_PARSE_C)
7955#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7956 session->peer_cert = NULL;
7957#else
7958 session->peer_cert_digest = NULL;
7959#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7960#endif /* MBEDTLS_X509_CRT_PARSE_C */
7961#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7962 session->ticket = NULL;
7963#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7964
7965 /*
7966 * Peer certificate
7967 */
7968#if defined(MBEDTLS_X509_CRT_PARSE_C)
7969#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7970 /* Deserialize CRT from the end of the ticket. */
7971 if( 3 > (size_t)( end - p ) )
7972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7973
7974 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7975 p += 3;
7976
7977 if( cert_len != 0 )
7978 {
7979 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7980
7981 if( cert_len > (size_t)( end - p ) )
7982 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7983
7984 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7985
7986 if( session->peer_cert == NULL )
7987 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7988
7989 mbedtls_x509_crt_init( session->peer_cert );
7990
7991 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7992 p, cert_len ) ) != 0 )
7993 {
7994 mbedtls_x509_crt_free( session->peer_cert );
7995 mbedtls_free( session->peer_cert );
7996 session->peer_cert = NULL;
7997 return( ret );
7998 }
7999
8000 p += cert_len;
8001 }
8002#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8003 /* Deserialize CRT digest from the end of the ticket. */
8004 if( 2 > (size_t)( end - p ) )
8005 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8006
8007 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8008 session->peer_cert_digest_len = (size_t) *p++;
8009
8010 if( session->peer_cert_digest_len != 0 )
8011 {
8012 const mbedtls_md_info_t *md_info =
8013 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8014 if( md_info == NULL )
8015 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8016 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8017 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8018
8019 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8020 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8021
8022 session->peer_cert_digest =
8023 mbedtls_calloc( 1, session->peer_cert_digest_len );
8024 if( session->peer_cert_digest == NULL )
8025 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8026
8027 memcpy( session->peer_cert_digest, p,
8028 session->peer_cert_digest_len );
8029 p += session->peer_cert_digest_len;
8030 }
8031#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8032#endif /* MBEDTLS_X509_CRT_PARSE_C */
8033
8034 /*
8035 * Session ticket and associated data
8036 */
8037#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8038 if( 3 > (size_t)( end - p ) )
8039 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8040
8041 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8042 p += 3;
8043
8044 if( session->ticket_len != 0 )
8045 {
8046 if( session->ticket_len > (size_t)( end - p ) )
8047 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8048
8049 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8050 if( session->ticket == NULL )
8051 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8052
8053 memcpy( session->ticket, p, session->ticket_len );
8054 p += session->ticket_len;
8055 }
8056
8057 if( 4 > (size_t)( end - p ) )
8058 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8059
8060 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8061 ( (uint32_t) p[1] << 16 ) |
8062 ( (uint32_t) p[2] << 8 ) |
8063 ( (uint32_t) p[3] );
8064 p += 4;
8065#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8066
8067 /*
8068 * Misc extension-related info
8069 */
8070#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8071 if( 1 > (size_t)( end - p ) )
8072 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8073
8074 session->mfl_code = *p++;
8075#endif
8076
8077#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8078 if( 1 > (size_t)( end - p ) )
8079 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8080
8081 session->encrypt_then_mac = *p++;
8082#endif
8083
8084 /* Done, should have consumed entire buffer */
8085 if( p != end )
8086 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8087
8088 return( 0 );
8089}
Jerry Yudc7bd172022-02-17 13:44:15 +08008090#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8091
XiaokangQian75d40ef2022-04-20 11:05:24 +00008092int mbedtls_ssl_validate_ciphersuite(
8093 const mbedtls_ssl_context *ssl,
8094 const mbedtls_ssl_ciphersuite_t *suite_info,
8095 mbedtls_ssl_protocol_version min_tls_version,
8096 mbedtls_ssl_protocol_version max_tls_version )
8097{
8098 (void) ssl;
8099
8100 if( suite_info == NULL )
8101 return( -1 );
8102
8103 if( ( suite_info->min_tls_version > max_tls_version ) ||
8104 ( suite_info->max_tls_version < min_tls_version ) )
8105 {
8106 return( -1 );
8107 }
8108
XiaokangQian060d8672022-04-21 09:24:56 +00008109#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008110#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8111 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8112 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8113 {
8114 return( -1 );
8115 }
8116#endif
8117
8118 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8119#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8120 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8121 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8122 {
8123 return( -1 );
8124 }
8125#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8126#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8127
8128 return( 0 );
8129}
8130
XiaokangQianeaf36512022-04-24 09:07:44 +00008131#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8132/*
8133 * Function for writing a signature algorithm extension.
8134 *
8135 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8136 * value (TLS 1.3 RFC8446):
8137 * enum {
8138 * ....
8139 * ecdsa_secp256r1_sha256( 0x0403 ),
8140 * ecdsa_secp384r1_sha384( 0x0503 ),
8141 * ecdsa_secp521r1_sha512( 0x0603 ),
8142 * ....
8143 * } SignatureScheme;
8144 *
8145 * struct {
8146 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8147 * } SignatureSchemeList;
8148 *
8149 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8150 * value (TLS 1.2 RFC5246):
8151 * enum {
8152 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8153 * sha512(6), (255)
8154 * } HashAlgorithm;
8155 *
8156 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8157 * SignatureAlgorithm;
8158 *
8159 * struct {
8160 * HashAlgorithm hash;
8161 * SignatureAlgorithm signature;
8162 * } SignatureAndHashAlgorithm;
8163 *
8164 * SignatureAndHashAlgorithm
8165 * supported_signature_algorithms<2..2^16-2>;
8166 *
8167 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8168 * generalization of the TLS 1.2 signature algorithm extension.
8169 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8170 * `SignatureScheme` field of TLS 1.3
8171 *
8172 */
8173int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8174 const unsigned char *end, size_t *out_len )
8175{
8176 unsigned char *p = buf;
8177 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8178 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8179
8180 *out_len = 0;
8181
8182 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8183
8184 /* Check if we have space for header and length field:
8185 * - extension_type (2 bytes)
8186 * - extension_data_length (2 bytes)
8187 * - supported_signature_algorithms_length (2 bytes)
8188 */
8189 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8190 p += 6;
8191
8192 /*
8193 * Write supported_signature_algorithms
8194 */
8195 supported_sig_alg = p;
8196 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8197 if( sig_alg == NULL )
8198 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8199
8200 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8201 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008202 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8203 *sig_alg,
8204 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008205 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8206 continue;
8207 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8208 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8209 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008210 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008211 *sig_alg,
8212 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008213 }
8214
8215 /* Length of supported_signature_algorithms */
8216 supported_sig_alg_len = p - supported_sig_alg;
8217 if( supported_sig_alg_len == 0 )
8218 {
8219 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8220 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8221 }
8222
XiaokangQianeaf36512022-04-24 09:07:44 +00008223 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008224 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008225 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8226
XiaokangQianeaf36512022-04-24 09:07:44 +00008227 *out_len = p - buf;
8228
8229#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8230 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8231#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8232 return( 0 );
8233}
8234#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8235
XiaokangQian40a35232022-05-07 09:02:40 +00008236#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008237/*
8238 * mbedtls_ssl_parse_server_name_ext
8239 *
8240 * Structure of server_name extension:
8241 *
8242 * enum {
8243 * host_name(0), (255)
8244 * } NameType;
8245 * opaque HostName<1..2^16-1>;
8246 *
8247 * struct {
8248 * NameType name_type;
8249 * select (name_type) {
8250 * case host_name: HostName;
8251 * } name;
8252 * } ServerName;
8253 * struct {
8254 * ServerName server_name_list<1..2^16-1>
8255 * } ServerNameList;
8256 */
8257int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8258 const unsigned char *buf,
8259 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008260{
8261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8262 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008263 size_t server_name_list_len, hostname_len;
8264 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008265
XiaokangQianf2a94202022-05-20 06:44:24 +00008266 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008267
8268 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008269 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008270 p += 2;
8271
XiaokangQian9b2b7712022-05-17 02:57:00 +00008272 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8273 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008274 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008275 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008276 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008277 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008278 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8279 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008280
8281 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8282 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008283 /* sni_name is intended to be used only during the parsing of the
8284 * ClientHello message (it is reset to NULL before the end of
8285 * the message parsing). Thus it is ok to just point to the
8286 * reception buffer and not make a copy of it.
8287 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008288 ssl->handshake->sni_name = p + 3;
8289 ssl->handshake->sni_name_len = hostname_len;
8290 if( ssl->conf->f_sni == NULL )
8291 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008292 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008293 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008294 if( ret != 0 )
8295 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008296 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008297 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8298 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008299 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8300 }
8301 return( 0 );
8302 }
8303
8304 p += hostname_len + 3;
8305 }
8306
8307 return( 0 );
8308}
8309#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8310
XiaokangQianacb39922022-06-17 10:18:48 +00008311#if defined(MBEDTLS_SSL_ALPN)
8312int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8313 const unsigned char *buf,
8314 const unsigned char *end )
8315{
8316 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008317 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008318 const unsigned char *protocol_name_list;
8319 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008320 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008321
8322 /* If ALPN not configured, just ignore the extension */
8323 if( ssl->conf->alpn_list == NULL )
8324 return( 0 );
8325
8326 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008327 * RFC7301, section 3.1
8328 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008329 *
XiaokangQianc7403452022-06-23 03:24:12 +00008330 * struct {
8331 * ProtocolName protocol_name_list<2..2^16-1>
8332 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008333 */
8334
XiaokangQianc7403452022-06-23 03:24:12 +00008335 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008336 * protocol_name_list_len 2 bytes
8337 * protocol_name_len 1 bytes
8338 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008339 */
XiaokangQianacb39922022-06-17 10:18:48 +00008340 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8341
XiaokangQianc7403452022-06-23 03:24:12 +00008342 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008343 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008344 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008345 protocol_name_list = p;
8346 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008347
8348 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008349 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008350 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008351 protocol_name_len = *p++;
8352 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8353 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008354 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008355 {
8356 MBEDTLS_SSL_PEND_FATAL_ALERT(
8357 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8358 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008359 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008360 }
8361
8362 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008363 }
8364
8365 /* Use our order of preference */
8366 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8367 {
8368 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008369 p = protocol_name_list;
8370 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008371 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008372 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008373 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008374 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008375 {
8376 ssl->alpn_chosen = *alpn;
8377 return( 0 );
8378 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008379
8380 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008381 }
8382 }
8383
XiaokangQian95d5f542022-06-24 02:29:26 +00008384 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008385 MBEDTLS_SSL_PEND_FATAL_ALERT(
8386 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8387 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8388 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8389}
8390
8391int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8392 unsigned char *buf,
8393 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008394 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008395{
8396 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008397 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008398 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008399
8400 if( ssl->alpn_chosen == NULL )
8401 {
8402 return( 0 );
8403 }
8404
XiaokangQian95d5f542022-06-24 02:29:26 +00008405 protocol_name_len = strlen( ssl->alpn_chosen );
8406 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008407
8408 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8409 /*
8410 * 0 . 1 ext identifier
8411 * 2 . 3 ext length
8412 * 4 . 5 protocol list length
8413 * 6 . 6 protocol name length
8414 * 7 . 7+n protocol name
8415 */
8416 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8417
XiaokangQian95d5f542022-06-24 02:29:26 +00008418 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008419
XiaokangQian95d5f542022-06-24 02:29:26 +00008420 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8421 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008422 /* Note: the length of the chosen protocol has been checked to be less
8423 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8424 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008425 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008426
XiaokangQian95d5f542022-06-24 02:29:26 +00008427 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008428 return ( 0 );
8429}
8430#endif /* MBEDTLS_SSL_ALPN */
8431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008432#endif /* MBEDTLS_SSL_TLS_C */