blob: 68d91e8f3fa6c6f6e67b54f3fbf6c660406372db [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
Ronald Cronad8c17b2022-06-10 17:18:09 +020061#if defined(MBEDTLS_TEST_HOOKS)
62static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
63
64void mbedtls_ssl_set_chk_buf_ptr_fail_args(
65 const uint8_t *cur, const uint8_t *end, size_t need )
66{
67 chk_buf_ptr_fail_args.cur = cur;
68 chk_buf_ptr_fail_args.end = end;
69 chk_buf_ptr_fail_args.need = need;
70}
71
72void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void )
73{
74 memset( &chk_buf_ptr_fail_args, 0, sizeof( chk_buf_ptr_fail_args ) );
75}
76
77int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args )
78{
79 return( ( chk_buf_ptr_fail_args.cur != args->cur ) ||
80 ( chk_buf_ptr_fail_args.end != args->end ) ||
81 ( chk_buf_ptr_fail_args.need != args->need ) );
82}
83#endif /* MBEDTLS_TEST_HOOKS */
84
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010086
Hanno Beckera0e20d02019-05-15 14:03:01 +010087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010088/* Top-level Connection ID API */
89
Hanno Becker8367ccc2019-05-14 11:30:10 +010090int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
91 size_t len,
92 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010093{
94 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
95 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
96
Hanno Becker611ac772019-05-14 11:45:26 +010097 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
98 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
99 {
100 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
101 }
102
103 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100104 conf->cid_len = len;
105 return( 0 );
106}
107
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100108int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
109 int enable,
110 unsigned char const *own_cid,
111 size_t own_cid_len )
112{
Hanno Becker76a79ab2019-05-03 14:38:32 +0100113 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
114 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
115
Hanno Beckerca092242019-04-25 16:01:49 +0100116 ssl->negotiate_cid = enable;
117 if( enable == MBEDTLS_SSL_CID_DISABLED )
118 {
119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
120 return( 0 );
121 }
122 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +0100123 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Hanno Beckerad4a1372019-05-03 13:06:44 +0100125 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100126 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100127 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
128 (unsigned) own_cid_len,
129 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100130 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
131 }
132
133 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100134 /* Truncation is not an issue here because
135 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
136 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100137
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100138 return( 0 );
139}
140
Paul Elliott0113cf12022-03-11 20:26:47 +0000141int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
142 int *enabled,
143 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
144 size_t *own_cid_len )
145{
146 *enabled = MBEDTLS_SSL_CID_DISABLED;
147
148 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
149 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
150
151 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
152 * zero as this is indistinguishable from not requesting to use
153 * the CID extension. */
154 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
155 return( 0 );
156
157 if( own_cid_len != NULL )
158 {
159 *own_cid_len = ssl->own_cid_len;
160 if( own_cid != NULL )
161 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
162 }
163
164 *enabled = MBEDTLS_SSL_CID_ENABLED;
165
166 return( 0 );
167}
168
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100169int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
170 int *enabled,
171 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
172 size_t *peer_cid_len )
173{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100174 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100175
Hanno Becker76a79ab2019-05-03 14:38:32 +0100176 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000177 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100178 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100179 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100180 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181
Hanno Beckerc5f24222019-05-03 12:54:52 +0100182 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
183 * were used, but client and server requested the empty CID.
184 * This is indistinguishable from not using the CID extension
185 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186 if( ssl->transform_in->in_cid_len == 0 &&
187 ssl->transform_in->out_cid_len == 0 )
188 {
189 return( 0 );
190 }
191
Hanno Becker615ef172019-05-22 16:50:35 +0100192 if( peer_cid_len != NULL )
193 {
194 *peer_cid_len = ssl->transform_in->out_cid_len;
195 if( peer_cid != NULL )
196 {
197 memcpy( peer_cid, ssl->transform_in->out_cid,
198 ssl->transform_in->out_cid_len );
199 }
200 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100201
202 *enabled = MBEDTLS_SSL_CID_ENABLED;
203
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100204 return( 0 );
205}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100206#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200211/*
212 * Convert max_fragment_length codes to length.
213 * RFC 6066 says:
214 * enum{
215 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
216 * } MaxFragmentLength;
217 * and we add 0 -> extension unused
218 */
Angus Grattond8213d02016-05-25 20:56:48 +1000219static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200220{
Angus Grattond8213d02016-05-25 20:56:48 +1000221 switch( mfl )
222 {
223 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
224 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
225 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
226 return 512;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
228 return 1024;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
230 return 2048;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
232 return 4096;
233 default:
234 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
235 }
236}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200238
Hanno Becker52055ae2019-02-06 14:30:46 +0000239int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
240 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200241{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 mbedtls_ssl_session_free( dst );
243 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200244
吴敬辉0b716112021-11-29 10:46:35 +0800245#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
246 dst->ticket = NULL;
247#endif
248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000250
251#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252 if( src->peer_cert != NULL )
253 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200255
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200256 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200257 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200258 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200263 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200266 dst->peer_cert = NULL;
267 return( ret );
268 }
269 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000270#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 if( src->peer_cert_digest != NULL )
272 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000274 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000275 if( dst->peer_cert_digest == NULL )
276 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
277
278 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
279 src->peer_cert_digest_len );
280 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000281 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 }
283#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200287#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288 if( src->ticket != NULL )
289 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200290 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200291 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200292 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200293
294 memcpy( dst->ticket, src->ticket, src->ticket_len );
295 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200296#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297
298 return( 0 );
299}
300
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500301#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200302MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
304{
305 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
306 if( resized_buffer == NULL )
307 return -1;
308
309 /* We want to copy len_new bytes when downsizing the buffer, and
310 * len_old bytes when upsizing, so we choose the smaller of two sizes,
311 * to fit one buffer into another. Size checks, ensuring that no data is
312 * lost, are done outside of this function. */
313 memcpy( resized_buffer, *buffer,
314 ( len_new < *len_old ) ? len_new : *len_old );
315 mbedtls_platform_zeroize( *buffer, *len_old );
316 mbedtls_free( *buffer );
317
318 *buffer = resized_buffer;
319 *len_old = len_new;
320
321 return 0;
322}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323
324static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500325 size_t in_buf_new_len,
326 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200327{
328 int modified = 0;
329 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
330 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
331 if( ssl->in_buf != NULL )
332 {
333 written_in = ssl->in_msg - ssl->in_buf;
334 iv_offset_in = ssl->in_iv - ssl->in_buf;
335 len_offset_in = ssl->in_len - ssl->in_buf;
336 if( downsizing ?
337 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
338 ssl->in_buf_len < in_buf_new_len )
339 {
340 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
341 {
342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
343 }
344 else
345 {
Paul Elliottb7449902021-03-10 18:14:58 +0000346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
347 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200348 modified = 1;
349 }
350 }
351 }
352
353 if( ssl->out_buf != NULL )
354 {
355 written_out = ssl->out_msg - ssl->out_buf;
356 iv_offset_out = ssl->out_iv - ssl->out_buf;
357 len_offset_out = ssl->out_len - ssl->out_buf;
358 if( downsizing ?
359 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
360 ssl->out_buf_len < out_buf_new_len )
361 {
362 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
363 {
364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
365 }
366 else
367 {
Paul Elliottb7449902021-03-10 18:14:58 +0000368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
369 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 modified = 1;
371 }
372 }
373 }
374 if( modified )
375 {
376 /* Update pointers here to avoid doing it twice. */
377 mbedtls_ssl_reset_in_out_pointers( ssl );
378 /* Fields below might not be properly updated with record
379 * splitting or with CID, so they are manually updated here. */
380 ssl->out_msg = ssl->out_buf + written_out;
381 ssl->out_len = ssl->out_buf + len_offset_out;
382 ssl->out_iv = ssl->out_buf + iv_offset_out;
383
384 ssl->in_msg = ssl->in_buf + written_in;
385 ssl->in_len = ssl->in_buf + len_offset_in;
386 ssl->in_iv = ssl->in_buf + iv_offset_in;
387 }
388}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500389#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
390
Jerry Yudb8c48a2022-01-27 14:54:54 +0800391#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
394typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
395 const char *label,
396 const unsigned char *random, size_t rlen,
397 unsigned char *dstbuf, size_t dlen );
398
399static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
400
401#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
402
403/* Type for the TLS PRF */
404typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
405 const unsigned char *, size_t,
406 unsigned char *, size_t);
407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200408MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800409static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
410 int ciphersuite,
411 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800415 ssl_tls_prf_t tls_prf,
416 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400417 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800418 unsigned endpoint,
419 const mbedtls_ssl_context *ssl );
420
421#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800423static int tls_prf_sha256( const unsigned char *secret, size_t slen,
424 const char *label,
425 const unsigned char *random, size_t rlen,
426 unsigned char *dstbuf, size_t dlen );
427static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
428static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
429
430#endif /* MBEDTLS_SHA256_C */
431
432#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200433MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800434static int tls_prf_sha384( 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
439static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
440static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
441#endif /* MBEDTLS_SHA384_C */
442
443static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
444 unsigned char *buf,
445 size_t buf_len );
Jerry Yu251a12e2022-07-13 15:15:48 +0800446
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200447MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800448static int ssl_session_load_tls12( mbedtls_ssl_session *session,
449 const unsigned char *buf,
450 size_t len );
451#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
452
Jerry Yu53d23e22022-02-09 16:25:09 +0800453static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
454
Jerry Yudb8c48a2022-01-27 14:54:54 +0800455#if defined(MBEDTLS_SHA256_C)
456static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800457#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800458
459#if defined(MBEDTLS_SHA384_C)
460static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800461#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000462
Ron Eldor51d3ab52019-05-12 14:54:30 +0300463int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
464 const unsigned char *secret, size_t slen,
465 const char *label,
466 const unsigned char *random, size_t rlen,
467 unsigned char *dstbuf, size_t dlen )
468{
469 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
470
471 switch( prf )
472 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300473#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200474#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300475 case MBEDTLS_SSL_TLS_PRF_SHA384:
476 tls_prf = tls_prf_sha384;
477 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200478#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300479#if defined(MBEDTLS_SHA256_C)
480 case MBEDTLS_SSL_TLS_PRF_SHA256:
481 tls_prf = tls_prf_sha256;
482 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300483#endif /* MBEDTLS_SHA256_C */
484#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300485 default:
486 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
487 }
488
489 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
490}
491
Jerry Yuc73c6182022-02-08 20:29:25 +0800492#if defined(MBEDTLS_X509_CRT_PARSE_C)
493static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
494{
495#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
496 if( session->peer_cert != NULL )
497 {
498 mbedtls_x509_crt_free( session->peer_cert );
499 mbedtls_free( session->peer_cert );
500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
503 if( session->peer_cert_digest != NULL )
504 {
505 /* Zeroization is not necessary. */
506 mbedtls_free( session->peer_cert_digest );
507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
515void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
516 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
517{
518 ((void) ciphersuite_info);
519
520#if defined(MBEDTLS_SHA384_C)
521 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
522 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
523 else
524#endif
525#if defined(MBEDTLS_SHA256_C)
526 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
527 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
528 else
529#endif
530 {
531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
532 return;
533 }
534}
535
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100536static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
537 unsigned hs_type,
538 size_t total_hs_len )
539{
540 unsigned char hs_hdr[4];
541
542 /* Build HS header for checksum update. */
543 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
544 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
545 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
546 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
547
548 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
549}
550
551void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
552 unsigned hs_type,
553 unsigned char const *msg,
554 size_t msg_len )
555{
556 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
557 ssl->handshake->update_checksum( ssl, msg, msg_len );
558}
559
Jerry Yuc73c6182022-02-08 20:29:25 +0800560void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
561{
562 ((void) ssl);
563#if defined(MBEDTLS_SHA256_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
566 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
567#else
568 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
569#endif
570#endif
571#if defined(MBEDTLS_SHA384_C)
572#if defined(MBEDTLS_USE_PSA_CRYPTO)
573 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
574 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
575#else
576 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
577#endif
578#endif
579}
580
581static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
582 const unsigned char *buf, size_t len )
583{
584#if defined(MBEDTLS_SHA256_C)
585#if defined(MBEDTLS_USE_PSA_CRYPTO)
586 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
587#else
588 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
589#endif
590#endif
591#if defined(MBEDTLS_SHA384_C)
592#if defined(MBEDTLS_USE_PSA_CRYPTO)
593 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
594#else
595 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
596#endif
597#endif
598}
599
600#if defined(MBEDTLS_SHA256_C)
601static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
602 const unsigned char *buf, size_t len )
603{
604#if defined(MBEDTLS_USE_PSA_CRYPTO)
605 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
606#else
607 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
608#endif
609}
610#endif
611
612#if defined(MBEDTLS_SHA384_C)
613static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
614 const unsigned char *buf, size_t len )
615{
616#if defined(MBEDTLS_USE_PSA_CRYPTO)
617 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
618#else
619 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
620#endif
621}
622#endif
623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500629#if defined(MBEDTLS_USE_PSA_CRYPTO)
630 handshake->fin_sha256_psa = psa_hash_operation_init();
631 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
632#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200634 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200635#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500636#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200637#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500638#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500639 handshake->fin_sha384_psa = psa_hash_operation_init();
640 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500641#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200643 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200644#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500645#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200646
647 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649#if defined(MBEDTLS_DHM_C)
650 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200651#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200652#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200654#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200655#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200656 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200657#if defined(MBEDTLS_SSL_CLI_C)
658 handshake->ecjpake_cache = NULL;
659 handshake->ecjpake_cache_len = 0;
660#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200661#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200662
Gilles Peskineeccd8882020-03-10 12:19:08 +0100663#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200664 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200665#endif
666
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200667#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
668 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
669#endif
Hanno Becker75173122019-02-06 16:18:31 +0000670
671#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
672 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
673 mbedtls_pk_init( &handshake->peer_pubkey );
674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Hanno Beckera18d1322018-01-03 14:27:32 +0000677void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200680
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100681#if defined(MBEDTLS_USE_PSA_CRYPTO)
682 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
683 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100684#else
685 mbedtls_cipher_init( &transform->cipher_ctx_enc );
686 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100687#endif
688
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100690#if defined(MBEDTLS_USE_PSA_CRYPTO)
691 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
692 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100693#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 mbedtls_md_init( &transform->md_ctx_enc );
695 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000696#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100697#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200698}
699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200703}
704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200705MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000707{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200708 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000709 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200711 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200713 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200714 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715
716 /*
717 * Either the pointers are now NULL or cleared properly and can be freed.
718 * Now allocate missing structures.
719 */
720 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200721 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200722 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200723 }
Paul Bakker48916f92012-09-16 19:57:18 +0000724
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200726 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200727 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200728 }
Paul Bakker48916f92012-09-16 19:57:18 +0000729
Paul Bakker82788fb2014-10-20 13:59:19 +0200730 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200731 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200732 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200733 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500734#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
735 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400736
Andrzej Kurek4a063792020-10-21 15:08:44 +0200737 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
738 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500739#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000740
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200741 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000742 if( ssl->handshake == NULL ||
743 ssl->transform_negotiate == NULL ||
744 ssl->session_negotiate == NULL )
745 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 mbedtls_free( ssl->handshake );
749 mbedtls_free( ssl->transform_negotiate );
750 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200751
752 ssl->handshake = NULL;
753 ssl->transform_negotiate = NULL;
754 ssl->session_negotiate = NULL;
755
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200756 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000757 }
758
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200759 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000761 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200762 ssl_handshake_params_init( ssl->handshake );
763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200765 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
766 {
767 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200768
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200769 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
770 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
771 else
772 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200773
Hanno Becker0f57a652020-02-05 10:37:26 +0000774 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200775 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200776#endif
777
Brett Warrene0edc842021-08-17 09:53:13 +0100778/*
779 * curve_list is translated to IANA TLS group identifiers here because
780 * mbedtls_ssl_conf_curves returns void and so can't return
781 * any error codes.
782 */
783#if defined(MBEDTLS_ECP_C)
784#if !defined(MBEDTLS_DEPRECATED_REMOVED)
785 /* Heap allocate and translate curve_list from internal to IANA group ids */
786 if ( ssl->conf->curve_list != NULL )
787 {
788 size_t length;
789 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
790
791 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
792 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
793
794 /* Leave room for zero termination */
795 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
796 if ( group_list == NULL )
797 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
798
799 for( size_t i = 0; i < length; i++ )
800 {
801 const mbedtls_ecp_curve_info *info =
802 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
803 if ( info == NULL )
804 {
805 mbedtls_free( group_list );
806 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
807 }
808 group_list[i] = info->tls_id;
809 }
810
811 group_list[length] = 0;
812
813 ssl->handshake->group_list = group_list;
814 ssl->handshake->group_list_heap_allocated = 1;
815 }
816 else
817 {
818 ssl->handshake->group_list = ssl->conf->group_list;
819 ssl->handshake->group_list_heap_allocated = 0;
820 }
821#endif /* MBEDTLS_DEPRECATED_REMOVED */
822#endif /* MBEDTLS_ECP_C */
823
Jerry Yuf017ee42022-01-12 15:49:48 +0800824#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
825#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800826#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800827 /* Heap allocate and translate sig_hashes from internal hash identifiers to
828 signature algorithms IANA identifiers. */
829 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 ssl->conf->sig_hashes != NULL )
831 {
832 const int *md;
833 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800834 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 uint16_t *p;
836
Jerry Yub476a442022-01-21 18:14:45 +0800837#if defined(static_assert)
838 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
839 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
840 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800841#endif
842
Jerry Yuf017ee42022-01-12 15:49:48 +0800843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
846 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800847#if defined(MBEDTLS_ECDSA_C)
848 sig_algs_len += sizeof( uint16_t );
849#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800850
Jerry Yub476a442022-01-21 18:14:45 +0800851#if defined(MBEDTLS_RSA_C)
852 sig_algs_len += sizeof( uint16_t );
853#endif
854 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
855 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857
Jerry Yub476a442022-01-21 18:14:45 +0800858 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800859 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
860
Jerry Yub476a442022-01-21 18:14:45 +0800861 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
862 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800863 if( ssl->handshake->sig_algs == NULL )
864 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
865
866 p = (uint16_t *)ssl->handshake->sig_algs;
867 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
868 {
869 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
870 if( hash == MBEDTLS_SSL_HASH_NONE )
871 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800872#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800873 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
874 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800875#endif
876#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800877 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
878 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800879#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800880 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200881 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800882 ssl->handshake->sig_algs_heap_allocated = 1;
883 }
884 else
Jerry Yua69269a2022-01-17 21:06:01 +0800885#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800886 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800887 ssl->handshake->sig_algs_heap_allocated = 0;
888 }
Jerry Yucc539102022-06-27 16:27:35 +0800889#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800890#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000891 return( 0 );
892}
893
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200894#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200896MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897static int ssl_cookie_write_dummy( void *ctx,
898 unsigned char **p, unsigned char *end,
899 const unsigned char *cli_id, size_t cli_id_len )
900{
901 ((void) ctx);
902 ((void) p);
903 ((void) end);
904 ((void) cli_id);
905 ((void) cli_id_len);
906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200908}
909
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200910MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200911static int ssl_cookie_check_dummy( void *ctx,
912 const unsigned char *cookie, size_t cookie_len,
913 const unsigned char *cli_id, size_t cli_id_len )
914{
915 ((void) ctx);
916 ((void) cookie);
917 ((void) cookie_len);
918 ((void) cli_id);
919 ((void) cli_id_len);
920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200922}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200923#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200924
Paul Bakker5121ce52009-01-03 21:22:43 +0000925/*
926 * Initialize an SSL context
927 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200928void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
929{
930 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
931}
932
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200933MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800934static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
935{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100936 const mbedtls_ssl_config *conf = ssl->conf;
937
Ronald Cron6f135e12021-12-08 16:57:54 +0100938#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100939 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
940 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000941 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
Jerry Yu60835a82021-08-04 10:13:52 +0800947 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
948 return( 0 );
949 }
950#endif
951
952#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100953 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800954 {
955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
956 return( 0 );
957 }
958#endif
959
Ronald Cron6f135e12021-12-08 16:57:54 +0100960#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100961 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800962 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
964 {
965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
966 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
967 }
968
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000969 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
970 {
971 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
972 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
973 }
974
975
Ronald Crone1d3f062022-02-10 14:50:54 +0100976 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
977 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800978 }
979#endif
980
981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
982 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
983}
984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200985MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800986static int ssl_conf_check(const mbedtls_ssl_context *ssl)
987{
988 int ret;
989 ret = ssl_conf_version_check( ssl );
990 if( ret != 0 )
991 return( ret );
992
993 /* Space for further checks */
994
995 return( 0 );
996}
997
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200998/*
999 * Setup an SSL context
1000 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001001
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001002int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001003 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004{
Janos Follath865b3eb2019-12-16 11:46:15 +00001005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001006 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1007 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001008
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001009 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001010
Jerry Yu60835a82021-08-04 10:13:52 +08001011 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1012 return( ret );
1013
Paul Bakker62f2dee2012-09-28 07:31:51 +00001014 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001015 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001016 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001017
1018 /* Set to NULL in case of an error condition */
1019 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001020
Darryl Greenb33cc762019-11-28 14:29:44 +00001021#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1022 ssl->in_buf_len = in_buf_len;
1023#endif
1024 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001025 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001028 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001030 }
1031
Darryl Greenb33cc762019-11-28 14:29:44 +00001032#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1033 ssl->out_buf_len = out_buf_len;
1034#endif
1035 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001036 if( ssl->out_buf == NULL )
1037 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001039 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001040 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001041 }
1042
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001043 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001044
Johan Pascalb62bb512015-12-03 21:56:45 +01001045#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001046 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001047#endif
1048
Paul Bakker48916f92012-09-16 19:57:18 +00001049 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001050 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001051
1052 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001053
1054error:
1055 mbedtls_free( ssl->in_buf );
1056 mbedtls_free( ssl->out_buf );
1057
1058 ssl->conf = NULL;
1059
Darryl Greenb33cc762019-11-28 14:29:44 +00001060#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1061 ssl->in_buf_len = 0;
1062 ssl->out_buf_len = 0;
1063#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001064 ssl->in_buf = NULL;
1065 ssl->out_buf = NULL;
1066
1067 ssl->in_hdr = NULL;
1068 ssl->in_ctr = NULL;
1069 ssl->in_len = NULL;
1070 ssl->in_iv = NULL;
1071 ssl->in_msg = NULL;
1072
1073 ssl->out_hdr = NULL;
1074 ssl->out_ctr = NULL;
1075 ssl->out_len = NULL;
1076 ssl->out_iv = NULL;
1077 ssl->out_msg = NULL;
1078
k-stachowiak9f7798e2018-07-31 16:52:32 +02001079 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001080}
1081
1082/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001083 * Reset an initialized and used SSL context for re-use while retaining
1084 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001085 *
1086 * If partial is non-zero, keep data in the input buffer and client ID.
1087 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001088 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001089void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1090 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001091{
Darryl Greenb33cc762019-11-28 14:29:44 +00001092#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1093 size_t in_buf_len = ssl->in_buf_len;
1094 size_t out_buf_len = ssl->out_buf_len;
1095#else
1096 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1097 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1098#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001099
Hanno Beckerb0302c42021-08-03 09:39:42 +01001100#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1101 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001102#endif
1103
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001104 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001105 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001106
Hanno Beckerb0302c42021-08-03 09:39:42 +01001107 mbedtls_ssl_reset_in_out_pointers( ssl );
1108
1109 /* Reset incoming message parsing */
1110 ssl->in_offt = NULL;
1111 ssl->nb_zero = 0;
1112 ssl->in_msgtype = 0;
1113 ssl->in_msglen = 0;
1114 ssl->in_hslen = 0;
1115 ssl->keep_current_message = 0;
1116 ssl->transform_in = NULL;
1117
1118#if defined(MBEDTLS_SSL_PROTO_DTLS)
1119 ssl->next_record_offset = 0;
1120 ssl->in_epoch = 0;
1121#endif
1122
1123 /* Keep current datagram if partial == 1 */
1124 if( partial == 0 )
1125 {
1126 ssl->in_left = 0;
1127 memset( ssl->in_buf, 0, in_buf_len );
1128 }
1129
Ronald Cronad8c17b2022-06-10 17:18:09 +02001130 ssl->send_alert = 0;
1131
Hanno Beckerb0302c42021-08-03 09:39:42 +01001132 /* Reset outgoing message writing */
1133 ssl->out_msgtype = 0;
1134 ssl->out_msglen = 0;
1135 ssl->out_left = 0;
1136 memset( ssl->out_buf, 0, out_buf_len );
1137 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1138 ssl->transform_out = NULL;
1139
1140#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1141 mbedtls_ssl_dtls_replay_reset( ssl );
1142#endif
1143
XiaokangQian2b01dc32022-01-21 02:53:13 +00001144#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001145 if( ssl->transform )
1146 {
1147 mbedtls_ssl_transform_free( ssl->transform );
1148 mbedtls_free( ssl->transform );
1149 ssl->transform = NULL;
1150 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001151#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1152
XiaokangQian2b01dc32022-01-21 02:53:13 +00001153#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1154 mbedtls_ssl_transform_free( ssl->transform_application );
1155 mbedtls_free( ssl->transform_application );
1156 ssl->transform_application = NULL;
1157
1158 if( ssl->handshake != NULL )
1159 {
1160 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1161 mbedtls_free( ssl->handshake->transform_earlydata );
1162 ssl->handshake->transform_earlydata = NULL;
1163
1164 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1165 mbedtls_free( ssl->handshake->transform_handshake );
1166 ssl->handshake->transform_handshake = NULL;
1167 }
1168
XiaokangQian2b01dc32022-01-21 02:53:13 +00001169#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001170}
1171
1172int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1173{
1174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1175
1176 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1177
XiaokangQian78b1fa72022-01-19 06:56:30 +00001178 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001179
1180 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#if defined(MBEDTLS_SSL_RENEGOTIATION)
1182 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001183 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001184
1185 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1187 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001188#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001190
Hanno Beckerb0302c42021-08-03 09:39:42 +01001191 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001192 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001193 if( ssl->session )
1194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195 mbedtls_ssl_session_free( ssl->session );
1196 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001197 ssl->session = NULL;
1198 }
1199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001201 ssl->alpn_chosen = NULL;
1202#endif
1203
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001204#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001205#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001206 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001207#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001208 {
1209 mbedtls_free( ssl->cli_id );
1210 ssl->cli_id = NULL;
1211 ssl->cli_id_len = 0;
1212 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001213#endif
1214
Paul Bakker48916f92012-09-16 19:57:18 +00001215 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1216 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001217
1218 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001219}
1220
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001221/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001222 * Reset an initialized and used SSL context for re-use while retaining
1223 * all application-set variables, function pointers and data.
1224 */
1225int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1226{
Hanno Becker43aefe22020-02-05 10:44:56 +00001227 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001228}
1229
1230/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001231 * SSL set accessors
1232 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001233void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001236}
1237
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001238void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001239{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001240 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001241}
1242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001244void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001245{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001246 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001247}
1248#endif
1249
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001250void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001251{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001252 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001253}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001256
Hanno Becker1841b0a2018-08-24 11:13:57 +01001257void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1258 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001259{
1260 ssl->disable_datagram_packing = !allow_packing;
1261}
1262
1263void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1264 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001265{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001266 conf->hs_timeout_min = min;
1267 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001268}
1269#endif
1270
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001271void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001272{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001273 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001274}
1275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001277void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001278 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001279 void *p_vrfy )
1280{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001281 conf->f_vrfy = f_vrfy;
1282 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001283}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001285
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001286void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001287 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001288 void *p_rng )
1289{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001290 conf->f_rng = f_rng;
1291 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001292}
1293
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001294void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001295 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001296 void *p_dbg )
1297{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001298 conf->f_dbg = f_dbg;
1299 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001300}
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001303 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_send_t *f_send,
1305 mbedtls_ssl_recv_t *f_recv,
1306 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001307{
1308 ssl->p_bio = p_bio;
1309 ssl->f_send = f_send;
1310 ssl->f_recv = f_recv;
1311 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001312}
1313
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001314#if defined(MBEDTLS_SSL_PROTO_DTLS)
1315void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1316{
1317 ssl->mtu = mtu;
1318}
1319#endif
1320
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001321void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001322{
1323 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001324}
1325
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001326void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1327 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001328 mbedtls_ssl_set_timer_t *f_set_timer,
1329 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001330{
1331 ssl->p_timer = p_timer;
1332 ssl->f_set_timer = f_set_timer;
1333 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001334
1335 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001336 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001337}
1338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001340void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001341 void *p_cache,
1342 mbedtls_ssl_cache_get_t *f_get_cache,
1343 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001344{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001345 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001346 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001347 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001348}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#if defined(MBEDTLS_SSL_CLI_C)
1352int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001353{
Janos Follath865b3eb2019-12-16 11:46:15 +00001354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001355
1356 if( ssl == NULL ||
1357 session == NULL ||
1358 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001359 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001362 }
1363
Hanno Beckere810bbc2021-05-14 16:01:05 +01001364 if( ssl->handshake->resume == 1 )
1365 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1366
Hanno Becker52055ae2019-02-06 14:30:46 +00001367 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1368 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001369 return( ret );
1370
Paul Bakker0a597072012-09-25 21:55:46 +00001371 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001372
1373 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001376
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001377void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1378 const int *ciphersuites )
1379{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001380 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001381}
1382
Ronald Cron6f135e12021-12-08 16:57:54 +01001383#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001384void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001385 const int kex_modes )
1386{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001387 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001388}
Ronald Cron6f135e12021-12-08 16:57:54 +01001389#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001392void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001393 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001394{
1395 conf->cert_profile = profile;
1396}
1397
Glenn Strauss36872db2022-01-22 05:06:31 -05001398static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1399{
1400 mbedtls_ssl_key_cert *cur = key_cert, *next;
1401
1402 while( cur != NULL )
1403 {
1404 next = cur->next;
1405 mbedtls_free( cur );
1406 cur = next;
1407 }
1408}
1409
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001411MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001412static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1413 mbedtls_x509_crt *cert,
1414 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415{
niisato8ee24222018-06-25 19:05:48 +09001416 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417
Glenn Strauss36872db2022-01-22 05:06:31 -05001418 if( cert == NULL )
1419 {
1420 /* Free list if cert is null */
1421 ssl_key_cert_free( *head );
1422 *head = NULL;
1423 return( 0 );
1424 }
1425
niisato8ee24222018-06-25 19:05:48 +09001426 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1427 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001428 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001429
niisato8ee24222018-06-25 19:05:48 +09001430 new_cert->cert = cert;
1431 new_cert->key = key;
1432 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001433
Glenn Strauss36872db2022-01-22 05:06:31 -05001434 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001435 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001436 {
niisato8ee24222018-06-25 19:05:48 +09001437 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001438 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001439 else
1440 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001441 mbedtls_ssl_key_cert *cur = *head;
1442 while( cur->next != NULL )
1443 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001444 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001445 }
1446
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001447 return( 0 );
1448}
1449
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001450int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001451 mbedtls_x509_crt *own_cert,
1452 mbedtls_pk_context *pk_key )
1453{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001454 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001455}
1456
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001457void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001458 mbedtls_x509_crt *ca_chain,
1459 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001460{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001461 conf->ca_chain = ca_chain;
1462 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001463
1464#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1465 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1466 * cannot be used together. */
1467 conf->f_ca_cb = NULL;
1468 conf->p_ca_cb = NULL;
1469#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001470}
Hanno Becker5adaad92019-03-27 16:54:37 +00001471
1472#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1473void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001474 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001475 void *p_ca_cb )
1476{
1477 conf->f_ca_cb = f_ca_cb;
1478 conf->p_ca_cb = p_ca_cb;
1479
1480 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1481 * cannot be used together. */
1482 conf->ca_chain = NULL;
1483 conf->ca_crl = NULL;
1484}
1485#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001487
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001488#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001489const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1490 size_t *name_len )
1491{
1492 *name_len = ssl->handshake->sni_name_len;
1493 return( ssl->handshake->sni_name );
1494}
1495
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001496int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1497 mbedtls_x509_crt *own_cert,
1498 mbedtls_pk_context *pk_key )
1499{
1500 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1501 own_cert, pk_key ) );
1502}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001503
1504void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1505 mbedtls_x509_crt *ca_chain,
1506 mbedtls_x509_crl *ca_crl )
1507{
1508 ssl->handshake->sni_ca_chain = ca_chain;
1509 ssl->handshake->sni_ca_crl = ca_crl;
1510}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001511
Glenn Strauss999ef702022-03-11 01:37:23 -05001512#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1513void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1514 const mbedtls_x509_crt *crt)
1515{
1516 ssl->handshake->dn_hints = crt;
1517}
1518#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1519
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001520void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1521 int authmode )
1522{
1523 ssl->handshake->sni_authmode = authmode;
1524}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001525#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1526
Hanno Becker8927c832019-04-03 12:52:50 +01001527#if defined(MBEDTLS_X509_CRT_PARSE_C)
1528void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1529 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1530 void *p_vrfy )
1531{
1532 ssl->f_vrfy = f_vrfy;
1533 ssl->p_vrfy = p_vrfy;
1534}
1535#endif
1536
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001537#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001538/*
1539 * Set EC J-PAKE password for current handshake
1540 */
1541int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1542 const unsigned char *pw,
1543 size_t pw_len )
1544{
1545 mbedtls_ecjpake_role role;
1546
Janos Follath8eb64132016-06-03 15:40:57 +01001547 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001548 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1549
1550 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1551 role = MBEDTLS_ECJPAKE_SERVER;
1552 else
1553 role = MBEDTLS_ECJPAKE_CLIENT;
1554
1555 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1556 role,
1557 MBEDTLS_MD_SHA256,
1558 MBEDTLS_ECP_DP_SECP256R1,
1559 pw, pw_len ) );
1560}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001561#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001562
Gilles Peskineeccd8882020-03-10 12:19:08 +01001563#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001564
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001565MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001566static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1567{
1568#if defined(MBEDTLS_USE_PSA_CRYPTO)
1569 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1570 return( 1 );
1571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001572 if( conf->psk != NULL )
1573 return( 1 );
1574
1575 return( 0 );
1576}
1577
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001578static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1579{
1580 /* Remove reference to existing PSK, if any. */
1581#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001582 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001583 {
1584 /* The maintenance of the PSK key slot is the
1585 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001586 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001587 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001588#endif /* MBEDTLS_USE_PSA_CRYPTO */
1589 if( conf->psk != NULL )
1590 {
1591 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1592
1593 mbedtls_free( conf->psk );
1594 conf->psk = NULL;
1595 conf->psk_len = 0;
1596 }
1597
1598 /* Remove reference to PSK identity, if any. */
1599 if( conf->psk_identity != NULL )
1600 {
1601 mbedtls_free( conf->psk_identity );
1602 conf->psk_identity = NULL;
1603 conf->psk_identity_len = 0;
1604 }
1605}
1606
Hanno Becker7390c712018-11-15 13:33:04 +00001607/* This function assumes that PSK identity in the SSL config is unset.
1608 * It checks that the provided identity is well-formed and attempts
1609 * to make a copy of it in the SSL config.
1610 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001611MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001612static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1613 unsigned char const *psk_identity,
1614 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001615{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001616 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001617 if( psk_identity == NULL ||
1618 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001619 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001620 {
1621 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1622 }
1623
Hanno Becker7390c712018-11-15 13:33:04 +00001624 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1625 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001626 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001627
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001628 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001629 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001630
1631 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001632}
1633
Hanno Becker7390c712018-11-15 13:33:04 +00001634int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1635 const unsigned char *psk, size_t psk_len,
1636 const unsigned char *psk_identity, size_t psk_identity_len )
1637{
Janos Follath865b3eb2019-12-16 11:46:15 +00001638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001639
1640 /* We currently only support one PSK, raw or opaque. */
1641 if( ssl_conf_psk_is_configured( conf ) )
1642 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001643
1644 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001645 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001647 if( psk_len == 0 )
1648 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1649 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1651
Hanno Becker7390c712018-11-15 13:33:04 +00001652 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1653 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1654 conf->psk_len = psk_len;
1655 memcpy( conf->psk, psk, conf->psk_len );
1656
1657 /* Check and set PSK Identity */
1658 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1659 if( ret != 0 )
1660 ssl_conf_remove_psk( conf );
1661
1662 return( ret );
1663}
1664
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001665static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1666{
1667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001668 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001669 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001670 /* The maintenance of the external PSK key slot is the
1671 * user's responsibility. */
1672 if( ssl->handshake->psk_opaque_is_internal )
1673 {
1674 psa_destroy_key( ssl->handshake->psk_opaque );
1675 ssl->handshake->psk_opaque_is_internal = 0;
1676 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001677 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001678 }
Neil Armstronge952a302022-05-03 10:22:14 +02001679#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680 if( ssl->handshake->psk != NULL )
1681 {
1682 mbedtls_platform_zeroize( ssl->handshake->psk,
1683 ssl->handshake->psk_len );
1684 mbedtls_free( ssl->handshake->psk );
1685 ssl->handshake->psk_len = 0;
1686 }
Neil Armstronge952a302022-05-03 10:22:14 +02001687#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001688}
1689
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001690int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1691 const unsigned char *psk, size_t psk_len )
1692{
Neil Armstrong501c9322022-05-03 09:35:09 +02001693#if defined(MBEDTLS_USE_PSA_CRYPTO)
1694 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1695 psa_status_t status;
1696 psa_algorithm_t alg;
1697 mbedtls_svc_key_id_t key;
1698#endif /* MBEDTLS_USE_PSA_CRYPTO */
1699
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001700 if( psk == NULL || ssl->handshake == NULL )
1701 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1702
1703 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1705
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001707
Neil Armstrong501c9322022-05-03 09:35:09 +02001708#if defined(MBEDTLS_USE_PSA_CRYPTO)
1709 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1710 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1711 else
1712 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1713
1714 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1715 psa_set_key_algorithm( &key_attributes, alg );
1716 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1717
1718 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1719 if( status != PSA_SUCCESS )
1720 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1721
1722 /* Allow calling psa_destroy_key() on psk remove */
1723 ssl->handshake->psk_opaque_is_internal = 1;
1724 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1725#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001726 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001727 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001728
1729 ssl->handshake->psk_len = psk_len;
1730 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1731
1732 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001733#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001734}
1735
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001736#if defined(MBEDTLS_USE_PSA_CRYPTO)
1737int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001738 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001739 const unsigned char *psk_identity,
1740 size_t psk_identity_len )
1741{
Janos Follath865b3eb2019-12-16 11:46:15 +00001742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001743
1744 /* We currently only support one PSK, raw or opaque. */
1745 if( ssl_conf_psk_is_configured( conf ) )
1746 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001747
Hanno Becker7390c712018-11-15 13:33:04 +00001748 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001749 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001750 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001751 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001752
1753 /* Check and set PSK Identity */
1754 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1755 psk_identity_len );
1756 if( ret != 0 )
1757 ssl_conf_remove_psk( conf );
1758
1759 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001760}
1761
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001762int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1763 mbedtls_svc_key_id_t psk )
1764{
1765 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1766 ( ssl->handshake == NULL ) )
1767 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1768
1769 ssl_remove_psk( ssl );
1770 ssl->handshake->psk_opaque = psk;
1771 return( 0 );
1772}
1773#endif /* MBEDTLS_USE_PSA_CRYPTO */
1774
1775void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1776 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1777 size_t),
1778 void *p_psk )
1779{
1780 conf->f_psk = f_psk;
1781 conf->p_psk = p_psk;
1782}
1783#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1784
1785#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001786static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1787 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001788{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001789#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001790 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001791 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001792#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001793 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001794 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001795 return( MBEDTLS_SSL_MODE_STREAM );
1796}
1797
1798#else /* MBEDTLS_USE_PSA_CRYPTO */
1799
1800static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1801 mbedtls_cipher_mode_t mode )
1802{
1803#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1804 if( mode == MBEDTLS_MODE_CBC )
1805 return( MBEDTLS_SSL_MODE_CBC );
1806#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1807
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001808#if defined(MBEDTLS_GCM_C) || \
1809 defined(MBEDTLS_CCM_C) || \
1810 defined(MBEDTLS_CHACHAPOLY_C)
1811 if( mode == MBEDTLS_MODE_GCM ||
1812 mode == MBEDTLS_MODE_CCM ||
1813 mode == MBEDTLS_MODE_CHACHAPOLY )
1814 return( MBEDTLS_SSL_MODE_AEAD );
1815#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001816
1817 return( MBEDTLS_SSL_MODE_STREAM );
1818}
Gilles Peskine301711e2022-04-26 16:57:05 +02001819#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001820
Gilles Peskinee108d982022-04-26 16:50:40 +02001821static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1822 mbedtls_ssl_mode_t base_mode,
1823 int encrypt_then_mac )
1824{
1825#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1826 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1827 base_mode == MBEDTLS_SSL_MODE_CBC )
1828 {
1829 return( MBEDTLS_SSL_MODE_CBC_ETM );
1830 }
1831#else
1832 (void) encrypt_then_mac;
1833#endif
1834 return( base_mode );
1835}
1836
Neil Armstrongab555e02022-04-04 11:07:59 +02001837mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001838 const mbedtls_ssl_transform *transform )
1839{
Gilles Peskinee108d982022-04-26 16:50:40 +02001840 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001841#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001842 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001843#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001844 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1845#endif
1846 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001847
Gilles Peskinee108d982022-04-26 16:50:40 +02001848 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001849#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001850 encrypt_then_mac = transform->encrypt_then_mac;
1851#endif
1852 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001853}
1854
Neil Armstrongab555e02022-04-04 11:07:59 +02001855mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001856#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001857 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001858#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001859 const mbedtls_ssl_ciphersuite_t *suite )
1860{
Gilles Peskinee108d982022-04-26 16:50:40 +02001861 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1862
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001863#if defined(MBEDTLS_USE_PSA_CRYPTO)
1864 psa_status_t status;
1865 psa_algorithm_t alg;
1866 psa_key_type_t type;
1867 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001868 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1869 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001870 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001871#else
1872 const mbedtls_cipher_info_t *cipher =
1873 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001874 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001875 {
1876 base_mode =
1877 mbedtls_ssl_get_base_mode(
1878 mbedtls_cipher_info_get_mode( cipher ) );
1879 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001880#endif /* MBEDTLS_USE_PSA_CRYPTO */
1881
Gilles Peskinee108d982022-04-26 16:50:40 +02001882#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1883 int encrypt_then_mac = 0;
1884#endif
1885 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001886}
1887
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001888#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001889
1890#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1891static size_t ssl_session_save_tls13( const mbedtls_ssl_session *session,
1892 unsigned char *buf,
1893 size_t buf_len )
1894{
1895 ((void) session);
1896 ((void) buf);
1897 ((void) buf_len);
1898 return( 0 );
1899}
1900#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1901
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001902psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001903 size_t taglen,
1904 psa_algorithm_t *alg,
1905 psa_key_type_t *key_type,
1906 size_t *key_size )
1907{
1908 switch ( mbedtls_cipher_type )
1909 {
1910 case MBEDTLS_CIPHER_AES_128_CBC:
1911 *alg = PSA_ALG_CBC_NO_PADDING;
1912 *key_type = PSA_KEY_TYPE_AES;
1913 *key_size = 128;
1914 break;
1915 case MBEDTLS_CIPHER_AES_128_CCM:
1916 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1917 *key_type = PSA_KEY_TYPE_AES;
1918 *key_size = 128;
1919 break;
1920 case MBEDTLS_CIPHER_AES_128_GCM:
1921 *alg = PSA_ALG_GCM;
1922 *key_type = PSA_KEY_TYPE_AES;
1923 *key_size = 128;
1924 break;
1925 case MBEDTLS_CIPHER_AES_192_CCM:
1926 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1927 *key_type = PSA_KEY_TYPE_AES;
1928 *key_size = 192;
1929 break;
1930 case MBEDTLS_CIPHER_AES_192_GCM:
1931 *alg = PSA_ALG_GCM;
1932 *key_type = PSA_KEY_TYPE_AES;
1933 *key_size = 192;
1934 break;
1935 case MBEDTLS_CIPHER_AES_256_CBC:
1936 *alg = PSA_ALG_CBC_NO_PADDING;
1937 *key_type = PSA_KEY_TYPE_AES;
1938 *key_size = 256;
1939 break;
1940 case MBEDTLS_CIPHER_AES_256_CCM:
1941 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1942 *key_type = PSA_KEY_TYPE_AES;
1943 *key_size = 256;
1944 break;
1945 case MBEDTLS_CIPHER_AES_256_GCM:
1946 *alg = PSA_ALG_GCM;
1947 *key_type = PSA_KEY_TYPE_AES;
1948 *key_size = 256;
1949 break;
1950 case MBEDTLS_CIPHER_ARIA_128_CBC:
1951 *alg = PSA_ALG_CBC_NO_PADDING;
1952 *key_type = PSA_KEY_TYPE_ARIA;
1953 *key_size = 128;
1954 break;
1955 case MBEDTLS_CIPHER_ARIA_128_CCM:
1956 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1957 *key_type = PSA_KEY_TYPE_ARIA;
1958 *key_size = 128;
1959 break;
1960 case MBEDTLS_CIPHER_ARIA_128_GCM:
1961 *alg = PSA_ALG_GCM;
1962 *key_type = PSA_KEY_TYPE_ARIA;
1963 *key_size = 128;
1964 break;
1965 case MBEDTLS_CIPHER_ARIA_192_CCM:
1966 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1967 *key_type = PSA_KEY_TYPE_ARIA;
1968 *key_size = 192;
1969 break;
1970 case MBEDTLS_CIPHER_ARIA_192_GCM:
1971 *alg = PSA_ALG_GCM;
1972 *key_type = PSA_KEY_TYPE_ARIA;
1973 *key_size = 192;
1974 break;
1975 case MBEDTLS_CIPHER_ARIA_256_CBC:
1976 *alg = PSA_ALG_CBC_NO_PADDING;
1977 *key_type = PSA_KEY_TYPE_ARIA;
1978 *key_size = 256;
1979 break;
1980 case MBEDTLS_CIPHER_ARIA_256_CCM:
1981 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1982 *key_type = PSA_KEY_TYPE_ARIA;
1983 *key_size = 256;
1984 break;
1985 case MBEDTLS_CIPHER_ARIA_256_GCM:
1986 *alg = PSA_ALG_GCM;
1987 *key_type = PSA_KEY_TYPE_ARIA;
1988 *key_size = 256;
1989 break;
1990 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1991 *alg = PSA_ALG_CBC_NO_PADDING;
1992 *key_type = PSA_KEY_TYPE_CAMELLIA;
1993 *key_size = 128;
1994 break;
1995 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1996 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1997 *key_type = PSA_KEY_TYPE_CAMELLIA;
1998 *key_size = 128;
1999 break;
2000 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2001 *alg = PSA_ALG_GCM;
2002 *key_type = PSA_KEY_TYPE_CAMELLIA;
2003 *key_size = 128;
2004 break;
2005 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2006 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2007 *key_type = PSA_KEY_TYPE_CAMELLIA;
2008 *key_size = 192;
2009 break;
2010 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2011 *alg = PSA_ALG_GCM;
2012 *key_type = PSA_KEY_TYPE_CAMELLIA;
2013 *key_size = 192;
2014 break;
2015 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2016 *alg = PSA_ALG_CBC_NO_PADDING;
2017 *key_type = PSA_KEY_TYPE_CAMELLIA;
2018 *key_size = 256;
2019 break;
2020 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2021 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2022 *key_type = PSA_KEY_TYPE_CAMELLIA;
2023 *key_size = 256;
2024 break;
2025 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2026 *alg = PSA_ALG_GCM;
2027 *key_type = PSA_KEY_TYPE_CAMELLIA;
2028 *key_size = 256;
2029 break;
2030 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2031 *alg = PSA_ALG_CHACHA20_POLY1305;
2032 *key_type = PSA_KEY_TYPE_CHACHA20;
2033 *key_size = 256;
2034 break;
2035 case MBEDTLS_CIPHER_NULL:
2036 *alg = MBEDTLS_SSL_NULL_CIPHER;
2037 *key_type = 0;
2038 *key_size = 0;
2039 break;
2040 default:
2041 return PSA_ERROR_NOT_SUPPORTED;
2042 }
2043
2044 return PSA_SUCCESS;
2045}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002046#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002047
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002048#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002049int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2050 const unsigned char *dhm_P, size_t P_len,
2051 const unsigned char *dhm_G, size_t G_len )
2052{
Janos Follath865b3eb2019-12-16 11:46:15 +00002053 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002054
Glenn Strausscee11292021-12-20 01:43:17 -05002055 mbedtls_mpi_free( &conf->dhm_P );
2056 mbedtls_mpi_free( &conf->dhm_G );
2057
Hanno Beckera90658f2017-10-04 15:29:08 +01002058 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2059 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2060 {
2061 mbedtls_mpi_free( &conf->dhm_P );
2062 mbedtls_mpi_free( &conf->dhm_G );
2063 return( ret );
2064 }
2065
2066 return( 0 );
2067}
Paul Bakker5121ce52009-01-03 21:22:43 +00002068
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002069int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002070{
Janos Follath865b3eb2019-12-16 11:46:15 +00002071 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002072
Glenn Strausscee11292021-12-20 01:43:17 -05002073 mbedtls_mpi_free( &conf->dhm_P );
2074 mbedtls_mpi_free( &conf->dhm_G );
2075
Gilles Peskinee5702482021-06-11 21:59:08 +02002076 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2077 &conf->dhm_P ) ) != 0 ||
2078 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2079 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002080 {
2081 mbedtls_mpi_free( &conf->dhm_P );
2082 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002083 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002084 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002085
2086 return( 0 );
2087}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002088#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002089
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002090#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2091/*
2092 * Set the minimum length for Diffie-Hellman parameters
2093 */
2094void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2095 unsigned int bitlen )
2096{
2097 conf->dhm_min_bitlen = bitlen;
2098}
2099#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2100
Gilles Peskineeccd8882020-03-10 12:19:08 +01002101#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002102#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002103/*
2104 * Set allowed/preferred hashes for handshake signatures
2105 */
2106void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2107 const int *hashes )
2108{
2109 conf->sig_hashes = hashes;
2110}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002111#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002112
Jerry Yuf017ee42022-01-12 15:49:48 +08002113/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002114void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2115 const uint16_t* sig_algs )
2116{
Jerry Yuf017ee42022-01-12 15:49:48 +08002117#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2118 conf->sig_hashes = NULL;
2119#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2120 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002121}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002122#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002123
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002124#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002125#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002126/*
2127 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002128 *
2129 * mbedtls_ssl_setup() takes the provided list
2130 * and translates it to a list of IANA TLS group identifiers,
2131 * stored in ssl->handshake->group_list.
2132 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002133 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002134void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002135 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002136{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002137 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002138 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002139}
Brett Warrene0edc842021-08-17 09:53:13 +01002140#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002141#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002142
Brett Warrene0edc842021-08-17 09:53:13 +01002143/*
2144 * Set the allowed groups
2145 */
2146void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2147 const uint16_t *group_list )
2148{
2149#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2150 conf->curve_list = NULL;
2151#endif
2152 conf->group_list = group_list;
2153}
2154
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002155#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002157{
Hanno Becker947194e2017-04-07 13:25:49 +01002158 /* Initialize to suppress unnecessary compiler warning */
2159 size_t hostname_len = 0;
2160
2161 /* Check if new hostname is valid before
2162 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002163 if( hostname != NULL )
2164 {
2165 hostname_len = strlen( hostname );
2166
2167 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2169 }
2170
2171 /* Now it's clear that we will overwrite the old hostname,
2172 * so we can free it safely */
2173
2174 if( ssl->hostname != NULL )
2175 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002176 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002177 mbedtls_free( ssl->hostname );
2178 }
2179
2180 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002181
Paul Bakker5121ce52009-01-03 21:22:43 +00002182 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002183 {
2184 ssl->hostname = NULL;
2185 }
2186 else
2187 {
2188 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002189 if( ssl->hostname == NULL )
2190 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002191
Hanno Becker947194e2017-04-07 13:25:49 +01002192 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002193
Hanno Becker947194e2017-04-07 13:25:49 +01002194 ssl->hostname[hostname_len] = '\0';
2195 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002196
2197 return( 0 );
2198}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002199#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002200
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002201#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002202void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002204 const unsigned char *, size_t),
2205 void *p_sni )
2206{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002207 conf->f_sni = f_sni;
2208 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002209}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002213int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002214{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002215 size_t cur_len, tot_len;
2216 const char **p;
2217
2218 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002219 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2220 * MUST NOT be truncated."
2221 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002222 */
2223 tot_len = 0;
2224 for( p = protos; *p != NULL; p++ )
2225 {
2226 cur_len = strlen( *p );
2227 tot_len += cur_len;
2228
Ronald Cron8216dd32020-04-23 16:41:44 +02002229 if( ( cur_len == 0 ) ||
2230 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2231 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002233 }
2234
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002235 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002236
2237 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002238}
2239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002240const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002241{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002242 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002243}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002245
Johan Pascalb62bb512015-12-03 21:56:45 +01002246#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002247void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2248 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002249{
2250 conf->dtls_srtp_mki_support = support_mki_value;
2251}
2252
Ron Eldoref72faf2018-07-12 11:54:20 +03002253int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2254 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002255 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002256{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002257 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002258 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002259 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002260 }
Ron Eldor591f1622018-01-22 12:30:04 +02002261
2262 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002263 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002264 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002265 }
Ron Eldor591f1622018-01-22 12:30:04 +02002266
2267 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2268 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002269 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002270}
2271
Ron Eldoref72faf2018-07-12 11:54:20 +03002272int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002273 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002274{
Johan Pascal253d0262020-09-22 13:04:45 +02002275 const mbedtls_ssl_srtp_profile *p;
2276 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002277
Johan Pascal253d0262020-09-22 13:04:45 +02002278 /* check the profiles list: all entry must be valid,
2279 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002280 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2281 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2282 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002283 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002284 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002285 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002286 list_size++;
2287 }
2288 else
2289 {
2290 /* unsupported value, stop parsing and set the size to an error value */
2291 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002292 }
2293 }
2294
Johan Pascal5ef72d22020-10-28 17:05:47 +01002295 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002296 {
Johan Pascal253d0262020-09-22 13:04:45 +02002297 conf->dtls_srtp_profile_list = NULL;
2298 conf->dtls_srtp_profile_list_len = 0;
2299 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2300 }
2301
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002302 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002303 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002304
2305 return( 0 );
2306}
2307
Johan Pascal5ef72d22020-10-28 17:05:47 +01002308void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2309 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002310{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002311 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2312 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002313 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002314 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002315 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002316 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002317 else
2318 {
2319 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002320 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2321 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002322 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002323}
Johan Pascalb62bb512015-12-03 21:56:45 +01002324#endif /* MBEDTLS_SSL_DTLS_SRTP */
2325
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002326void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002327{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002328 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002329}
2330
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002331void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002332{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002333 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002334}
2335
Janos Follath088ce432017-04-10 12:42:31 +01002336#if defined(MBEDTLS_SSL_SRV_C)
2337void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2338 char cert_req_ca_list )
2339{
2340 conf->cert_req_ca_list = cert_req_ca_list;
2341}
2342#endif
2343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002345void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002346{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002347 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002348}
2349#endif
2350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002352void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002353{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002354 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002355}
2356#endif
2357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002359int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002360{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002362 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002363 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002365 }
2366
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002367 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002368
2369 return( 0 );
2370}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002372
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002373void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002374{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002375 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002376}
2377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002379void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002380{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002381 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002382}
2383
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002384void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002385{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002386 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002387}
2388
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002389void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002390 const unsigned char period[8] )
2391{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002392 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002393}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002394#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002397#if defined(MBEDTLS_SSL_CLI_C)
2398void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002399{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002400 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002401}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002402#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002403
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002404#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002405void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2406 mbedtls_ssl_ticket_write_t *f_ticket_write,
2407 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2408 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002409{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002410 conf->f_ticket_write = f_ticket_write;
2411 conf->f_ticket_parse = f_ticket_parse;
2412 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002413}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002414#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002416
Hanno Becker7e6c1782021-06-08 09:24:55 +01002417void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2418 mbedtls_ssl_export_keys_t *f_export_keys,
2419 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002420{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002421 ssl->f_export_keys = f_export_keys;
2422 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002423}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002424
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002425#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002426void mbedtls_ssl_conf_async_private_cb(
2427 mbedtls_ssl_config *conf,
2428 mbedtls_ssl_async_sign_t *f_async_sign,
2429 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2430 mbedtls_ssl_async_resume_t *f_async_resume,
2431 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002432 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002433{
2434 conf->f_async_sign_start = f_async_sign;
2435 conf->f_async_decrypt_start = f_async_decrypt;
2436 conf->f_async_resume = f_async_resume;
2437 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002438 conf->p_async_config_data = async_config_data;
2439}
2440
Gilles Peskine8f97af72018-04-26 11:46:10 +02002441void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2442{
2443 return( conf->p_async_config_data );
2444}
2445
Gilles Peskine1febfef2018-04-30 11:54:39 +02002446void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002447{
2448 if( ssl->handshake == NULL )
2449 return( NULL );
2450 else
2451 return( ssl->handshake->user_async_ctx );
2452}
2453
Gilles Peskine1febfef2018-04-30 11:54:39 +02002454void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002455 void *ctx )
2456{
2457 if( ssl->handshake != NULL )
2458 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002459}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002460#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002461
Paul Bakker5121ce52009-01-03 21:22:43 +00002462/*
2463 * SSL get accessors
2464 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002465uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002466{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002467 if( ssl->session != NULL )
2468 return( ssl->session->verify_result );
2469
2470 if( ssl->session_negotiate != NULL )
2471 return( ssl->session_negotiate->verify_result );
2472
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002473 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002474}
2475
Glenn Strauss8f526902022-01-13 00:04:49 -05002476int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2477{
2478 if( ssl == NULL || ssl->session == NULL )
2479 return( 0 );
2480
2481 return( ssl->session->ciphersuite );
2482}
2483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002485{
Paul Bakker926c8e42013-03-06 10:23:34 +01002486 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002487 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002490}
2491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002493{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002495 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002496 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002497 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002498 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002499 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002500 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002501 default:
2502 return( "unknown (DTLS)" );
2503 }
2504 }
2505#endif
2506
Glenn Strauss60bfe602022-03-14 19:04:24 -04002507 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002508 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002509 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002510 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002511 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002512 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002513 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002514 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002515 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002516}
2517
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002518#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002519size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2520{
David Horstmann95d516f2021-05-04 18:36:56 +01002521 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002522 size_t read_mfl;
2523
2524 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2525 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2526 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2527 {
2528 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2529 }
2530
2531 /* Check if a smaller max length was negotiated */
2532 if( ssl->session_out != NULL )
2533 {
2534 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2535 if( read_mfl < max_len )
2536 {
2537 max_len = read_mfl;
2538 }
2539 }
2540
2541 // During a handshake, use the value being negotiated
2542 if( ssl->session_negotiate != NULL )
2543 {
2544 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2545 if( read_mfl < max_len )
2546 {
2547 max_len = read_mfl;
2548 }
2549 }
2550
2551 return( max_len );
2552}
2553
2554size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002555{
2556 size_t max_len;
2557
2558 /*
2559 * Assume mfl_code is correct since it was checked when set
2560 */
Angus Grattond8213d02016-05-25 20:56:48 +10002561 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002562
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002563 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002564 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002565 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002566 {
Angus Grattond8213d02016-05-25 20:56:48 +10002567 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002568 }
2569
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002570 /* During a handshake, use the value being negotiated */
2571 if( ssl->session_negotiate != NULL &&
2572 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2573 {
2574 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2575 }
2576
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002577 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002578}
2579#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2580
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002581#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002582size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002583{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002584 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2585 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2586 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2587 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2588 return ( 0 );
2589
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002590 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2591 return( ssl->mtu );
2592
2593 if( ssl->mtu == 0 )
2594 return( ssl->handshake->mtu );
2595
2596 return( ssl->mtu < ssl->handshake->mtu ?
2597 ssl->mtu : ssl->handshake->mtu );
2598}
2599#endif /* MBEDTLS_SSL_PROTO_DTLS */
2600
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002601int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2602{
2603 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2604
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002605#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2606 !defined(MBEDTLS_SSL_PROTO_DTLS)
2607 (void) ssl;
2608#endif
2609
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002610#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002611 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002612
2613 if( max_len > mfl )
2614 max_len = mfl;
2615#endif
2616
2617#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002618 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002619 {
Hanno Becker89490712020-02-05 10:50:12 +00002620 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002621 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2622 const size_t overhead = (size_t) ret;
2623
2624 if( ret < 0 )
2625 return( ret );
2626
2627 if( mtu <= overhead )
2628 {
2629 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2630 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2631 }
2632
2633 if( max_len > mtu - overhead )
2634 max_len = mtu - overhead;
2635 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002636#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002637
Hanno Becker0defedb2018-08-10 12:35:02 +01002638#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2639 !defined(MBEDTLS_SSL_PROTO_DTLS)
2640 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002641#endif
2642
2643 return( (int) max_len );
2644}
2645
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002646int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2647{
2648 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2649
2650#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2651 (void) ssl;
2652#endif
2653
2654#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2655 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2656
2657 if( max_len > mfl )
2658 max_len = mfl;
2659#endif
2660
2661 return( (int) max_len );
2662}
2663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664#if defined(MBEDTLS_X509_CRT_PARSE_C)
2665const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002666{
2667 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002668 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002669
Hanno Beckere6824572019-02-07 13:18:46 +00002670#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002671 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002672#else
2673 return( NULL );
2674#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002675}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002679int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2680 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002681{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002682 int ret;
2683
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002684 if( ssl == NULL ||
2685 dst == NULL ||
2686 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002687 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002690 }
2691
Hanno Beckere810bbc2021-05-14 16:01:05 +01002692 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2693 * idempotent: Each session can only be exported once.
2694 *
2695 * (This is in preparation for TLS 1.3 support where we will
2696 * need the ability to export multiple sessions (aka tickets),
2697 * which will be achieved by calling mbedtls_ssl_get_session()
2698 * multiple times until it fails.)
2699 *
2700 * Check whether we have already exported the current session,
2701 * and fail if so.
2702 */
2703 if( ssl->session->exported == 1 )
2704 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2705
2706 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2707 if( ret != 0 )
2708 return( ret );
2709
2710 /* Remember that we've exported the session. */
2711 ssl->session->exported = 1;
2712 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002713}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002715
Paul Bakker5121ce52009-01-03 21:22:43 +00002716/*
Hanno Beckera835da52019-05-16 12:39:07 +01002717 * Define ticket header determining Mbed TLS version
2718 * and structure of the ticket.
2719 */
2720
Hanno Becker94ef3b32019-05-16 12:50:45 +01002721/*
Hanno Becker50b59662019-05-28 14:30:45 +01002722 * Define bitflag determining compile-time settings influencing
2723 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002724 */
2725
Hanno Becker50b59662019-05-28 14:30:45 +01002726#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002727#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002728#else
Hanno Becker3e088662019-05-29 11:10:18 +01002729#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002730#endif /* MBEDTLS_HAVE_TIME */
2731
2732#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002733#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002734#else
Hanno Becker3e088662019-05-29 11:10:18 +01002735#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002736#endif /* MBEDTLS_X509_CRT_PARSE_C */
2737
2738#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002739#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002740#else
Hanno Becker3e088662019-05-29 11:10:18 +01002741#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002742#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2743
2744#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002745#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002746#else
Hanno Becker3e088662019-05-29 11:10:18 +01002747#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002748#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2749
Hanno Becker94ef3b32019-05-16 12:50:45 +01002750#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002751#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002752#else
Hanno Becker3e088662019-05-29 11:10:18 +01002753#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002754#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2755
Hanno Becker94ef3b32019-05-16 12:50:45 +01002756#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2757#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2758#else
2759#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2760#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2761
Hanno Becker3e088662019-05-29 11:10:18 +01002762#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2763#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2764#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2765#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002766#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2767#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002768
Hanno Becker50b59662019-05-28 14:30:45 +01002769#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002770 ( (uint16_t) ( \
2771 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2772 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2773 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2774 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002775 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002776 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002777
Hanno Beckerf8787072019-05-16 12:41:07 +01002778static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002779 MBEDTLS_VERSION_MAJOR,
2780 MBEDTLS_VERSION_MINOR,
2781 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002782 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2783 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002784};
Hanno Beckera835da52019-05-16 12:39:07 +01002785
2786/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002787 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002788 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002789 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002790 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002791 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002792 * opaque mbedtls_version[3]; // library version: major, minor, patch
2793 * opaque session_format[2]; // library-version specific 16-bit field
2794 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002795 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002796 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002797 * Note: When updating the format, remember to keep
2798 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002799 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002800 * // In this version, `session_format` determines
2801 * // the setting of those compile-time
2802 * // configuration options which influence
2803 * // the structure of mbedtls_ssl_session.
2804 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002805 * uint8_t minor_ver; // Protocol minor version. Possible values:
2806 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002807 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002808 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002809 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002810 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002811 * serialized_session_tls12 data;
2812 *
2813 * };
2814 *
2815 * } serialized_session;
2816 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002817 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002818
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002819MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002820static int ssl_session_save( const mbedtls_ssl_session *session,
2821 unsigned char omit_header,
2822 unsigned char *buf,
2823 size_t buf_len,
2824 size_t *olen )
2825{
2826 unsigned char *p = buf;
2827 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08002828 size_t remaining_len;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002829
2830 if( !omit_header )
2831 {
2832 /*
2833 * Add Mbed TLS version identifier
2834 */
2835
2836 used += sizeof( ssl_serialized_session_header );
2837
2838 if( used <= buf_len )
2839 {
2840 memcpy( p, ssl_serialized_session_header,
2841 sizeof( ssl_serialized_session_header ) );
2842 p += sizeof( ssl_serialized_session_header );
2843 }
2844 }
2845
2846 /*
2847 * TLS version identifier
2848 */
2849 used += 1;
2850 if( used <= buf_len )
2851 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002852 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002853 }
2854
2855 /* Forward to version-specific serialization routine. */
Jerry Yu251a12e2022-07-13 15:15:48 +08002856 remaining_len = used <= buf_len ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04002857 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002858 {
2859#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002860 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002861 {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002862 used += ssl_session_save_tls12( session, p, remaining_len );
2863 break;
2864 }
2865#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2866
Jerry Yu251a12e2022-07-13 15:15:48 +08002867#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
2868 case MBEDTLS_SSL_VERSION_TLS1_3:
2869 {
2870 used += ssl_session_save_tls13( session, p, remaining_len );
2871 break;
2872 }
2873#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2874
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002875 default:
2876 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2877 }
2878
2879 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002880 if( used > buf_len )
2881 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002882
2883 return( 0 );
2884}
2885
2886/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002887 * Public wrapper for ssl_session_save()
2888 */
2889int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2890 unsigned char *buf,
2891 size_t buf_len,
2892 size_t *olen )
2893{
2894 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2895}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002896
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002897/*
2898 * Deserialize session, see mbedtls_ssl_session_save() for format.
2899 *
2900 * This internal version is wrapped by a public function that cleans up in
2901 * case of error, and has an extra option omit_header.
2902 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002903MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002904static int ssl_session_load( mbedtls_ssl_session *session,
2905 unsigned char omit_header,
2906 const unsigned char *buf,
2907 size_t len )
2908{
2909 const unsigned char *p = buf;
2910 const unsigned char * const end = buf + len;
2911
2912 if( !omit_header )
2913 {
2914 /*
2915 * Check Mbed TLS version identifier
2916 */
2917
2918 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2919 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2920
2921 if( memcmp( p, ssl_serialized_session_header,
2922 sizeof( ssl_serialized_session_header ) ) != 0 )
2923 {
2924 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2925 }
2926 p += sizeof( ssl_serialized_session_header );
2927 }
2928
2929 /*
2930 * TLS version identifier
2931 */
2932 if( 1 > (size_t)( end - p ) )
2933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002934 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002935
2936 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002937 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002938 {
2939#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002940 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002941 {
2942 size_t remaining_len = ( end - p );
2943 return( ssl_session_load_tls12( session, p, remaining_len ) );
2944 }
2945#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2946
2947 default:
2948 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2949 }
2950}
2951
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002952/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002953 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002954 */
2955int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2956 const unsigned char *buf,
2957 size_t len )
2958{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002959 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002960
2961 if( ret != 0 )
2962 mbedtls_ssl_session_free( session );
2963
2964 return( ret );
2965}
2966
2967/*
Paul Bakker1961b702013-01-25 14:49:24 +01002968 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002969 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002970MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01002971static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2972{
2973 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2974
Ronald Cron66dbf912022-02-02 15:33:46 +01002975 /*
2976 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002977 * that were written into the output buffer by the previous handshake step,
2978 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002979 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2980 * We proceed to the next handshake step only when all data from the
2981 * previous one have been sent to the peer, thus we make sure that this is
2982 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2983 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2984 * we have to wait before to go ahead.
2985 * In the case of TLS 1.3, handshake step handlers do not send data to the
2986 * peer. Data are only sent here and through
2987 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002988 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002989 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002990 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2991 return( ret );
2992
2993#if defined(MBEDTLS_SSL_PROTO_DTLS)
2994 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2995 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2996 {
2997 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2998 return( ret );
2999 }
3000#endif /* MBEDTLS_SSL_PROTO_DTLS */
3001
3002 return( ret );
3003}
3004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003006{
Hanno Becker41934dd2021-08-07 19:13:43 +01003007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Hanno Becker41934dd2021-08-07 19:13:43 +01003009 if( ssl == NULL ||
3010 ssl->conf == NULL ||
3011 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003012 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003013 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003014 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003015 }
3016
3017 ret = ssl_prepare_handshake_step( ssl );
3018 if( ret != 0 )
3019 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003020
Jerry Yue7047812021-09-13 19:26:39 +08003021 ret = mbedtls_ssl_handle_pending_alert( ssl );
3022 if( ret != 0 )
3023 goto cleanup;
3024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003026 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003027 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003028 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3029 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003030
Ronald Cron9f0fba32022-02-10 16:45:15 +01003031 switch( ssl->state )
3032 {
3033 case MBEDTLS_SSL_HELLO_REQUEST:
3034 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3035 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003036
Ronald Cron9f0fba32022-02-10 16:45:15 +01003037 case MBEDTLS_SSL_CLIENT_HELLO:
3038 ret = mbedtls_ssl_write_client_hello( ssl );
3039 break;
3040
3041 default:
3042#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003043 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003044 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3045 else
3046 ret = mbedtls_ssl_handshake_client_step( ssl );
3047#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3048 ret = mbedtls_ssl_handshake_client_step( ssl );
3049#else
3050 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3051#endif
3052 }
Jerry Yub9930e72021-08-06 17:11:51 +08003053 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003054#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003056 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003057 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003058#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003059 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003060 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003061#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003062
3063#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3064 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3065 ret = mbedtls_ssl_handshake_server_step( ssl );
3066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3067 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003068#endif
3069
Jerry Yue7047812021-09-13 19:26:39 +08003070 if( ret != 0 )
3071 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003072 /* handshake_step return error. And it is same
3073 * with alert_reason.
3074 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003075 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003076 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003077 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003078 goto cleanup;
3079 }
3080 }
3081
3082cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003083 return( ret );
3084}
3085
3086/*
3087 * Perform the SSL handshake
3088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003090{
3091 int ret = 0;
3092
Hanno Beckera817ea42020-10-20 15:20:23 +01003093 /* Sanity checks */
3094
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003095 if( ssl == NULL || ssl->conf == NULL )
3096 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3097
Hanno Beckera817ea42020-10-20 15:20:23 +01003098#if defined(MBEDTLS_SSL_PROTO_DTLS)
3099 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3100 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3101 {
3102 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3103 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3104 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3105 }
3106#endif /* MBEDTLS_SSL_PROTO_DTLS */
3107
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003109
Hanno Beckera817ea42020-10-20 15:20:23 +01003110 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003111 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003112 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003114
3115 if( ret != 0 )
3116 break;
3117 }
3118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003120
3121 return( ret );
3122}
3123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124#if defined(MBEDTLS_SSL_RENEGOTIATION)
3125#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003126/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003127 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003128 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003129MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003131{
Janos Follath865b3eb2019-12-16 11:46:15 +00003132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003135
3136 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3138 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003139
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003140 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003141 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003142 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003143 return( ret );
3144 }
3145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003147
3148 return( 0 );
3149}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003151
3152/*
3153 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 * - any side: calling mbedtls_ssl_renegotiate(),
3155 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3156 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003157 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003158 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003160 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003161int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003162{
Janos Follath865b3eb2019-12-16 11:46:15 +00003163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003166
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003167 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3168 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003169
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003170 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3171 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003173 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003175 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003176 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003177 ssl->handshake->out_msg_seq = 1;
3178 else
3179 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003180 }
3181#endif
3182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3184 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003187 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003189 return( ret );
3190 }
3191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003193
3194 return( 0 );
3195}
3196
3197/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003198 * Renegotiate current connection on client,
3199 * or request renegotiation on server
3200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003202{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003204
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003205 if( ssl == NULL || ssl->conf == NULL )
3206 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003209 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003210 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003211 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003212 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003216
3217 /* Did we already try/start sending HelloRequest? */
3218 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003220
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003221 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003222 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003226 /*
3227 * On client, either start the renegotiation process or,
3228 * if already in progress, continue the handshake
3229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003231 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003232 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003234
Hanno Becker40cdaa12020-02-05 10:48:27 +00003235 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003236 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003237 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003238 return( ret );
3239 }
3240 }
3241 else
3242 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003244 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003246 return( ret );
3247 }
3248 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003250
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003251 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003252}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003254
Gilles Peskine9b562d52018-04-25 20:32:43 +02003255void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003256{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003257 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3258
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003259 if( handshake == NULL )
3260 return;
3261
Brett Warrene0edc842021-08-17 09:53:13 +01003262#if defined(MBEDTLS_ECP_C)
3263#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3264 if ( ssl->handshake->group_list_heap_allocated )
3265 mbedtls_free( (void*) handshake->group_list );
3266 handshake->group_list = NULL;
3267#endif /* MBEDTLS_DEPRECATED_REMOVED */
3268#endif /* MBEDTLS_ECP_C */
3269
Jerry Yuf017ee42022-01-12 15:49:48 +08003270#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3271#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3272 if ( ssl->handshake->sig_algs_heap_allocated )
3273 mbedtls_free( (void*) handshake->sig_algs );
3274 handshake->sig_algs = NULL;
3275#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003276#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3277 if( ssl->handshake->certificate_request_context )
3278 {
3279 mbedtls_free( (void*) handshake->certificate_request_context );
3280 }
3281#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003282#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3283
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003284#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3285 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3286 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003287 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003288 handshake->async_in_progress = 0;
3289 }
3290#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3291
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003292#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003293#if defined(MBEDTLS_USE_PSA_CRYPTO)
3294 psa_hash_abort( &handshake->fin_sha256_psa );
3295#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003296 mbedtls_sha256_free( &handshake->fin_sha256 );
3297#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003298#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003299#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003300#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003301 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003302#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003303 mbedtls_sha512_free( &handshake->fin_sha512 );
3304#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003305#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307#if defined(MBEDTLS_DHM_C)
3308 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003309#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003310#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003312#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003313#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003314 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003315#if defined(MBEDTLS_SSL_CLI_C)
3316 mbedtls_free( handshake->ecjpake_cache );
3317 handshake->ecjpake_cache = NULL;
3318 handshake->ecjpake_cache_len = 0;
3319#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003320#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003321
Janos Follath4ae5c292016-02-10 11:27:43 +00003322#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3323 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003324 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003326#endif
3327
Gilles Peskineeccd8882020-03-10 12:19:08 +01003328#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003329#if defined(MBEDTLS_USE_PSA_CRYPTO)
3330 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3331 {
3332 /* The maintenance of the external PSK key slot is the
3333 * user's responsibility. */
3334 if( ssl->handshake->psk_opaque_is_internal )
3335 {
3336 psa_destroy_key( ssl->handshake->psk_opaque );
3337 ssl->handshake->psk_opaque_is_internal = 0;
3338 }
3339 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3340 }
Neil Armstronge952a302022-05-03 10:22:14 +02003341#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003342 if( handshake->psk != NULL )
3343 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003344 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003345 mbedtls_free( handshake->psk );
3346 }
Neil Armstronge952a302022-05-03 10:22:14 +02003347#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003348#endif
3349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3351 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003352 /*
3353 * Free only the linked list wrapper, not the keys themselves
3354 * since the belong to the SNI callback
3355 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003356 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003358
Gilles Peskineeccd8882020-03-10 12:19:08 +01003359#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003360 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003361 if( handshake->ecrs_peer_cert != NULL )
3362 {
3363 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3364 mbedtls_free( handshake->ecrs_peer_cert );
3365 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003366#endif
3367
Hanno Becker75173122019-02-06 16:18:31 +00003368#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3369 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3370 mbedtls_pk_free( &handshake->peer_pubkey );
3371#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3372
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003373#if defined(MBEDTLS_SSL_CLI_C) && \
3374 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3375 mbedtls_free( handshake->cookie );
3376#endif /* MBEDTLS_SSL_CLI_C &&
3377 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003378
3379#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003380 mbedtls_ssl_flight_free( handshake->flight );
3381 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003382#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003383
Ronald Cronf12b81d2022-03-15 10:42:41 +01003384#if defined(MBEDTLS_ECDH_C) && \
3385 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003386 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003387 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003388#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3389
Ronald Cron6f135e12021-12-08 16:57:54 +01003390#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003391 mbedtls_ssl_transform_free( handshake->transform_handshake );
3392 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003393 mbedtls_free( handshake->transform_earlydata );
3394 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003395#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003396
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003397
3398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3399 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3400 * processes datagrams and the fact that a datagram is allowed to have
3401 * several records in it, it is possible that the I/O buffers are not
3402 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003403 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3404 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003405#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003406
Jerry Yuba9c7272021-10-30 11:54:10 +08003407 /* mbedtls_platform_zeroize MUST be last one in this function */
3408 mbedtls_platform_zeroize( handshake,
3409 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003410}
3411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003413{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003414 if( session == NULL )
3415 return;
3416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003418 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003419#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003420
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003421#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003423#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003424
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003425 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003426}
3427
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003428#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003429
3430#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3431#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3432#else
3433#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3434#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3435
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003436#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003437
3438#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3439#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3440#else
3441#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3442#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3443
3444#if defined(MBEDTLS_SSL_ALPN)
3445#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3446#else
3447#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3448#endif /* MBEDTLS_SSL_ALPN */
3449
3450#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3451#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3452#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3453#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3454
3455#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3456 ( (uint32_t) ( \
3457 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3458 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3459 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3460 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3461 0u ) )
3462
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003463static unsigned char ssl_serialized_context_header[] = {
3464 MBEDTLS_VERSION_MAJOR,
3465 MBEDTLS_VERSION_MINOR,
3466 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003467 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3468 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3469 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3470 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3471 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003472};
3473
Paul Bakker5121ce52009-01-03 21:22:43 +00003474/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003475 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003476 *
3477 * The format of the serialized data is:
3478 * (in the presentation language of TLS, RFC 8446 section 3)
3479 *
3480 * // header
3481 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003482 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003483 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003484 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003485 * Note: When updating the format, remember to keep these
3486 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003487 *
3488 * // session sub-structure
3489 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3490 * // transform sub-structure
3491 * uint8 random[64]; // ServerHello.random+ClientHello.random
3492 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3493 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3494 * // fields from ssl_context
3495 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3496 * uint64 in_window_top; // DTLS: last validated record seq_num
3497 * uint64 in_window; // DTLS: bitmask for replay protection
3498 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3499 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3500 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3501 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3502 *
3503 * Note that many fields of the ssl_context or sub-structures are not
3504 * serialized, as they fall in one of the following categories:
3505 *
3506 * 1. forced value (eg in_left must be 0)
3507 * 2. pointer to dynamically-allocated memory (eg session, transform)
3508 * 3. value can be re-derived from other data (eg session keys from MS)
3509 * 4. value was temporary (eg content of input buffer)
3510 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003511 */
3512int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3513 unsigned char *buf,
3514 size_t buf_len,
3515 size_t *olen )
3516{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003517 unsigned char *p = buf;
3518 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003519 size_t session_len;
3520 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003521
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003522 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003523 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3524 * this function's documentation.
3525 *
3526 * These are due to assumptions/limitations in the implementation. Some of
3527 * them are likely to stay (no handshake in progress) some might go away
3528 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003529 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003530 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003531 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003532 {
3533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003534 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003535 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003536 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003537 {
3538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003539 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003540 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003541 /* Double-check that sub-structures are indeed ready */
3542 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003543 {
3544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003545 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003546 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003547 /* There must be no pending incoming or outgoing data */
3548 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003549 {
3550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003551 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003552 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003553 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003554 {
3555 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003556 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003557 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003558 /* Protocol must be DLTS, not TLS */
3559 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003560 {
3561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003562 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003563 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003564 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003565 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003566 {
3567 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003568 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003569 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003570 /* We must be using an AEAD ciphersuite */
3571 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003572 {
3573 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003574 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003575 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003576 /* Renegotiation must not be enabled */
3577#if defined(MBEDTLS_SSL_RENEGOTIATION)
3578 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003579 {
3580 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003582 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003583#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003584
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003585 /*
3586 * Version and format identifier
3587 */
3588 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003589
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003590 if( used <= buf_len )
3591 {
3592 memcpy( p, ssl_serialized_context_header,
3593 sizeof( ssl_serialized_context_header ) );
3594 p += sizeof( ssl_serialized_context_header );
3595 }
3596
3597 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003598 * Session (length + data)
3599 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003600 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003601 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3602 return( ret );
3603
3604 used += 4 + session_len;
3605 if( used <= buf_len )
3606 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003607 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3608 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003609
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003610 ret = ssl_session_save( ssl->session, 1,
3611 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003612 if( ret != 0 )
3613 return( ret );
3614
3615 p += session_len;
3616 }
3617
3618 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003619 * Transform
3620 */
3621 used += sizeof( ssl->transform->randbytes );
3622 if( used <= buf_len )
3623 {
3624 memcpy( p, ssl->transform->randbytes,
3625 sizeof( ssl->transform->randbytes ) );
3626 p += sizeof( ssl->transform->randbytes );
3627 }
3628
3629#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3630 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3631 if( used <= buf_len )
3632 {
3633 *p++ = ssl->transform->in_cid_len;
3634 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3635 p += ssl->transform->in_cid_len;
3636
3637 *p++ = ssl->transform->out_cid_len;
3638 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3639 p += ssl->transform->out_cid_len;
3640 }
3641#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3642
3643 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003644 * Saved fields from top-level ssl_context structure
3645 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003646 used += 4;
3647 if( used <= buf_len )
3648 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003649 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3650 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003651 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003652
3653#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3654 used += 16;
3655 if( used <= buf_len )
3656 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003657 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3658 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003659
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003660 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3661 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003662 }
3663#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3664
3665#if defined(MBEDTLS_SSL_PROTO_DTLS)
3666 used += 1;
3667 if( used <= buf_len )
3668 {
3669 *p++ = ssl->disable_datagram_packing;
3670 }
3671#endif /* MBEDTLS_SSL_PROTO_DTLS */
3672
Jerry Yuae0b2e22021-10-08 15:21:19 +08003673 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003674 if( used <= buf_len )
3675 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003676 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3677 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003678 }
3679
3680#if defined(MBEDTLS_SSL_PROTO_DTLS)
3681 used += 2;
3682 if( used <= buf_len )
3683 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003684 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3685 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003686 }
3687#endif /* MBEDTLS_SSL_PROTO_DTLS */
3688
3689#if defined(MBEDTLS_SSL_ALPN)
3690 {
3691 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003692 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003693 : 0;
3694
3695 used += 1 + alpn_len;
3696 if( used <= buf_len )
3697 {
3698 *p++ = alpn_len;
3699
3700 if( ssl->alpn_chosen != NULL )
3701 {
3702 memcpy( p, ssl->alpn_chosen, alpn_len );
3703 p += alpn_len;
3704 }
3705 }
3706 }
3707#endif /* MBEDTLS_SSL_ALPN */
3708
3709 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003710 * Done
3711 */
3712 *olen = used;
3713
3714 if( used > buf_len )
3715 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003716
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003717 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3718
Hanno Becker43aefe22020-02-05 10:44:56 +00003719 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003720}
3721
3722/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003723 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003724 *
3725 * This internal version is wrapped by a public function that cleans up in
3726 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003727 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003728MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729static int ssl_context_load( mbedtls_ssl_context *ssl,
3730 const unsigned char *buf,
3731 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003732{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003733 const unsigned char *p = buf;
3734 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003735 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003736 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003737
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003738 /*
3739 * The context should have been freshly setup or reset.
3740 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003741 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003742 * renegotiating, or if the user mistakenly loaded a session first.)
3743 */
3744 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3745 ssl->session != NULL )
3746 {
3747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3748 }
3749
3750 /*
3751 * We can't check that the config matches the initial one, but we can at
3752 * least check it matches the requirements for serializing.
3753 */
3754 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003755 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3756 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003757#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003758 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003759#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003760 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003761 {
3762 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3763 }
3764
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003765 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3766
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003767 /*
3768 * Check version identifier
3769 */
3770 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3771 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3772
3773 if( memcmp( p, ssl_serialized_context_header,
3774 sizeof( ssl_serialized_context_header ) ) != 0 )
3775 {
3776 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3777 }
3778 p += sizeof( ssl_serialized_context_header );
3779
3780 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003781 * Session
3782 */
3783 if( (size_t)( end - p ) < 4 )
3784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3785
3786 session_len = ( (size_t) p[0] << 24 ) |
3787 ( (size_t) p[1] << 16 ) |
3788 ( (size_t) p[2] << 8 ) |
3789 ( (size_t) p[3] );
3790 p += 4;
3791
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003792 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003793 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003794 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003795 ssl->session_in = ssl->session;
3796 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003797 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003798
3799 if( (size_t)( end - p ) < session_len )
3800 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3801
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003802 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003803 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003804 {
3805 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003806 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003807 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003808
3809 p += session_len;
3810
3811 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003812 * Transform
3813 */
3814
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003815 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003816 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003817 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003818 ssl->transform_in = ssl->transform;
3819 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003820 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003821
3822 /* Read random bytes and populate structure */
3823 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3824 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003825#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003826 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003827 ssl->session->ciphersuite,
3828 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003829#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003830 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003831#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003832 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3833 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003834 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003835 ssl->conf->endpoint,
3836 ssl );
3837 if( ret != 0 )
3838 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003839#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003840 p += sizeof( ssl->transform->randbytes );
3841
3842#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3843 /* Read connection IDs and store them */
3844 if( (size_t)( end - p ) < 1 )
3845 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3846
3847 ssl->transform->in_cid_len = *p++;
3848
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003849 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003850 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3851
3852 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3853 p += ssl->transform->in_cid_len;
3854
3855 ssl->transform->out_cid_len = *p++;
3856
3857 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3858 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3859
3860 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3861 p += ssl->transform->out_cid_len;
3862#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3863
3864 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003865 * Saved fields from top-level ssl_context structure
3866 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003867 if( (size_t)( end - p ) < 4 )
3868 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3869
3870 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3871 ( (uint32_t) p[1] << 16 ) |
3872 ( (uint32_t) p[2] << 8 ) |
3873 ( (uint32_t) p[3] );
3874 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003875
3876#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3877 if( (size_t)( end - p ) < 16 )
3878 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3879
3880 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3881 ( (uint64_t) p[1] << 48 ) |
3882 ( (uint64_t) p[2] << 40 ) |
3883 ( (uint64_t) p[3] << 32 ) |
3884 ( (uint64_t) p[4] << 24 ) |
3885 ( (uint64_t) p[5] << 16 ) |
3886 ( (uint64_t) p[6] << 8 ) |
3887 ( (uint64_t) p[7] );
3888 p += 8;
3889
3890 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3891 ( (uint64_t) p[1] << 48 ) |
3892 ( (uint64_t) p[2] << 40 ) |
3893 ( (uint64_t) p[3] << 32 ) |
3894 ( (uint64_t) p[4] << 24 ) |
3895 ( (uint64_t) p[5] << 16 ) |
3896 ( (uint64_t) p[6] << 8 ) |
3897 ( (uint64_t) p[7] );
3898 p += 8;
3899#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3900
3901#if defined(MBEDTLS_SSL_PROTO_DTLS)
3902 if( (size_t)( end - p ) < 1 )
3903 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3904
3905 ssl->disable_datagram_packing = *p++;
3906#endif /* MBEDTLS_SSL_PROTO_DTLS */
3907
Jerry Yud9a94fe2021-09-28 18:58:59 +08003908 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003909 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003910 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3911 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003912
3913#if defined(MBEDTLS_SSL_PROTO_DTLS)
3914 if( (size_t)( end - p ) < 2 )
3915 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3916
3917 ssl->mtu = ( p[0] << 8 ) | p[1];
3918 p += 2;
3919#endif /* MBEDTLS_SSL_PROTO_DTLS */
3920
3921#if defined(MBEDTLS_SSL_ALPN)
3922 {
3923 uint8_t alpn_len;
3924 const char **cur;
3925
3926 if( (size_t)( end - p ) < 1 )
3927 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3928
3929 alpn_len = *p++;
3930
3931 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3932 {
3933 /* alpn_chosen should point to an item in the configured list */
3934 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3935 {
3936 if( strlen( *cur ) == alpn_len &&
3937 memcmp( p, cur, alpn_len ) == 0 )
3938 {
3939 ssl->alpn_chosen = *cur;
3940 break;
3941 }
3942 }
3943 }
3944
3945 /* can only happen on conf mismatch */
3946 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3947 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3948
3949 p += alpn_len;
3950 }
3951#endif /* MBEDTLS_SSL_ALPN */
3952
3953 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003954 * Forced fields from top-level ssl_context structure
3955 *
3956 * Most of them already set to the correct value by mbedtls_ssl_init() and
3957 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3958 */
3959 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003960 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003961
Hanno Becker361b10d2019-08-30 10:42:49 +01003962 /* Adjust pointers for header fields of outgoing records to
3963 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003964 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003965
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003966#if defined(MBEDTLS_SSL_PROTO_DTLS)
3967 ssl->in_epoch = 1;
3968#endif
3969
3970 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3971 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003972 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3973 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003974 if( ssl->handshake != NULL )
3975 {
3976 mbedtls_ssl_handshake_free( ssl );
3977 mbedtls_free( ssl->handshake );
3978 ssl->handshake = NULL;
3979 }
3980
3981 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003982 * Done - should have consumed entire buffer
3983 */
3984 if( p != end )
3985 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003986
3987 return( 0 );
3988}
3989
3990/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003991 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003992 */
3993int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3994 const unsigned char *buf,
3995 size_t len )
3996{
3997 int ret = ssl_context_load( context, buf, len );
3998
3999 if( ret != 0 )
4000 mbedtls_ssl_free( context );
4001
4002 return( ret );
4003}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004004#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004005
4006/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004007 * Free an SSL context
4008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004009void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004010{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004011 if( ssl == NULL )
4012 return;
4013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004015
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004016 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004017 {
sander-visserb8aa2072020-05-06 22:05:13 +02004018#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4019 size_t out_buf_len = ssl->out_buf_len;
4020#else
4021 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4022#endif
4023
Darryl Greenb33cc762019-11-28 14:29:44 +00004024 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004026 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004027 }
4028
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004029 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004030 {
sander-visserb8aa2072020-05-06 22:05:13 +02004031#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4032 size_t in_buf_len = ssl->in_buf_len;
4033#else
4034 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4035#endif
4036
Darryl Greenb33cc762019-11-28 14:29:44 +00004037 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004039 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004040 }
4041
Paul Bakker48916f92012-09-16 19:57:18 +00004042 if( ssl->transform )
4043 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004044 mbedtls_ssl_transform_free( ssl->transform );
4045 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004046 }
4047
4048 if( ssl->handshake )
4049 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004050 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004051 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4052 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054 mbedtls_free( ssl->handshake );
4055 mbedtls_free( ssl->transform_negotiate );
4056 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004057 }
4058
Ronald Cron6f135e12021-12-08 16:57:54 +01004059#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004060 mbedtls_ssl_transform_free( ssl->transform_application );
4061 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004062#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004063
Paul Bakkerc0463502013-02-14 11:19:38 +01004064 if( ssl->session )
4065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004066 mbedtls_ssl_session_free( ssl->session );
4067 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004068 }
4069
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004070#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004071 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004072 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004073 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004074 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004075 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004076#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004077
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004078#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004079 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004080#endif
4081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004083
Paul Bakker86f04f42013-02-14 11:20:09 +01004084 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004085 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004086}
4087
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004088/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004089 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004090 */
4091void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4092{
4093 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4094}
4095
Gilles Peskineae270bf2021-06-02 00:05:29 +02004096/* The selection should be the same as mbedtls_x509_crt_profile_default in
4097 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004098 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004099 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004100 * about this list.
4101 */
Brett Warrene0edc842021-08-17 09:53:13 +01004102static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004103#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004104 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004105#endif
4106#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004107 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004108#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004109#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004110 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004111#endif
4112#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004113 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004114#endif
4115#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004116 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004117#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004118#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004119 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004120#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004121#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004122 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004123#endif
4124#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004125 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004126#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004127 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004128};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004129
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004130static int ssl_preset_suiteb_ciphersuites[] = {
4131 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4132 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4133 0
4134};
4135
Gilles Peskineeccd8882020-03-10 12:19:08 +01004136#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004137
Jerry Yu909df7b2022-01-22 11:56:27 +08004138/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004139 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004140 * rules SHOULD be upheld.
4141 * - No duplicate entries.
4142 * - But if there is a good reason, do not change the order of the algorithms.
4143 * - ssl_tls12_present* is for TLS 1.2 use only.
4144 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004145 *
Jerry Yua1255e62022-06-24 10:10:47 +08004146 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4147 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4148 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
Jerry Yucc539102022-06-27 16:27:35 +08004149 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4150 * for its signature in the key exchange message. As Mbed TLS 1.2 does not
Jerry Yua1255e62022-06-24 10:10:47 +08004151 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004152 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004153static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004154
Jerry Yued5e9f42022-01-26 11:21:34 +08004155#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4156 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4157 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4158#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4159 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004160
Jerry Yu909df7b2022-01-22 11:56:27 +08004161#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4162 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4163 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4164#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4165 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4166
Jerry Yued5e9f42022-01-26 11:21:34 +08004167#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4168 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4169 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4170#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4171 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004172
Ronald Cron8540cf62022-03-16 08:01:09 +01004173#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4174 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4175#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4176
4177#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4178 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4179#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4180
Jerry Yu53037892022-01-25 11:02:06 +08004181#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4182 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4183#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4184
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004185#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4186 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4187#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4188
4189#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4190 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4191#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4192
4193#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4194 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4195#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4196
Gabor Mezei15b95a62022-05-09 16:37:58 +02004197 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004198};
4199
4200/* NOTICE: see above */
4201#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4202static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004203#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004204#if defined(MBEDTLS_ECDSA_C)
4205 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004206#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004207#if defined(MBEDTLS_RSA_C)
4208 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4209#endif
4210#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004211#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004212#if defined(MBEDTLS_ECDSA_C)
4213 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004214#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004215#if defined(MBEDTLS_RSA_C)
4216 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4217#endif
4218#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004219#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004220#if defined(MBEDTLS_ECDSA_C)
4221 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004222#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004223#if defined(MBEDTLS_RSA_C)
4224 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4225#endif
4226#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004227 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004228};
4229#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4230/* NOTICE: see above */
4231static uint16_t ssl_preset_suiteb_sig_algs[] = {
4232
Jerry Yu909df7b2022-01-22 11:56:27 +08004233#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4234 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4235 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4236#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4237 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4238
Jerry Yu53037892022-01-25 11:02:06 +08004239#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4240 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4241 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4242#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4243 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004244
4245#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4246 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4247#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004248
Jerry Yu53037892022-01-25 11:02:06 +08004249#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4250 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4251#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4252
Gabor Mezei15b95a62022-05-09 16:37:58 +02004253 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004254};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004255
Jerry Yu909df7b2022-01-22 11:56:27 +08004256/* NOTICE: see above */
4257#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4258static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004259#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004260#if defined(MBEDTLS_ECDSA_C)
4261 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004262#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004263#if defined(MBEDTLS_RSA_C)
4264 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4265#endif
4266#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004267#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004268#if defined(MBEDTLS_ECDSA_C)
4269 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004270#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004271#if defined(MBEDTLS_RSA_C)
4272 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4273#endif
4274#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004275 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004276};
Jerry Yu909df7b2022-01-22 11:56:27 +08004277#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4278
Jerry Yu1a8b4812022-01-20 17:56:50 +08004279#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004280
Brett Warrene0edc842021-08-17 09:53:13 +01004281static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004282#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004283 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004284#endif
4285#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004286 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004287#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004288 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004289};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004290
Jerry Yu1a8b4812022-01-20 17:56:50 +08004291#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004292/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004293 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004294MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004295static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004296{
4297 size_t i, j;
4298 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004299
Gabor Mezei15b95a62022-05-09 16:37:58 +02004300 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004301 {
Jerry Yuf377d642022-01-25 10:43:59 +08004302 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004303 {
Jerry Yuf377d642022-01-25 10:43:59 +08004304 if( sig_algs[i] != sig_algs[j] )
4305 continue;
4306 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4307 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4308 sig_algs[i], j, i );
4309 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004310 }
4311 }
4312 return( ret );
4313}
4314
4315#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4316
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004317/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004318 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004319 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004320int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004321 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004322{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004323#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004324 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004325#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004326
Jerry Yu1a8b4812022-01-20 17:56:50 +08004327#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004328 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004329 {
4330 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4331 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4332 }
4333
Jerry Yuf377d642022-01-25 10:43:59 +08004334 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004335 {
4336 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4337 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4338 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004339
4340#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004341 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004342 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004343 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004344 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4345 }
4346
Jerry Yuf377d642022-01-25 10:43:59 +08004347 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004348 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004349 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004350 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4351 }
4352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004353#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4354
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004355 /* Use the functions here so that they are covered in tests,
4356 * but otherwise access member directly for efficiency */
4357 mbedtls_ssl_conf_endpoint( conf, endpoint );
4358 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004359
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004360 /*
4361 * Things that are common to all presets
4362 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004363#if defined(MBEDTLS_SSL_CLI_C)
4364 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4365 {
4366 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4367#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4368 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4369#endif
4370 }
4371#endif
4372
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004373#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4374 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4375#endif
4376
4377#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4378 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4379#endif
4380
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004381#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004382 conf->f_cookie_write = ssl_cookie_write_dummy;
4383 conf->f_cookie_check = ssl_cookie_check_dummy;
4384#endif
4385
4386#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4387 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4388#endif
4389
Janos Follath088ce432017-04-10 12:42:31 +01004390#if defined(MBEDTLS_SSL_SRV_C)
4391 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004392 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004393#endif
4394
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004395#if defined(MBEDTLS_SSL_PROTO_DTLS)
4396 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4397 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4398#endif
4399
4400#if defined(MBEDTLS_SSL_RENEGOTIATION)
4401 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004402 memset( conf->renego_period, 0x00, 2 );
4403 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004404#endif
4405
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004406#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004407 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4408 {
4409 const unsigned char dhm_p[] =
4410 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4411 const unsigned char dhm_g[] =
4412 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004413
Hanno Beckere2defad2021-07-24 05:59:17 +01004414 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4415 dhm_p, sizeof( dhm_p ),
4416 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4417 {
4418 return( ret );
4419 }
4420 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004421#endif
4422
Ronald Cron6f135e12021-12-08 16:57:54 +01004423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004424 /*
4425 * Allow all TLS 1.3 key exchange modes by default.
4426 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004427 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004428#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004429
XiaokangQian4d3a6042022-04-21 13:46:17 +00004430 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4431 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004432#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004433 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004434 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004435#else
XiaokangQian060d8672022-04-21 09:24:56 +00004436 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004437#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004438 }
4439 else
4440 {
4441#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4442 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4443 {
4444 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4445 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4446 }
4447 else
4448 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4449 {
4450 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4451 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4452 }
4453#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4454 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4455 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4456#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4457 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4458 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4459#else
4460 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4461#endif
4462 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004463
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004464 /*
4465 * Preset-specific defaults
4466 */
4467 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004468 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004469 /*
4470 * NSA Suite B
4471 */
4472 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004473
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004474 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004475
4476#if defined(MBEDTLS_X509_CRT_PARSE_C)
4477 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004478#endif
4479
Gilles Peskineeccd8882020-03-10 12:19:08 +01004480#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004481#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4482 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4483 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4484 else
4485#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4486 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004487#endif
4488
Brett Warrene0edc842021-08-17 09:53:13 +01004489#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4490 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004491#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004492 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004493 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004494
4495 /*
4496 * Default
4497 */
4498 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004499
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004500 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004501
4502#if defined(MBEDTLS_X509_CRT_PARSE_C)
4503 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4504#endif
4505
Gilles Peskineeccd8882020-03-10 12:19:08 +01004506#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004507#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4508 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4509 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4510 else
4511#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4512 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004513#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004514
Brett Warrene0edc842021-08-17 09:53:13 +01004515#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4516 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004517#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004518 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004519
4520#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4521 conf->dhm_min_bitlen = 1024;
4522#endif
4523 }
4524
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004525 return( 0 );
4526}
4527
4528/*
4529 * Free mbedtls_ssl_config
4530 */
4531void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4532{
4533#if defined(MBEDTLS_DHM_C)
4534 mbedtls_mpi_free( &conf->dhm_P );
4535 mbedtls_mpi_free( &conf->dhm_G );
4536#endif
4537
Gilles Peskineeccd8882020-03-10 12:19:08 +01004538#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004539#if defined(MBEDTLS_USE_PSA_CRYPTO)
4540 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4541 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004542 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4543 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004544#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004545 if( conf->psk != NULL )
4546 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004547 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004548 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004549 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004550 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004551 }
4552
4553 if( conf->psk_identity != NULL )
4554 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004555 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004556 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004557 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004558 conf->psk_identity_len = 0;
4559 }
4560#endif
4561
4562#if defined(MBEDTLS_X509_CRT_PARSE_C)
4563 ssl_key_cert_free( conf->key_cert );
4564#endif
4565
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004566 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004567}
4568
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004569#if defined(MBEDTLS_PK_C) && \
4570 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004571/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004572 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004575{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004576#if defined(MBEDTLS_RSA_C)
4577 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4578 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004579#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004580#if defined(MBEDTLS_ECDSA_C)
4581 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4582 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004583#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004584 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004585}
4586
Hanno Becker7e5437a2017-04-28 17:15:26 +01004587unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4588{
4589 switch( type ) {
4590 case MBEDTLS_PK_RSA:
4591 return( MBEDTLS_SSL_SIG_RSA );
4592 case MBEDTLS_PK_ECDSA:
4593 case MBEDTLS_PK_ECKEY:
4594 return( MBEDTLS_SSL_SIG_ECDSA );
4595 default:
4596 return( MBEDTLS_SSL_SIG_ANON );
4597 }
4598}
4599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004600mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004601{
4602 switch( sig )
4603 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004604#if defined(MBEDTLS_RSA_C)
4605 case MBEDTLS_SSL_SIG_RSA:
4606 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004607#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004608#if defined(MBEDTLS_ECDSA_C)
4609 case MBEDTLS_SSL_SIG_ECDSA:
4610 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004611#endif
4612 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004613 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004614 }
4615}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004616#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004617
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004618/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004619 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004622{
4623 switch( hash )
4624 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004625#if defined(MBEDTLS_MD5_C)
4626 case MBEDTLS_SSL_HASH_MD5:
4627 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004628#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004629#if defined(MBEDTLS_SHA1_C)
4630 case MBEDTLS_SSL_HASH_SHA1:
4631 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004632#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004633#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634 case MBEDTLS_SSL_HASH_SHA224:
4635 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004636#endif
4637#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004638 case MBEDTLS_SSL_HASH_SHA256:
4639 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004640#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004641#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 case MBEDTLS_SSL_HASH_SHA384:
4643 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004644#endif
4645#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004646 case MBEDTLS_SSL_HASH_SHA512:
4647 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004648#endif
4649 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004651 }
4652}
4653
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004654/*
4655 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4656 */
4657unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4658{
4659 switch( md )
4660 {
4661#if defined(MBEDTLS_MD5_C)
4662 case MBEDTLS_MD_MD5:
4663 return( MBEDTLS_SSL_HASH_MD5 );
4664#endif
4665#if defined(MBEDTLS_SHA1_C)
4666 case MBEDTLS_MD_SHA1:
4667 return( MBEDTLS_SSL_HASH_SHA1 );
4668#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004669#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004670 case MBEDTLS_MD_SHA224:
4671 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004672#endif
4673#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004674 case MBEDTLS_MD_SHA256:
4675 return( MBEDTLS_SSL_HASH_SHA256 );
4676#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004677#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004678 case MBEDTLS_MD_SHA384:
4679 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004680#endif
4681#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004682 case MBEDTLS_MD_SHA512:
4683 return( MBEDTLS_SSL_HASH_SHA512 );
4684#endif
4685 default:
4686 return( MBEDTLS_SSL_HASH_NONE );
4687 }
4688}
4689
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004690/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004691 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004692 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004693 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004694int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004695{
Brett Warrene0edc842021-08-17 09:53:13 +01004696 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004697
Brett Warrene0edc842021-08-17 09:53:13 +01004698 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004699 return( -1 );
4700
Brett Warrene0edc842021-08-17 09:53:13 +01004701 for( ; *group_list != 0; group_list++ )
4702 {
4703 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004704 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004705 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004706
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004707 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004708}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004709
4710#if defined(MBEDTLS_ECP_C)
4711/*
4712 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4713 */
4714int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4715{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004716 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004717 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4718}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004719#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721#if defined(MBEDTLS_X509_CRT_PARSE_C)
4722int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4723 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004724 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004725 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004726{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004727 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004728 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004729 const char *ext_oid;
4730 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004733 {
4734 /* Server part of the key exchange */
4735 switch( ciphersuite->key_exchange )
4736 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737 case MBEDTLS_KEY_EXCHANGE_RSA:
4738 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004739 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004740 break;
4741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4743 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4744 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4745 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004746 break;
4747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004748 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4749 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004750 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004751 break;
4752
4753 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754 case MBEDTLS_KEY_EXCHANGE_NONE:
4755 case MBEDTLS_KEY_EXCHANGE_PSK:
4756 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4757 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004758 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004759 usage = 0;
4760 }
4761 }
4762 else
4763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4765 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004766 }
4767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004768 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004769 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004770 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004771 ret = -1;
4772 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004774 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004776 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4777 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004778 }
4779 else
4780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4782 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004783 }
4784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004786 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004787 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004788 ret = -1;
4789 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004790
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004791 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004792}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004793#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004794
Jerry Yu148165c2021-09-24 23:20:59 +08004795#if defined(MBEDTLS_USE_PSA_CRYPTO)
4796int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4797 const mbedtls_md_type_t md,
4798 unsigned char *dst,
4799 size_t dst_len,
4800 size_t *olen )
4801{
Ronald Cronf6893e12022-01-07 22:09:01 +01004802 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4803 psa_hash_operation_t *hash_operation_to_clone;
4804 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4805
Jerry Yu148165c2021-09-24 23:20:59 +08004806 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004807
4808 switch( md )
4809 {
4810#if defined(MBEDTLS_SHA384_C)
4811 case MBEDTLS_MD_SHA384:
4812 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4813 break;
4814#endif
4815
4816#if defined(MBEDTLS_SHA256_C)
4817 case MBEDTLS_MD_SHA256:
4818 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4819 break;
4820#endif
4821
4822 default:
4823 goto exit;
4824 }
4825
4826 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4827 if( status != PSA_SUCCESS )
4828 goto exit;
4829
4830 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4831 if( status != PSA_SUCCESS )
4832 goto exit;
4833
4834exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004835 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004836}
4837#else /* MBEDTLS_USE_PSA_CRYPTO */
4838
Jerry Yu24c0ec32021-09-09 14:21:07 +08004839#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004840MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004841static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4842 unsigned char *dst,
4843 size_t dst_len,
4844 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004845{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004846 int ret;
4847 mbedtls_sha512_context sha512;
4848
4849 if( dst_len < 48 )
4850 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4851
4852 mbedtls_sha512_init( &sha512 );
4853 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4854
4855 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4856 {
4857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4858 goto exit;
4859 }
4860
4861 *olen = 48;
4862
4863exit:
4864
4865 mbedtls_sha512_free( &sha512 );
4866 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004867}
4868#endif /* MBEDTLS_SHA384_C */
4869
4870#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004871MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004872static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4873 unsigned char *dst,
4874 size_t dst_len,
4875 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004876{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004877 int ret;
4878 mbedtls_sha256_context sha256;
4879
4880 if( dst_len < 32 )
4881 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4882
4883 mbedtls_sha256_init( &sha256 );
4884 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004885
Jerry Yu24c0ec32021-09-09 14:21:07 +08004886 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4887 {
4888 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4889 goto exit;
4890 }
4891
4892 *olen = 32;
4893
4894exit:
4895
4896 mbedtls_sha256_free( &sha256 );
4897 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004898}
4899#endif /* MBEDTLS_SHA256_C */
4900
Jerry Yu000f9762021-09-14 11:12:51 +08004901int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4902 const mbedtls_md_type_t md,
4903 unsigned char *dst,
4904 size_t dst_len,
4905 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004906{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004907 switch( md )
4908 {
4909
Jerry Yu24c0ec32021-09-09 14:21:07 +08004910#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004911 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004912 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004913#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004914
Jerry Yu24c0ec32021-09-09 14:21:07 +08004915#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004916 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004917 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004918#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004919
4920 default:
4921 break;
4922 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004923 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004924}
XiaokangQian647719a2021-12-07 09:16:29 +00004925
Jerry Yu148165c2021-09-24 23:20:59 +08004926#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004927
Gabor Mezei078e8032022-04-27 21:17:56 +02004928#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4929/* mbedtls_ssl_parse_sig_alg_ext()
4930 *
4931 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4932 * value (TLS 1.3 RFC8446):
4933 * enum {
4934 * ....
4935 * ecdsa_secp256r1_sha256( 0x0403 ),
4936 * ecdsa_secp384r1_sha384( 0x0503 ),
4937 * ecdsa_secp521r1_sha512( 0x0603 ),
4938 * ....
4939 * } SignatureScheme;
4940 *
4941 * struct {
4942 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4943 * } SignatureSchemeList;
4944 *
4945 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4946 * value (TLS 1.2 RFC5246):
4947 * enum {
4948 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4949 * sha512(6), (255)
4950 * } HashAlgorithm;
4951 *
4952 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4953 * SignatureAlgorithm;
4954 *
4955 * struct {
4956 * HashAlgorithm hash;
4957 * SignatureAlgorithm signature;
4958 * } SignatureAndHashAlgorithm;
4959 *
4960 * SignatureAndHashAlgorithm
4961 * supported_signature_algorithms<2..2^16-2>;
4962 *
4963 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4964 * generalization of the TLS 1.2 signature algorithm extension.
4965 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4966 * `SignatureScheme` field of TLS 1.3
4967 *
4968 */
4969int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4970 const unsigned char *buf,
4971 const unsigned char *end )
4972{
4973 const unsigned char *p = buf;
4974 size_t supported_sig_algs_len = 0;
4975 const unsigned char *supported_sig_algs_end;
4976 uint16_t sig_alg;
4977 uint32_t common_idx = 0;
4978
4979 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4980 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4981 p += 2;
4982
4983 memset( ssl->handshake->received_sig_algs, 0,
4984 sizeof(ssl->handshake->received_sig_algs) );
4985
4986 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4987 supported_sig_algs_end = p + supported_sig_algs_len;
4988 while( p < supported_sig_algs_end )
4989 {
4990 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4991 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4992 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004993 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4994 sig_alg,
4995 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08004996#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08004997 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08004998 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
4999 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5000 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005001 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005002 }
5003#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005004
Jerry Yuf3b46b52022-06-19 16:52:27 +08005005 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5006 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005007
5008 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5009 {
5010 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5011 common_idx += 1;
5012 }
5013 }
5014 /* Check that we consumed all the message. */
5015 if( p != end )
5016 {
5017 MBEDTLS_SSL_DEBUG_MSG( 1,
5018 ( "Signature algorithms extension length misaligned" ) );
5019 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5020 MBEDTLS_ERR_SSL_DECODE_ERROR );
5021 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5022 }
5023
5024 if( common_idx == 0 )
5025 {
5026 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5027 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5028 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5029 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5030 }
5031
Gabor Mezei15b95a62022-05-09 16:37:58 +02005032 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005033 return( 0 );
5034}
5035
5036#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5037
Jerry Yudc7bd172022-02-17 13:44:15 +08005038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5039
5040#if defined(MBEDTLS_USE_PSA_CRYPTO)
5041
5042static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5043 mbedtls_svc_key_id_t key,
5044 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005045 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005046 const unsigned char* seed, size_t seed_length,
5047 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005048 const unsigned char* other_secret,
5049 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005050 size_t capacity )
5051{
5052 psa_status_t status;
5053
5054 status = psa_key_derivation_setup( derivation, alg );
5055 if( status != PSA_SUCCESS )
5056 return( status );
5057
5058 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5059 {
5060 status = psa_key_derivation_input_bytes( derivation,
5061 PSA_KEY_DERIVATION_INPUT_SEED,
5062 seed, seed_length );
5063 if( status != PSA_SUCCESS )
5064 return( status );
5065
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005066 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005067 {
5068 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005069 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5070 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005071 if( status != PSA_SUCCESS )
5072 return( status );
5073 }
5074
Jerry Yudc7bd172022-02-17 13:44:15 +08005075 if( mbedtls_svc_key_id_is_null( key ) )
5076 {
5077 status = psa_key_derivation_input_bytes(
5078 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005079 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005080 }
5081 else
5082 {
5083 status = psa_key_derivation_input_key(
5084 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5085 }
5086 if( status != PSA_SUCCESS )
5087 return( status );
5088
5089 status = psa_key_derivation_input_bytes( derivation,
5090 PSA_KEY_DERIVATION_INPUT_LABEL,
5091 label, label_length );
5092 if( status != PSA_SUCCESS )
5093 return( status );
5094 }
5095 else
5096 {
5097 return( PSA_ERROR_NOT_SUPPORTED );
5098 }
5099
5100 status = psa_key_derivation_set_capacity( derivation, capacity );
5101 if( status != PSA_SUCCESS )
5102 return( status );
5103
5104 return( PSA_SUCCESS );
5105}
5106
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005107MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005108static int tls_prf_generic( mbedtls_md_type_t md_type,
5109 const unsigned char *secret, size_t slen,
5110 const char *label,
5111 const unsigned char *random, size_t rlen,
5112 unsigned char *dstbuf, size_t dlen )
5113{
5114 psa_status_t status;
5115 psa_algorithm_t alg;
5116 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5117 psa_key_derivation_operation_t derivation =
5118 PSA_KEY_DERIVATION_OPERATION_INIT;
5119
5120 if( md_type == MBEDTLS_MD_SHA384 )
5121 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5122 else
5123 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5124
5125 /* Normally a "secret" should be long enough to be impossible to
5126 * find by brute force, and in particular should not be empty. But
5127 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5128 * and for this use case it makes sense to have a 0-length "secret".
5129 * Since the key API doesn't allow importing a key of length 0,
5130 * keep master_key=0, which setup_psa_key_derivation() understands
5131 * to mean a 0-length "secret" input. */
5132 if( slen != 0 )
5133 {
5134 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5135 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5136 psa_set_key_algorithm( &key_attributes, alg );
5137 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5138
5139 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5140 if( status != PSA_SUCCESS )
5141 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5142 }
5143
5144 status = setup_psa_key_derivation( &derivation,
5145 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005146 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005147 random, rlen,
5148 (unsigned char const *) label,
5149 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005150 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005151 dlen );
5152 if( status != PSA_SUCCESS )
5153 {
5154 psa_key_derivation_abort( &derivation );
5155 psa_destroy_key( master_key );
5156 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5157 }
5158
5159 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5160 if( status != PSA_SUCCESS )
5161 {
5162 psa_key_derivation_abort( &derivation );
5163 psa_destroy_key( master_key );
5164 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5165 }
5166
5167 status = psa_key_derivation_abort( &derivation );
5168 if( status != PSA_SUCCESS )
5169 {
5170 psa_destroy_key( master_key );
5171 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5172 }
5173
5174 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5175 status = psa_destroy_key( master_key );
5176 if( status != PSA_SUCCESS )
5177 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5178
5179 return( 0 );
5180}
5181
5182#else /* MBEDTLS_USE_PSA_CRYPTO */
5183
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005184MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005185static int tls_prf_generic( mbedtls_md_type_t md_type,
5186 const unsigned char *secret, size_t slen,
5187 const char *label,
5188 const unsigned char *random, size_t rlen,
5189 unsigned char *dstbuf, size_t dlen )
5190{
5191 size_t nb;
5192 size_t i, j, k, md_len;
5193 unsigned char *tmp;
5194 size_t tmp_len = 0;
5195 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5196 const mbedtls_md_info_t *md_info;
5197 mbedtls_md_context_t md_ctx;
5198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5199
5200 mbedtls_md_init( &md_ctx );
5201
5202 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5203 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5204
5205 md_len = mbedtls_md_get_size( md_info );
5206
5207 tmp_len = md_len + strlen( label ) + rlen;
5208 tmp = mbedtls_calloc( 1, tmp_len );
5209 if( tmp == NULL )
5210 {
5211 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5212 goto exit;
5213 }
5214
5215 nb = strlen( label );
5216 memcpy( tmp + md_len, label, nb );
5217 memcpy( tmp + md_len + nb, random, rlen );
5218 nb += rlen;
5219
5220 /*
5221 * Compute P_<hash>(secret, label + random)[0..dlen]
5222 */
5223 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5224 goto exit;
5225
5226 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5227 if( ret != 0 )
5228 goto exit;
5229 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5230 if( ret != 0 )
5231 goto exit;
5232 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5233 if( ret != 0 )
5234 goto exit;
5235
5236 for( i = 0; i < dlen; i += md_len )
5237 {
5238 ret = mbedtls_md_hmac_reset ( &md_ctx );
5239 if( ret != 0 )
5240 goto exit;
5241 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5242 if( ret != 0 )
5243 goto exit;
5244 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5245 if( ret != 0 )
5246 goto exit;
5247
5248 ret = mbedtls_md_hmac_reset ( &md_ctx );
5249 if( ret != 0 )
5250 goto exit;
5251 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5252 if( ret != 0 )
5253 goto exit;
5254 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5255 if( ret != 0 )
5256 goto exit;
5257
5258 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5259
5260 for( j = 0; j < k; j++ )
5261 dstbuf[i + j] = h_i[j];
5262 }
5263
5264exit:
5265 mbedtls_md_free( &md_ctx );
5266
5267 mbedtls_platform_zeroize( tmp, tmp_len );
5268 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5269
5270 mbedtls_free( tmp );
5271
5272 return( ret );
5273}
5274#endif /* MBEDTLS_USE_PSA_CRYPTO */
5275
5276#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005277MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005278static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5279 const char *label,
5280 const unsigned char *random, size_t rlen,
5281 unsigned char *dstbuf, size_t dlen )
5282{
5283 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5284 label, random, rlen, dstbuf, dlen ) );
5285}
5286#endif /* MBEDTLS_SHA256_C */
5287
5288#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005289MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005290static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5291 const char *label,
5292 const unsigned char *random, size_t rlen,
5293 unsigned char *dstbuf, size_t dlen )
5294{
5295 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5296 label, random, rlen, dstbuf, dlen ) );
5297}
5298#endif /* MBEDTLS_SHA384_C */
5299
Jerry Yuf009d862022-02-17 14:01:37 +08005300/*
5301 * Set appropriate PRF function and other SSL / TLS1.2 functions
5302 *
5303 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005304 * - hash associated with the ciphersuite (only used by TLS 1.2)
5305 *
5306 * Outputs:
5307 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5308 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005309MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005310static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005311 mbedtls_md_type_t hash )
5312{
Jerry Yuf009d862022-02-17 14:01:37 +08005313#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005314 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005315 {
5316 handshake->tls_prf = tls_prf_sha384;
5317 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5318 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5319 }
5320 else
5321#endif
5322#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005323 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005324 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005325 handshake->tls_prf = tls_prf_sha256;
5326 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5327 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5328 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005329#else
Jerry Yuf009d862022-02-17 14:01:37 +08005330 {
Jerry Yuf009d862022-02-17 14:01:37 +08005331 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005332 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005333 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5334 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005335#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005336
5337 return( 0 );
5338}
Jerry Yud6ab2352022-02-17 14:03:43 +08005339
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005340/*
5341 * Compute master secret if needed
5342 *
5343 * Parameters:
5344 * [in/out] handshake
5345 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5346 * (PSA-PSK) ciphersuite_info, psk_opaque
5347 * [out] premaster (cleared)
5348 * [out] master
5349 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5350 * debug: conf->f_dbg, conf->p_dbg
5351 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005352 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005353 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005354MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005355static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5356 unsigned char *master,
5357 const mbedtls_ssl_context *ssl )
5358{
5359 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5360
5361 /* cf. RFC 5246, Section 8.1:
5362 * "The master secret is always exactly 48 bytes in length." */
5363 size_t const master_secret_len = 48;
5364
5365#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5366 unsigned char session_hash[48];
5367#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5368
5369 /* The label for the KDF used for key expansion.
5370 * This is either "master secret" or "extended master secret"
5371 * depending on whether the Extended Master Secret extension
5372 * is used. */
5373 char const *lbl = "master secret";
5374
Przemek Stekielae4ed302022-04-05 17:15:55 +02005375 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005376 * - If the Extended Master Secret extension is not used,
5377 * this is ClientHello.Random + ServerHello.Random
5378 * (see Sect. 8.1 in RFC 5246).
5379 * - If the Extended Master Secret extension is used,
5380 * this is the transcript of the handshake so far.
5381 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005382 unsigned char const *seed = handshake->randbytes;
5383 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005384
5385#if !defined(MBEDTLS_DEBUG_C) && \
5386 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5387 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5388 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5389 ssl = NULL; /* make sure we don't use it except for those cases */
5390 (void) ssl;
5391#endif
5392
5393 if( handshake->resume != 0 )
5394 {
5395 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5396 return( 0 );
5397 }
5398
5399#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5400 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5401 {
5402 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005403 seed = session_hash;
5404 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005405
5406 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005407 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005408 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005409#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005410
Przemek Stekiel99114f32022-04-22 11:20:09 +02005411#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005412 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005413 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005414 {
5415 /* Perform PSK-to-MS expansion in a single step. */
5416 psa_status_t status;
5417 psa_algorithm_t alg;
5418 mbedtls_svc_key_id_t psk;
5419 psa_key_derivation_operation_t derivation =
5420 PSA_KEY_DERIVATION_OPERATION_INIT;
5421 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5422
5423 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5424
5425 psk = mbedtls_ssl_get_opaque_psk( ssl );
5426
5427 if( hash_alg == MBEDTLS_MD_SHA384 )
5428 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5429 else
5430 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5431
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005432 size_t other_secret_len = 0;
5433 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005434
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005435 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005436 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005437 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005438 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005439 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005440 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005441 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005442 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005443 other_secret_len = 48;
5444 other_secret = handshake->premaster + 2;
5445 break;
5446 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005447 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005448 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5449 other_secret = handshake->premaster + 2;
5450 break;
5451 default:
5452 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005453 }
5454
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005455 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005456 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005457 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005458 (unsigned char const *) lbl,
5459 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005460 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005461 master_secret_len );
5462 if( status != PSA_SUCCESS )
5463 {
5464 psa_key_derivation_abort( &derivation );
5465 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5466 }
5467
5468 status = psa_key_derivation_output_bytes( &derivation,
5469 master,
5470 master_secret_len );
5471 if( status != PSA_SUCCESS )
5472 {
5473 psa_key_derivation_abort( &derivation );
5474 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5475 }
5476
5477 status = psa_key_derivation_abort( &derivation );
5478 if( status != PSA_SUCCESS )
5479 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5480 }
5481 else
5482#endif
5483 {
5484 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005485 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005486 master,
5487 master_secret_len );
5488 if( ret != 0 )
5489 {
5490 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5491 return( ret );
5492 }
5493
5494 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5495 handshake->premaster,
5496 handshake->pmslen );
5497
5498 mbedtls_platform_zeroize( handshake->premaster,
5499 sizeof(handshake->premaster) );
5500 }
5501
5502 return( 0 );
5503}
5504
Jerry Yud62f87e2022-02-17 14:09:02 +08005505int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5506{
5507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5508 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5509 ssl->handshake->ciphersuite_info;
5510
5511 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5512
5513 /* Set PRF, calc_verify and calc_finished function pointers */
5514 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005515 ciphersuite_info->mac );
5516 if( ret != 0 )
5517 {
5518 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5519 return( ret );
5520 }
5521
5522 /* Compute master secret if needed */
5523 ret = ssl_compute_master( ssl->handshake,
5524 ssl->session_negotiate->master,
5525 ssl );
5526 if( ret != 0 )
5527 {
5528 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5529 return( ret );
5530 }
5531
5532 /* Swap the client and server random values:
5533 * - MS derivation wanted client+server (RFC 5246 8.1)
5534 * - key derivation wants server+client (RFC 5246 6.3) */
5535 {
5536 unsigned char tmp[64];
5537 memcpy( tmp, ssl->handshake->randbytes, 64 );
5538 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5539 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5540 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5541 }
5542
5543 /* Populate transform structure */
5544 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5545 ssl->session_negotiate->ciphersuite,
5546 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005547#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005548 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005549#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005550 ssl->handshake->tls_prf,
5551 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005552 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005553 ssl->conf->endpoint,
5554 ssl );
5555 if( ret != 0 )
5556 {
5557 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5558 return( ret );
5559 }
5560
5561 /* We no longer need Server/ClientHello.random values */
5562 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5563 sizeof( ssl->handshake->randbytes ) );
5564
5565 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5566
5567 return( 0 );
5568}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005569
Ronald Cron4dcbca92022-03-07 10:21:40 +01005570int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5571{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005572 switch( md )
5573 {
5574#if defined(MBEDTLS_SHA384_C)
5575 case MBEDTLS_SSL_HASH_SHA384:
5576 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5577 break;
5578#endif
5579#if defined(MBEDTLS_SHA256_C)
5580 case MBEDTLS_SSL_HASH_SHA256:
5581 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5582 break;
5583#endif
5584 default:
5585 return( -1 );
5586 }
5587
Ronald Cronc2f13a02022-03-07 10:25:24 +01005588 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005589}
5590
Jerry Yu8392e0d2022-02-17 14:10:24 +08005591#if defined(MBEDTLS_SHA256_C)
5592void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5593 unsigned char *hash,
5594 size_t *hlen )
5595{
5596#if defined(MBEDTLS_USE_PSA_CRYPTO)
5597 size_t hash_size;
5598 psa_status_t status;
5599 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5600
5601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5602 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5603 if( status != PSA_SUCCESS )
5604 {
5605 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5606 return;
5607 }
5608
5609 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5610 if( status != PSA_SUCCESS )
5611 {
5612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5613 return;
5614 }
5615
5616 *hlen = 32;
5617 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5618 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5619#else
5620 mbedtls_sha256_context sha256;
5621
5622 mbedtls_sha256_init( &sha256 );
5623
5624 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5625
5626 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5627 mbedtls_sha256_finish( &sha256, hash );
5628
5629 *hlen = 32;
5630
5631 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5633
5634 mbedtls_sha256_free( &sha256 );
5635#endif /* MBEDTLS_USE_PSA_CRYPTO */
5636 return;
5637}
5638#endif /* MBEDTLS_SHA256_C */
5639
Jerry Yuc1cb3842022-02-17 14:13:48 +08005640#if defined(MBEDTLS_SHA384_C)
5641void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5642 unsigned char *hash,
5643 size_t *hlen )
5644{
5645#if defined(MBEDTLS_USE_PSA_CRYPTO)
5646 size_t hash_size;
5647 psa_status_t status;
5648 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5649
5650 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5651 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5652 if( status != PSA_SUCCESS )
5653 {
5654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5655 return;
5656 }
5657
5658 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5659 if( status != PSA_SUCCESS )
5660 {
5661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5662 return;
5663 }
5664
5665 *hlen = 48;
5666 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5668#else
5669 mbedtls_sha512_context sha512;
5670
5671 mbedtls_sha512_init( &sha512 );
5672
5673 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5674
5675 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5676 mbedtls_sha512_finish( &sha512, hash );
5677
5678 *hlen = 48;
5679
5680 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5682
5683 mbedtls_sha512_free( &sha512 );
5684#endif /* MBEDTLS_USE_PSA_CRYPTO */
5685 return;
5686}
5687#endif /* MBEDTLS_SHA384_C */
5688
Neil Armstrong80f6f322022-05-03 17:56:38 +02005689#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5690 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005691int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5692{
5693 unsigned char *p = ssl->handshake->premaster;
5694 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5695 const unsigned char *psk = NULL;
5696 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005697 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005698
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005699 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005700 {
5701 /*
5702 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005703 * checked before calling this function.
5704 *
5705 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005706 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005707 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005708 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5709 {
5710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5711 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5712 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005713 }
5714
5715 /*
5716 * PMS = struct {
5717 * opaque other_secret<0..2^16-1>;
5718 * opaque psk<0..2^16-1>;
5719 * };
5720 * with "other_secret" depending on the particular key exchange
5721 */
5722#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5723 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5724 {
5725 if( end - p < 2 )
5726 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5727
5728 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5729 p += 2;
5730
5731 if( end < p || (size_t)( end - p ) < psk_len )
5732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5733
5734 memset( p, 0, psk_len );
5735 p += psk_len;
5736 }
5737 else
5738#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5739#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5740 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5741 {
5742 /*
5743 * other_secret already set by the ClientKeyExchange message,
5744 * and is 48 bytes long
5745 */
5746 if( end - p < 2 )
5747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5748
5749 *p++ = 0;
5750 *p++ = 48;
5751 p += 48;
5752 }
5753 else
5754#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5755#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5756 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5757 {
5758 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5759 size_t len;
5760
5761 /* Write length only when we know the actual value */
5762 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5763 p + 2, end - ( p + 2 ), &len,
5764 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5765 {
5766 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5767 return( ret );
5768 }
5769 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5770 p += 2 + len;
5771
5772 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5773 }
5774 else
5775#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005776#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005777 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5778 {
5779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5780 size_t zlen;
5781
5782 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5783 p + 2, end - ( p + 2 ),
5784 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5785 {
5786 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5787 return( ret );
5788 }
5789
5790 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5791 p += 2 + zlen;
5792
5793 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5794 MBEDTLS_DEBUG_ECDH_Z );
5795 }
5796 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005797#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005798 {
5799 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5800 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5801 }
5802
5803 /* opaque psk<0..2^16-1>; */
5804 if( end - p < 2 )
5805 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5806
5807 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5808 p += 2;
5809
5810 if( end < p || (size_t)( end - p ) < psk_len )
5811 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5812
5813 memcpy( p, psk, psk_len );
5814 p += psk_len;
5815
5816 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5817
5818 return( 0 );
5819}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005820#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005821
5822#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005823MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08005824static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5825
5826#if defined(MBEDTLS_SSL_PROTO_DTLS)
5827int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5828{
5829 /* If renegotiation is not enforced, retransmit until we would reach max
5830 * timeout if we were using the usual handshake doubling scheme */
5831 if( ssl->conf->renego_max_records < 0 )
5832 {
5833 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5834 unsigned char doublings = 1;
5835
5836 while( ratio != 0 )
5837 {
5838 ++doublings;
5839 ratio >>= 1;
5840 }
5841
5842 if( ++ssl->renego_records_seen > doublings )
5843 {
5844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5845 return( 0 );
5846 }
5847 }
5848
5849 return( ssl_write_hello_request( ssl ) );
5850}
5851#endif
5852#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005853
Jerry Yud9526692022-02-17 14:23:47 +08005854/*
5855 * Handshake functions
5856 */
5857#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5858/* No certificate support -> dummy functions */
5859int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5860{
5861 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5862 ssl->handshake->ciphersuite_info;
5863
5864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5865
5866 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5867 {
5868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5869 ssl->state++;
5870 return( 0 );
5871 }
5872
5873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5874 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5875}
5876
5877int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5878{
5879 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5880 ssl->handshake->ciphersuite_info;
5881
5882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5883
5884 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5885 {
5886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5887 ssl->state++;
5888 return( 0 );
5889 }
5890
5891 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5892 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5893}
5894
5895#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5896/* Some certificate support -> implement write and parse */
5897
5898int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5899{
5900 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5901 size_t i, n;
5902 const mbedtls_x509_crt *crt;
5903 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5904 ssl->handshake->ciphersuite_info;
5905
5906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5907
5908 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5909 {
5910 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5911 ssl->state++;
5912 return( 0 );
5913 }
5914
5915#if defined(MBEDTLS_SSL_CLI_C)
5916 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5917 {
5918 if( ssl->handshake->client_auth == 0 )
5919 {
5920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5921 ssl->state++;
5922 return( 0 );
5923 }
5924 }
5925#endif /* MBEDTLS_SSL_CLI_C */
5926#if defined(MBEDTLS_SSL_SRV_C)
5927 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5928 {
5929 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5930 {
5931 /* Should never happen because we shouldn't have picked the
5932 * ciphersuite if we don't have a certificate. */
5933 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5934 }
5935 }
5936#endif
5937
5938 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5939
5940 /*
5941 * 0 . 0 handshake type
5942 * 1 . 3 handshake length
5943 * 4 . 6 length of all certs
5944 * 7 . 9 length of cert. 1
5945 * 10 . n-1 peer certificate
5946 * n . n+2 length of cert. 2
5947 * n+3 . ... upper level cert, etc.
5948 */
5949 i = 7;
5950 crt = mbedtls_ssl_own_cert( ssl );
5951
5952 while( crt != NULL )
5953 {
5954 n = crt->raw.len;
5955 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5956 {
5957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5958 " > %" MBEDTLS_PRINTF_SIZET,
5959 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5960 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5961 }
5962
5963 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5964 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5965 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5966
5967 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5968 i += n; crt = crt->next;
5969 }
5970
5971 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5972 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5973 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5974
5975 ssl->out_msglen = i;
5976 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5977 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5978
5979 ssl->state++;
5980
5981 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5982 {
5983 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5984 return( ret );
5985 }
5986
5987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5988
5989 return( ret );
5990}
5991
5992#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5993
5994#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005995MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08005996static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5997 unsigned char *crt_buf,
5998 size_t crt_buf_len )
5999{
6000 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6001
6002 if( peer_crt == NULL )
6003 return( -1 );
6004
6005 if( peer_crt->raw.len != crt_buf_len )
6006 return( -1 );
6007
6008 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6009}
6010#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006011MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006012static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6013 unsigned char *crt_buf,
6014 size_t crt_buf_len )
6015{
6016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6017 unsigned char const * const peer_cert_digest =
6018 ssl->session->peer_cert_digest;
6019 mbedtls_md_type_t const peer_cert_digest_type =
6020 ssl->session->peer_cert_digest_type;
6021 mbedtls_md_info_t const * const digest_info =
6022 mbedtls_md_info_from_type( peer_cert_digest_type );
6023 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6024 size_t digest_len;
6025
6026 if( peer_cert_digest == NULL || digest_info == NULL )
6027 return( -1 );
6028
6029 digest_len = mbedtls_md_get_size( digest_info );
6030 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6031 return( -1 );
6032
6033 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6034 if( ret != 0 )
6035 return( -1 );
6036
6037 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6038}
6039#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6040#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6041
6042/*
6043 * Once the certificate message is read, parse it into a cert chain and
6044 * perform basic checks, but leave actual verification to the caller
6045 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006046MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006047static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6048 mbedtls_x509_crt *chain )
6049{
6050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6051#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6052 int crt_cnt=0;
6053#endif
6054 size_t i, n;
6055 uint8_t alert;
6056
6057 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6058 {
6059 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6060 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6061 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6062 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6063 }
6064
6065 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6066 {
6067 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6068 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6069 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6070 }
6071
6072 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6073 {
6074 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6075 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6076 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6077 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6078 }
6079
6080 i = mbedtls_ssl_hs_hdr_len( ssl );
6081
6082 /*
6083 * Same message structure as in mbedtls_ssl_write_certificate()
6084 */
6085 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6086
6087 if( ssl->in_msg[i] != 0 ||
6088 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6089 {
6090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6091 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6092 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6093 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6094 }
6095
6096 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6097 i += 3;
6098
6099 /* Iterate through and parse the CRTs in the provided chain. */
6100 while( i < ssl->in_hslen )
6101 {
6102 /* Check that there's room for the next CRT's length fields. */
6103 if ( i + 3 > ssl->in_hslen ) {
6104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6105 mbedtls_ssl_send_alert_message( ssl,
6106 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6107 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6108 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6109 }
6110 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6111 * anything beyond 2**16 ~ 64K. */
6112 if( ssl->in_msg[i] != 0 )
6113 {
6114 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6115 mbedtls_ssl_send_alert_message( ssl,
6116 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6117 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6118 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6119 }
6120
6121 /* Read length of the next CRT in the chain. */
6122 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6123 | (unsigned int) ssl->in_msg[i + 2];
6124 i += 3;
6125
6126 if( n < 128 || i + n > ssl->in_hslen )
6127 {
6128 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6129 mbedtls_ssl_send_alert_message( ssl,
6130 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6131 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6132 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6133 }
6134
6135 /* Check if we're handling the first CRT in the chain. */
6136#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6137 if( crt_cnt++ == 0 &&
6138 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6139 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6140 {
6141 /* During client-side renegotiation, check that the server's
6142 * end-CRTs hasn't changed compared to the initial handshake,
6143 * mitigating the triple handshake attack. On success, reuse
6144 * the original end-CRT instead of parsing it again. */
6145 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6146 if( ssl_check_peer_crt_unchanged( ssl,
6147 &ssl->in_msg[i],
6148 n ) != 0 )
6149 {
6150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6151 mbedtls_ssl_send_alert_message( ssl,
6152 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6153 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6154 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6155 }
6156
6157 /* Now we can safely free the original chain. */
6158 ssl_clear_peer_cert( ssl->session );
6159 }
6160#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6161
6162 /* Parse the next certificate in the chain. */
6163#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6164 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6165#else
6166 /* If we don't need to store the CRT chain permanently, parse
6167 * it in-place from the input buffer instead of making a copy. */
6168 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6169#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6170 switch( ret )
6171 {
6172 case 0: /*ok*/
6173 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6174 /* Ignore certificate with an unknown algorithm: maybe a
6175 prior certificate was already trusted. */
6176 break;
6177
6178 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6179 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6180 goto crt_parse_der_failed;
6181
6182 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6183 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6184 goto crt_parse_der_failed;
6185
6186 default:
6187 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6188 crt_parse_der_failed:
6189 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6190 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6191 return( ret );
6192 }
6193
6194 i += n;
6195 }
6196
6197 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6198 return( 0 );
6199}
6200
6201#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006202MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006203static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6204{
6205 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6206 return( -1 );
6207
6208 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6209 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6210 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6211 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6212 {
Ronald Cron19385882022-06-15 16:26:13 +02006213 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006214 return( 0 );
6215 }
6216 return( -1 );
6217}
6218#endif /* MBEDTLS_SSL_SRV_C */
6219
6220/* Check if a certificate message is expected.
6221 * Return either
6222 * - SSL_CERTIFICATE_EXPECTED, or
6223 * - SSL_CERTIFICATE_SKIP
6224 * indicating whether a Certificate message is expected or not.
6225 */
6226#define SSL_CERTIFICATE_EXPECTED 0
6227#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006228MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006229static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6230 int authmode )
6231{
6232 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6233 ssl->handshake->ciphersuite_info;
6234
6235 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6236 return( SSL_CERTIFICATE_SKIP );
6237
6238#if defined(MBEDTLS_SSL_SRV_C)
6239 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6240 {
6241 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6242 return( SSL_CERTIFICATE_SKIP );
6243
6244 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6245 {
6246 ssl->session_negotiate->verify_result =
6247 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6248 return( SSL_CERTIFICATE_SKIP );
6249 }
6250 }
6251#else
6252 ((void) authmode);
6253#endif /* MBEDTLS_SSL_SRV_C */
6254
6255 return( SSL_CERTIFICATE_EXPECTED );
6256}
6257
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006258MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006259static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6260 int authmode,
6261 mbedtls_x509_crt *chain,
6262 void *rs_ctx )
6263{
6264 int ret = 0;
6265 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6266 ssl->handshake->ciphersuite_info;
6267 int have_ca_chain = 0;
6268
6269 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6270 void *p_vrfy;
6271
6272 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6273 return( 0 );
6274
6275 if( ssl->f_vrfy != NULL )
6276 {
6277 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6278 f_vrfy = ssl->f_vrfy;
6279 p_vrfy = ssl->p_vrfy;
6280 }
6281 else
6282 {
6283 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6284 f_vrfy = ssl->conf->f_vrfy;
6285 p_vrfy = ssl->conf->p_vrfy;
6286 }
6287
6288 /*
6289 * Main check: verify certificate
6290 */
6291#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6292 if( ssl->conf->f_ca_cb != NULL )
6293 {
6294 ((void) rs_ctx);
6295 have_ca_chain = 1;
6296
6297 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6298 ret = mbedtls_x509_crt_verify_with_ca_cb(
6299 chain,
6300 ssl->conf->f_ca_cb,
6301 ssl->conf->p_ca_cb,
6302 ssl->conf->cert_profile,
6303 ssl->hostname,
6304 &ssl->session_negotiate->verify_result,
6305 f_vrfy, p_vrfy );
6306 }
6307 else
6308#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6309 {
6310 mbedtls_x509_crt *ca_chain;
6311 mbedtls_x509_crl *ca_crl;
6312
6313#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6314 if( ssl->handshake->sni_ca_chain != NULL )
6315 {
6316 ca_chain = ssl->handshake->sni_ca_chain;
6317 ca_crl = ssl->handshake->sni_ca_crl;
6318 }
6319 else
6320#endif
6321 {
6322 ca_chain = ssl->conf->ca_chain;
6323 ca_crl = ssl->conf->ca_crl;
6324 }
6325
6326 if( ca_chain != NULL )
6327 have_ca_chain = 1;
6328
6329 ret = mbedtls_x509_crt_verify_restartable(
6330 chain,
6331 ca_chain, ca_crl,
6332 ssl->conf->cert_profile,
6333 ssl->hostname,
6334 &ssl->session_negotiate->verify_result,
6335 f_vrfy, p_vrfy, rs_ctx );
6336 }
6337
6338 if( ret != 0 )
6339 {
6340 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6341 }
6342
6343#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6344 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6345 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6346#endif
6347
6348 /*
6349 * Secondary checks: always done, but change 'ret' only if it was 0
6350 */
6351
6352#if defined(MBEDTLS_ECP_C)
6353 {
6354 const mbedtls_pk_context *pk = &chain->pk;
6355
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006356 /* If certificate uses an EC key, make sure the curve is OK.
6357 * This is a public key, so it can't be opaque, so can_do() is a good
6358 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006359 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6360 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6361 {
6362 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6363
6364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6365 if( ret == 0 )
6366 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6367 }
6368 }
6369#endif /* MBEDTLS_ECP_C */
6370
6371 if( mbedtls_ssl_check_cert_usage( chain,
6372 ciphersuite_info,
6373 ! ssl->conf->endpoint,
6374 &ssl->session_negotiate->verify_result ) != 0 )
6375 {
6376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6377 if( ret == 0 )
6378 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6379 }
6380
6381 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6382 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6383 * with details encoded in the verification flags. All other kinds
6384 * of error codes, including those from the user provided f_vrfy
6385 * functions, are treated as fatal and lead to a failure of
6386 * ssl_parse_certificate even if verification was optional. */
6387 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6388 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6389 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6390 {
6391 ret = 0;
6392 }
6393
6394 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6395 {
6396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6397 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6398 }
6399
6400 if( ret != 0 )
6401 {
6402 uint8_t alert;
6403
6404 /* The certificate may have been rejected for several reasons.
6405 Pick one and send the corresponding alert. Which alert to send
6406 may be a subject of debate in some cases. */
6407 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6408 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6409 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6410 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6411 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6412 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6413 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6414 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6415 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6416 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6417 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6418 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6419 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6420 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6421 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6422 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6423 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6424 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6425 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6426 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6427 else
6428 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6429 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6430 alert );
6431 }
6432
6433#if defined(MBEDTLS_DEBUG_C)
6434 if( ssl->session_negotiate->verify_result != 0 )
6435 {
6436 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6437 (unsigned int) ssl->session_negotiate->verify_result ) );
6438 }
6439 else
6440 {
6441 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6442 }
6443#endif /* MBEDTLS_DEBUG_C */
6444
6445 return( ret );
6446}
6447
6448#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006449MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006450static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6451 unsigned char *start, size_t len )
6452{
6453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6454 /* Remember digest of the peer's end-CRT. */
6455 ssl->session_negotiate->peer_cert_digest =
6456 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6457 if( ssl->session_negotiate->peer_cert_digest == NULL )
6458 {
6459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6460 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6461 mbedtls_ssl_send_alert_message( ssl,
6462 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6463 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6464
6465 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6466 }
6467
6468 ret = mbedtls_md( mbedtls_md_info_from_type(
6469 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6470 start, len,
6471 ssl->session_negotiate->peer_cert_digest );
6472
6473 ssl->session_negotiate->peer_cert_digest_type =
6474 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6475 ssl->session_negotiate->peer_cert_digest_len =
6476 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6477
6478 return( ret );
6479}
6480
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006481MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006482static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6483 unsigned char *start, size_t len )
6484{
6485 unsigned char *end = start + len;
6486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6487
6488 /* Make a copy of the peer's raw public key. */
6489 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6490 ret = mbedtls_pk_parse_subpubkey( &start, end,
6491 &ssl->handshake->peer_pubkey );
6492 if( ret != 0 )
6493 {
6494 /* We should have parsed the public key before. */
6495 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6496 }
6497
6498 return( 0 );
6499}
6500#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6501
6502int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6503{
6504 int ret = 0;
6505 int crt_expected;
6506#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6507 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6508 ? ssl->handshake->sni_authmode
6509 : ssl->conf->authmode;
6510#else
6511 const int authmode = ssl->conf->authmode;
6512#endif
6513 void *rs_ctx = NULL;
6514 mbedtls_x509_crt *chain = NULL;
6515
6516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6517
6518 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6519 if( crt_expected == SSL_CERTIFICATE_SKIP )
6520 {
6521 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6522 goto exit;
6523 }
6524
6525#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6526 if( ssl->handshake->ecrs_enabled &&
6527 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6528 {
6529 chain = ssl->handshake->ecrs_peer_cert;
6530 ssl->handshake->ecrs_peer_cert = NULL;
6531 goto crt_verify;
6532 }
6533#endif
6534
6535 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6536 {
6537 /* mbedtls_ssl_read_record may have sent an alert already. We
6538 let it decide whether to alert. */
6539 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6540 goto exit;
6541 }
6542
6543#if defined(MBEDTLS_SSL_SRV_C)
6544 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6545 {
6546 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6547
6548 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6549 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6550
6551 goto exit;
6552 }
6553#endif /* MBEDTLS_SSL_SRV_C */
6554
6555 /* Clear existing peer CRT structure in case we tried to
6556 * reuse a session but it failed, and allocate a new one. */
6557 ssl_clear_peer_cert( ssl->session_negotiate );
6558
6559 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6560 if( chain == NULL )
6561 {
6562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6563 sizeof( mbedtls_x509_crt ) ) );
6564 mbedtls_ssl_send_alert_message( ssl,
6565 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6566 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6567
6568 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6569 goto exit;
6570 }
6571 mbedtls_x509_crt_init( chain );
6572
6573 ret = ssl_parse_certificate_chain( ssl, chain );
6574 if( ret != 0 )
6575 goto exit;
6576
6577#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6578 if( ssl->handshake->ecrs_enabled)
6579 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6580
6581crt_verify:
6582 if( ssl->handshake->ecrs_enabled)
6583 rs_ctx = &ssl->handshake->ecrs_ctx;
6584#endif
6585
6586 ret = ssl_parse_certificate_verify( ssl, authmode,
6587 chain, rs_ctx );
6588 if( ret != 0 )
6589 goto exit;
6590
6591#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6592 {
6593 unsigned char *crt_start, *pk_start;
6594 size_t crt_len, pk_len;
6595
6596 /* We parse the CRT chain without copying, so
6597 * these pointers point into the input buffer,
6598 * and are hence still valid after freeing the
6599 * CRT chain. */
6600
6601 crt_start = chain->raw.p;
6602 crt_len = chain->raw.len;
6603
6604 pk_start = chain->pk_raw.p;
6605 pk_len = chain->pk_raw.len;
6606
6607 /* Free the CRT structures before computing
6608 * digest and copying the peer's public key. */
6609 mbedtls_x509_crt_free( chain );
6610 mbedtls_free( chain );
6611 chain = NULL;
6612
6613 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6614 if( ret != 0 )
6615 goto exit;
6616
6617 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6618 if( ret != 0 )
6619 goto exit;
6620 }
6621#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6622 /* Pass ownership to session structure. */
6623 ssl->session_negotiate->peer_cert = chain;
6624 chain = NULL;
6625#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6626
6627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6628
6629exit:
6630
6631 if( ret == 0 )
6632 ssl->state++;
6633
6634#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6635 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6636 {
6637 ssl->handshake->ecrs_peer_cert = chain;
6638 chain = NULL;
6639 }
6640#endif
6641
6642 if( chain != NULL )
6643 {
6644 mbedtls_x509_crt_free( chain );
6645 mbedtls_free( chain );
6646 }
6647
6648 return( ret );
6649}
6650#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6651
Jerry Yu615bd6f2022-02-17 14:25:15 +08006652#if defined(MBEDTLS_SHA256_C)
6653static void ssl_calc_finished_tls_sha256(
6654 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6655{
6656 int len = 12;
6657 const char *sender;
6658 unsigned char padbuf[32];
6659#if defined(MBEDTLS_USE_PSA_CRYPTO)
6660 size_t hash_size;
6661 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6662 psa_status_t status;
6663#else
6664 mbedtls_sha256_context sha256;
6665#endif
6666
6667 mbedtls_ssl_session *session = ssl->session_negotiate;
6668 if( !session )
6669 session = ssl->session;
6670
6671 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6672 ? "client finished"
6673 : "server finished";
6674
6675#if defined(MBEDTLS_USE_PSA_CRYPTO)
6676 sha256_psa = psa_hash_operation_init();
6677
6678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6679
6680 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6681 if( status != PSA_SUCCESS )
6682 {
6683 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6684 return;
6685 }
6686
6687 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6688 if( status != PSA_SUCCESS )
6689 {
6690 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6691 return;
6692 }
6693 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6694#else
6695
6696 mbedtls_sha256_init( &sha256 );
6697
6698 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6699
6700 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6701
6702 /*
6703 * TLSv1.2:
6704 * hash = PRF( master, finished_label,
6705 * Hash( handshake ) )[0.11]
6706 */
6707
6708#if !defined(MBEDTLS_SHA256_ALT)
6709 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6710 sha256.state, sizeof( sha256.state ) );
6711#endif
6712
6713 mbedtls_sha256_finish( &sha256, padbuf );
6714 mbedtls_sha256_free( &sha256 );
6715#endif /* MBEDTLS_USE_PSA_CRYPTO */
6716
6717 ssl->handshake->tls_prf( session->master, 48, sender,
6718 padbuf, 32, buf, len );
6719
6720 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6721
6722 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6723
6724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6725}
6726#endif /* MBEDTLS_SHA256_C */
6727
Jerry Yub7ba49e2022-02-17 14:25:53 +08006728
6729#if defined(MBEDTLS_SHA384_C)
6730
6731static void ssl_calc_finished_tls_sha384(
6732 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6733{
6734 int len = 12;
6735 const char *sender;
6736 unsigned char padbuf[48];
6737#if defined(MBEDTLS_USE_PSA_CRYPTO)
6738 size_t hash_size;
6739 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6740 psa_status_t status;
6741#else
6742 mbedtls_sha512_context sha512;
6743#endif
6744
6745 mbedtls_ssl_session *session = ssl->session_negotiate;
6746 if( !session )
6747 session = ssl->session;
6748
6749 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6750 ? "client finished"
6751 : "server finished";
6752
6753#if defined(MBEDTLS_USE_PSA_CRYPTO)
6754 sha384_psa = psa_hash_operation_init();
6755
6756 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6757
6758 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6759 if( status != PSA_SUCCESS )
6760 {
6761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6762 return;
6763 }
6764
6765 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6766 if( status != PSA_SUCCESS )
6767 {
6768 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6769 return;
6770 }
6771 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6772#else
6773 mbedtls_sha512_init( &sha512 );
6774
6775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6776
6777 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6778
6779 /*
6780 * TLSv1.2:
6781 * hash = PRF( master, finished_label,
6782 * Hash( handshake ) )[0.11]
6783 */
6784
6785#if !defined(MBEDTLS_SHA512_ALT)
6786 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6787 sha512.state, sizeof( sha512.state ) );
6788#endif
6789 mbedtls_sha512_finish( &sha512, padbuf );
6790
6791 mbedtls_sha512_free( &sha512 );
6792#endif
6793
6794 ssl->handshake->tls_prf( session->master, 48, sender,
6795 padbuf, 48, buf, len );
6796
6797 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6798
6799 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6800
6801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6802}
6803#endif /* MBEDTLS_SHA384_C */
6804
Jerry Yuaef00152022-02-17 14:27:31 +08006805void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6806{
6807 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6808
6809 /*
6810 * Free our handshake params
6811 */
6812 mbedtls_ssl_handshake_free( ssl );
6813 mbedtls_free( ssl->handshake );
6814 ssl->handshake = NULL;
6815
6816 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006817 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006818 */
6819 if( ssl->transform )
6820 {
6821 mbedtls_ssl_transform_free( ssl->transform );
6822 mbedtls_free( ssl->transform );
6823 }
6824 ssl->transform = ssl->transform_negotiate;
6825 ssl->transform_negotiate = NULL;
6826
6827 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6828}
6829
Jerry Yu2a9fff52022-02-17 14:28:51 +08006830void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6831{
6832 int resume = ssl->handshake->resume;
6833
6834 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6835
6836#if defined(MBEDTLS_SSL_RENEGOTIATION)
6837 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6838 {
6839 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6840 ssl->renego_records_seen = 0;
6841 }
6842#endif
6843
6844 /*
6845 * Free the previous session and switch in the current one
6846 */
6847 if( ssl->session )
6848 {
6849#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6850 /* RFC 7366 3.1: keep the EtM state */
6851 ssl->session_negotiate->encrypt_then_mac =
6852 ssl->session->encrypt_then_mac;
6853#endif
6854
6855 mbedtls_ssl_session_free( ssl->session );
6856 mbedtls_free( ssl->session );
6857 }
6858 ssl->session = ssl->session_negotiate;
6859 ssl->session_negotiate = NULL;
6860
6861 /*
6862 * Add cache entry
6863 */
6864 if( ssl->conf->f_set_cache != NULL &&
6865 ssl->session->id_len != 0 &&
6866 resume == 0 )
6867 {
6868 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6869 ssl->session->id,
6870 ssl->session->id_len,
6871 ssl->session ) != 0 )
6872 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6873 }
6874
6875#if defined(MBEDTLS_SSL_PROTO_DTLS)
6876 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6877 ssl->handshake->flight != NULL )
6878 {
6879 /* Cancel handshake timer */
6880 mbedtls_ssl_set_timer( ssl, 0 );
6881
6882 /* Keep last flight around in case we need to resend it:
6883 * we need the handshake and transform structures for that */
6884 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6885 }
6886 else
6887#endif
6888 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6889
6890 ssl->state++;
6891
6892 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6893}
6894
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006895int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6896{
6897 int ret, hash_len;
6898
6899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6900
6901 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6902
6903 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6904
6905 /*
6906 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6907 * may define some other value. Currently (early 2016), no defined
6908 * ciphersuite does this (and this is unlikely to change as activity has
6909 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6910 */
6911 hash_len = 12;
6912
6913#if defined(MBEDTLS_SSL_RENEGOTIATION)
6914 ssl->verify_data_len = hash_len;
6915 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6916#endif
6917
6918 ssl->out_msglen = 4 + hash_len;
6919 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6920 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6921
6922 /*
6923 * In case of session resuming, invert the client and server
6924 * ChangeCipherSpec messages order.
6925 */
6926 if( ssl->handshake->resume != 0 )
6927 {
6928#if defined(MBEDTLS_SSL_CLI_C)
6929 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6930 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6931#endif
6932#if defined(MBEDTLS_SSL_SRV_C)
6933 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6934 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6935#endif
6936 }
6937 else
6938 ssl->state++;
6939
6940 /*
6941 * Switch to our negotiated transform and session parameters for outbound
6942 * data.
6943 */
6944 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6945
6946#if defined(MBEDTLS_SSL_PROTO_DTLS)
6947 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6948 {
6949 unsigned char i;
6950
6951 /* Remember current epoch settings for resending */
6952 ssl->handshake->alt_transform_out = ssl->transform_out;
6953 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6954 sizeof( ssl->handshake->alt_out_ctr ) );
6955
6956 /* Set sequence_number to zero */
6957 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6958
6959
6960 /* Increment epoch */
6961 for( i = 2; i > 0; i-- )
6962 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6963 break;
6964
6965 /* The loop goes to its end iff the counter is wrapping */
6966 if( i == 0 )
6967 {
6968 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6969 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6970 }
6971 }
6972 else
6973#endif /* MBEDTLS_SSL_PROTO_DTLS */
6974 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6975
6976 ssl->transform_out = ssl->transform_negotiate;
6977 ssl->session_out = ssl->session_negotiate;
6978
6979#if defined(MBEDTLS_SSL_PROTO_DTLS)
6980 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6981 mbedtls_ssl_send_flight_completed( ssl );
6982#endif
6983
6984 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6985 {
6986 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6987 return( ret );
6988 }
6989
6990#if defined(MBEDTLS_SSL_PROTO_DTLS)
6991 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6992 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6993 {
6994 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6995 return( ret );
6996 }
6997#endif
6998
6999 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7000
7001 return( 0 );
7002}
7003
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007004#define SSL_MAX_HASH_LEN 12
7005
7006int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7007{
7008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7009 unsigned int hash_len = 12;
7010 unsigned char buf[SSL_MAX_HASH_LEN];
7011
7012 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7013
7014 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7015
7016 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7017 {
7018 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7019 goto exit;
7020 }
7021
7022 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7023 {
7024 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7025 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7026 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7027 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7028 goto exit;
7029 }
7030
7031 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7032 {
7033 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7034 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7035 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7036 goto exit;
7037 }
7038
7039 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7040 {
7041 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7042 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7043 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7044 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7045 goto exit;
7046 }
7047
7048 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7049 buf, hash_len ) != 0 )
7050 {
7051 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7052 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7053 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7054 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7055 goto exit;
7056 }
7057
7058#if defined(MBEDTLS_SSL_RENEGOTIATION)
7059 ssl->verify_data_len = hash_len;
7060 memcpy( ssl->peer_verify_data, buf, hash_len );
7061#endif
7062
7063 if( ssl->handshake->resume != 0 )
7064 {
7065#if defined(MBEDTLS_SSL_CLI_C)
7066 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7067 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7068#endif
7069#if defined(MBEDTLS_SSL_SRV_C)
7070 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7071 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7072#endif
7073 }
7074 else
7075 ssl->state++;
7076
7077#if defined(MBEDTLS_SSL_PROTO_DTLS)
7078 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7079 mbedtls_ssl_recv_flight_completed( ssl );
7080#endif
7081
7082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7083
7084exit:
7085 mbedtls_platform_zeroize( buf, hash_len );
7086 return( ret );
7087}
7088
Jerry Yu392112c2022-02-17 14:34:10 +08007089#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7090/*
7091 * Helper to get TLS 1.2 PRF from ciphersuite
7092 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7093 */
7094static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7095{
7096#if defined(MBEDTLS_SHA384_C)
7097 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7098 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7099
7100 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7101 return( tls_prf_sha384 );
7102#else
7103 (void) ciphersuite_id;
7104#endif
7105 return( tls_prf_sha256 );
7106}
7107#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007108
7109static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7110{
7111 ((void) tls_prf);
7112#if defined(MBEDTLS_SHA384_C)
7113 if( tls_prf == tls_prf_sha384 )
7114 {
7115 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7116 }
7117 else
7118#endif
7119#if defined(MBEDTLS_SHA256_C)
7120 if( tls_prf == tls_prf_sha256 )
7121 {
7122 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7123 }
7124 else
7125#endif
7126 return( MBEDTLS_SSL_TLS_PRF_NONE );
7127}
7128
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007129/*
7130 * Populate a transform structure with session keys and all the other
7131 * necessary information.
7132 *
7133 * Parameters:
7134 * - [in/out]: transform: structure to populate
7135 * [in] must be just initialised with mbedtls_ssl_transform_init()
7136 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7137 * - [in] ciphersuite
7138 * - [in] master
7139 * - [in] encrypt_then_mac
7140 * - [in] compression
7141 * - [in] tls_prf: pointer to PRF to use for key derivation
7142 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007143 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007144 * - [in] endpoint: client or server
7145 * - [in] ssl: used for:
7146 * - ssl->conf->{f,p}_export_keys
7147 * [in] optionally used for:
7148 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7149 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007150MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007151static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7152 int ciphersuite,
7153 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007154#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007155 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007156#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007157 ssl_tls_prf_t tls_prf,
7158 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007159 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007160 unsigned endpoint,
7161 const mbedtls_ssl_context *ssl )
7162{
7163 int ret = 0;
7164 unsigned char keyblk[256];
7165 unsigned char *key1;
7166 unsigned char *key2;
7167 unsigned char *mac_enc;
7168 unsigned char *mac_dec;
7169 size_t mac_key_len = 0;
7170 size_t iv_copy_len;
7171 size_t keylen;
7172 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007173 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007174#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007175 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007176 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007177#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007178
7179#if defined(MBEDTLS_USE_PSA_CRYPTO)
7180 psa_key_type_t key_type;
7181 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7182 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007183 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007184 size_t key_bits;
7185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7186#endif
7187
7188#if !defined(MBEDTLS_DEBUG_C) && \
7189 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7190 if( ssl->f_export_keys == NULL )
7191 {
7192 ssl = NULL; /* make sure we don't use it except for these cases */
7193 (void) ssl;
7194 }
7195#endif
7196
7197 /*
7198 * Some data just needs copying into the structure
7199 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007200#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007201 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007202#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007203 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007204
7205#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7206 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7207#endif
7208
7209#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007210 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007211 {
7212 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7213 * generation separate. This should never happen. */
7214 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7215 }
7216#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7217
7218 /*
7219 * Get various info structures
7220 */
7221 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7222 if( ciphersuite_info == NULL )
7223 {
7224 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7225 ciphersuite ) );
7226 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7227 }
7228
Neil Armstrongab555e02022-04-04 11:07:59 +02007229 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007230#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007231 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007232#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007233 ciphersuite_info );
7234
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007235 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7236 transform->taglen =
7237 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7238
7239#if defined(MBEDTLS_USE_PSA_CRYPTO)
7240 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7241 transform->taglen,
7242 &alg,
7243 &key_type,
7244 &key_bits ) ) != PSA_SUCCESS )
7245 {
7246 ret = psa_ssl_status_to_mbedtls( status );
7247 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7248 goto end;
7249 }
7250#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007251 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7252 if( cipher_info == NULL )
7253 {
7254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7255 ciphersuite_info->cipher ) );
7256 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7257 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007258#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007259
Neil Armstronge4512952022-03-08 09:08:22 +01007260#if defined(MBEDTLS_USE_PSA_CRYPTO)
7261 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7262 if( mac_alg == 0 )
7263 {
7264 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7265 (unsigned) ciphersuite_info->mac ) );
7266 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7267 }
7268#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007269 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7270 if( md_info == NULL )
7271 {
7272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7273 (unsigned) ciphersuite_info->mac ) );
7274 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7275 }
Neil Armstronge4512952022-03-08 09:08:22 +01007276#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007277
7278#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7279 /* Copy own and peer's CID if the use of the CID
7280 * extension has been negotiated. */
7281 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7282 {
7283 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7284
7285 transform->in_cid_len = ssl->own_cid_len;
7286 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7287 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7288 transform->in_cid_len );
7289
7290 transform->out_cid_len = ssl->handshake->peer_cid_len;
7291 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7292 ssl->handshake->peer_cid_len );
7293 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7294 transform->out_cid_len );
7295 }
7296#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7297
7298 /*
7299 * Compute key block using the PRF
7300 */
7301 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7302 if( ret != 0 )
7303 {
7304 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7305 return( ret );
7306 }
7307
7308 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7309 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7310 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7311 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7312 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7313
7314 /*
7315 * Determine the appropriate key, IV and MAC length.
7316 */
7317
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007318#if defined(MBEDTLS_USE_PSA_CRYPTO)
7319 keylen = PSA_BITS_TO_BYTES(key_bits);
7320#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007321 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007322#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007323
7324#if defined(MBEDTLS_GCM_C) || \
7325 defined(MBEDTLS_CCM_C) || \
7326 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007327 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007328 {
7329 size_t explicit_ivlen;
7330
7331 transform->maclen = 0;
7332 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007333
7334 /* All modes haves 96-bit IVs, but the length of the static parts vary
7335 * with mode and version:
7336 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7337 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7338 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7339 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7340 * sequence number).
7341 */
7342 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007343#if defined(MBEDTLS_USE_PSA_CRYPTO)
7344 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7345#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007346 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007347#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007348 transform->fixed_ivlen = 12;
7349 else
7350 transform->fixed_ivlen = 4;
7351
7352 /* Minimum length of encrypted record */
7353 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7354 transform->minlen = explicit_ivlen + transform->taglen;
7355 }
7356 else
7357#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7358#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007359 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7360 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7361 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007362 {
Neil Armstronge4512952022-03-08 09:08:22 +01007363#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007364 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007365#else
7366 size_t block_size = cipher_info->block_size;
7367#endif /* MBEDTLS_USE_PSA_CRYPTO */
7368
7369#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007370 /* Get MAC length */
7371 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7372#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007373 /* Initialize HMAC contexts */
7374 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7375 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7376 {
7377 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7378 goto end;
7379 }
7380
7381 /* Get MAC length */
7382 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007383#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007384 transform->maclen = mac_key_len;
7385
7386 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007387#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007388 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007389#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007390 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007391#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007392
7393 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007394 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007395 transform->minlen = transform->maclen;
7396 else
7397 {
7398 /*
7399 * GenericBlockCipher:
7400 * 1. if EtM is in use: one block plus MAC
7401 * otherwise: * first multiple of blocklen greater than maclen
7402 * 2. IV
7403 */
7404#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007405 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007406 {
7407 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007408 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007409 }
7410 else
7411#endif
7412 {
7413 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007414 + block_size
7415 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007416 }
7417
Glenn Strauss07c64162022-03-14 12:34:51 -04007418 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007419 {
7420 transform->minlen += transform->ivlen;
7421 }
7422 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007423 {
7424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7425 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7426 goto end;
7427 }
7428 }
7429 }
7430 else
7431#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7432 {
7433 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7434 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7435 }
7436
7437 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7438 (unsigned) keylen,
7439 (unsigned) transform->minlen,
7440 (unsigned) transform->ivlen,
7441 (unsigned) transform->maclen ) );
7442
7443 /*
7444 * Finally setup the cipher contexts, IVs and MAC secrets.
7445 */
7446#if defined(MBEDTLS_SSL_CLI_C)
7447 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7448 {
7449 key1 = keyblk + mac_key_len * 2;
7450 key2 = keyblk + mac_key_len * 2 + keylen;
7451
7452 mac_enc = keyblk;
7453 mac_dec = keyblk + mac_key_len;
7454
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007455 iv_copy_len = ( transform->fixed_ivlen ) ?
7456 transform->fixed_ivlen : transform->ivlen;
7457 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7458 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7459 iv_copy_len );
7460 }
7461 else
7462#endif /* MBEDTLS_SSL_CLI_C */
7463#if defined(MBEDTLS_SSL_SRV_C)
7464 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7465 {
7466 key1 = keyblk + mac_key_len * 2 + keylen;
7467 key2 = keyblk + mac_key_len * 2;
7468
7469 mac_enc = keyblk + mac_key_len;
7470 mac_dec = keyblk;
7471
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007472 iv_copy_len = ( transform->fixed_ivlen ) ?
7473 transform->fixed_ivlen : transform->ivlen;
7474 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7475 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7476 iv_copy_len );
7477 }
7478 else
7479#endif /* MBEDTLS_SSL_SRV_C */
7480 {
7481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7482 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7483 goto end;
7484 }
7485
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007486 if( ssl != NULL && ssl->f_export_keys != NULL )
7487 {
7488 ssl->f_export_keys( ssl->p_export_keys,
7489 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7490 master, 48,
7491 randbytes + 32,
7492 randbytes,
7493 tls_prf_get_type( tls_prf ) );
7494 }
7495
7496#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007497 transform->psa_alg = alg;
7498
7499 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7500 {
7501 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7502 psa_set_key_algorithm( &attributes, alg );
7503 psa_set_key_type( &attributes, key_type );
7504
7505 if( ( status = psa_import_key( &attributes,
7506 key1,
7507 PSA_BITS_TO_BYTES( key_bits ),
7508 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7509 {
7510 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7511 ret = psa_ssl_status_to_mbedtls( status );
7512 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7513 goto end;
7514 }
7515
7516 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7517
7518 if( ( status = psa_import_key( &attributes,
7519 key2,
7520 PSA_BITS_TO_BYTES( key_bits ),
7521 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7522 {
7523 ret = psa_ssl_status_to_mbedtls( status );
7524 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7525 goto end;
7526 }
7527 }
7528#else
7529 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7530 cipher_info ) ) != 0 )
7531 {
7532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7533 goto end;
7534 }
7535
7536 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7537 cipher_info ) ) != 0 )
7538 {
7539 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7540 goto end;
7541 }
7542
7543 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7544 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7545 MBEDTLS_ENCRYPT ) ) != 0 )
7546 {
7547 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7548 goto end;
7549 }
7550
7551 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7552 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7553 MBEDTLS_DECRYPT ) ) != 0 )
7554 {
7555 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7556 goto end;
7557 }
7558
7559#if defined(MBEDTLS_CIPHER_MODE_CBC)
7560 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7561 {
7562 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7563 MBEDTLS_PADDING_NONE ) ) != 0 )
7564 {
7565 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7566 goto end;
7567 }
7568
7569 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7570 MBEDTLS_PADDING_NONE ) ) != 0 )
7571 {
7572 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7573 goto end;
7574 }
7575 }
7576#endif /* MBEDTLS_CIPHER_MODE_CBC */
7577#endif /* MBEDTLS_USE_PSA_CRYPTO */
7578
Neil Armstrong29c0c042022-03-17 17:47:28 +01007579#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7580 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7581 For AEAD-based ciphersuites, there is nothing to do here. */
7582 if( mac_key_len != 0 )
7583 {
7584#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007585 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007586
7587 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007588 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007589 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7590
7591 if( ( status = psa_import_key( &attributes,
7592 mac_enc, mac_key_len,
7593 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7594 {
7595 ret = psa_ssl_status_to_mbedtls( status );
7596 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7597 goto end;
7598 }
7599
Ronald Cronfb39f152022-03-25 14:36:28 +01007600 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7601 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7602 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007603 /* mbedtls_ct_hmac() requires the key to be exportable */
7604 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7605 PSA_KEY_USAGE_VERIFY_HASH );
7606 else
7607 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7608
7609 if( ( status = psa_import_key( &attributes,
7610 mac_dec, mac_key_len,
7611 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7612 {
7613 ret = psa_ssl_status_to_mbedtls( status );
7614 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7615 goto end;
7616 }
7617#else
7618 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7619 if( ret != 0 )
7620 goto end;
7621 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7622 if( ret != 0 )
7623 goto end;
7624#endif /* MBEDTLS_USE_PSA_CRYPTO */
7625 }
7626#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7627
7628 ((void) mac_dec);
7629 ((void) mac_enc);
7630
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007631end:
7632 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7633 return( ret );
7634}
7635
Jerry Yuee40f9d2022-02-17 14:55:16 +08007636#if defined(MBEDTLS_USE_PSA_CRYPTO)
7637int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7638 unsigned char *hash, size_t *hashlen,
7639 unsigned char *data, size_t data_len,
7640 mbedtls_md_type_t md_alg )
7641{
7642 psa_status_t status;
7643 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7644 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7645
7646 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7647
7648 if( ( status = psa_hash_setup( &hash_operation,
7649 hash_alg ) ) != PSA_SUCCESS )
7650 {
7651 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7652 goto exit;
7653 }
7654
7655 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7656 64 ) ) != PSA_SUCCESS )
7657 {
7658 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7659 goto exit;
7660 }
7661
7662 if( ( status = psa_hash_update( &hash_operation,
7663 data, data_len ) ) != PSA_SUCCESS )
7664 {
7665 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7666 goto exit;
7667 }
7668
7669 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7670 hashlen ) ) != PSA_SUCCESS )
7671 {
7672 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7673 goto exit;
7674 }
7675
7676exit:
7677 if( status != PSA_SUCCESS )
7678 {
7679 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7680 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7681 switch( status )
7682 {
7683 case PSA_ERROR_NOT_SUPPORTED:
7684 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7685 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7686 case PSA_ERROR_BUFFER_TOO_SMALL:
7687 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7688 case PSA_ERROR_INSUFFICIENT_MEMORY:
7689 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7690 default:
7691 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7692 }
7693 }
7694 return( 0 );
7695}
7696
7697#else
7698
7699int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7700 unsigned char *hash, size_t *hashlen,
7701 unsigned char *data, size_t data_len,
7702 mbedtls_md_type_t md_alg )
7703{
7704 int ret = 0;
7705 mbedtls_md_context_t ctx;
7706 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7707 *hashlen = mbedtls_md_get_size( md_info );
7708
7709 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7710
7711 mbedtls_md_init( &ctx );
7712
7713 /*
7714 * digitally-signed struct {
7715 * opaque client_random[32];
7716 * opaque server_random[32];
7717 * ServerDHParams params;
7718 * };
7719 */
7720 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7721 {
7722 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7723 goto exit;
7724 }
7725 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7726 {
7727 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7728 goto exit;
7729 }
7730 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7731 {
7732 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7733 goto exit;
7734 }
7735 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7736 {
7737 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7738 goto exit;
7739 }
7740 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7741 {
7742 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7743 goto exit;
7744 }
7745
7746exit:
7747 mbedtls_md_free( &ctx );
7748
7749 if( ret != 0 )
7750 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7751 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7752
7753 return( ret );
7754}
7755#endif /* MBEDTLS_USE_PSA_CRYPTO */
7756
Jerry Yud9d91da2022-02-17 14:57:06 +08007757#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7758
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007759/* Find the preferred hash for a given signature algorithm. */
7760unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7761 mbedtls_ssl_context *ssl,
7762 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007763{
Gabor Mezei078e8032022-04-27 21:17:56 +02007764 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007765 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007766
7767 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007768 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007769
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007770 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007771 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007772 unsigned int hash_alg_received =
7773 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7774 received_sig_algs[i] );
7775 unsigned int sig_alg_received =
7776 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7777 received_sig_algs[i] );
7778
7779 if( sig_alg == sig_alg_received )
7780 {
7781#if defined(MBEDTLS_USE_PSA_CRYPTO)
7782 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7783 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007784 psa_algorithm_t psa_hash_alg =
7785 mbedtls_psa_translate_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007786
Neil Armstrong96eceb82022-06-30 18:05:05 +02007787 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7788 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7789 PSA_ALG_ECDSA( psa_hash_alg ),
7790 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007791 continue;
7792
Neil Armstrong96eceb82022-06-30 18:05:05 +02007793 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02007794 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7795 PSA_ALG_RSA_PKCS1V15_SIGN(
7796 psa_hash_alg ),
7797 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007798 continue;
7799 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007800#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02007801
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007802 return( hash_alg_received );
7803 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007804 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007805
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007806 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007807}
7808
7809#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7810
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007811/* Serialization of TLS 1.2 sessions:
7812 *
7813 * struct {
7814 * uint64 start_time;
7815 * uint8 ciphersuite[2]; // defined by the standard
7816 * uint8 compression; // 0 or 1
7817 * uint8 session_id_len; // at most 32
7818 * opaque session_id[32];
7819 * opaque master[48]; // fixed length in the standard
7820 * uint32 verify_result;
7821 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7822 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7823 * uint32 ticket_lifetime;
7824 * uint8 mfl_code; // up to 255 according to standard
7825 * uint8 encrypt_then_mac; // 0 or 1
7826 * } serialized_session_tls12;
7827 *
7828 */
7829static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7830 unsigned char *buf,
7831 size_t buf_len )
7832{
7833 unsigned char *p = buf;
7834 size_t used = 0;
7835
7836#if defined(MBEDTLS_HAVE_TIME)
7837 uint64_t start;
7838#endif
7839#if defined(MBEDTLS_X509_CRT_PARSE_C)
7840#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7841 size_t cert_len;
7842#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7843#endif /* MBEDTLS_X509_CRT_PARSE_C */
7844
7845 /*
7846 * Time
7847 */
7848#if defined(MBEDTLS_HAVE_TIME)
7849 used += 8;
7850
7851 if( used <= buf_len )
7852 {
7853 start = (uint64_t) session->start;
7854
7855 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7856 p += 8;
7857 }
7858#endif /* MBEDTLS_HAVE_TIME */
7859
7860 /*
7861 * Basic mandatory fields
7862 */
7863 used += 2 /* ciphersuite */
7864 + 1 /* compression */
7865 + 1 /* id_len */
7866 + sizeof( session->id )
7867 + sizeof( session->master )
7868 + 4; /* verify_result */
7869
7870 if( used <= buf_len )
7871 {
7872 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7873 p += 2;
7874
7875 *p++ = MBEDTLS_BYTE_0( session->compression );
7876
7877 *p++ = MBEDTLS_BYTE_0( session->id_len );
7878 memcpy( p, session->id, 32 );
7879 p += 32;
7880
7881 memcpy( p, session->master, 48 );
7882 p += 48;
7883
7884 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7885 p += 4;
7886 }
7887
7888 /*
7889 * Peer's end-entity certificate
7890 */
7891#if defined(MBEDTLS_X509_CRT_PARSE_C)
7892#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7893 if( session->peer_cert == NULL )
7894 cert_len = 0;
7895 else
7896 cert_len = session->peer_cert->raw.len;
7897
7898 used += 3 + cert_len;
7899
7900 if( used <= buf_len )
7901 {
7902 *p++ = MBEDTLS_BYTE_2( cert_len );
7903 *p++ = MBEDTLS_BYTE_1( cert_len );
7904 *p++ = MBEDTLS_BYTE_0( cert_len );
7905
7906 if( session->peer_cert != NULL )
7907 {
7908 memcpy( p, session->peer_cert->raw.p, cert_len );
7909 p += cert_len;
7910 }
7911 }
7912#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7913 if( session->peer_cert_digest != NULL )
7914 {
7915 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7916 if( used <= buf_len )
7917 {
7918 *p++ = (unsigned char) session->peer_cert_digest_type;
7919 *p++ = (unsigned char) session->peer_cert_digest_len;
7920 memcpy( p, session->peer_cert_digest,
7921 session->peer_cert_digest_len );
7922 p += session->peer_cert_digest_len;
7923 }
7924 }
7925 else
7926 {
7927 used += 2;
7928 if( used <= buf_len )
7929 {
7930 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7931 *p++ = 0;
7932 }
7933 }
7934#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7935#endif /* MBEDTLS_X509_CRT_PARSE_C */
7936
7937 /*
7938 * Session ticket if any, plus associated data
7939 */
7940#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7941 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7942
7943 if( used <= buf_len )
7944 {
7945 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7946 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7947 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7948
7949 if( session->ticket != NULL )
7950 {
7951 memcpy( p, session->ticket, session->ticket_len );
7952 p += session->ticket_len;
7953 }
7954
7955 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7956 p += 4;
7957 }
7958#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7959
7960 /*
7961 * Misc extension-related info
7962 */
7963#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7964 used += 1;
7965
7966 if( used <= buf_len )
7967 *p++ = session->mfl_code;
7968#endif
7969
7970#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7971 used += 1;
7972
7973 if( used <= buf_len )
7974 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7975#endif
7976
7977 return( used );
7978}
7979
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007980MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007981static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7982 const unsigned char *buf,
7983 size_t len )
7984{
7985#if defined(MBEDTLS_HAVE_TIME)
7986 uint64_t start;
7987#endif
7988#if defined(MBEDTLS_X509_CRT_PARSE_C)
7989#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7990 size_t cert_len;
7991#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7992#endif /* MBEDTLS_X509_CRT_PARSE_C */
7993
7994 const unsigned char *p = buf;
7995 const unsigned char * const end = buf + len;
7996
7997 /*
7998 * Time
7999 */
8000#if defined(MBEDTLS_HAVE_TIME)
8001 if( 8 > (size_t)( end - p ) )
8002 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8003
8004 start = ( (uint64_t) p[0] << 56 ) |
8005 ( (uint64_t) p[1] << 48 ) |
8006 ( (uint64_t) p[2] << 40 ) |
8007 ( (uint64_t) p[3] << 32 ) |
8008 ( (uint64_t) p[4] << 24 ) |
8009 ( (uint64_t) p[5] << 16 ) |
8010 ( (uint64_t) p[6] << 8 ) |
8011 ( (uint64_t) p[7] );
8012 p += 8;
8013
8014 session->start = (time_t) start;
8015#endif /* MBEDTLS_HAVE_TIME */
8016
8017 /*
8018 * Basic mandatory fields
8019 */
8020 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
8021 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8022
8023 session->ciphersuite = ( p[0] << 8 ) | p[1];
8024 p += 2;
8025
8026 session->compression = *p++;
8027
8028 session->id_len = *p++;
8029 memcpy( session->id, p, 32 );
8030 p += 32;
8031
8032 memcpy( session->master, p, 48 );
8033 p += 48;
8034
8035 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8036 ( (uint32_t) p[1] << 16 ) |
8037 ( (uint32_t) p[2] << 8 ) |
8038 ( (uint32_t) p[3] );
8039 p += 4;
8040
8041 /* Immediately clear invalid pointer values that have been read, in case
8042 * we exit early before we replaced them with valid ones. */
8043#if defined(MBEDTLS_X509_CRT_PARSE_C)
8044#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8045 session->peer_cert = NULL;
8046#else
8047 session->peer_cert_digest = NULL;
8048#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8049#endif /* MBEDTLS_X509_CRT_PARSE_C */
8050#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8051 session->ticket = NULL;
8052#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8053
8054 /*
8055 * Peer certificate
8056 */
8057#if defined(MBEDTLS_X509_CRT_PARSE_C)
8058#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8059 /* Deserialize CRT from the end of the ticket. */
8060 if( 3 > (size_t)( end - p ) )
8061 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8062
8063 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8064 p += 3;
8065
8066 if( cert_len != 0 )
8067 {
8068 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8069
8070 if( cert_len > (size_t)( end - p ) )
8071 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8072
8073 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8074
8075 if( session->peer_cert == NULL )
8076 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8077
8078 mbedtls_x509_crt_init( session->peer_cert );
8079
8080 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8081 p, cert_len ) ) != 0 )
8082 {
8083 mbedtls_x509_crt_free( session->peer_cert );
8084 mbedtls_free( session->peer_cert );
8085 session->peer_cert = NULL;
8086 return( ret );
8087 }
8088
8089 p += cert_len;
8090 }
8091#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8092 /* Deserialize CRT digest from the end of the ticket. */
8093 if( 2 > (size_t)( end - p ) )
8094 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8095
8096 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8097 session->peer_cert_digest_len = (size_t) *p++;
8098
8099 if( session->peer_cert_digest_len != 0 )
8100 {
8101 const mbedtls_md_info_t *md_info =
8102 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8103 if( md_info == NULL )
8104 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8105 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8107
8108 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8109 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8110
8111 session->peer_cert_digest =
8112 mbedtls_calloc( 1, session->peer_cert_digest_len );
8113 if( session->peer_cert_digest == NULL )
8114 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8115
8116 memcpy( session->peer_cert_digest, p,
8117 session->peer_cert_digest_len );
8118 p += session->peer_cert_digest_len;
8119 }
8120#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8121#endif /* MBEDTLS_X509_CRT_PARSE_C */
8122
8123 /*
8124 * Session ticket and associated data
8125 */
8126#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8127 if( 3 > (size_t)( end - p ) )
8128 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8129
8130 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8131 p += 3;
8132
8133 if( session->ticket_len != 0 )
8134 {
8135 if( session->ticket_len > (size_t)( end - p ) )
8136 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8137
8138 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8139 if( session->ticket == NULL )
8140 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8141
8142 memcpy( session->ticket, p, session->ticket_len );
8143 p += session->ticket_len;
8144 }
8145
8146 if( 4 > (size_t)( end - p ) )
8147 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8148
8149 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8150 ( (uint32_t) p[1] << 16 ) |
8151 ( (uint32_t) p[2] << 8 ) |
8152 ( (uint32_t) p[3] );
8153 p += 4;
8154#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8155
8156 /*
8157 * Misc extension-related info
8158 */
8159#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8160 if( 1 > (size_t)( end - p ) )
8161 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8162
8163 session->mfl_code = *p++;
8164#endif
8165
8166#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8167 if( 1 > (size_t)( end - p ) )
8168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8169
8170 session->encrypt_then_mac = *p++;
8171#endif
8172
8173 /* Done, should have consumed entire buffer */
8174 if( p != end )
8175 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8176
8177 return( 0 );
8178}
Jerry Yudc7bd172022-02-17 13:44:15 +08008179#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8180
XiaokangQian75d40ef2022-04-20 11:05:24 +00008181int mbedtls_ssl_validate_ciphersuite(
8182 const mbedtls_ssl_context *ssl,
8183 const mbedtls_ssl_ciphersuite_t *suite_info,
8184 mbedtls_ssl_protocol_version min_tls_version,
8185 mbedtls_ssl_protocol_version max_tls_version )
8186{
8187 (void) ssl;
8188
8189 if( suite_info == NULL )
8190 return( -1 );
8191
8192 if( ( suite_info->min_tls_version > max_tls_version ) ||
8193 ( suite_info->max_tls_version < min_tls_version ) )
8194 {
8195 return( -1 );
8196 }
8197
XiaokangQian060d8672022-04-21 09:24:56 +00008198#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008199#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8200 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8201 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8202 {
8203 return( -1 );
8204 }
8205#endif
8206
8207 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8208#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8209 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8210 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8211 {
8212 return( -1 );
8213 }
8214#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8215#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8216
8217 return( 0 );
8218}
8219
XiaokangQianeaf36512022-04-24 09:07:44 +00008220#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8221/*
8222 * Function for writing a signature algorithm extension.
8223 *
8224 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8225 * value (TLS 1.3 RFC8446):
8226 * enum {
8227 * ....
8228 * ecdsa_secp256r1_sha256( 0x0403 ),
8229 * ecdsa_secp384r1_sha384( 0x0503 ),
8230 * ecdsa_secp521r1_sha512( 0x0603 ),
8231 * ....
8232 * } SignatureScheme;
8233 *
8234 * struct {
8235 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8236 * } SignatureSchemeList;
8237 *
8238 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8239 * value (TLS 1.2 RFC5246):
8240 * enum {
8241 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8242 * sha512(6), (255)
8243 * } HashAlgorithm;
8244 *
8245 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8246 * SignatureAlgorithm;
8247 *
8248 * struct {
8249 * HashAlgorithm hash;
8250 * SignatureAlgorithm signature;
8251 * } SignatureAndHashAlgorithm;
8252 *
8253 * SignatureAndHashAlgorithm
8254 * supported_signature_algorithms<2..2^16-2>;
8255 *
8256 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8257 * generalization of the TLS 1.2 signature algorithm extension.
8258 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8259 * `SignatureScheme` field of TLS 1.3
8260 *
8261 */
8262int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8263 const unsigned char *end, size_t *out_len )
8264{
8265 unsigned char *p = buf;
8266 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8267 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8268
8269 *out_len = 0;
8270
8271 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8272
8273 /* Check if we have space for header and length field:
8274 * - extension_type (2 bytes)
8275 * - extension_data_length (2 bytes)
8276 * - supported_signature_algorithms_length (2 bytes)
8277 */
8278 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8279 p += 6;
8280
8281 /*
8282 * Write supported_signature_algorithms
8283 */
8284 supported_sig_alg = p;
8285 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8286 if( sig_alg == NULL )
8287 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8288
8289 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8290 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008291 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8292 *sig_alg,
8293 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008294 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8295 continue;
8296 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8297 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8298 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008299 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008300 *sig_alg,
8301 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008302 }
8303
8304 /* Length of supported_signature_algorithms */
8305 supported_sig_alg_len = p - supported_sig_alg;
8306 if( supported_sig_alg_len == 0 )
8307 {
8308 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8309 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8310 }
8311
XiaokangQianeaf36512022-04-24 09:07:44 +00008312 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008313 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008314 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8315
XiaokangQianeaf36512022-04-24 09:07:44 +00008316 *out_len = p - buf;
8317
8318#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8319 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8320#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8321 return( 0 );
8322}
8323#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8324
XiaokangQian40a35232022-05-07 09:02:40 +00008325#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008326/*
8327 * mbedtls_ssl_parse_server_name_ext
8328 *
8329 * Structure of server_name extension:
8330 *
8331 * enum {
8332 * host_name(0), (255)
8333 * } NameType;
8334 * opaque HostName<1..2^16-1>;
8335 *
8336 * struct {
8337 * NameType name_type;
8338 * select (name_type) {
8339 * case host_name: HostName;
8340 * } name;
8341 * } ServerName;
8342 * struct {
8343 * ServerName server_name_list<1..2^16-1>
8344 * } ServerNameList;
8345 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008346MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008347int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8348 const unsigned char *buf,
8349 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008350{
8351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8352 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008353 size_t server_name_list_len, hostname_len;
8354 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008355
XiaokangQianf2a94202022-05-20 06:44:24 +00008356 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008357
8358 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008359 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008360 p += 2;
8361
XiaokangQian9b2b7712022-05-17 02:57:00 +00008362 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8363 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008364 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008365 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008366 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008367 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008368 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8369 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008370
8371 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8372 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008373 /* sni_name is intended to be used only during the parsing of the
8374 * ClientHello message (it is reset to NULL before the end of
8375 * the message parsing). Thus it is ok to just point to the
8376 * reception buffer and not make a copy of it.
8377 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008378 ssl->handshake->sni_name = p + 3;
8379 ssl->handshake->sni_name_len = hostname_len;
8380 if( ssl->conf->f_sni == NULL )
8381 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008382 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008383 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008384 if( ret != 0 )
8385 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008386 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008387 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8388 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008389 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8390 }
8391 return( 0 );
8392 }
8393
8394 p += hostname_len + 3;
8395 }
8396
8397 return( 0 );
8398}
8399#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8400
XiaokangQianacb39922022-06-17 10:18:48 +00008401#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008402MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008403int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8404 const unsigned char *buf,
8405 const unsigned char *end )
8406{
8407 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008408 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008409 const unsigned char *protocol_name_list;
8410 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008411 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008412
8413 /* If ALPN not configured, just ignore the extension */
8414 if( ssl->conf->alpn_list == NULL )
8415 return( 0 );
8416
8417 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008418 * RFC7301, section 3.1
8419 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008420 *
XiaokangQianc7403452022-06-23 03:24:12 +00008421 * struct {
8422 * ProtocolName protocol_name_list<2..2^16-1>
8423 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008424 */
8425
XiaokangQianc7403452022-06-23 03:24:12 +00008426 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008427 * protocol_name_list_len 2 bytes
8428 * protocol_name_len 1 bytes
8429 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008430 */
XiaokangQianacb39922022-06-17 10:18:48 +00008431 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8432
XiaokangQianc7403452022-06-23 03:24:12 +00008433 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008434 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008435 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008436 protocol_name_list = p;
8437 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008438
8439 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008440 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008441 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008442 protocol_name_len = *p++;
8443 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8444 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008445 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008446 {
8447 MBEDTLS_SSL_PEND_FATAL_ALERT(
8448 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8449 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008450 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008451 }
8452
8453 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008454 }
8455
8456 /* Use our order of preference */
8457 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8458 {
8459 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008460 p = protocol_name_list;
8461 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008462 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008463 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008464 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008465 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008466 {
8467 ssl->alpn_chosen = *alpn;
8468 return( 0 );
8469 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008470
8471 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008472 }
8473 }
8474
XiaokangQian95d5f542022-06-24 02:29:26 +00008475 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008476 MBEDTLS_SSL_PEND_FATAL_ALERT(
8477 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8478 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8479 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8480}
8481
8482int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8483 unsigned char *buf,
8484 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008485 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008486{
8487 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008488 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008489 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008490
8491 if( ssl->alpn_chosen == NULL )
8492 {
8493 return( 0 );
8494 }
8495
XiaokangQian95d5f542022-06-24 02:29:26 +00008496 protocol_name_len = strlen( ssl->alpn_chosen );
8497 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008498
8499 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8500 /*
8501 * 0 . 1 ext identifier
8502 * 2 . 3 ext length
8503 * 4 . 5 protocol list length
8504 * 6 . 6 protocol name length
8505 * 7 . 7+n protocol name
8506 */
8507 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8508
XiaokangQian95d5f542022-06-24 02:29:26 +00008509 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008510
XiaokangQian95d5f542022-06-24 02:29:26 +00008511 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8512 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008513 /* Note: the length of the chosen protocol has been checked to be less
8514 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8515 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008516 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008517
XiaokangQian95d5f542022-06-24 02:29:26 +00008518 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008519 return ( 0 );
8520}
8521#endif /* MBEDTLS_SSL_ALPN */
8522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008523#endif /* MBEDTLS_SSL_TLS_C */