blob: 5a72fede49155cd67939324a550f9c4c3cd8f803 [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 );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200446MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800447static int ssl_session_load_tls12( mbedtls_ssl_session *session,
448 const unsigned char *buf,
449 size_t len );
450#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
451
Jerry Yu53d23e22022-02-09 16:25:09 +0800452static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
453
Jerry Yudb8c48a2022-01-27 14:54:54 +0800454#if defined(MBEDTLS_SHA256_C)
455static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800456#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800457
458#if defined(MBEDTLS_SHA384_C)
459static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800460#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000461
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
463 const unsigned char *secret, size_t slen,
464 const char *label,
465 const unsigned char *random, size_t rlen,
466 unsigned char *dstbuf, size_t dlen )
467{
468 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
469
470 switch( prf )
471 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300472#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200473#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 case MBEDTLS_SSL_TLS_PRF_SHA384:
475 tls_prf = tls_prf_sha384;
476 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200477#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300478#if defined(MBEDTLS_SHA256_C)
479 case MBEDTLS_SSL_TLS_PRF_SHA256:
480 tls_prf = tls_prf_sha256;
481 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300482#endif /* MBEDTLS_SHA256_C */
483#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300484 default:
485 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
486 }
487
488 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
489}
490
Jerry Yuc73c6182022-02-08 20:29:25 +0800491#if defined(MBEDTLS_X509_CRT_PARSE_C)
492static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
493{
494#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
495 if( session->peer_cert != NULL )
496 {
497 mbedtls_x509_crt_free( session->peer_cert );
498 mbedtls_free( session->peer_cert );
499 session->peer_cert = NULL;
500 }
501#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
502 if( session->peer_cert_digest != NULL )
503 {
504 /* Zeroization is not necessary. */
505 mbedtls_free( session->peer_cert_digest );
506 session->peer_cert_digest = NULL;
507 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
508 session->peer_cert_digest_len = 0;
509 }
510#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
511}
512#endif /* MBEDTLS_X509_CRT_PARSE_C */
513
514void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
515 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
516{
517 ((void) ciphersuite_info);
518
519#if defined(MBEDTLS_SHA384_C)
520 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
521 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
522 else
523#endif
524#if defined(MBEDTLS_SHA256_C)
525 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
526 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
527 else
528#endif
529 {
530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
531 return;
532 }
533}
534
XiaokangQianadab9a62022-07-18 07:41:26 +0000535void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
536 unsigned hs_type,
537 size_t total_hs_len )
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100538{
539 unsigned char hs_hdr[4];
540
541 /* Build HS header for checksum update. */
542 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
543 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
544 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
545 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
546
547 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
548}
549
550void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
551 unsigned hs_type,
552 unsigned char const *msg,
553 size_t msg_len )
554{
555 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
556 ssl->handshake->update_checksum( ssl, msg, msg_len );
557}
558
Jerry Yuc73c6182022-02-08 20:29:25 +0800559void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
560{
561 ((void) ssl);
562#if defined(MBEDTLS_SHA256_C)
563#if defined(MBEDTLS_USE_PSA_CRYPTO)
564 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
565 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
566#else
567 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
568#endif
569#endif
570#if defined(MBEDTLS_SHA384_C)
571#if defined(MBEDTLS_USE_PSA_CRYPTO)
572 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
573 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
574#else
575 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
576#endif
577#endif
578}
579
580static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
581 const unsigned char *buf, size_t len )
582{
583#if defined(MBEDTLS_SHA256_C)
584#if defined(MBEDTLS_USE_PSA_CRYPTO)
585 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
586#else
587 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
588#endif
589#endif
590#if defined(MBEDTLS_SHA384_C)
591#if defined(MBEDTLS_USE_PSA_CRYPTO)
592 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
593#else
594 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
595#endif
596#endif
597}
598
599#if defined(MBEDTLS_SHA256_C)
600static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
601 const unsigned char *buf, size_t len )
602{
603#if defined(MBEDTLS_USE_PSA_CRYPTO)
604 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
605#else
606 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
607#endif
608}
609#endif
610
611#if defined(MBEDTLS_SHA384_C)
612static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
613 const unsigned char *buf, size_t len )
614{
615#if defined(MBEDTLS_USE_PSA_CRYPTO)
616 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
617#else
618 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
619#endif
620}
621#endif
622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200624{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200625 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500628#if defined(MBEDTLS_USE_PSA_CRYPTO)
629 handshake->fin_sha256_psa = psa_hash_operation_init();
630 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
631#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200633 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200634#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500635#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200636#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500637#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500638 handshake->fin_sha384_psa = psa_hash_operation_init();
639 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500640#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200642 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200643#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500644#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200645
646 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#if defined(MBEDTLS_DHM_C)
649 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200650#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200651#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200653#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200654#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200655 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200656#if defined(MBEDTLS_SSL_CLI_C)
657 handshake->ecjpake_cache = NULL;
658 handshake->ecjpake_cache_len = 0;
659#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200660#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200661
Gilles Peskineeccd8882020-03-10 12:19:08 +0100662#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200663 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200664#endif
665
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200666#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
667 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
668#endif
Hanno Becker75173122019-02-06 16:18:31 +0000669
670#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
671 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
672 mbedtls_pk_init( &handshake->peer_pubkey );
673#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200674}
675
Hanno Beckera18d1322018-01-03 14:27:32 +0000676void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200677{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200679
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100680#if defined(MBEDTLS_USE_PSA_CRYPTO)
681 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
682 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100683#else
684 mbedtls_cipher_init( &transform->cipher_ctx_enc );
685 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100686#endif
687
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000688#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100689#if defined(MBEDTLS_USE_PSA_CRYPTO)
690 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
691 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100692#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 mbedtls_md_init( &transform->md_ctx_enc );
694 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000695#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100696#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200697}
698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200700{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200702}
703
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200704MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200705static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000706{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200707 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000708 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200710 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200712 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200713 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200714
715 /*
716 * Either the pointers are now NULL or cleared properly and can be freed.
717 * Now allocate missing structures.
718 */
719 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200720 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200721 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200722 }
Paul Bakker48916f92012-09-16 19:57:18 +0000723
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200724 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200725 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200726 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200727 }
Paul Bakker48916f92012-09-16 19:57:18 +0000728
Paul Bakker82788fb2014-10-20 13:59:19 +0200729 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200730 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200731 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200732 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500733#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
734 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400735
Andrzej Kurek4a063792020-10-21 15:08:44 +0200736 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
737 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500738#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000739
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200740 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000741 if( ssl->handshake == NULL ||
742 ssl->transform_negotiate == NULL ||
743 ssl->session_negotiate == NULL )
744 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 mbedtls_free( ssl->handshake );
748 mbedtls_free( ssl->transform_negotiate );
749 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200750
751 ssl->handshake = NULL;
752 ssl->transform_negotiate = NULL;
753 ssl->session_negotiate = NULL;
754
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200755 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000756 }
757
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200758 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000760 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200761 ssl_handshake_params_init( ssl->handshake );
762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200763#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200764 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
765 {
766 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200767
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200768 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
769 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
770 else
771 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200772
Hanno Becker0f57a652020-02-05 10:37:26 +0000773 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200774 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200775#endif
776
Brett Warrene0edc842021-08-17 09:53:13 +0100777/*
778 * curve_list is translated to IANA TLS group identifiers here because
779 * mbedtls_ssl_conf_curves returns void and so can't return
780 * any error codes.
781 */
782#if defined(MBEDTLS_ECP_C)
783#if !defined(MBEDTLS_DEPRECATED_REMOVED)
784 /* Heap allocate and translate curve_list from internal to IANA group ids */
785 if ( ssl->conf->curve_list != NULL )
786 {
787 size_t length;
788 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
789
790 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
791 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
792
793 /* Leave room for zero termination */
794 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
795 if ( group_list == NULL )
796 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
797
798 for( size_t i = 0; i < length; i++ )
799 {
800 const mbedtls_ecp_curve_info *info =
801 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
802 if ( info == NULL )
803 {
804 mbedtls_free( group_list );
805 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
806 }
807 group_list[i] = info->tls_id;
808 }
809
810 group_list[length] = 0;
811
812 ssl->handshake->group_list = group_list;
813 ssl->handshake->group_list_heap_allocated = 1;
814 }
815 else
816 {
817 ssl->handshake->group_list = ssl->conf->group_list;
818 ssl->handshake->group_list_heap_allocated = 0;
819 }
820#endif /* MBEDTLS_DEPRECATED_REMOVED */
821#endif /* MBEDTLS_ECP_C */
822
Jerry Yuf017ee42022-01-12 15:49:48 +0800823#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
824#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800825#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800826 /* Heap allocate and translate sig_hashes from internal hash identifiers to
827 signature algorithms IANA identifiers. */
828 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800829 ssl->conf->sig_hashes != NULL )
830 {
831 const int *md;
832 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800833 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800834 uint16_t *p;
835
Jerry Yub476a442022-01-21 18:14:45 +0800836#if defined(static_assert)
837 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
838 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
839 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800840#endif
841
Jerry Yuf017ee42022-01-12 15:49:48 +0800842 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
843 {
844 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
845 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800846#if defined(MBEDTLS_ECDSA_C)
847 sig_algs_len += sizeof( uint16_t );
848#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800849
Jerry Yub476a442022-01-21 18:14:45 +0800850#if defined(MBEDTLS_RSA_C)
851 sig_algs_len += sizeof( uint16_t );
852#endif
853 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
854 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800855 }
856
Jerry Yub476a442022-01-21 18:14:45 +0800857 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800858 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
859
Jerry Yub476a442022-01-21 18:14:45 +0800860 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
861 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800862 if( ssl->handshake->sig_algs == NULL )
863 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
864
865 p = (uint16_t *)ssl->handshake->sig_algs;
866 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
867 {
868 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
869 if( hash == MBEDTLS_SSL_HASH_NONE )
870 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800871#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800872 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
873 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800874#endif
875#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800876 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
877 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800878#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800879 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200880 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800881 ssl->handshake->sig_algs_heap_allocated = 1;
882 }
883 else
Jerry Yua69269a2022-01-17 21:06:01 +0800884#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800885 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800886 ssl->handshake->sig_algs_heap_allocated = 0;
887 }
Jerry Yucc539102022-06-27 16:27:35 +0800888#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800889#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000890 return( 0 );
891}
892
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200893#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200894/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200895MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200896static int ssl_cookie_write_dummy( void *ctx,
897 unsigned char **p, unsigned char *end,
898 const unsigned char *cli_id, size_t cli_id_len )
899{
900 ((void) ctx);
901 ((void) p);
902 ((void) end);
903 ((void) cli_id);
904 ((void) cli_id_len);
905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200907}
908
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200909MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200910static int ssl_cookie_check_dummy( void *ctx,
911 const unsigned char *cookie, size_t cookie_len,
912 const unsigned char *cli_id, size_t cli_id_len )
913{
914 ((void) ctx);
915 ((void) cookie);
916 ((void) cookie_len);
917 ((void) cli_id);
918 ((void) cli_id_len);
919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200921}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200922#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200923
Paul Bakker5121ce52009-01-03 21:22:43 +0000924/*
925 * Initialize an SSL context
926 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200927void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
928{
929 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
930}
931
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200932MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800933static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
934{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100935 const mbedtls_ssl_config *conf = ssl->conf;
936
Ronald Cron6f135e12021-12-08 16:57:54 +0100937#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100938 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
939 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000940 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
941 {
942 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
943 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
944 }
945
Jerry Yu60835a82021-08-04 10:13:52 +0800946 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
947 return( 0 );
948 }
949#endif
950
951#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100952 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800953 {
954 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
955 return( 0 );
956 }
957#endif
958
Ronald Cron6f135e12021-12-08 16:57:54 +0100959#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100960 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800961 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000962 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
963 {
964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
965 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
966 }
967
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000968 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
969 {
970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
971 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
972 }
973
974
Ronald Crone1d3f062022-02-10 14:50:54 +0100975 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
976 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800977 }
978#endif
979
980 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
981 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
982}
983
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200984MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800985static int ssl_conf_check(const mbedtls_ssl_context *ssl)
986{
987 int ret;
988 ret = ssl_conf_version_check( ssl );
989 if( ret != 0 )
990 return( ret );
991
992 /* Space for further checks */
993
994 return( 0 );
995}
996
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200997/*
998 * Setup an SSL context
999 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001000
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001001int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001002 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001003{
Janos Follath865b3eb2019-12-16 11:46:15 +00001004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001005 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1006 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001007
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001008 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001009
Jerry Yu60835a82021-08-04 10:13:52 +08001010 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1011 return( ret );
1012
Paul Bakker62f2dee2012-09-28 07:31:51 +00001013 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001014 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001015 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001016
1017 /* Set to NULL in case of an error condition */
1018 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001019
Darryl Greenb33cc762019-11-28 14:29:44 +00001020#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1021 ssl->in_buf_len = in_buf_len;
1022#endif
1023 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001024 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001025 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001026 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001027 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001028 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001029 }
1030
Darryl Greenb33cc762019-11-28 14:29:44 +00001031#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1032 ssl->out_buf_len = out_buf_len;
1033#endif
1034 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001035 if( ssl->out_buf == NULL )
1036 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001038 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001039 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001040 }
1041
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001042 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001043
Johan Pascalb62bb512015-12-03 21:56:45 +01001044#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001045 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001046#endif
1047
Paul Bakker48916f92012-09-16 19:57:18 +00001048 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001049 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001050
1051 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001052
1053error:
1054 mbedtls_free( ssl->in_buf );
1055 mbedtls_free( ssl->out_buf );
1056
1057 ssl->conf = NULL;
1058
Darryl Greenb33cc762019-11-28 14:29:44 +00001059#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1060 ssl->in_buf_len = 0;
1061 ssl->out_buf_len = 0;
1062#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001063 ssl->in_buf = NULL;
1064 ssl->out_buf = NULL;
1065
1066 ssl->in_hdr = NULL;
1067 ssl->in_ctr = NULL;
1068 ssl->in_len = NULL;
1069 ssl->in_iv = NULL;
1070 ssl->in_msg = NULL;
1071
1072 ssl->out_hdr = NULL;
1073 ssl->out_ctr = NULL;
1074 ssl->out_len = NULL;
1075 ssl->out_iv = NULL;
1076 ssl->out_msg = NULL;
1077
k-stachowiak9f7798e2018-07-31 16:52:32 +02001078 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001079}
1080
1081/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001082 * Reset an initialized and used SSL context for re-use while retaining
1083 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001084 *
1085 * If partial is non-zero, keep data in the input buffer and client ID.
1086 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001087 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001088void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1089 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001090{
Darryl Greenb33cc762019-11-28 14:29:44 +00001091#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1092 size_t in_buf_len = ssl->in_buf_len;
1093 size_t out_buf_len = ssl->out_buf_len;
1094#else
1095 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1096 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1097#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001098
Hanno Beckerb0302c42021-08-03 09:39:42 +01001099#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1100 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001101#endif
1102
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001103 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001104 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001105
Hanno Beckerb0302c42021-08-03 09:39:42 +01001106 mbedtls_ssl_reset_in_out_pointers( ssl );
1107
1108 /* Reset incoming message parsing */
1109 ssl->in_offt = NULL;
1110 ssl->nb_zero = 0;
1111 ssl->in_msgtype = 0;
1112 ssl->in_msglen = 0;
1113 ssl->in_hslen = 0;
1114 ssl->keep_current_message = 0;
1115 ssl->transform_in = NULL;
1116
1117#if defined(MBEDTLS_SSL_PROTO_DTLS)
1118 ssl->next_record_offset = 0;
1119 ssl->in_epoch = 0;
1120#endif
1121
1122 /* Keep current datagram if partial == 1 */
1123 if( partial == 0 )
1124 {
1125 ssl->in_left = 0;
1126 memset( ssl->in_buf, 0, in_buf_len );
1127 }
1128
Ronald Cronad8c17b2022-06-10 17:18:09 +02001129 ssl->send_alert = 0;
1130
Hanno Beckerb0302c42021-08-03 09:39:42 +01001131 /* Reset outgoing message writing */
1132 ssl->out_msgtype = 0;
1133 ssl->out_msglen = 0;
1134 ssl->out_left = 0;
1135 memset( ssl->out_buf, 0, out_buf_len );
1136 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1137 ssl->transform_out = NULL;
1138
1139#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1140 mbedtls_ssl_dtls_replay_reset( ssl );
1141#endif
1142
XiaokangQian2b01dc32022-01-21 02:53:13 +00001143#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001144 if( ssl->transform )
1145 {
1146 mbedtls_ssl_transform_free( ssl->transform );
1147 mbedtls_free( ssl->transform );
1148 ssl->transform = NULL;
1149 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001150#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1151
XiaokangQian2b01dc32022-01-21 02:53:13 +00001152#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1153 mbedtls_ssl_transform_free( ssl->transform_application );
1154 mbedtls_free( ssl->transform_application );
1155 ssl->transform_application = NULL;
1156
1157 if( ssl->handshake != NULL )
1158 {
1159 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1160 mbedtls_free( ssl->handshake->transform_earlydata );
1161 ssl->handshake->transform_earlydata = NULL;
1162
1163 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1164 mbedtls_free( ssl->handshake->transform_handshake );
1165 ssl->handshake->transform_handshake = NULL;
1166 }
1167
XiaokangQian2b01dc32022-01-21 02:53:13 +00001168#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001169}
1170
1171int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1172{
1173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1174
1175 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1176
XiaokangQian78b1fa72022-01-19 06:56:30 +00001177 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001178
1179 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180#if defined(MBEDTLS_SSL_RENEGOTIATION)
1181 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001182 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001183
1184 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1186 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001187#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001189
Hanno Beckerb0302c42021-08-03 09:39:42 +01001190 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001191 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001192 if( ssl->session )
1193 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 mbedtls_ssl_session_free( ssl->session );
1195 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001196 ssl->session = NULL;
1197 }
1198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001200 ssl->alpn_chosen = NULL;
1201#endif
1202
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001203#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001204#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001205 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001206#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001207 {
1208 mbedtls_free( ssl->cli_id );
1209 ssl->cli_id = NULL;
1210 ssl->cli_id_len = 0;
1211 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001212#endif
1213
Paul Bakker48916f92012-09-16 19:57:18 +00001214 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1215 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001216
1217 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001218}
1219
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001220/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001221 * Reset an initialized and used SSL context for re-use while retaining
1222 * all application-set variables, function pointers and data.
1223 */
1224int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1225{
Hanno Becker43aefe22020-02-05 10:44:56 +00001226 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001227}
1228
1229/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001230 * SSL set accessors
1231 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001232void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001233{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001234 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001235}
1236
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001237void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001238{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001239 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001240}
1241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001243void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001244{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001245 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001246}
1247#endif
1248
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001249void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001250{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001251 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001252}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001255
Hanno Becker1841b0a2018-08-24 11:13:57 +01001256void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1257 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001258{
1259 ssl->disable_datagram_packing = !allow_packing;
1260}
1261
1262void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1263 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001264{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001265 conf->hs_timeout_min = min;
1266 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001267}
1268#endif
1269
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001270void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001271{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001272 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001273}
1274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001276void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001277 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001278 void *p_vrfy )
1279{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001280 conf->f_vrfy = f_vrfy;
1281 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001282}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001284
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001285void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001286 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001287 void *p_rng )
1288{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001289 conf->f_rng = f_rng;
1290 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001291}
1292
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001293void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001294 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 void *p_dbg )
1296{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001297 conf->f_dbg = f_dbg;
1298 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001299}
1300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001302 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001303 mbedtls_ssl_send_t *f_send,
1304 mbedtls_ssl_recv_t *f_recv,
1305 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001306{
1307 ssl->p_bio = p_bio;
1308 ssl->f_send = f_send;
1309 ssl->f_recv = f_recv;
1310 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001311}
1312
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001313#if defined(MBEDTLS_SSL_PROTO_DTLS)
1314void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1315{
1316 ssl->mtu = mtu;
1317}
1318#endif
1319
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001320void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001321{
1322 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001323}
1324
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001325void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1326 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001327 mbedtls_ssl_set_timer_t *f_set_timer,
1328 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001329{
1330 ssl->p_timer = p_timer;
1331 ssl->f_set_timer = f_set_timer;
1332 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001333
1334 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001335 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001336}
1337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001339void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001340 void *p_cache,
1341 mbedtls_ssl_cache_get_t *f_get_cache,
1342 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001343{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001344 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001345 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001346 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001347}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350#if defined(MBEDTLS_SSL_CLI_C)
1351int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001352{
Janos Follath865b3eb2019-12-16 11:46:15 +00001353 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001354
1355 if( ssl == NULL ||
1356 session == NULL ||
1357 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001358 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001361 }
1362
Hanno Beckere810bbc2021-05-14 16:01:05 +01001363 if( ssl->handshake->resume == 1 )
1364 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1365
Hanno Becker52055ae2019-02-06 14:30:46 +00001366 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1367 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001368 return( ret );
1369
Paul Bakker0a597072012-09-25 21:55:46 +00001370 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001371
1372 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001373}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001375
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001376void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1377 const int *ciphersuites )
1378{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001379 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001380}
1381
Ronald Cron6f135e12021-12-08 16:57:54 +01001382#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001383void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001384 const int kex_modes )
1385{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001386 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001387}
Ronald Cron6f135e12021-12-08 16:57:54 +01001388#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001391void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001392 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001393{
1394 conf->cert_profile = profile;
1395}
1396
Glenn Strauss36872db2022-01-22 05:06:31 -05001397static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1398{
1399 mbedtls_ssl_key_cert *cur = key_cert, *next;
1400
1401 while( cur != NULL )
1402 {
1403 next = cur->next;
1404 mbedtls_free( cur );
1405 cur = next;
1406 }
1407}
1408
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001409/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001410MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001411static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1412 mbedtls_x509_crt *cert,
1413 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001414{
niisato8ee24222018-06-25 19:05:48 +09001415 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001416
Glenn Strauss36872db2022-01-22 05:06:31 -05001417 if( cert == NULL )
1418 {
1419 /* Free list if cert is null */
1420 ssl_key_cert_free( *head );
1421 *head = NULL;
1422 return( 0 );
1423 }
1424
niisato8ee24222018-06-25 19:05:48 +09001425 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1426 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001427 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001428
niisato8ee24222018-06-25 19:05:48 +09001429 new_cert->cert = cert;
1430 new_cert->key = key;
1431 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001432
Glenn Strauss36872db2022-01-22 05:06:31 -05001433 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001434 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001435 {
niisato8ee24222018-06-25 19:05:48 +09001436 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001437 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001438 else
1439 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001440 mbedtls_ssl_key_cert *cur = *head;
1441 while( cur->next != NULL )
1442 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001443 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001444 }
1445
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001446 return( 0 );
1447}
1448
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001449int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001450 mbedtls_x509_crt *own_cert,
1451 mbedtls_pk_context *pk_key )
1452{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001453 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001454}
1455
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001456void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001457 mbedtls_x509_crt *ca_chain,
1458 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001459{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001460 conf->ca_chain = ca_chain;
1461 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001462
1463#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1464 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1465 * cannot be used together. */
1466 conf->f_ca_cb = NULL;
1467 conf->p_ca_cb = NULL;
1468#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001469}
Hanno Becker5adaad92019-03-27 16:54:37 +00001470
1471#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1472void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001473 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001474 void *p_ca_cb )
1475{
1476 conf->f_ca_cb = f_ca_cb;
1477 conf->p_ca_cb = p_ca_cb;
1478
1479 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1480 * cannot be used together. */
1481 conf->ca_chain = NULL;
1482 conf->ca_crl = NULL;
1483}
1484#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001486
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001487#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001488const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1489 size_t *name_len )
1490{
1491 *name_len = ssl->handshake->sni_name_len;
1492 return( ssl->handshake->sni_name );
1493}
1494
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001495int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1496 mbedtls_x509_crt *own_cert,
1497 mbedtls_pk_context *pk_key )
1498{
1499 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1500 own_cert, pk_key ) );
1501}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001502
1503void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1504 mbedtls_x509_crt *ca_chain,
1505 mbedtls_x509_crl *ca_crl )
1506{
1507 ssl->handshake->sni_ca_chain = ca_chain;
1508 ssl->handshake->sni_ca_crl = ca_crl;
1509}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001510
Glenn Strauss999ef702022-03-11 01:37:23 -05001511#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1512void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1513 const mbedtls_x509_crt *crt)
1514{
1515 ssl->handshake->dn_hints = crt;
1516}
1517#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1518
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001519void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1520 int authmode )
1521{
1522 ssl->handshake->sni_authmode = authmode;
1523}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001524#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1525
Hanno Becker8927c832019-04-03 12:52:50 +01001526#if defined(MBEDTLS_X509_CRT_PARSE_C)
1527void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1528 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1529 void *p_vrfy )
1530{
1531 ssl->f_vrfy = f_vrfy;
1532 ssl->p_vrfy = p_vrfy;
1533}
1534#endif
1535
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001536#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001537/*
1538 * Set EC J-PAKE password for current handshake
1539 */
1540int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1541 const unsigned char *pw,
1542 size_t pw_len )
1543{
1544 mbedtls_ecjpake_role role;
1545
Janos Follath8eb64132016-06-03 15:40:57 +01001546 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001547 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1548
1549 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1550 role = MBEDTLS_ECJPAKE_SERVER;
1551 else
1552 role = MBEDTLS_ECJPAKE_CLIENT;
1553
1554 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1555 role,
1556 MBEDTLS_MD_SHA256,
1557 MBEDTLS_ECP_DP_SECP256R1,
1558 pw, pw_len ) );
1559}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001560#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001561
Gilles Peskineeccd8882020-03-10 12:19:08 +01001562#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001563
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001564MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001565static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1566{
1567#if defined(MBEDTLS_USE_PSA_CRYPTO)
1568 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1569 return( 1 );
1570#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001571 if( conf->psk != NULL )
1572 return( 1 );
1573
1574 return( 0 );
1575}
1576
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001577static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1578{
1579 /* Remove reference to existing PSK, if any. */
1580#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001581 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001582 {
1583 /* The maintenance of the PSK key slot is the
1584 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001585 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001586 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001587#endif /* MBEDTLS_USE_PSA_CRYPTO */
1588 if( conf->psk != NULL )
1589 {
1590 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1591
1592 mbedtls_free( conf->psk );
1593 conf->psk = NULL;
1594 conf->psk_len = 0;
1595 }
1596
1597 /* Remove reference to PSK identity, if any. */
1598 if( conf->psk_identity != NULL )
1599 {
1600 mbedtls_free( conf->psk_identity );
1601 conf->psk_identity = NULL;
1602 conf->psk_identity_len = 0;
1603 }
1604}
1605
Hanno Becker7390c712018-11-15 13:33:04 +00001606/* This function assumes that PSK identity in the SSL config is unset.
1607 * It checks that the provided identity is well-formed and attempts
1608 * to make a copy of it in the SSL config.
1609 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001610MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001611static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1612 unsigned char const *psk_identity,
1613 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001614{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001615 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001616 if( psk_identity == NULL ||
1617 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001618 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001619 {
1620 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1621 }
1622
Hanno Becker7390c712018-11-15 13:33:04 +00001623 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1624 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001625 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001626
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001627 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001628 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001629
1630 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001631}
1632
Hanno Becker7390c712018-11-15 13:33:04 +00001633int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1634 const unsigned char *psk, size_t psk_len,
1635 const unsigned char *psk_identity, size_t psk_identity_len )
1636{
Janos Follath865b3eb2019-12-16 11:46:15 +00001637 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001638
1639 /* We currently only support one PSK, raw or opaque. */
1640 if( ssl_conf_psk_is_configured( conf ) )
1641 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001642
1643 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001644 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001645 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001646 if( psk_len == 0 )
1647 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1648 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1649 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1650
Hanno Becker7390c712018-11-15 13:33:04 +00001651 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1652 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1653 conf->psk_len = psk_len;
1654 memcpy( conf->psk, psk, conf->psk_len );
1655
1656 /* Check and set PSK Identity */
1657 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1658 if( ret != 0 )
1659 ssl_conf_remove_psk( conf );
1660
1661 return( ret );
1662}
1663
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001664static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1665{
1666#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001667 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001668 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001669 /* The maintenance of the external PSK key slot is the
1670 * user's responsibility. */
1671 if( ssl->handshake->psk_opaque_is_internal )
1672 {
1673 psa_destroy_key( ssl->handshake->psk_opaque );
1674 ssl->handshake->psk_opaque_is_internal = 0;
1675 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001676 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001677 }
Neil Armstronge952a302022-05-03 10:22:14 +02001678#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001679 if( ssl->handshake->psk != NULL )
1680 {
1681 mbedtls_platform_zeroize( ssl->handshake->psk,
1682 ssl->handshake->psk_len );
1683 mbedtls_free( ssl->handshake->psk );
1684 ssl->handshake->psk_len = 0;
1685 }
Neil Armstronge952a302022-05-03 10:22:14 +02001686#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001687}
1688
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001689int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1690 const unsigned char *psk, size_t psk_len )
1691{
Neil Armstrong501c9322022-05-03 09:35:09 +02001692#if defined(MBEDTLS_USE_PSA_CRYPTO)
1693 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1694 psa_status_t status;
1695 psa_algorithm_t alg;
1696 mbedtls_svc_key_id_t key;
1697#endif /* MBEDTLS_USE_PSA_CRYPTO */
1698
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001699 if( psk == NULL || ssl->handshake == NULL )
1700 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1701
1702 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1704
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001705 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001706
Neil Armstrong501c9322022-05-03 09:35:09 +02001707#if defined(MBEDTLS_USE_PSA_CRYPTO)
1708 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1709 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1710 else
1711 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1712
1713 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
1714 psa_set_key_algorithm( &key_attributes, alg );
1715 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1716
1717 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1718 if( status != PSA_SUCCESS )
1719 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1720
1721 /* Allow calling psa_destroy_key() on psk remove */
1722 ssl->handshake->psk_opaque_is_internal = 1;
1723 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1724#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001725 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001726 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001727
1728 ssl->handshake->psk_len = psk_len;
1729 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1730
1731 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001732#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001733}
1734
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001735#if defined(MBEDTLS_USE_PSA_CRYPTO)
1736int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001737 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001738 const unsigned char *psk_identity,
1739 size_t psk_identity_len )
1740{
Janos Follath865b3eb2019-12-16 11:46:15 +00001741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001742
1743 /* We currently only support one PSK, raw or opaque. */
1744 if( ssl_conf_psk_is_configured( conf ) )
1745 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001746
Hanno Becker7390c712018-11-15 13:33:04 +00001747 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001748 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001749 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001750 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001751
1752 /* Check and set PSK Identity */
1753 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1754 psk_identity_len );
1755 if( ret != 0 )
1756 ssl_conf_remove_psk( conf );
1757
1758 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001759}
1760
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001761int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1762 mbedtls_svc_key_id_t psk )
1763{
1764 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1765 ( ssl->handshake == NULL ) )
1766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1767
1768 ssl_remove_psk( ssl );
1769 ssl->handshake->psk_opaque = psk;
1770 return( 0 );
1771}
1772#endif /* MBEDTLS_USE_PSA_CRYPTO */
1773
1774void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1775 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1776 size_t),
1777 void *p_psk )
1778{
1779 conf->f_psk = f_psk;
1780 conf->p_psk = p_psk;
1781}
1782#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1783
1784#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001785static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1786 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001787{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001788#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001789 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001790 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001791#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001792 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001793 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001794 return( MBEDTLS_SSL_MODE_STREAM );
1795}
1796
1797#else /* MBEDTLS_USE_PSA_CRYPTO */
1798
1799static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1800 mbedtls_cipher_mode_t mode )
1801{
1802#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1803 if( mode == MBEDTLS_MODE_CBC )
1804 return( MBEDTLS_SSL_MODE_CBC );
1805#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1806
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001807#if defined(MBEDTLS_GCM_C) || \
1808 defined(MBEDTLS_CCM_C) || \
1809 defined(MBEDTLS_CHACHAPOLY_C)
1810 if( mode == MBEDTLS_MODE_GCM ||
1811 mode == MBEDTLS_MODE_CCM ||
1812 mode == MBEDTLS_MODE_CHACHAPOLY )
1813 return( MBEDTLS_SSL_MODE_AEAD );
1814#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001815
1816 return( MBEDTLS_SSL_MODE_STREAM );
1817}
Gilles Peskine301711e2022-04-26 16:57:05 +02001818#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001819
Gilles Peskinee108d982022-04-26 16:50:40 +02001820static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1821 mbedtls_ssl_mode_t base_mode,
1822 int encrypt_then_mac )
1823{
1824#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1825 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1826 base_mode == MBEDTLS_SSL_MODE_CBC )
1827 {
1828 return( MBEDTLS_SSL_MODE_CBC_ETM );
1829 }
1830#else
1831 (void) encrypt_then_mac;
1832#endif
1833 return( base_mode );
1834}
1835
Neil Armstrongab555e02022-04-04 11:07:59 +02001836mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001837 const mbedtls_ssl_transform *transform )
1838{
Gilles Peskinee108d982022-04-26 16:50:40 +02001839 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001840#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001841 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001842#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001843 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1844#endif
1845 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001846
Gilles Peskinee108d982022-04-26 16:50:40 +02001847 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001848#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001849 encrypt_then_mac = transform->encrypt_then_mac;
1850#endif
1851 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001852}
1853
Neil Armstrongab555e02022-04-04 11:07:59 +02001854mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001855#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001856 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001857#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001858 const mbedtls_ssl_ciphersuite_t *suite )
1859{
Gilles Peskinee108d982022-04-26 16:50:40 +02001860 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1861
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001862#if defined(MBEDTLS_USE_PSA_CRYPTO)
1863 psa_status_t status;
1864 psa_algorithm_t alg;
1865 psa_key_type_t type;
1866 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001867 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1868 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001869 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001870#else
1871 const mbedtls_cipher_info_t *cipher =
1872 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001873 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001874 {
1875 base_mode =
1876 mbedtls_ssl_get_base_mode(
1877 mbedtls_cipher_info_get_mode( cipher ) );
1878 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001879#endif /* MBEDTLS_USE_PSA_CRYPTO */
1880
Gilles Peskinee108d982022-04-26 16:50:40 +02001881#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1882 int encrypt_then_mac = 0;
1883#endif
1884 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001885}
1886
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001887#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001888psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001889 size_t taglen,
1890 psa_algorithm_t *alg,
1891 psa_key_type_t *key_type,
1892 size_t *key_size )
1893{
1894 switch ( mbedtls_cipher_type )
1895 {
1896 case MBEDTLS_CIPHER_AES_128_CBC:
1897 *alg = PSA_ALG_CBC_NO_PADDING;
1898 *key_type = PSA_KEY_TYPE_AES;
1899 *key_size = 128;
1900 break;
1901 case MBEDTLS_CIPHER_AES_128_CCM:
1902 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1903 *key_type = PSA_KEY_TYPE_AES;
1904 *key_size = 128;
1905 break;
1906 case MBEDTLS_CIPHER_AES_128_GCM:
1907 *alg = PSA_ALG_GCM;
1908 *key_type = PSA_KEY_TYPE_AES;
1909 *key_size = 128;
1910 break;
1911 case MBEDTLS_CIPHER_AES_192_CCM:
1912 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1913 *key_type = PSA_KEY_TYPE_AES;
1914 *key_size = 192;
1915 break;
1916 case MBEDTLS_CIPHER_AES_192_GCM:
1917 *alg = PSA_ALG_GCM;
1918 *key_type = PSA_KEY_TYPE_AES;
1919 *key_size = 192;
1920 break;
1921 case MBEDTLS_CIPHER_AES_256_CBC:
1922 *alg = PSA_ALG_CBC_NO_PADDING;
1923 *key_type = PSA_KEY_TYPE_AES;
1924 *key_size = 256;
1925 break;
1926 case MBEDTLS_CIPHER_AES_256_CCM:
1927 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1928 *key_type = PSA_KEY_TYPE_AES;
1929 *key_size = 256;
1930 break;
1931 case MBEDTLS_CIPHER_AES_256_GCM:
1932 *alg = PSA_ALG_GCM;
1933 *key_type = PSA_KEY_TYPE_AES;
1934 *key_size = 256;
1935 break;
1936 case MBEDTLS_CIPHER_ARIA_128_CBC:
1937 *alg = PSA_ALG_CBC_NO_PADDING;
1938 *key_type = PSA_KEY_TYPE_ARIA;
1939 *key_size = 128;
1940 break;
1941 case MBEDTLS_CIPHER_ARIA_128_CCM:
1942 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1943 *key_type = PSA_KEY_TYPE_ARIA;
1944 *key_size = 128;
1945 break;
1946 case MBEDTLS_CIPHER_ARIA_128_GCM:
1947 *alg = PSA_ALG_GCM;
1948 *key_type = PSA_KEY_TYPE_ARIA;
1949 *key_size = 128;
1950 break;
1951 case MBEDTLS_CIPHER_ARIA_192_CCM:
1952 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1953 *key_type = PSA_KEY_TYPE_ARIA;
1954 *key_size = 192;
1955 break;
1956 case MBEDTLS_CIPHER_ARIA_192_GCM:
1957 *alg = PSA_ALG_GCM;
1958 *key_type = PSA_KEY_TYPE_ARIA;
1959 *key_size = 192;
1960 break;
1961 case MBEDTLS_CIPHER_ARIA_256_CBC:
1962 *alg = PSA_ALG_CBC_NO_PADDING;
1963 *key_type = PSA_KEY_TYPE_ARIA;
1964 *key_size = 256;
1965 break;
1966 case MBEDTLS_CIPHER_ARIA_256_CCM:
1967 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1968 *key_type = PSA_KEY_TYPE_ARIA;
1969 *key_size = 256;
1970 break;
1971 case MBEDTLS_CIPHER_ARIA_256_GCM:
1972 *alg = PSA_ALG_GCM;
1973 *key_type = PSA_KEY_TYPE_ARIA;
1974 *key_size = 256;
1975 break;
1976 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1977 *alg = PSA_ALG_CBC_NO_PADDING;
1978 *key_type = PSA_KEY_TYPE_CAMELLIA;
1979 *key_size = 128;
1980 break;
1981 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1982 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1983 *key_type = PSA_KEY_TYPE_CAMELLIA;
1984 *key_size = 128;
1985 break;
1986 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1987 *alg = PSA_ALG_GCM;
1988 *key_type = PSA_KEY_TYPE_CAMELLIA;
1989 *key_size = 128;
1990 break;
1991 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1992 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1993 *key_type = PSA_KEY_TYPE_CAMELLIA;
1994 *key_size = 192;
1995 break;
1996 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1997 *alg = PSA_ALG_GCM;
1998 *key_type = PSA_KEY_TYPE_CAMELLIA;
1999 *key_size = 192;
2000 break;
2001 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2002 *alg = PSA_ALG_CBC_NO_PADDING;
2003 *key_type = PSA_KEY_TYPE_CAMELLIA;
2004 *key_size = 256;
2005 break;
2006 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2007 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2008 *key_type = PSA_KEY_TYPE_CAMELLIA;
2009 *key_size = 256;
2010 break;
2011 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2012 *alg = PSA_ALG_GCM;
2013 *key_type = PSA_KEY_TYPE_CAMELLIA;
2014 *key_size = 256;
2015 break;
2016 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2017 *alg = PSA_ALG_CHACHA20_POLY1305;
2018 *key_type = PSA_KEY_TYPE_CHACHA20;
2019 *key_size = 256;
2020 break;
2021 case MBEDTLS_CIPHER_NULL:
2022 *alg = MBEDTLS_SSL_NULL_CIPHER;
2023 *key_type = 0;
2024 *key_size = 0;
2025 break;
2026 default:
2027 return PSA_ERROR_NOT_SUPPORTED;
2028 }
2029
2030 return PSA_SUCCESS;
2031}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002032#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002033
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002034#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002035int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2036 const unsigned char *dhm_P, size_t P_len,
2037 const unsigned char *dhm_G, size_t G_len )
2038{
Janos Follath865b3eb2019-12-16 11:46:15 +00002039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002040
Glenn Strausscee11292021-12-20 01:43:17 -05002041 mbedtls_mpi_free( &conf->dhm_P );
2042 mbedtls_mpi_free( &conf->dhm_G );
2043
Hanno Beckera90658f2017-10-04 15:29:08 +01002044 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2045 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2046 {
2047 mbedtls_mpi_free( &conf->dhm_P );
2048 mbedtls_mpi_free( &conf->dhm_G );
2049 return( ret );
2050 }
2051
2052 return( 0 );
2053}
Paul Bakker5121ce52009-01-03 21:22:43 +00002054
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002055int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002056{
Janos Follath865b3eb2019-12-16 11:46:15 +00002057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002058
Glenn Strausscee11292021-12-20 01:43:17 -05002059 mbedtls_mpi_free( &conf->dhm_P );
2060 mbedtls_mpi_free( &conf->dhm_G );
2061
Gilles Peskinee5702482021-06-11 21:59:08 +02002062 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2063 &conf->dhm_P ) ) != 0 ||
2064 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2065 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002066 {
2067 mbedtls_mpi_free( &conf->dhm_P );
2068 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002069 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002070 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002071
2072 return( 0 );
2073}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002074#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002075
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002076#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2077/*
2078 * Set the minimum length for Diffie-Hellman parameters
2079 */
2080void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2081 unsigned int bitlen )
2082{
2083 conf->dhm_min_bitlen = bitlen;
2084}
2085#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2086
Gilles Peskineeccd8882020-03-10 12:19:08 +01002087#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002088#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002089/*
2090 * Set allowed/preferred hashes for handshake signatures
2091 */
2092void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2093 const int *hashes )
2094{
2095 conf->sig_hashes = hashes;
2096}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002097#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002098
Jerry Yuf017ee42022-01-12 15:49:48 +08002099/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002100void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2101 const uint16_t* sig_algs )
2102{
Jerry Yuf017ee42022-01-12 15:49:48 +08002103#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2104 conf->sig_hashes = NULL;
2105#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2106 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002107}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002108#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002109
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002110#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002111#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002112/*
2113 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002114 *
2115 * mbedtls_ssl_setup() takes the provided list
2116 * and translates it to a list of IANA TLS group identifiers,
2117 * stored in ssl->handshake->group_list.
2118 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002119 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002120void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002121 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002122{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002123 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002124 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002125}
Brett Warrene0edc842021-08-17 09:53:13 +01002126#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002127#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002128
Brett Warrene0edc842021-08-17 09:53:13 +01002129/*
2130 * Set the allowed groups
2131 */
2132void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2133 const uint16_t *group_list )
2134{
2135#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2136 conf->curve_list = NULL;
2137#endif
2138 conf->group_list = group_list;
2139}
2140
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002141#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002143{
Hanno Becker947194e2017-04-07 13:25:49 +01002144 /* Initialize to suppress unnecessary compiler warning */
2145 size_t hostname_len = 0;
2146
2147 /* Check if new hostname is valid before
2148 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002149 if( hostname != NULL )
2150 {
2151 hostname_len = strlen( hostname );
2152
2153 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2154 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2155 }
2156
2157 /* Now it's clear that we will overwrite the old hostname,
2158 * so we can free it safely */
2159
2160 if( ssl->hostname != NULL )
2161 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002162 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002163 mbedtls_free( ssl->hostname );
2164 }
2165
2166 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002167
Paul Bakker5121ce52009-01-03 21:22:43 +00002168 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002169 {
2170 ssl->hostname = NULL;
2171 }
2172 else
2173 {
2174 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002175 if( ssl->hostname == NULL )
2176 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002177
Hanno Becker947194e2017-04-07 13:25:49 +01002178 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002179
Hanno Becker947194e2017-04-07 13:25:49 +01002180 ssl->hostname[hostname_len] = '\0';
2181 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002182
2183 return( 0 );
2184}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002185#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002186
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002187#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002188void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002190 const unsigned char *, size_t),
2191 void *p_sni )
2192{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002193 conf->f_sni = f_sni;
2194 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002195}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002199int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002200{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002201 size_t cur_len, tot_len;
2202 const char **p;
2203
2204 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002205 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2206 * MUST NOT be truncated."
2207 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002208 */
2209 tot_len = 0;
2210 for( p = protos; *p != NULL; p++ )
2211 {
2212 cur_len = strlen( *p );
2213 tot_len += cur_len;
2214
Ronald Cron8216dd32020-04-23 16:41:44 +02002215 if( ( cur_len == 0 ) ||
2216 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2217 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002219 }
2220
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002221 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002222
2223 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002224}
2225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002227{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002228 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002229}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002231
Johan Pascalb62bb512015-12-03 21:56:45 +01002232#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002233void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2234 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002235{
2236 conf->dtls_srtp_mki_support = support_mki_value;
2237}
2238
Ron Eldoref72faf2018-07-12 11:54:20 +03002239int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2240 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002241 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002242{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002243 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002244 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002245 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002246 }
Ron Eldor591f1622018-01-22 12:30:04 +02002247
2248 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002249 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002250 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002251 }
Ron Eldor591f1622018-01-22 12:30:04 +02002252
2253 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2254 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002255 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002256}
2257
Ron Eldoref72faf2018-07-12 11:54:20 +03002258int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002259 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002260{
Johan Pascal253d0262020-09-22 13:04:45 +02002261 const mbedtls_ssl_srtp_profile *p;
2262 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002263
Johan Pascal253d0262020-09-22 13:04:45 +02002264 /* check the profiles list: all entry must be valid,
2265 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002266 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2267 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2268 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002269 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002270 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002271 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002272 list_size++;
2273 }
2274 else
2275 {
2276 /* unsupported value, stop parsing and set the size to an error value */
2277 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002278 }
2279 }
2280
Johan Pascal5ef72d22020-10-28 17:05:47 +01002281 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002282 {
Johan Pascal253d0262020-09-22 13:04:45 +02002283 conf->dtls_srtp_profile_list = NULL;
2284 conf->dtls_srtp_profile_list_len = 0;
2285 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2286 }
2287
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002288 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002289 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002290
2291 return( 0 );
2292}
2293
Johan Pascal5ef72d22020-10-28 17:05:47 +01002294void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2295 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002296{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002297 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2298 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002299 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002300 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002301 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002302 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002303 else
2304 {
2305 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002306 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2307 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002308 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002309}
Johan Pascalb62bb512015-12-03 21:56:45 +01002310#endif /* MBEDTLS_SSL_DTLS_SRTP */
2311
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002312void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002313{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002314 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002315}
2316
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002317void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002318{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002319 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002320}
2321
Janos Follath088ce432017-04-10 12:42:31 +01002322#if defined(MBEDTLS_SSL_SRV_C)
2323void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2324 char cert_req_ca_list )
2325{
2326 conf->cert_req_ca_list = cert_req_ca_list;
2327}
2328#endif
2329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002331void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002332{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002333 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002334}
2335#endif
2336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002338void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002339{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002340 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002341}
2342#endif
2343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002345int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002346{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002348 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002351 }
2352
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002353 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002354
2355 return( 0 );
2356}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002358
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002359void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002360{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002361 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002362}
2363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002365void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002366{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002367 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002368}
2369
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002370void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002371{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002372 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002373}
2374
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002375void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002376 const unsigned char period[8] )
2377{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002378 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002379}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002380#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002381
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002383#if defined(MBEDTLS_SSL_CLI_C)
2384void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002385{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002386 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002387}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002388#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002389
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002390#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002391void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2392 mbedtls_ssl_ticket_write_t *f_ticket_write,
2393 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2394 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002395{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002396 conf->f_ticket_write = f_ticket_write;
2397 conf->f_ticket_parse = f_ticket_parse;
2398 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002399}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002400#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002402
Hanno Becker7e6c1782021-06-08 09:24:55 +01002403void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2404 mbedtls_ssl_export_keys_t *f_export_keys,
2405 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002406{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002407 ssl->f_export_keys = f_export_keys;
2408 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002409}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002410
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002411#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002412void mbedtls_ssl_conf_async_private_cb(
2413 mbedtls_ssl_config *conf,
2414 mbedtls_ssl_async_sign_t *f_async_sign,
2415 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2416 mbedtls_ssl_async_resume_t *f_async_resume,
2417 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002418 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002419{
2420 conf->f_async_sign_start = f_async_sign;
2421 conf->f_async_decrypt_start = f_async_decrypt;
2422 conf->f_async_resume = f_async_resume;
2423 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002424 conf->p_async_config_data = async_config_data;
2425}
2426
Gilles Peskine8f97af72018-04-26 11:46:10 +02002427void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2428{
2429 return( conf->p_async_config_data );
2430}
2431
Gilles Peskine1febfef2018-04-30 11:54:39 +02002432void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002433{
2434 if( ssl->handshake == NULL )
2435 return( NULL );
2436 else
2437 return( ssl->handshake->user_async_ctx );
2438}
2439
Gilles Peskine1febfef2018-04-30 11:54:39 +02002440void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002441 void *ctx )
2442{
2443 if( ssl->handshake != NULL )
2444 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002445}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002446#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002447
Paul Bakker5121ce52009-01-03 21:22:43 +00002448/*
2449 * SSL get accessors
2450 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002451uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002452{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002453 if( ssl->session != NULL )
2454 return( ssl->session->verify_result );
2455
2456 if( ssl->session_negotiate != NULL )
2457 return( ssl->session_negotiate->verify_result );
2458
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002459 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002460}
2461
Glenn Strauss8f526902022-01-13 00:04:49 -05002462int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2463{
2464 if( ssl == NULL || ssl->session == NULL )
2465 return( 0 );
2466
2467 return( ssl->session->ciphersuite );
2468}
2469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002471{
Paul Bakker926c8e42013-03-06 10:23:34 +01002472 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002473 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002476}
2477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002479{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002481 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002482 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002483 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002484 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002485 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002486 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002487 default:
2488 return( "unknown (DTLS)" );
2489 }
2490 }
2491#endif
2492
Glenn Strauss60bfe602022-03-14 19:04:24 -04002493 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002494 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002495 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002496 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002497 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002498 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002499 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002500 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002501 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002502}
2503
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002504#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002505size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2506{
David Horstmann95d516f2021-05-04 18:36:56 +01002507 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002508 size_t read_mfl;
2509
2510 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2511 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2512 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2513 {
2514 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2515 }
2516
2517 /* Check if a smaller max length was negotiated */
2518 if( ssl->session_out != NULL )
2519 {
2520 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2521 if( read_mfl < max_len )
2522 {
2523 max_len = read_mfl;
2524 }
2525 }
2526
2527 // During a handshake, use the value being negotiated
2528 if( ssl->session_negotiate != NULL )
2529 {
2530 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2531 if( read_mfl < max_len )
2532 {
2533 max_len = read_mfl;
2534 }
2535 }
2536
2537 return( max_len );
2538}
2539
2540size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002541{
2542 size_t max_len;
2543
2544 /*
2545 * Assume mfl_code is correct since it was checked when set
2546 */
Angus Grattond8213d02016-05-25 20:56:48 +10002547 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002548
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002549 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002550 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002551 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002552 {
Angus Grattond8213d02016-05-25 20:56:48 +10002553 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002554 }
2555
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002556 /* During a handshake, use the value being negotiated */
2557 if( ssl->session_negotiate != NULL &&
2558 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2559 {
2560 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2561 }
2562
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002563 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002564}
2565#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2566
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002567#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002568size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002569{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002570 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2571 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2572 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2573 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2574 return ( 0 );
2575
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002576 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2577 return( ssl->mtu );
2578
2579 if( ssl->mtu == 0 )
2580 return( ssl->handshake->mtu );
2581
2582 return( ssl->mtu < ssl->handshake->mtu ?
2583 ssl->mtu : ssl->handshake->mtu );
2584}
2585#endif /* MBEDTLS_SSL_PROTO_DTLS */
2586
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002587int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2588{
2589 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2590
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002591#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2592 !defined(MBEDTLS_SSL_PROTO_DTLS)
2593 (void) ssl;
2594#endif
2595
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002596#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002597 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002598
2599 if( max_len > mfl )
2600 max_len = mfl;
2601#endif
2602
2603#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002604 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002605 {
Hanno Becker89490712020-02-05 10:50:12 +00002606 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002607 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2608 const size_t overhead = (size_t) ret;
2609
2610 if( ret < 0 )
2611 return( ret );
2612
2613 if( mtu <= overhead )
2614 {
2615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2616 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2617 }
2618
2619 if( max_len > mtu - overhead )
2620 max_len = mtu - overhead;
2621 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002622#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002623
Hanno Becker0defedb2018-08-10 12:35:02 +01002624#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2625 !defined(MBEDTLS_SSL_PROTO_DTLS)
2626 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002627#endif
2628
2629 return( (int) max_len );
2630}
2631
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002632int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2633{
2634 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2635
2636#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2637 (void) ssl;
2638#endif
2639
2640#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2641 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2642
2643 if( max_len > mfl )
2644 max_len = mfl;
2645#endif
2646
2647 return( (int) max_len );
2648}
2649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650#if defined(MBEDTLS_X509_CRT_PARSE_C)
2651const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002652{
2653 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002654 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002655
Hanno Beckere6824572019-02-07 13:18:46 +00002656#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002657 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002658#else
2659 return( NULL );
2660#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002665int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2666 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002667{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002668 int ret;
2669
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002670 if( ssl == NULL ||
2671 dst == NULL ||
2672 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002673 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002674 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002676 }
2677
Hanno Beckere810bbc2021-05-14 16:01:05 +01002678 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2679 * idempotent: Each session can only be exported once.
2680 *
2681 * (This is in preparation for TLS 1.3 support where we will
2682 * need the ability to export multiple sessions (aka tickets),
2683 * which will be achieved by calling mbedtls_ssl_get_session()
2684 * multiple times until it fails.)
2685 *
2686 * Check whether we have already exported the current session,
2687 * and fail if so.
2688 */
2689 if( ssl->session->exported == 1 )
2690 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2691
2692 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2693 if( ret != 0 )
2694 return( ret );
2695
2696 /* Remember that we've exported the session. */
2697 ssl->session->exported = 1;
2698 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002699}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002701
Paul Bakker5121ce52009-01-03 21:22:43 +00002702/*
Hanno Beckera835da52019-05-16 12:39:07 +01002703 * Define ticket header determining Mbed TLS version
2704 * and structure of the ticket.
2705 */
2706
Hanno Becker94ef3b32019-05-16 12:50:45 +01002707/*
Hanno Becker50b59662019-05-28 14:30:45 +01002708 * Define bitflag determining compile-time settings influencing
2709 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002710 */
2711
Hanno Becker50b59662019-05-28 14:30:45 +01002712#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002713#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002714#else
Hanno Becker3e088662019-05-29 11:10:18 +01002715#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002716#endif /* MBEDTLS_HAVE_TIME */
2717
2718#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002719#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002720#else
Hanno Becker3e088662019-05-29 11:10:18 +01002721#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002722#endif /* MBEDTLS_X509_CRT_PARSE_C */
2723
2724#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002725#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002726#else
Hanno Becker3e088662019-05-29 11:10:18 +01002727#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002728#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2729
2730#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002731#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002732#else
Hanno Becker3e088662019-05-29 11:10:18 +01002733#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002734#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2735
Hanno Becker94ef3b32019-05-16 12:50:45 +01002736#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002737#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002738#else
Hanno Becker3e088662019-05-29 11:10:18 +01002739#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002740#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2741
Hanno Becker94ef3b32019-05-16 12:50:45 +01002742#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2743#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2744#else
2745#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2746#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2747
Hanno Becker3e088662019-05-29 11:10:18 +01002748#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2749#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2750#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2751#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002752#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2753#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002754
Hanno Becker50b59662019-05-28 14:30:45 +01002755#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002756 ( (uint16_t) ( \
2757 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2758 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2759 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2760 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002761 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002762 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002763
Hanno Beckerf8787072019-05-16 12:41:07 +01002764static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002765 MBEDTLS_VERSION_MAJOR,
2766 MBEDTLS_VERSION_MINOR,
2767 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002768 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2769 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002770};
Hanno Beckera835da52019-05-16 12:39:07 +01002771
2772/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002773 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002774 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002775 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002776 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002777 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002778 * opaque mbedtls_version[3]; // library version: major, minor, patch
2779 * opaque session_format[2]; // library-version specific 16-bit field
2780 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002781 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002782 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002783 * Note: When updating the format, remember to keep
2784 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002785 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002786 * // In this version, `session_format` determines
2787 * // the setting of those compile-time
2788 * // configuration options which influence
2789 * // the structure of mbedtls_ssl_session.
2790 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002791 * uint8_t minor_ver; // Protocol minor version. Possible values:
2792 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002793 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002794 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002795 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002796 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002797 * serialized_session_tls12 data;
2798 *
2799 * };
2800 *
2801 * } serialized_session;
2802 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002803 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002804
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002805MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002806static int ssl_session_save( const mbedtls_ssl_session *session,
2807 unsigned char omit_header,
2808 unsigned char *buf,
2809 size_t buf_len,
2810 size_t *olen )
2811{
2812 unsigned char *p = buf;
2813 size_t used = 0;
2814
2815 if( !omit_header )
2816 {
2817 /*
2818 * Add Mbed TLS version identifier
2819 */
2820
2821 used += sizeof( ssl_serialized_session_header );
2822
2823 if( used <= buf_len )
2824 {
2825 memcpy( p, ssl_serialized_session_header,
2826 sizeof( ssl_serialized_session_header ) );
2827 p += sizeof( ssl_serialized_session_header );
2828 }
2829 }
2830
2831 /*
2832 * TLS version identifier
2833 */
2834 used += 1;
2835 if( used <= buf_len )
2836 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002837 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002838 }
2839
2840 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002841 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002842 {
2843#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002844 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002845 {
2846 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2847 used += ssl_session_save_tls12( session, p, remaining_len );
2848 break;
2849 }
2850#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2851
2852 default:
2853 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2854 }
2855
2856 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002857 if( used > buf_len )
2858 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002859
2860 return( 0 );
2861}
2862
2863/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002864 * Public wrapper for ssl_session_save()
2865 */
2866int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2867 unsigned char *buf,
2868 size_t buf_len,
2869 size_t *olen )
2870{
2871 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2872}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002873
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002874/*
2875 * Deserialize session, see mbedtls_ssl_session_save() for format.
2876 *
2877 * This internal version is wrapped by a public function that cleans up in
2878 * case of error, and has an extra option omit_header.
2879 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002880MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002881static int ssl_session_load( mbedtls_ssl_session *session,
2882 unsigned char omit_header,
2883 const unsigned char *buf,
2884 size_t len )
2885{
2886 const unsigned char *p = buf;
2887 const unsigned char * const end = buf + len;
2888
2889 if( !omit_header )
2890 {
2891 /*
2892 * Check Mbed TLS version identifier
2893 */
2894
2895 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2896 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2897
2898 if( memcmp( p, ssl_serialized_session_header,
2899 sizeof( ssl_serialized_session_header ) ) != 0 )
2900 {
2901 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2902 }
2903 p += sizeof( ssl_serialized_session_header );
2904 }
2905
2906 /*
2907 * TLS version identifier
2908 */
2909 if( 1 > (size_t)( end - p ) )
2910 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002911 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002912
2913 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002914 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002915 {
2916#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002917 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002918 {
2919 size_t remaining_len = ( end - p );
2920 return( ssl_session_load_tls12( session, p, remaining_len ) );
2921 }
2922#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2923
2924 default:
2925 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2926 }
2927}
2928
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002929/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002930 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002931 */
2932int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2933 const unsigned char *buf,
2934 size_t len )
2935{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002936 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002937
2938 if( ret != 0 )
2939 mbedtls_ssl_session_free( session );
2940
2941 return( ret );
2942}
2943
2944/*
Paul Bakker1961b702013-01-25 14:49:24 +01002945 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002946 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002947MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01002948static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2949{
2950 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2951
Ronald Cron66dbf912022-02-02 15:33:46 +01002952 /*
2953 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002954 * that were written into the output buffer by the previous handshake step,
2955 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002956 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2957 * We proceed to the next handshake step only when all data from the
2958 * previous one have been sent to the peer, thus we make sure that this is
2959 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2960 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2961 * we have to wait before to go ahead.
2962 * In the case of TLS 1.3, handshake step handlers do not send data to the
2963 * peer. Data are only sent here and through
2964 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002965 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002966 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002967 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2968 return( ret );
2969
2970#if defined(MBEDTLS_SSL_PROTO_DTLS)
2971 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2972 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2973 {
2974 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2975 return( ret );
2976 }
2977#endif /* MBEDTLS_SSL_PROTO_DTLS */
2978
2979 return( ret );
2980}
2981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002983{
Hanno Becker41934dd2021-08-07 19:13:43 +01002984 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002985
Hanno Becker41934dd2021-08-07 19:13:43 +01002986 if( ssl == NULL ||
2987 ssl->conf == NULL ||
2988 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002989 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002990 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002991 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002992 }
2993
2994 ret = ssl_prepare_handshake_step( ssl );
2995 if( ret != 0 )
2996 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002997
Jerry Yue7047812021-09-13 19:26:39 +08002998 ret = mbedtls_ssl_handle_pending_alert( ssl );
2999 if( ret != 0 )
3000 goto cleanup;
3001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003003 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003004 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003005 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3006 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003007
Ronald Cron9f0fba32022-02-10 16:45:15 +01003008 switch( ssl->state )
3009 {
3010 case MBEDTLS_SSL_HELLO_REQUEST:
3011 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3012 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003013
Ronald Cron9f0fba32022-02-10 16:45:15 +01003014 case MBEDTLS_SSL_CLIENT_HELLO:
3015 ret = mbedtls_ssl_write_client_hello( ssl );
3016 break;
3017
3018 default:
3019#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003020 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003021 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3022 else
3023 ret = mbedtls_ssl_handshake_client_step( ssl );
3024#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3025 ret = mbedtls_ssl_handshake_client_step( ssl );
3026#else
3027 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3028#endif
3029 }
Jerry Yub9930e72021-08-06 17:11:51 +08003030 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003031#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003033 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003034 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003035#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003036 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003037 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003038#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003039
3040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3041 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3042 ret = mbedtls_ssl_handshake_server_step( ssl );
3043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3044 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003045#endif
3046
Jerry Yue7047812021-09-13 19:26:39 +08003047 if( ret != 0 )
3048 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003049 /* handshake_step return error. And it is same
3050 * with alert_reason.
3051 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003052 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003053 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003054 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003055 goto cleanup;
3056 }
3057 }
3058
3059cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003060 return( ret );
3061}
3062
3063/*
3064 * Perform the SSL handshake
3065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003067{
3068 int ret = 0;
3069
Hanno Beckera817ea42020-10-20 15:20:23 +01003070 /* Sanity checks */
3071
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003072 if( ssl == NULL || ssl->conf == NULL )
3073 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3074
Hanno Beckera817ea42020-10-20 15:20:23 +01003075#if defined(MBEDTLS_SSL_PROTO_DTLS)
3076 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3077 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3078 {
3079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3080 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3081 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3082 }
3083#endif /* MBEDTLS_SSL_PROTO_DTLS */
3084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003086
Hanno Beckera817ea42020-10-20 15:20:23 +01003087 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003088 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003089 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003091
3092 if( ret != 0 )
3093 break;
3094 }
3095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003097
3098 return( ret );
3099}
3100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101#if defined(MBEDTLS_SSL_RENEGOTIATION)
3102#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003103/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003104 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003105 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003106MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003108{
Janos Follath865b3eb2019-12-16 11:46:15 +00003109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003112
3113 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3115 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003116
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003117 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003118 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003119 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003120 return( ret );
3121 }
3122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003124
3125 return( 0 );
3126}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003128
3129/*
3130 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131 * - any side: calling mbedtls_ssl_renegotiate(),
3132 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3133 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003134 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003135 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003137 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003138int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003139{
Janos Follath865b3eb2019-12-16 11:46:15 +00003140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003143
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003144 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3145 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003146
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003147 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3148 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003150 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003152 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003153 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003154 ssl->handshake->out_msg_seq = 1;
3155 else
3156 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003157 }
3158#endif
3159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3161 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003166 return( ret );
3167 }
3168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003170
3171 return( 0 );
3172}
3173
3174/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003175 * Renegotiate current connection on client,
3176 * or request renegotiation on server
3177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003179{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003180 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003181
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003182 if( ssl == NULL || ssl->conf == NULL )
3183 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003186 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003187 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003188 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003189 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003193
3194 /* Did we already try/start sending HelloRequest? */
3195 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003197
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003198 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003199 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003203 /*
3204 * On client, either start the renegotiation process or,
3205 * if already in progress, continue the handshake
3206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003208 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003209 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003210 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003211
Hanno Becker40cdaa12020-02-05 10:48:27 +00003212 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003213 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003214 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003215 return( ret );
3216 }
3217 }
3218 else
3219 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003221 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003223 return( ret );
3224 }
3225 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003227
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003228 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003229}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003231
Gilles Peskine9b562d52018-04-25 20:32:43 +02003232void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003233{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003234 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3235
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003236 if( handshake == NULL )
3237 return;
3238
Brett Warrene0edc842021-08-17 09:53:13 +01003239#if defined(MBEDTLS_ECP_C)
3240#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3241 if ( ssl->handshake->group_list_heap_allocated )
3242 mbedtls_free( (void*) handshake->group_list );
3243 handshake->group_list = NULL;
3244#endif /* MBEDTLS_DEPRECATED_REMOVED */
3245#endif /* MBEDTLS_ECP_C */
3246
Jerry Yuf017ee42022-01-12 15:49:48 +08003247#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3248#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3249 if ( ssl->handshake->sig_algs_heap_allocated )
3250 mbedtls_free( (void*) handshake->sig_algs );
3251 handshake->sig_algs = NULL;
3252#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003253#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3254 if( ssl->handshake->certificate_request_context )
3255 {
3256 mbedtls_free( (void*) handshake->certificate_request_context );
3257 }
3258#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003259#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3260
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003261#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3262 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3263 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003264 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003265 handshake->async_in_progress = 0;
3266 }
3267#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3268
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003269#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003270#if defined(MBEDTLS_USE_PSA_CRYPTO)
3271 psa_hash_abort( &handshake->fin_sha256_psa );
3272#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003273 mbedtls_sha256_free( &handshake->fin_sha256 );
3274#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003275#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003276#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003277#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003278 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003279#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003280 mbedtls_sha512_free( &handshake->fin_sha512 );
3281#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003282#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#if defined(MBEDTLS_DHM_C)
3285 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003286#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003287#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003289#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003290#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003291 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003292#if defined(MBEDTLS_SSL_CLI_C)
3293 mbedtls_free( handshake->ecjpake_cache );
3294 handshake->ecjpake_cache = NULL;
3295 handshake->ecjpake_cache_len = 0;
3296#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003297#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003298
Janos Follath4ae5c292016-02-10 11:27:43 +00003299#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3300 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003301 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003303#endif
3304
Gilles Peskineeccd8882020-03-10 12:19:08 +01003305#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003306#if defined(MBEDTLS_USE_PSA_CRYPTO)
3307 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3308 {
3309 /* The maintenance of the external PSK key slot is the
3310 * user's responsibility. */
3311 if( ssl->handshake->psk_opaque_is_internal )
3312 {
3313 psa_destroy_key( ssl->handshake->psk_opaque );
3314 ssl->handshake->psk_opaque_is_internal = 0;
3315 }
3316 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3317 }
Neil Armstronge952a302022-05-03 10:22:14 +02003318#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003319 if( handshake->psk != NULL )
3320 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003321 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003322 mbedtls_free( handshake->psk );
3323 }
Neil Armstronge952a302022-05-03 10:22:14 +02003324#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003325#endif
3326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3328 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003329 /*
3330 * Free only the linked list wrapper, not the keys themselves
3331 * since the belong to the SNI callback
3332 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003333 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003335
Gilles Peskineeccd8882020-03-10 12:19:08 +01003336#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003337 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003338 if( handshake->ecrs_peer_cert != NULL )
3339 {
3340 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3341 mbedtls_free( handshake->ecrs_peer_cert );
3342 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003343#endif
3344
Hanno Becker75173122019-02-06 16:18:31 +00003345#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3346 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3347 mbedtls_pk_free( &handshake->peer_pubkey );
3348#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3349
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003350#if defined(MBEDTLS_SSL_CLI_C) && \
3351 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3352 mbedtls_free( handshake->cookie );
3353#endif /* MBEDTLS_SSL_CLI_C &&
3354 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003355
3356#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003357 mbedtls_ssl_flight_free( handshake->flight );
3358 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003359#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003360
Ronald Cronf12b81d2022-03-15 10:42:41 +01003361#if defined(MBEDTLS_ECDH_C) && \
3362 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003363 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003364 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003365#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3366
Ronald Cron6f135e12021-12-08 16:57:54 +01003367#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003368 mbedtls_ssl_transform_free( handshake->transform_handshake );
3369 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003370 mbedtls_free( handshake->transform_earlydata );
3371 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003372#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003373
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003374
3375#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3376 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3377 * processes datagrams and the fact that a datagram is allowed to have
3378 * several records in it, it is possible that the I/O buffers are not
3379 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003380 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3381 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003382#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003383
Jerry Yuba9c7272021-10-30 11:54:10 +08003384 /* mbedtls_platform_zeroize MUST be last one in this function */
3385 mbedtls_platform_zeroize( handshake,
3386 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003387}
3388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003390{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003391 if( session == NULL )
3392 return;
3393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003395 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003396#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003397
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003398#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003400#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003401
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003402 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003403}
3404
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003405#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003406
3407#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3408#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3409#else
3410#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3411#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3412
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003413#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003414
3415#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3416#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3417#else
3418#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3419#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3420
3421#if defined(MBEDTLS_SSL_ALPN)
3422#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3423#else
3424#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3425#endif /* MBEDTLS_SSL_ALPN */
3426
3427#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3428#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3429#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3430#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3431
3432#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3433 ( (uint32_t) ( \
3434 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3435 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3436 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3437 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3438 0u ) )
3439
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003440static unsigned char ssl_serialized_context_header[] = {
3441 MBEDTLS_VERSION_MAJOR,
3442 MBEDTLS_VERSION_MINOR,
3443 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003444 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3445 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3446 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3447 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3448 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003449};
3450
Paul Bakker5121ce52009-01-03 21:22:43 +00003451/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003452 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003453 *
3454 * The format of the serialized data is:
3455 * (in the presentation language of TLS, RFC 8446 section 3)
3456 *
3457 * // header
3458 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003459 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003460 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003461 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003462 * Note: When updating the format, remember to keep these
3463 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003464 *
3465 * // session sub-structure
3466 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3467 * // transform sub-structure
3468 * uint8 random[64]; // ServerHello.random+ClientHello.random
3469 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3470 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3471 * // fields from ssl_context
3472 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3473 * uint64 in_window_top; // DTLS: last validated record seq_num
3474 * uint64 in_window; // DTLS: bitmask for replay protection
3475 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3476 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3477 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3478 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3479 *
3480 * Note that many fields of the ssl_context or sub-structures are not
3481 * serialized, as they fall in one of the following categories:
3482 *
3483 * 1. forced value (eg in_left must be 0)
3484 * 2. pointer to dynamically-allocated memory (eg session, transform)
3485 * 3. value can be re-derived from other data (eg session keys from MS)
3486 * 4. value was temporary (eg content of input buffer)
3487 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003488 */
3489int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3490 unsigned char *buf,
3491 size_t buf_len,
3492 size_t *olen )
3493{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003494 unsigned char *p = buf;
3495 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003496 size_t session_len;
3497 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003498
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003499 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003500 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3501 * this function's documentation.
3502 *
3503 * These are due to assumptions/limitations in the implementation. Some of
3504 * them are likely to stay (no handshake in progress) some might go away
3505 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003506 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003507 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003508 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003509 {
3510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003511 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003512 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003513 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003514 {
3515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003516 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003517 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003518 /* Double-check that sub-structures are indeed ready */
3519 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003520 {
3521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003522 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003523 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003524 /* There must be no pending incoming or outgoing data */
3525 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003526 {
3527 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003528 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003529 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003530 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003531 {
3532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003533 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003534 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003535 /* Protocol must be DLTS, not TLS */
3536 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003537 {
3538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003539 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003540 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003541 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003542 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003543 {
3544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
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 /* We must be using an AEAD ciphersuite */
3548 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003549 {
3550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
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 /* Renegotiation must not be enabled */
3554#if defined(MBEDTLS_SSL_RENEGOTIATION)
3555 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003556 {
3557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003558 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003559 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003560#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003561
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003562 /*
3563 * Version and format identifier
3564 */
3565 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003566
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003567 if( used <= buf_len )
3568 {
3569 memcpy( p, ssl_serialized_context_header,
3570 sizeof( ssl_serialized_context_header ) );
3571 p += sizeof( ssl_serialized_context_header );
3572 }
3573
3574 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003575 * Session (length + data)
3576 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003577 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003578 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3579 return( ret );
3580
3581 used += 4 + session_len;
3582 if( used <= buf_len )
3583 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003584 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3585 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003586
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003587 ret = ssl_session_save( ssl->session, 1,
3588 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003589 if( ret != 0 )
3590 return( ret );
3591
3592 p += session_len;
3593 }
3594
3595 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003596 * Transform
3597 */
3598 used += sizeof( ssl->transform->randbytes );
3599 if( used <= buf_len )
3600 {
3601 memcpy( p, ssl->transform->randbytes,
3602 sizeof( ssl->transform->randbytes ) );
3603 p += sizeof( ssl->transform->randbytes );
3604 }
3605
3606#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3607 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3608 if( used <= buf_len )
3609 {
3610 *p++ = ssl->transform->in_cid_len;
3611 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3612 p += ssl->transform->in_cid_len;
3613
3614 *p++ = ssl->transform->out_cid_len;
3615 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3616 p += ssl->transform->out_cid_len;
3617 }
3618#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3619
3620 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003621 * Saved fields from top-level ssl_context structure
3622 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003623 used += 4;
3624 if( used <= buf_len )
3625 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003626 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3627 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003628 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003629
3630#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3631 used += 16;
3632 if( used <= buf_len )
3633 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003634 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3635 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003636
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003637 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3638 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003639 }
3640#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3641
3642#if defined(MBEDTLS_SSL_PROTO_DTLS)
3643 used += 1;
3644 if( used <= buf_len )
3645 {
3646 *p++ = ssl->disable_datagram_packing;
3647 }
3648#endif /* MBEDTLS_SSL_PROTO_DTLS */
3649
Jerry Yuae0b2e22021-10-08 15:21:19 +08003650 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003651 if( used <= buf_len )
3652 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003653 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3654 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003655 }
3656
3657#if defined(MBEDTLS_SSL_PROTO_DTLS)
3658 used += 2;
3659 if( used <= buf_len )
3660 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003661 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3662 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003663 }
3664#endif /* MBEDTLS_SSL_PROTO_DTLS */
3665
3666#if defined(MBEDTLS_SSL_ALPN)
3667 {
3668 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003669 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003670 : 0;
3671
3672 used += 1 + alpn_len;
3673 if( used <= buf_len )
3674 {
3675 *p++ = alpn_len;
3676
3677 if( ssl->alpn_chosen != NULL )
3678 {
3679 memcpy( p, ssl->alpn_chosen, alpn_len );
3680 p += alpn_len;
3681 }
3682 }
3683 }
3684#endif /* MBEDTLS_SSL_ALPN */
3685
3686 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003687 * Done
3688 */
3689 *olen = used;
3690
3691 if( used > buf_len )
3692 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003693
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003694 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3695
Hanno Becker43aefe22020-02-05 10:44:56 +00003696 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003697}
3698
3699/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003700 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003701 *
3702 * This internal version is wrapped by a public function that cleans up in
3703 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003704 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003705MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003706static int ssl_context_load( mbedtls_ssl_context *ssl,
3707 const unsigned char *buf,
3708 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003709{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003710 const unsigned char *p = buf;
3711 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003712 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003713 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003714
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003715 /*
3716 * The context should have been freshly setup or reset.
3717 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003718 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003719 * renegotiating, or if the user mistakenly loaded a session first.)
3720 */
3721 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3722 ssl->session != NULL )
3723 {
3724 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3725 }
3726
3727 /*
3728 * We can't check that the config matches the initial one, but we can at
3729 * least check it matches the requirements for serializing.
3730 */
3731 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003732 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3733 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003734#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003735 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003736#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003737 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003738 {
3739 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3740 }
3741
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003742 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3743
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003744 /*
3745 * Check version identifier
3746 */
3747 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3748 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3749
3750 if( memcmp( p, ssl_serialized_context_header,
3751 sizeof( ssl_serialized_context_header ) ) != 0 )
3752 {
3753 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3754 }
3755 p += sizeof( ssl_serialized_context_header );
3756
3757 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003758 * Session
3759 */
3760 if( (size_t)( end - p ) < 4 )
3761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3762
3763 session_len = ( (size_t) p[0] << 24 ) |
3764 ( (size_t) p[1] << 16 ) |
3765 ( (size_t) p[2] << 8 ) |
3766 ( (size_t) p[3] );
3767 p += 4;
3768
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003769 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003770 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003771 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003772 ssl->session_in = ssl->session;
3773 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003774 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003775
3776 if( (size_t)( end - p ) < session_len )
3777 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3778
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003779 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003780 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003781 {
3782 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003783 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003784 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003785
3786 p += session_len;
3787
3788 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003789 * Transform
3790 */
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->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003795 ssl->transform_in = ssl->transform;
3796 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003797 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003798
3799 /* Read random bytes and populate structure */
3800 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3801 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003802#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003803 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003804 ssl->session->ciphersuite,
3805 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003806#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003807 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003808#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003809 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3810 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003811 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003812 ssl->conf->endpoint,
3813 ssl );
3814 if( ret != 0 )
3815 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003816#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003817 p += sizeof( ssl->transform->randbytes );
3818
3819#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3820 /* Read connection IDs and store them */
3821 if( (size_t)( end - p ) < 1 )
3822 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3823
3824 ssl->transform->in_cid_len = *p++;
3825
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003826 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003827 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3828
3829 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3830 p += ssl->transform->in_cid_len;
3831
3832 ssl->transform->out_cid_len = *p++;
3833
3834 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3835 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3836
3837 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3838 p += ssl->transform->out_cid_len;
3839#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3840
3841 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003842 * Saved fields from top-level ssl_context structure
3843 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003844 if( (size_t)( end - p ) < 4 )
3845 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3846
3847 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3848 ( (uint32_t) p[1] << 16 ) |
3849 ( (uint32_t) p[2] << 8 ) |
3850 ( (uint32_t) p[3] );
3851 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003852
3853#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3854 if( (size_t)( end - p ) < 16 )
3855 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3856
3857 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3858 ( (uint64_t) p[1] << 48 ) |
3859 ( (uint64_t) p[2] << 40 ) |
3860 ( (uint64_t) p[3] << 32 ) |
3861 ( (uint64_t) p[4] << 24 ) |
3862 ( (uint64_t) p[5] << 16 ) |
3863 ( (uint64_t) p[6] << 8 ) |
3864 ( (uint64_t) p[7] );
3865 p += 8;
3866
3867 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3868 ( (uint64_t) p[1] << 48 ) |
3869 ( (uint64_t) p[2] << 40 ) |
3870 ( (uint64_t) p[3] << 32 ) |
3871 ( (uint64_t) p[4] << 24 ) |
3872 ( (uint64_t) p[5] << 16 ) |
3873 ( (uint64_t) p[6] << 8 ) |
3874 ( (uint64_t) p[7] );
3875 p += 8;
3876#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3877
3878#if defined(MBEDTLS_SSL_PROTO_DTLS)
3879 if( (size_t)( end - p ) < 1 )
3880 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3881
3882 ssl->disable_datagram_packing = *p++;
3883#endif /* MBEDTLS_SSL_PROTO_DTLS */
3884
Jerry Yud9a94fe2021-09-28 18:58:59 +08003885 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003886 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003887 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3888 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003889
3890#if defined(MBEDTLS_SSL_PROTO_DTLS)
3891 if( (size_t)( end - p ) < 2 )
3892 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3893
3894 ssl->mtu = ( p[0] << 8 ) | p[1];
3895 p += 2;
3896#endif /* MBEDTLS_SSL_PROTO_DTLS */
3897
3898#if defined(MBEDTLS_SSL_ALPN)
3899 {
3900 uint8_t alpn_len;
3901 const char **cur;
3902
3903 if( (size_t)( end - p ) < 1 )
3904 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3905
3906 alpn_len = *p++;
3907
3908 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3909 {
3910 /* alpn_chosen should point to an item in the configured list */
3911 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3912 {
3913 if( strlen( *cur ) == alpn_len &&
3914 memcmp( p, cur, alpn_len ) == 0 )
3915 {
3916 ssl->alpn_chosen = *cur;
3917 break;
3918 }
3919 }
3920 }
3921
3922 /* can only happen on conf mismatch */
3923 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3924 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3925
3926 p += alpn_len;
3927 }
3928#endif /* MBEDTLS_SSL_ALPN */
3929
3930 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003931 * Forced fields from top-level ssl_context structure
3932 *
3933 * Most of them already set to the correct value by mbedtls_ssl_init() and
3934 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3935 */
3936 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003937 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003938
Hanno Becker361b10d2019-08-30 10:42:49 +01003939 /* Adjust pointers for header fields of outgoing records to
3940 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003941 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003942
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003943#if defined(MBEDTLS_SSL_PROTO_DTLS)
3944 ssl->in_epoch = 1;
3945#endif
3946
3947 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3948 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003949 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3950 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003951 if( ssl->handshake != NULL )
3952 {
3953 mbedtls_ssl_handshake_free( ssl );
3954 mbedtls_free( ssl->handshake );
3955 ssl->handshake = NULL;
3956 }
3957
3958 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003959 * Done - should have consumed entire buffer
3960 */
3961 if( p != end )
3962 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003963
3964 return( 0 );
3965}
3966
3967/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003968 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003969 */
3970int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3971 const unsigned char *buf,
3972 size_t len )
3973{
3974 int ret = ssl_context_load( context, buf, len );
3975
3976 if( ret != 0 )
3977 mbedtls_ssl_free( context );
3978
3979 return( ret );
3980}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003981#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003982
3983/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003984 * Free an SSL context
3985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003986void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003987{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003988 if( ssl == NULL )
3989 return;
3990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003991 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003992
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003993 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003994 {
sander-visserb8aa2072020-05-06 22:05:13 +02003995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3996 size_t out_buf_len = ssl->out_buf_len;
3997#else
3998 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3999#endif
4000
Darryl Greenb33cc762019-11-28 14:29:44 +00004001 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004003 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004004 }
4005
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004006 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004007 {
sander-visserb8aa2072020-05-06 22:05:13 +02004008#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4009 size_t in_buf_len = ssl->in_buf_len;
4010#else
4011 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4012#endif
4013
Darryl Greenb33cc762019-11-28 14:29:44 +00004014 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004016 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004017 }
4018
Paul Bakker48916f92012-09-16 19:57:18 +00004019 if( ssl->transform )
4020 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004021 mbedtls_ssl_transform_free( ssl->transform );
4022 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004023 }
4024
4025 if( ssl->handshake )
4026 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004027 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004028 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4029 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004031 mbedtls_free( ssl->handshake );
4032 mbedtls_free( ssl->transform_negotiate );
4033 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004034 }
4035
Ronald Cron6f135e12021-12-08 16:57:54 +01004036#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004037 mbedtls_ssl_transform_free( ssl->transform_application );
4038 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004039#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004040
Paul Bakkerc0463502013-02-14 11:19:38 +01004041 if( ssl->session )
4042 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043 mbedtls_ssl_session_free( ssl->session );
4044 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004045 }
4046
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004048 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004049 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004050 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004051 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004052 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004053#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004054
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004055#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004056 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004057#endif
4058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004059 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004060
Paul Bakker86f04f42013-02-14 11:20:09 +01004061 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004062 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004063}
4064
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004065/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004066 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004067 */
4068void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4069{
4070 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4071}
4072
Gilles Peskineae270bf2021-06-02 00:05:29 +02004073/* The selection should be the same as mbedtls_x509_crt_profile_default in
4074 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004075 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004076 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004077 * about this list.
4078 */
Brett Warrene0edc842021-08-17 09:53:13 +01004079static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004080#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004081 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004082#endif
4083#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004084 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004085#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004086#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004087 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004088#endif
4089#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004090 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004091#endif
4092#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004093 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004094#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004095#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004096 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004097#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004098#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004099 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004100#endif
4101#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004102 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004103#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004104 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004105};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004106
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004107static int ssl_preset_suiteb_ciphersuites[] = {
4108 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4109 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4110 0
4111};
4112
Gilles Peskineeccd8882020-03-10 12:19:08 +01004113#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004114
Jerry Yu909df7b2022-01-22 11:56:27 +08004115/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004116 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004117 * rules SHOULD be upheld.
4118 * - No duplicate entries.
4119 * - But if there is a good reason, do not change the order of the algorithms.
4120 * - ssl_tls12_present* is for TLS 1.2 use only.
4121 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004122 *
Jerry Yua1255e62022-06-24 10:10:47 +08004123 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4124 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4125 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
Jerry Yucc539102022-06-27 16:27:35 +08004126 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4127 * for its signature in the key exchange message. As Mbed TLS 1.2 does not
Jerry Yua1255e62022-06-24 10:10:47 +08004128 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004129 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004130static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004131
Jerry Yued5e9f42022-01-26 11:21:34 +08004132#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4133 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4134 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4135#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4136 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004137
Jerry Yu909df7b2022-01-22 11:56:27 +08004138#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4139 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4140 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4141#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4142 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4143
Jerry Yued5e9f42022-01-26 11:21:34 +08004144#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4145 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4146 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4147#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4148 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004149
Ronald Cron8540cf62022-03-16 08:01:09 +01004150#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4151 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4152#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4153
4154#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4155 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4156#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4157
Jerry Yu53037892022-01-25 11:02:06 +08004158#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4159 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4160#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4161
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004162#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4163 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4164#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4165
4166#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4167 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4168#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4169
4170#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4171 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4172#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4173
Gabor Mezei15b95a62022-05-09 16:37:58 +02004174 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004175};
4176
4177/* NOTICE: see above */
4178#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4179static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004180#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004181#if defined(MBEDTLS_ECDSA_C)
4182 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004183#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004184#if defined(MBEDTLS_RSA_C)
4185 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4186#endif
4187#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004188#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004189#if defined(MBEDTLS_ECDSA_C)
4190 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004191#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004192#if defined(MBEDTLS_RSA_C)
4193 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4194#endif
4195#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004196#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004197#if defined(MBEDTLS_ECDSA_C)
4198 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004199#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004200#if defined(MBEDTLS_RSA_C)
4201 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4202#endif
4203#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004204 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004205};
4206#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4207/* NOTICE: see above */
4208static uint16_t ssl_preset_suiteb_sig_algs[] = {
4209
Jerry Yu909df7b2022-01-22 11:56:27 +08004210#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4211 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4212 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4213#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4214 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4215
Jerry Yu53037892022-01-25 11:02:06 +08004216#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4217 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4218 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4219#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4220 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004221
4222#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4223 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4224#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004225
Jerry Yu53037892022-01-25 11:02:06 +08004226#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4227 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4228#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4229
Gabor Mezei15b95a62022-05-09 16:37:58 +02004230 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004231};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004232
Jerry Yu909df7b2022-01-22 11:56:27 +08004233/* NOTICE: see above */
4234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4235static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004236#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004237#if defined(MBEDTLS_ECDSA_C)
4238 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004239#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004240#if defined(MBEDTLS_RSA_C)
4241 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4242#endif
4243#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004244#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004245#if defined(MBEDTLS_ECDSA_C)
4246 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004247#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004248#if defined(MBEDTLS_RSA_C)
4249 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4250#endif
4251#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004252 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004253};
Jerry Yu909df7b2022-01-22 11:56:27 +08004254#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4255
Jerry Yu1a8b4812022-01-20 17:56:50 +08004256#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004257
Brett Warrene0edc842021-08-17 09:53:13 +01004258static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004259#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004260 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004261#endif
4262#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004263 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004264#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004265 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004266};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004267
Jerry Yu1a8b4812022-01-20 17:56:50 +08004268#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004269/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004270 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004271MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004272static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004273{
4274 size_t i, j;
4275 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004276
Gabor Mezei15b95a62022-05-09 16:37:58 +02004277 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004278 {
Jerry Yuf377d642022-01-25 10:43:59 +08004279 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004280 {
Jerry Yuf377d642022-01-25 10:43:59 +08004281 if( sig_algs[i] != sig_algs[j] )
4282 continue;
4283 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4284 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4285 sig_algs[i], j, i );
4286 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004287 }
4288 }
4289 return( ret );
4290}
4291
4292#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4293
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004294/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004295 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004296 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004297int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004298 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004299{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004300#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004302#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004303
Jerry Yu1a8b4812022-01-20 17:56:50 +08004304#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004305 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004306 {
4307 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4308 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4309 }
4310
Jerry Yuf377d642022-01-25 10:43:59 +08004311 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004312 {
4313 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4314 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4315 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004316
4317#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004318 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004319 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004320 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004321 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4322 }
4323
Jerry Yuf377d642022-01-25 10:43:59 +08004324 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004325 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004326 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004327 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4328 }
4329#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004330#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4331
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004332 /* Use the functions here so that they are covered in tests,
4333 * but otherwise access member directly for efficiency */
4334 mbedtls_ssl_conf_endpoint( conf, endpoint );
4335 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004336
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004337 /*
4338 * Things that are common to all presets
4339 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004340#if defined(MBEDTLS_SSL_CLI_C)
4341 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4342 {
4343 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4344#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4345 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4346#endif
4347 }
4348#endif
4349
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004350#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4351 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4352#endif
4353
4354#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4355 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4356#endif
4357
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004358#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004359 conf->f_cookie_write = ssl_cookie_write_dummy;
4360 conf->f_cookie_check = ssl_cookie_check_dummy;
4361#endif
4362
4363#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4364 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4365#endif
4366
Janos Follath088ce432017-04-10 12:42:31 +01004367#if defined(MBEDTLS_SSL_SRV_C)
4368 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004369 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004370#endif
4371
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004372#if defined(MBEDTLS_SSL_PROTO_DTLS)
4373 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4374 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4375#endif
4376
4377#if defined(MBEDTLS_SSL_RENEGOTIATION)
4378 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004379 memset( conf->renego_period, 0x00, 2 );
4380 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004381#endif
4382
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004383#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004384 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4385 {
4386 const unsigned char dhm_p[] =
4387 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4388 const unsigned char dhm_g[] =
4389 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004390
Hanno Beckere2defad2021-07-24 05:59:17 +01004391 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4392 dhm_p, sizeof( dhm_p ),
4393 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4394 {
4395 return( ret );
4396 }
4397 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004398#endif
4399
Ronald Cron6f135e12021-12-08 16:57:54 +01004400#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004401 /*
4402 * Allow all TLS 1.3 key exchange modes by default.
4403 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004404 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004405#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004406
XiaokangQian4d3a6042022-04-21 13:46:17 +00004407 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4408 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004409#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004410 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004411 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004412#else
XiaokangQian060d8672022-04-21 09:24:56 +00004413 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004414#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004415 }
4416 else
4417 {
4418#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4419 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4420 {
4421 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4422 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4423 }
4424 else
4425 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4426 {
4427 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4428 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4429 }
4430#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4431 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4432 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4433#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4434 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4435 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4436#else
4437 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4438#endif
4439 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004440
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004441 /*
4442 * Preset-specific defaults
4443 */
4444 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004445 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004446 /*
4447 * NSA Suite B
4448 */
4449 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004450
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004451 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004452
4453#if defined(MBEDTLS_X509_CRT_PARSE_C)
4454 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004455#endif
4456
Gilles Peskineeccd8882020-03-10 12:19:08 +01004457#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004458#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4459 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4460 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4461 else
4462#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4463 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004464#endif
4465
Brett Warrene0edc842021-08-17 09:53:13 +01004466#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4467 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004468#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004469 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004470 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004471
4472 /*
4473 * Default
4474 */
4475 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004476
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004477 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004478
4479#if defined(MBEDTLS_X509_CRT_PARSE_C)
4480 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4481#endif
4482
Gilles Peskineeccd8882020-03-10 12:19:08 +01004483#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004484#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4485 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4486 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4487 else
4488#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4489 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004490#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004491
Brett Warrene0edc842021-08-17 09:53:13 +01004492#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4493 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004494#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004495 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004496
4497#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4498 conf->dhm_min_bitlen = 1024;
4499#endif
4500 }
4501
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004502 return( 0 );
4503}
4504
4505/*
4506 * Free mbedtls_ssl_config
4507 */
4508void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4509{
4510#if defined(MBEDTLS_DHM_C)
4511 mbedtls_mpi_free( &conf->dhm_P );
4512 mbedtls_mpi_free( &conf->dhm_G );
4513#endif
4514
Gilles Peskineeccd8882020-03-10 12:19:08 +01004515#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004516#if defined(MBEDTLS_USE_PSA_CRYPTO)
4517 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4518 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004519 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4520 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004521#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004522 if( conf->psk != NULL )
4523 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004524 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004525 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004526 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004527 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004528 }
4529
4530 if( conf->psk_identity != NULL )
4531 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004532 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004533 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004534 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004535 conf->psk_identity_len = 0;
4536 }
4537#endif
4538
4539#if defined(MBEDTLS_X509_CRT_PARSE_C)
4540 ssl_key_cert_free( conf->key_cert );
4541#endif
4542
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004543 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004544}
4545
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004546#if defined(MBEDTLS_PK_C) && \
4547 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004548/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004552{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553#if defined(MBEDTLS_RSA_C)
4554 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4555 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004556#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557#if defined(MBEDTLS_ECDSA_C)
4558 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4559 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004560#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004562}
4563
Hanno Becker7e5437a2017-04-28 17:15:26 +01004564unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4565{
4566 switch( type ) {
4567 case MBEDTLS_PK_RSA:
4568 return( MBEDTLS_SSL_SIG_RSA );
4569 case MBEDTLS_PK_ECDSA:
4570 case MBEDTLS_PK_ECKEY:
4571 return( MBEDTLS_SSL_SIG_ECDSA );
4572 default:
4573 return( MBEDTLS_SSL_SIG_ANON );
4574 }
4575}
4576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004577mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004578{
4579 switch( sig )
4580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581#if defined(MBEDTLS_RSA_C)
4582 case MBEDTLS_SSL_SIG_RSA:
4583 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004584#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004585#if defined(MBEDTLS_ECDSA_C)
4586 case MBEDTLS_SSL_SIG_ECDSA:
4587 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004588#endif
4589 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004590 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004591 }
4592}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004593#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004594
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004595/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004596 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004599{
4600 switch( hash )
4601 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004602#if defined(MBEDTLS_MD5_C)
4603 case MBEDTLS_SSL_HASH_MD5:
4604 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004605#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004606#if defined(MBEDTLS_SHA1_C)
4607 case MBEDTLS_SSL_HASH_SHA1:
4608 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004609#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004610#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004611 case MBEDTLS_SSL_HASH_SHA224:
4612 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004613#endif
4614#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615 case MBEDTLS_SSL_HASH_SHA256:
4616 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004617#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004618#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619 case MBEDTLS_SSL_HASH_SHA384:
4620 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004621#endif
4622#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623 case MBEDTLS_SSL_HASH_SHA512:
4624 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004625#endif
4626 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004627 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004628 }
4629}
4630
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004631/*
4632 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4633 */
4634unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4635{
4636 switch( md )
4637 {
4638#if defined(MBEDTLS_MD5_C)
4639 case MBEDTLS_MD_MD5:
4640 return( MBEDTLS_SSL_HASH_MD5 );
4641#endif
4642#if defined(MBEDTLS_SHA1_C)
4643 case MBEDTLS_MD_SHA1:
4644 return( MBEDTLS_SSL_HASH_SHA1 );
4645#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004646#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004647 case MBEDTLS_MD_SHA224:
4648 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004649#endif
4650#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004651 case MBEDTLS_MD_SHA256:
4652 return( MBEDTLS_SSL_HASH_SHA256 );
4653#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004654#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004655 case MBEDTLS_MD_SHA384:
4656 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004657#endif
4658#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004659 case MBEDTLS_MD_SHA512:
4660 return( MBEDTLS_SSL_HASH_SHA512 );
4661#endif
4662 default:
4663 return( MBEDTLS_SSL_HASH_NONE );
4664 }
4665}
4666
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004667/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004668 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004669 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004670 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004671int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004672{
Brett Warrene0edc842021-08-17 09:53:13 +01004673 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004674
Brett Warrene0edc842021-08-17 09:53:13 +01004675 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004676 return( -1 );
4677
Brett Warrene0edc842021-08-17 09:53:13 +01004678 for( ; *group_list != 0; group_list++ )
4679 {
4680 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004681 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004682 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004683
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004684 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004685}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004686
4687#if defined(MBEDTLS_ECP_C)
4688/*
4689 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4690 */
4691int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4692{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004693 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004694 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4695}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004696#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004698#if defined(MBEDTLS_X509_CRT_PARSE_C)
4699int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4700 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004701 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004702 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004703{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004704 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004705 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004706 const char *ext_oid;
4707 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004710 {
4711 /* Server part of the key exchange */
4712 switch( ciphersuite->key_exchange )
4713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 case MBEDTLS_KEY_EXCHANGE_RSA:
4715 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004716 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004717 break;
4718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4720 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4721 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4722 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004723 break;
4724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4726 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004727 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004728 break;
4729
4730 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 case MBEDTLS_KEY_EXCHANGE_NONE:
4732 case MBEDTLS_KEY_EXCHANGE_PSK:
4733 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4734 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004735 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004736 usage = 0;
4737 }
4738 }
4739 else
4740 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4742 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004743 }
4744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004746 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004747 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004748 ret = -1;
4749 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4754 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004755 }
4756 else
4757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4759 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004760 }
4761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004763 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004764 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004765 ret = -1;
4766 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004767
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004768 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004769}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004771
Jerry Yu148165c2021-09-24 23:20:59 +08004772#if defined(MBEDTLS_USE_PSA_CRYPTO)
4773int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4774 const mbedtls_md_type_t md,
4775 unsigned char *dst,
4776 size_t dst_len,
4777 size_t *olen )
4778{
Ronald Cronf6893e12022-01-07 22:09:01 +01004779 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4780 psa_hash_operation_t *hash_operation_to_clone;
4781 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4782
Jerry Yu148165c2021-09-24 23:20:59 +08004783 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004784
4785 switch( md )
4786 {
4787#if defined(MBEDTLS_SHA384_C)
4788 case MBEDTLS_MD_SHA384:
4789 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4790 break;
4791#endif
4792
4793#if defined(MBEDTLS_SHA256_C)
4794 case MBEDTLS_MD_SHA256:
4795 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4796 break;
4797#endif
4798
4799 default:
4800 goto exit;
4801 }
4802
4803 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4804 if( status != PSA_SUCCESS )
4805 goto exit;
4806
4807 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4808 if( status != PSA_SUCCESS )
4809 goto exit;
4810
4811exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004812 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004813}
4814#else /* MBEDTLS_USE_PSA_CRYPTO */
4815
Jerry Yu24c0ec32021-09-09 14:21:07 +08004816#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004817MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004818static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4819 unsigned char *dst,
4820 size_t dst_len,
4821 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004822{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004823 int ret;
4824 mbedtls_sha512_context sha512;
4825
4826 if( dst_len < 48 )
4827 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4828
4829 mbedtls_sha512_init( &sha512 );
4830 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4831
4832 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4833 {
4834 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4835 goto exit;
4836 }
4837
4838 *olen = 48;
4839
4840exit:
4841
4842 mbedtls_sha512_free( &sha512 );
4843 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004844}
4845#endif /* MBEDTLS_SHA384_C */
4846
4847#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004848MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004849static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4850 unsigned char *dst,
4851 size_t dst_len,
4852 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004853{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004854 int ret;
4855 mbedtls_sha256_context sha256;
4856
4857 if( dst_len < 32 )
4858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4859
4860 mbedtls_sha256_init( &sha256 );
4861 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004862
Jerry Yu24c0ec32021-09-09 14:21:07 +08004863 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4864 {
4865 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4866 goto exit;
4867 }
4868
4869 *olen = 32;
4870
4871exit:
4872
4873 mbedtls_sha256_free( &sha256 );
4874 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004875}
4876#endif /* MBEDTLS_SHA256_C */
4877
Jerry Yu000f9762021-09-14 11:12:51 +08004878int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4879 const mbedtls_md_type_t md,
4880 unsigned char *dst,
4881 size_t dst_len,
4882 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004883{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004884 switch( md )
4885 {
4886
Jerry Yu24c0ec32021-09-09 14:21:07 +08004887#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004888 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004889 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004890#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004891
Jerry Yu24c0ec32021-09-09 14:21:07 +08004892#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004893 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004894 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004895#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004896
4897 default:
4898 break;
4899 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004900 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004901}
XiaokangQian647719a2021-12-07 09:16:29 +00004902
Jerry Yu148165c2021-09-24 23:20:59 +08004903#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004904
Gabor Mezei078e8032022-04-27 21:17:56 +02004905#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4906/* mbedtls_ssl_parse_sig_alg_ext()
4907 *
4908 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4909 * value (TLS 1.3 RFC8446):
4910 * enum {
4911 * ....
4912 * ecdsa_secp256r1_sha256( 0x0403 ),
4913 * ecdsa_secp384r1_sha384( 0x0503 ),
4914 * ecdsa_secp521r1_sha512( 0x0603 ),
4915 * ....
4916 * } SignatureScheme;
4917 *
4918 * struct {
4919 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4920 * } SignatureSchemeList;
4921 *
4922 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4923 * value (TLS 1.2 RFC5246):
4924 * enum {
4925 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4926 * sha512(6), (255)
4927 * } HashAlgorithm;
4928 *
4929 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4930 * SignatureAlgorithm;
4931 *
4932 * struct {
4933 * HashAlgorithm hash;
4934 * SignatureAlgorithm signature;
4935 * } SignatureAndHashAlgorithm;
4936 *
4937 * SignatureAndHashAlgorithm
4938 * supported_signature_algorithms<2..2^16-2>;
4939 *
4940 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4941 * generalization of the TLS 1.2 signature algorithm extension.
4942 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4943 * `SignatureScheme` field of TLS 1.3
4944 *
4945 */
4946int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4947 const unsigned char *buf,
4948 const unsigned char *end )
4949{
4950 const unsigned char *p = buf;
4951 size_t supported_sig_algs_len = 0;
4952 const unsigned char *supported_sig_algs_end;
4953 uint16_t sig_alg;
4954 uint32_t common_idx = 0;
4955
4956 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4957 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4958 p += 2;
4959
4960 memset( ssl->handshake->received_sig_algs, 0,
4961 sizeof(ssl->handshake->received_sig_algs) );
4962
4963 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4964 supported_sig_algs_end = p + supported_sig_algs_len;
4965 while( p < supported_sig_algs_end )
4966 {
4967 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4968 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4969 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004970 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4971 sig_alg,
4972 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08004973#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08004974 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08004975 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
4976 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
4977 {
Gabor Mezei078e8032022-04-27 21:17:56 +02004978 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08004979 }
4980#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02004981
Jerry Yuf3b46b52022-06-19 16:52:27 +08004982 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
4983 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02004984
4985 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
4986 {
4987 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
4988 common_idx += 1;
4989 }
4990 }
4991 /* Check that we consumed all the message. */
4992 if( p != end )
4993 {
4994 MBEDTLS_SSL_DEBUG_MSG( 1,
4995 ( "Signature algorithms extension length misaligned" ) );
4996 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
4997 MBEDTLS_ERR_SSL_DECODE_ERROR );
4998 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
4999 }
5000
5001 if( common_idx == 0 )
5002 {
5003 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5004 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5005 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5006 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5007 }
5008
Gabor Mezei15b95a62022-05-09 16:37:58 +02005009 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005010 return( 0 );
5011}
5012
5013#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5014
Jerry Yudc7bd172022-02-17 13:44:15 +08005015#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5016
5017#if defined(MBEDTLS_USE_PSA_CRYPTO)
5018
5019static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5020 mbedtls_svc_key_id_t key,
5021 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005022 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005023 const unsigned char* seed, size_t seed_length,
5024 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005025 const unsigned char* other_secret,
5026 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005027 size_t capacity )
5028{
5029 psa_status_t status;
5030
5031 status = psa_key_derivation_setup( derivation, alg );
5032 if( status != PSA_SUCCESS )
5033 return( status );
5034
5035 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5036 {
5037 status = psa_key_derivation_input_bytes( derivation,
5038 PSA_KEY_DERIVATION_INPUT_SEED,
5039 seed, seed_length );
5040 if( status != PSA_SUCCESS )
5041 return( status );
5042
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005043 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005044 {
5045 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005046 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5047 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005048 if( status != PSA_SUCCESS )
5049 return( status );
5050 }
5051
Jerry Yudc7bd172022-02-17 13:44:15 +08005052 if( mbedtls_svc_key_id_is_null( key ) )
5053 {
5054 status = psa_key_derivation_input_bytes(
5055 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005056 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005057 }
5058 else
5059 {
5060 status = psa_key_derivation_input_key(
5061 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5062 }
5063 if( status != PSA_SUCCESS )
5064 return( status );
5065
5066 status = psa_key_derivation_input_bytes( derivation,
5067 PSA_KEY_DERIVATION_INPUT_LABEL,
5068 label, label_length );
5069 if( status != PSA_SUCCESS )
5070 return( status );
5071 }
5072 else
5073 {
5074 return( PSA_ERROR_NOT_SUPPORTED );
5075 }
5076
5077 status = psa_key_derivation_set_capacity( derivation, capacity );
5078 if( status != PSA_SUCCESS )
5079 return( status );
5080
5081 return( PSA_SUCCESS );
5082}
5083
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005084MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005085static int tls_prf_generic( mbedtls_md_type_t md_type,
5086 const unsigned char *secret, size_t slen,
5087 const char *label,
5088 const unsigned char *random, size_t rlen,
5089 unsigned char *dstbuf, size_t dlen )
5090{
5091 psa_status_t status;
5092 psa_algorithm_t alg;
5093 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5094 psa_key_derivation_operation_t derivation =
5095 PSA_KEY_DERIVATION_OPERATION_INIT;
5096
5097 if( md_type == MBEDTLS_MD_SHA384 )
5098 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5099 else
5100 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5101
5102 /* Normally a "secret" should be long enough to be impossible to
5103 * find by brute force, and in particular should not be empty. But
5104 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5105 * and for this use case it makes sense to have a 0-length "secret".
5106 * Since the key API doesn't allow importing a key of length 0,
5107 * keep master_key=0, which setup_psa_key_derivation() understands
5108 * to mean a 0-length "secret" input. */
5109 if( slen != 0 )
5110 {
5111 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5112 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5113 psa_set_key_algorithm( &key_attributes, alg );
5114 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5115
5116 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5117 if( status != PSA_SUCCESS )
5118 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5119 }
5120
5121 status = setup_psa_key_derivation( &derivation,
5122 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005123 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005124 random, rlen,
5125 (unsigned char const *) label,
5126 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005127 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005128 dlen );
5129 if( status != PSA_SUCCESS )
5130 {
5131 psa_key_derivation_abort( &derivation );
5132 psa_destroy_key( master_key );
5133 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5134 }
5135
5136 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5137 if( status != PSA_SUCCESS )
5138 {
5139 psa_key_derivation_abort( &derivation );
5140 psa_destroy_key( master_key );
5141 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5142 }
5143
5144 status = psa_key_derivation_abort( &derivation );
5145 if( status != PSA_SUCCESS )
5146 {
5147 psa_destroy_key( master_key );
5148 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5149 }
5150
5151 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5152 status = psa_destroy_key( master_key );
5153 if( status != PSA_SUCCESS )
5154 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5155
5156 return( 0 );
5157}
5158
5159#else /* MBEDTLS_USE_PSA_CRYPTO */
5160
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005161MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005162static int tls_prf_generic( mbedtls_md_type_t md_type,
5163 const unsigned char *secret, size_t slen,
5164 const char *label,
5165 const unsigned char *random, size_t rlen,
5166 unsigned char *dstbuf, size_t dlen )
5167{
5168 size_t nb;
5169 size_t i, j, k, md_len;
5170 unsigned char *tmp;
5171 size_t tmp_len = 0;
5172 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5173 const mbedtls_md_info_t *md_info;
5174 mbedtls_md_context_t md_ctx;
5175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5176
5177 mbedtls_md_init( &md_ctx );
5178
5179 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5181
5182 md_len = mbedtls_md_get_size( md_info );
5183
5184 tmp_len = md_len + strlen( label ) + rlen;
5185 tmp = mbedtls_calloc( 1, tmp_len );
5186 if( tmp == NULL )
5187 {
5188 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5189 goto exit;
5190 }
5191
5192 nb = strlen( label );
5193 memcpy( tmp + md_len, label, nb );
5194 memcpy( tmp + md_len + nb, random, rlen );
5195 nb += rlen;
5196
5197 /*
5198 * Compute P_<hash>(secret, label + random)[0..dlen]
5199 */
5200 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5201 goto exit;
5202
5203 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5204 if( ret != 0 )
5205 goto exit;
5206 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5207 if( ret != 0 )
5208 goto exit;
5209 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5210 if( ret != 0 )
5211 goto exit;
5212
5213 for( i = 0; i < dlen; i += md_len )
5214 {
5215 ret = mbedtls_md_hmac_reset ( &md_ctx );
5216 if( ret != 0 )
5217 goto exit;
5218 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5219 if( ret != 0 )
5220 goto exit;
5221 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5222 if( ret != 0 )
5223 goto exit;
5224
5225 ret = mbedtls_md_hmac_reset ( &md_ctx );
5226 if( ret != 0 )
5227 goto exit;
5228 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5229 if( ret != 0 )
5230 goto exit;
5231 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5232 if( ret != 0 )
5233 goto exit;
5234
5235 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5236
5237 for( j = 0; j < k; j++ )
5238 dstbuf[i + j] = h_i[j];
5239 }
5240
5241exit:
5242 mbedtls_md_free( &md_ctx );
5243
5244 mbedtls_platform_zeroize( tmp, tmp_len );
5245 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5246
5247 mbedtls_free( tmp );
5248
5249 return( ret );
5250}
5251#endif /* MBEDTLS_USE_PSA_CRYPTO */
5252
5253#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005254MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005255static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5256 const char *label,
5257 const unsigned char *random, size_t rlen,
5258 unsigned char *dstbuf, size_t dlen )
5259{
5260 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5261 label, random, rlen, dstbuf, dlen ) );
5262}
5263#endif /* MBEDTLS_SHA256_C */
5264
5265#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005266MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005267static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5268 const char *label,
5269 const unsigned char *random, size_t rlen,
5270 unsigned char *dstbuf, size_t dlen )
5271{
5272 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5273 label, random, rlen, dstbuf, dlen ) );
5274}
5275#endif /* MBEDTLS_SHA384_C */
5276
Jerry Yuf009d862022-02-17 14:01:37 +08005277/*
5278 * Set appropriate PRF function and other SSL / TLS1.2 functions
5279 *
5280 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005281 * - hash associated with the ciphersuite (only used by TLS 1.2)
5282 *
5283 * Outputs:
5284 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5285 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005286MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005287static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005288 mbedtls_md_type_t hash )
5289{
Jerry Yuf009d862022-02-17 14:01:37 +08005290#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005291 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005292 {
5293 handshake->tls_prf = tls_prf_sha384;
5294 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5295 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5296 }
5297 else
5298#endif
5299#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005300 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005301 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005302 handshake->tls_prf = tls_prf_sha256;
5303 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5304 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5305 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005306#else
Jerry Yuf009d862022-02-17 14:01:37 +08005307 {
Jerry Yuf009d862022-02-17 14:01:37 +08005308 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005309 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005310 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5311 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005312#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005313
5314 return( 0 );
5315}
Jerry Yud6ab2352022-02-17 14:03:43 +08005316
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005317/*
5318 * Compute master secret if needed
5319 *
5320 * Parameters:
5321 * [in/out] handshake
5322 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5323 * (PSA-PSK) ciphersuite_info, psk_opaque
5324 * [out] premaster (cleared)
5325 * [out] master
5326 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5327 * debug: conf->f_dbg, conf->p_dbg
5328 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005329 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005330 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005331MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005332static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5333 unsigned char *master,
5334 const mbedtls_ssl_context *ssl )
5335{
5336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5337
5338 /* cf. RFC 5246, Section 8.1:
5339 * "The master secret is always exactly 48 bytes in length." */
5340 size_t const master_secret_len = 48;
5341
5342#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5343 unsigned char session_hash[48];
5344#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5345
5346 /* The label for the KDF used for key expansion.
5347 * This is either "master secret" or "extended master secret"
5348 * depending on whether the Extended Master Secret extension
5349 * is used. */
5350 char const *lbl = "master secret";
5351
Przemek Stekielae4ed302022-04-05 17:15:55 +02005352 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005353 * - If the Extended Master Secret extension is not used,
5354 * this is ClientHello.Random + ServerHello.Random
5355 * (see Sect. 8.1 in RFC 5246).
5356 * - If the Extended Master Secret extension is used,
5357 * this is the transcript of the handshake so far.
5358 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005359 unsigned char const *seed = handshake->randbytes;
5360 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005361
5362#if !defined(MBEDTLS_DEBUG_C) && \
5363 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5364 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5365 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5366 ssl = NULL; /* make sure we don't use it except for those cases */
5367 (void) ssl;
5368#endif
5369
5370 if( handshake->resume != 0 )
5371 {
5372 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5373 return( 0 );
5374 }
5375
5376#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5377 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5378 {
5379 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005380 seed = session_hash;
5381 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005382
5383 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005384 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005385 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005386#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005387
Przemek Stekiel99114f32022-04-22 11:20:09 +02005388#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005389 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005390 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005391 {
5392 /* Perform PSK-to-MS expansion in a single step. */
5393 psa_status_t status;
5394 psa_algorithm_t alg;
5395 mbedtls_svc_key_id_t psk;
5396 psa_key_derivation_operation_t derivation =
5397 PSA_KEY_DERIVATION_OPERATION_INIT;
5398 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5399
5400 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5401
5402 psk = mbedtls_ssl_get_opaque_psk( ssl );
5403
5404 if( hash_alg == MBEDTLS_MD_SHA384 )
5405 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5406 else
5407 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5408
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005409 size_t other_secret_len = 0;
5410 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005411
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005412 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005413 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005414 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005415 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005416 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005417 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005418 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005419 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005420 other_secret_len = 48;
5421 other_secret = handshake->premaster + 2;
5422 break;
5423 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005424 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005425 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5426 other_secret = handshake->premaster + 2;
5427 break;
5428 default:
5429 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005430 }
5431
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005432 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005433 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005434 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005435 (unsigned char const *) lbl,
5436 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005437 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005438 master_secret_len );
5439 if( status != PSA_SUCCESS )
5440 {
5441 psa_key_derivation_abort( &derivation );
5442 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5443 }
5444
5445 status = psa_key_derivation_output_bytes( &derivation,
5446 master,
5447 master_secret_len );
5448 if( status != PSA_SUCCESS )
5449 {
5450 psa_key_derivation_abort( &derivation );
5451 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5452 }
5453
5454 status = psa_key_derivation_abort( &derivation );
5455 if( status != PSA_SUCCESS )
5456 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5457 }
5458 else
5459#endif
5460 {
5461 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005462 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005463 master,
5464 master_secret_len );
5465 if( ret != 0 )
5466 {
5467 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5468 return( ret );
5469 }
5470
5471 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5472 handshake->premaster,
5473 handshake->pmslen );
5474
5475 mbedtls_platform_zeroize( handshake->premaster,
5476 sizeof(handshake->premaster) );
5477 }
5478
5479 return( 0 );
5480}
5481
Jerry Yud62f87e2022-02-17 14:09:02 +08005482int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5483{
5484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5485 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5486 ssl->handshake->ciphersuite_info;
5487
5488 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5489
5490 /* Set PRF, calc_verify and calc_finished function pointers */
5491 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005492 ciphersuite_info->mac );
5493 if( ret != 0 )
5494 {
5495 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5496 return( ret );
5497 }
5498
5499 /* Compute master secret if needed */
5500 ret = ssl_compute_master( ssl->handshake,
5501 ssl->session_negotiate->master,
5502 ssl );
5503 if( ret != 0 )
5504 {
5505 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5506 return( ret );
5507 }
5508
5509 /* Swap the client and server random values:
5510 * - MS derivation wanted client+server (RFC 5246 8.1)
5511 * - key derivation wants server+client (RFC 5246 6.3) */
5512 {
5513 unsigned char tmp[64];
5514 memcpy( tmp, ssl->handshake->randbytes, 64 );
5515 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5516 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5517 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5518 }
5519
5520 /* Populate transform structure */
5521 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5522 ssl->session_negotiate->ciphersuite,
5523 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005524#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005525 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005526#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005527 ssl->handshake->tls_prf,
5528 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005529 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005530 ssl->conf->endpoint,
5531 ssl );
5532 if( ret != 0 )
5533 {
5534 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5535 return( ret );
5536 }
5537
5538 /* We no longer need Server/ClientHello.random values */
5539 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5540 sizeof( ssl->handshake->randbytes ) );
5541
5542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5543
5544 return( 0 );
5545}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005546
Ronald Cron4dcbca92022-03-07 10:21:40 +01005547int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5548{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005549 switch( md )
5550 {
5551#if defined(MBEDTLS_SHA384_C)
5552 case MBEDTLS_SSL_HASH_SHA384:
5553 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5554 break;
5555#endif
5556#if defined(MBEDTLS_SHA256_C)
5557 case MBEDTLS_SSL_HASH_SHA256:
5558 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5559 break;
5560#endif
5561 default:
5562 return( -1 );
5563 }
5564
Ronald Cronc2f13a02022-03-07 10:25:24 +01005565 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005566}
5567
Jerry Yu8392e0d2022-02-17 14:10:24 +08005568#if defined(MBEDTLS_SHA256_C)
5569void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5570 unsigned char *hash,
5571 size_t *hlen )
5572{
5573#if defined(MBEDTLS_USE_PSA_CRYPTO)
5574 size_t hash_size;
5575 psa_status_t status;
5576 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5577
5578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5579 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5580 if( status != PSA_SUCCESS )
5581 {
5582 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5583 return;
5584 }
5585
5586 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5587 if( status != PSA_SUCCESS )
5588 {
5589 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5590 return;
5591 }
5592
5593 *hlen = 32;
5594 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5596#else
5597 mbedtls_sha256_context sha256;
5598
5599 mbedtls_sha256_init( &sha256 );
5600
5601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5602
5603 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5604 mbedtls_sha256_finish( &sha256, hash );
5605
5606 *hlen = 32;
5607
5608 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5609 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5610
5611 mbedtls_sha256_free( &sha256 );
5612#endif /* MBEDTLS_USE_PSA_CRYPTO */
5613 return;
5614}
5615#endif /* MBEDTLS_SHA256_C */
5616
Jerry Yuc1cb3842022-02-17 14:13:48 +08005617#if defined(MBEDTLS_SHA384_C)
5618void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5619 unsigned char *hash,
5620 size_t *hlen )
5621{
5622#if defined(MBEDTLS_USE_PSA_CRYPTO)
5623 size_t hash_size;
5624 psa_status_t status;
5625 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5626
5627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5628 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5629 if( status != PSA_SUCCESS )
5630 {
5631 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5632 return;
5633 }
5634
5635 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5636 if( status != PSA_SUCCESS )
5637 {
5638 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5639 return;
5640 }
5641
5642 *hlen = 48;
5643 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5644 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5645#else
5646 mbedtls_sha512_context sha512;
5647
5648 mbedtls_sha512_init( &sha512 );
5649
5650 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5651
5652 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5653 mbedtls_sha512_finish( &sha512, hash );
5654
5655 *hlen = 48;
5656
5657 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5659
5660 mbedtls_sha512_free( &sha512 );
5661#endif /* MBEDTLS_USE_PSA_CRYPTO */
5662 return;
5663}
5664#endif /* MBEDTLS_SHA384_C */
5665
Neil Armstrong80f6f322022-05-03 17:56:38 +02005666#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5667 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005668int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5669{
5670 unsigned char *p = ssl->handshake->premaster;
5671 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5672 const unsigned char *psk = NULL;
5673 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005674 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005675
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005676 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005677 {
5678 /*
5679 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005680 * checked before calling this function.
5681 *
5682 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005683 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005684 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005685 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5686 {
5687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5688 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5689 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005690 }
5691
5692 /*
5693 * PMS = struct {
5694 * opaque other_secret<0..2^16-1>;
5695 * opaque psk<0..2^16-1>;
5696 * };
5697 * with "other_secret" depending on the particular key exchange
5698 */
5699#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5700 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5701 {
5702 if( end - p < 2 )
5703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5704
5705 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5706 p += 2;
5707
5708 if( end < p || (size_t)( end - p ) < psk_len )
5709 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5710
5711 memset( p, 0, psk_len );
5712 p += psk_len;
5713 }
5714 else
5715#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5716#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5717 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5718 {
5719 /*
5720 * other_secret already set by the ClientKeyExchange message,
5721 * and is 48 bytes long
5722 */
5723 if( end - p < 2 )
5724 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5725
5726 *p++ = 0;
5727 *p++ = 48;
5728 p += 48;
5729 }
5730 else
5731#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5732#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5733 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5734 {
5735 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5736 size_t len;
5737
5738 /* Write length only when we know the actual value */
5739 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5740 p + 2, end - ( p + 2 ), &len,
5741 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5742 {
5743 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5744 return( ret );
5745 }
5746 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5747 p += 2 + len;
5748
5749 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5750 }
5751 else
5752#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005753#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005754 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5755 {
5756 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5757 size_t zlen;
5758
5759 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5760 p + 2, end - ( p + 2 ),
5761 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5762 {
5763 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5764 return( ret );
5765 }
5766
5767 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5768 p += 2 + zlen;
5769
5770 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5771 MBEDTLS_DEBUG_ECDH_Z );
5772 }
5773 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005774#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005775 {
5776 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5777 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5778 }
5779
5780 /* opaque psk<0..2^16-1>; */
5781 if( end - p < 2 )
5782 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5783
5784 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5785 p += 2;
5786
5787 if( end < p || (size_t)( end - p ) < psk_len )
5788 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5789
5790 memcpy( p, psk, psk_len );
5791 p += psk_len;
5792
5793 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5794
5795 return( 0 );
5796}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005797#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005798
5799#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005800MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08005801static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5802
5803#if defined(MBEDTLS_SSL_PROTO_DTLS)
5804int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5805{
5806 /* If renegotiation is not enforced, retransmit until we would reach max
5807 * timeout if we were using the usual handshake doubling scheme */
5808 if( ssl->conf->renego_max_records < 0 )
5809 {
5810 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5811 unsigned char doublings = 1;
5812
5813 while( ratio != 0 )
5814 {
5815 ++doublings;
5816 ratio >>= 1;
5817 }
5818
5819 if( ++ssl->renego_records_seen > doublings )
5820 {
5821 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5822 return( 0 );
5823 }
5824 }
5825
5826 return( ssl_write_hello_request( ssl ) );
5827}
5828#endif
5829#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005830
Jerry Yud9526692022-02-17 14:23:47 +08005831/*
5832 * Handshake functions
5833 */
5834#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5835/* No certificate support -> dummy functions */
5836int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5837{
5838 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5839 ssl->handshake->ciphersuite_info;
5840
5841 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5842
5843 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5844 {
5845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5846 ssl->state++;
5847 return( 0 );
5848 }
5849
5850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5851 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5852}
5853
5854int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5855{
5856 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5857 ssl->handshake->ciphersuite_info;
5858
5859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5860
5861 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5862 {
5863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5864 ssl->state++;
5865 return( 0 );
5866 }
5867
5868 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5869 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5870}
5871
5872#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5873/* Some certificate support -> implement write and parse */
5874
5875int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5876{
5877 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5878 size_t i, n;
5879 const mbedtls_x509_crt *crt;
5880 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5881 ssl->handshake->ciphersuite_info;
5882
5883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5884
5885 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5886 {
5887 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5888 ssl->state++;
5889 return( 0 );
5890 }
5891
5892#if defined(MBEDTLS_SSL_CLI_C)
5893 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5894 {
5895 if( ssl->handshake->client_auth == 0 )
5896 {
5897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5898 ssl->state++;
5899 return( 0 );
5900 }
5901 }
5902#endif /* MBEDTLS_SSL_CLI_C */
5903#if defined(MBEDTLS_SSL_SRV_C)
5904 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5905 {
5906 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5907 {
5908 /* Should never happen because we shouldn't have picked the
5909 * ciphersuite if we don't have a certificate. */
5910 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5911 }
5912 }
5913#endif
5914
5915 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5916
5917 /*
5918 * 0 . 0 handshake type
5919 * 1 . 3 handshake length
5920 * 4 . 6 length of all certs
5921 * 7 . 9 length of cert. 1
5922 * 10 . n-1 peer certificate
5923 * n . n+2 length of cert. 2
5924 * n+3 . ... upper level cert, etc.
5925 */
5926 i = 7;
5927 crt = mbedtls_ssl_own_cert( ssl );
5928
5929 while( crt != NULL )
5930 {
5931 n = crt->raw.len;
5932 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5933 {
5934 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5935 " > %" MBEDTLS_PRINTF_SIZET,
5936 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5937 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5938 }
5939
5940 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5941 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5942 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5943
5944 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5945 i += n; crt = crt->next;
5946 }
5947
5948 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5949 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5950 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5951
5952 ssl->out_msglen = i;
5953 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5954 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5955
5956 ssl->state++;
5957
5958 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5959 {
5960 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5961 return( ret );
5962 }
5963
5964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5965
5966 return( ret );
5967}
5968
5969#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5970
5971#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005972MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08005973static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5974 unsigned char *crt_buf,
5975 size_t crt_buf_len )
5976{
5977 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5978
5979 if( peer_crt == NULL )
5980 return( -1 );
5981
5982 if( peer_crt->raw.len != crt_buf_len )
5983 return( -1 );
5984
5985 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5986}
5987#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005988MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08005989static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5990 unsigned char *crt_buf,
5991 size_t crt_buf_len )
5992{
5993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5994 unsigned char const * const peer_cert_digest =
5995 ssl->session->peer_cert_digest;
5996 mbedtls_md_type_t const peer_cert_digest_type =
5997 ssl->session->peer_cert_digest_type;
5998 mbedtls_md_info_t const * const digest_info =
5999 mbedtls_md_info_from_type( peer_cert_digest_type );
6000 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6001 size_t digest_len;
6002
6003 if( peer_cert_digest == NULL || digest_info == NULL )
6004 return( -1 );
6005
6006 digest_len = mbedtls_md_get_size( digest_info );
6007 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6008 return( -1 );
6009
6010 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6011 if( ret != 0 )
6012 return( -1 );
6013
6014 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6015}
6016#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6017#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6018
6019/*
6020 * Once the certificate message is read, parse it into a cert chain and
6021 * perform basic checks, but leave actual verification to the caller
6022 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006023MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006024static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6025 mbedtls_x509_crt *chain )
6026{
6027 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6028#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6029 int crt_cnt=0;
6030#endif
6031 size_t i, n;
6032 uint8_t alert;
6033
6034 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6035 {
6036 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6037 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6038 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6039 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6040 }
6041
6042 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6043 {
6044 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6045 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6046 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6047 }
6048
6049 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6050 {
6051 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6052 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6053 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6054 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6055 }
6056
6057 i = mbedtls_ssl_hs_hdr_len( ssl );
6058
6059 /*
6060 * Same message structure as in mbedtls_ssl_write_certificate()
6061 */
6062 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6063
6064 if( ssl->in_msg[i] != 0 ||
6065 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6066 {
6067 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6068 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6069 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6070 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6071 }
6072
6073 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6074 i += 3;
6075
6076 /* Iterate through and parse the CRTs in the provided chain. */
6077 while( i < ssl->in_hslen )
6078 {
6079 /* Check that there's room for the next CRT's length fields. */
6080 if ( i + 3 > ssl->in_hslen ) {
6081 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6082 mbedtls_ssl_send_alert_message( ssl,
6083 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6084 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6085 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6086 }
6087 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6088 * anything beyond 2**16 ~ 64K. */
6089 if( ssl->in_msg[i] != 0 )
6090 {
6091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6092 mbedtls_ssl_send_alert_message( ssl,
6093 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6094 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6095 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6096 }
6097
6098 /* Read length of the next CRT in the chain. */
6099 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6100 | (unsigned int) ssl->in_msg[i + 2];
6101 i += 3;
6102
6103 if( n < 128 || i + n > ssl->in_hslen )
6104 {
6105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6106 mbedtls_ssl_send_alert_message( ssl,
6107 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6108 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6109 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6110 }
6111
6112 /* Check if we're handling the first CRT in the chain. */
6113#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6114 if( crt_cnt++ == 0 &&
6115 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6116 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6117 {
6118 /* During client-side renegotiation, check that the server's
6119 * end-CRTs hasn't changed compared to the initial handshake,
6120 * mitigating the triple handshake attack. On success, reuse
6121 * the original end-CRT instead of parsing it again. */
6122 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6123 if( ssl_check_peer_crt_unchanged( ssl,
6124 &ssl->in_msg[i],
6125 n ) != 0 )
6126 {
6127 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6128 mbedtls_ssl_send_alert_message( ssl,
6129 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6130 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6131 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6132 }
6133
6134 /* Now we can safely free the original chain. */
6135 ssl_clear_peer_cert( ssl->session );
6136 }
6137#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6138
6139 /* Parse the next certificate in the chain. */
6140#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6141 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6142#else
6143 /* If we don't need to store the CRT chain permanently, parse
6144 * it in-place from the input buffer instead of making a copy. */
6145 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6146#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6147 switch( ret )
6148 {
6149 case 0: /*ok*/
6150 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6151 /* Ignore certificate with an unknown algorithm: maybe a
6152 prior certificate was already trusted. */
6153 break;
6154
6155 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6156 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6157 goto crt_parse_der_failed;
6158
6159 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6160 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6161 goto crt_parse_der_failed;
6162
6163 default:
6164 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6165 crt_parse_der_failed:
6166 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6167 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6168 return( ret );
6169 }
6170
6171 i += n;
6172 }
6173
6174 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6175 return( 0 );
6176}
6177
6178#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006179MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006180static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6181{
6182 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6183 return( -1 );
6184
6185 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6186 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6187 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6188 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6189 {
Ronald Cron19385882022-06-15 16:26:13 +02006190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006191 return( 0 );
6192 }
6193 return( -1 );
6194}
6195#endif /* MBEDTLS_SSL_SRV_C */
6196
6197/* Check if a certificate message is expected.
6198 * Return either
6199 * - SSL_CERTIFICATE_EXPECTED, or
6200 * - SSL_CERTIFICATE_SKIP
6201 * indicating whether a Certificate message is expected or not.
6202 */
6203#define SSL_CERTIFICATE_EXPECTED 0
6204#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006205MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006206static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6207 int authmode )
6208{
6209 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6210 ssl->handshake->ciphersuite_info;
6211
6212 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6213 return( SSL_CERTIFICATE_SKIP );
6214
6215#if defined(MBEDTLS_SSL_SRV_C)
6216 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6217 {
6218 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6219 return( SSL_CERTIFICATE_SKIP );
6220
6221 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6222 {
6223 ssl->session_negotiate->verify_result =
6224 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6225 return( SSL_CERTIFICATE_SKIP );
6226 }
6227 }
6228#else
6229 ((void) authmode);
6230#endif /* MBEDTLS_SSL_SRV_C */
6231
6232 return( SSL_CERTIFICATE_EXPECTED );
6233}
6234
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006235MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006236static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6237 int authmode,
6238 mbedtls_x509_crt *chain,
6239 void *rs_ctx )
6240{
6241 int ret = 0;
6242 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6243 ssl->handshake->ciphersuite_info;
6244 int have_ca_chain = 0;
6245
6246 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6247 void *p_vrfy;
6248
6249 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6250 return( 0 );
6251
6252 if( ssl->f_vrfy != NULL )
6253 {
6254 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6255 f_vrfy = ssl->f_vrfy;
6256 p_vrfy = ssl->p_vrfy;
6257 }
6258 else
6259 {
6260 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6261 f_vrfy = ssl->conf->f_vrfy;
6262 p_vrfy = ssl->conf->p_vrfy;
6263 }
6264
6265 /*
6266 * Main check: verify certificate
6267 */
6268#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6269 if( ssl->conf->f_ca_cb != NULL )
6270 {
6271 ((void) rs_ctx);
6272 have_ca_chain = 1;
6273
6274 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6275 ret = mbedtls_x509_crt_verify_with_ca_cb(
6276 chain,
6277 ssl->conf->f_ca_cb,
6278 ssl->conf->p_ca_cb,
6279 ssl->conf->cert_profile,
6280 ssl->hostname,
6281 &ssl->session_negotiate->verify_result,
6282 f_vrfy, p_vrfy );
6283 }
6284 else
6285#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6286 {
6287 mbedtls_x509_crt *ca_chain;
6288 mbedtls_x509_crl *ca_crl;
6289
6290#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6291 if( ssl->handshake->sni_ca_chain != NULL )
6292 {
6293 ca_chain = ssl->handshake->sni_ca_chain;
6294 ca_crl = ssl->handshake->sni_ca_crl;
6295 }
6296 else
6297#endif
6298 {
6299 ca_chain = ssl->conf->ca_chain;
6300 ca_crl = ssl->conf->ca_crl;
6301 }
6302
6303 if( ca_chain != NULL )
6304 have_ca_chain = 1;
6305
6306 ret = mbedtls_x509_crt_verify_restartable(
6307 chain,
6308 ca_chain, ca_crl,
6309 ssl->conf->cert_profile,
6310 ssl->hostname,
6311 &ssl->session_negotiate->verify_result,
6312 f_vrfy, p_vrfy, rs_ctx );
6313 }
6314
6315 if( ret != 0 )
6316 {
6317 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6318 }
6319
6320#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6321 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6322 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6323#endif
6324
6325 /*
6326 * Secondary checks: always done, but change 'ret' only if it was 0
6327 */
6328
6329#if defined(MBEDTLS_ECP_C)
6330 {
6331 const mbedtls_pk_context *pk = &chain->pk;
6332
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006333 /* If certificate uses an EC key, make sure the curve is OK.
6334 * This is a public key, so it can't be opaque, so can_do() is a good
6335 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006336 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6337 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6338 {
6339 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6340
6341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6342 if( ret == 0 )
6343 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6344 }
6345 }
6346#endif /* MBEDTLS_ECP_C */
6347
6348 if( mbedtls_ssl_check_cert_usage( chain,
6349 ciphersuite_info,
6350 ! ssl->conf->endpoint,
6351 &ssl->session_negotiate->verify_result ) != 0 )
6352 {
6353 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6354 if( ret == 0 )
6355 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6356 }
6357
6358 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6359 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6360 * with details encoded in the verification flags. All other kinds
6361 * of error codes, including those from the user provided f_vrfy
6362 * functions, are treated as fatal and lead to a failure of
6363 * ssl_parse_certificate even if verification was optional. */
6364 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6365 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6366 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6367 {
6368 ret = 0;
6369 }
6370
6371 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6372 {
6373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6374 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6375 }
6376
6377 if( ret != 0 )
6378 {
6379 uint8_t alert;
6380
6381 /* The certificate may have been rejected for several reasons.
6382 Pick one and send the corresponding alert. Which alert to send
6383 may be a subject of debate in some cases. */
6384 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6385 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6386 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6387 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6388 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6389 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6390 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6391 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6392 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6393 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6394 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6395 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6396 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6397 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6398 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6399 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6400 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6401 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6402 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6403 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6404 else
6405 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6406 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6407 alert );
6408 }
6409
6410#if defined(MBEDTLS_DEBUG_C)
6411 if( ssl->session_negotiate->verify_result != 0 )
6412 {
6413 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6414 (unsigned int) ssl->session_negotiate->verify_result ) );
6415 }
6416 else
6417 {
6418 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6419 }
6420#endif /* MBEDTLS_DEBUG_C */
6421
6422 return( ret );
6423}
6424
6425#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006426MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006427static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6428 unsigned char *start, size_t len )
6429{
6430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6431 /* Remember digest of the peer's end-CRT. */
6432 ssl->session_negotiate->peer_cert_digest =
6433 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6434 if( ssl->session_negotiate->peer_cert_digest == NULL )
6435 {
6436 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6437 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6438 mbedtls_ssl_send_alert_message( ssl,
6439 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6440 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6441
6442 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6443 }
6444
6445 ret = mbedtls_md( mbedtls_md_info_from_type(
6446 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6447 start, len,
6448 ssl->session_negotiate->peer_cert_digest );
6449
6450 ssl->session_negotiate->peer_cert_digest_type =
6451 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6452 ssl->session_negotiate->peer_cert_digest_len =
6453 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6454
6455 return( ret );
6456}
6457
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006458MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006459static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6460 unsigned char *start, size_t len )
6461{
6462 unsigned char *end = start + len;
6463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6464
6465 /* Make a copy of the peer's raw public key. */
6466 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6467 ret = mbedtls_pk_parse_subpubkey( &start, end,
6468 &ssl->handshake->peer_pubkey );
6469 if( ret != 0 )
6470 {
6471 /* We should have parsed the public key before. */
6472 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6473 }
6474
6475 return( 0 );
6476}
6477#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6478
6479int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6480{
6481 int ret = 0;
6482 int crt_expected;
6483#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6484 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6485 ? ssl->handshake->sni_authmode
6486 : ssl->conf->authmode;
6487#else
6488 const int authmode = ssl->conf->authmode;
6489#endif
6490 void *rs_ctx = NULL;
6491 mbedtls_x509_crt *chain = NULL;
6492
6493 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6494
6495 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6496 if( crt_expected == SSL_CERTIFICATE_SKIP )
6497 {
6498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6499 goto exit;
6500 }
6501
6502#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6503 if( ssl->handshake->ecrs_enabled &&
6504 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6505 {
6506 chain = ssl->handshake->ecrs_peer_cert;
6507 ssl->handshake->ecrs_peer_cert = NULL;
6508 goto crt_verify;
6509 }
6510#endif
6511
6512 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6513 {
6514 /* mbedtls_ssl_read_record may have sent an alert already. We
6515 let it decide whether to alert. */
6516 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6517 goto exit;
6518 }
6519
6520#if defined(MBEDTLS_SSL_SRV_C)
6521 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6522 {
6523 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6524
6525 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6526 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6527
6528 goto exit;
6529 }
6530#endif /* MBEDTLS_SSL_SRV_C */
6531
6532 /* Clear existing peer CRT structure in case we tried to
6533 * reuse a session but it failed, and allocate a new one. */
6534 ssl_clear_peer_cert( ssl->session_negotiate );
6535
6536 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6537 if( chain == NULL )
6538 {
6539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6540 sizeof( mbedtls_x509_crt ) ) );
6541 mbedtls_ssl_send_alert_message( ssl,
6542 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6543 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6544
6545 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6546 goto exit;
6547 }
6548 mbedtls_x509_crt_init( chain );
6549
6550 ret = ssl_parse_certificate_chain( ssl, chain );
6551 if( ret != 0 )
6552 goto exit;
6553
6554#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6555 if( ssl->handshake->ecrs_enabled)
6556 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6557
6558crt_verify:
6559 if( ssl->handshake->ecrs_enabled)
6560 rs_ctx = &ssl->handshake->ecrs_ctx;
6561#endif
6562
6563 ret = ssl_parse_certificate_verify( ssl, authmode,
6564 chain, rs_ctx );
6565 if( ret != 0 )
6566 goto exit;
6567
6568#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6569 {
6570 unsigned char *crt_start, *pk_start;
6571 size_t crt_len, pk_len;
6572
6573 /* We parse the CRT chain without copying, so
6574 * these pointers point into the input buffer,
6575 * and are hence still valid after freeing the
6576 * CRT chain. */
6577
6578 crt_start = chain->raw.p;
6579 crt_len = chain->raw.len;
6580
6581 pk_start = chain->pk_raw.p;
6582 pk_len = chain->pk_raw.len;
6583
6584 /* Free the CRT structures before computing
6585 * digest and copying the peer's public key. */
6586 mbedtls_x509_crt_free( chain );
6587 mbedtls_free( chain );
6588 chain = NULL;
6589
6590 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6591 if( ret != 0 )
6592 goto exit;
6593
6594 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6595 if( ret != 0 )
6596 goto exit;
6597 }
6598#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6599 /* Pass ownership to session structure. */
6600 ssl->session_negotiate->peer_cert = chain;
6601 chain = NULL;
6602#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6603
6604 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6605
6606exit:
6607
6608 if( ret == 0 )
6609 ssl->state++;
6610
6611#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6612 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6613 {
6614 ssl->handshake->ecrs_peer_cert = chain;
6615 chain = NULL;
6616 }
6617#endif
6618
6619 if( chain != NULL )
6620 {
6621 mbedtls_x509_crt_free( chain );
6622 mbedtls_free( chain );
6623 }
6624
6625 return( ret );
6626}
6627#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6628
Jerry Yu615bd6f2022-02-17 14:25:15 +08006629#if defined(MBEDTLS_SHA256_C)
6630static void ssl_calc_finished_tls_sha256(
6631 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6632{
6633 int len = 12;
6634 const char *sender;
6635 unsigned char padbuf[32];
6636#if defined(MBEDTLS_USE_PSA_CRYPTO)
6637 size_t hash_size;
6638 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6639 psa_status_t status;
6640#else
6641 mbedtls_sha256_context sha256;
6642#endif
6643
6644 mbedtls_ssl_session *session = ssl->session_negotiate;
6645 if( !session )
6646 session = ssl->session;
6647
6648 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6649 ? "client finished"
6650 : "server finished";
6651
6652#if defined(MBEDTLS_USE_PSA_CRYPTO)
6653 sha256_psa = psa_hash_operation_init();
6654
6655 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6656
6657 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6658 if( status != PSA_SUCCESS )
6659 {
6660 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6661 return;
6662 }
6663
6664 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6665 if( status != PSA_SUCCESS )
6666 {
6667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6668 return;
6669 }
6670 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6671#else
6672
6673 mbedtls_sha256_init( &sha256 );
6674
6675 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6676
6677 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6678
6679 /*
6680 * TLSv1.2:
6681 * hash = PRF( master, finished_label,
6682 * Hash( handshake ) )[0.11]
6683 */
6684
6685#if !defined(MBEDTLS_SHA256_ALT)
6686 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6687 sha256.state, sizeof( sha256.state ) );
6688#endif
6689
6690 mbedtls_sha256_finish( &sha256, padbuf );
6691 mbedtls_sha256_free( &sha256 );
6692#endif /* MBEDTLS_USE_PSA_CRYPTO */
6693
6694 ssl->handshake->tls_prf( session->master, 48, sender,
6695 padbuf, 32, buf, len );
6696
6697 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6698
6699 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6700
6701 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6702}
6703#endif /* MBEDTLS_SHA256_C */
6704
Jerry Yub7ba49e2022-02-17 14:25:53 +08006705
6706#if defined(MBEDTLS_SHA384_C)
6707
6708static void ssl_calc_finished_tls_sha384(
6709 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6710{
6711 int len = 12;
6712 const char *sender;
6713 unsigned char padbuf[48];
6714#if defined(MBEDTLS_USE_PSA_CRYPTO)
6715 size_t hash_size;
6716 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6717 psa_status_t status;
6718#else
6719 mbedtls_sha512_context sha512;
6720#endif
6721
6722 mbedtls_ssl_session *session = ssl->session_negotiate;
6723 if( !session )
6724 session = ssl->session;
6725
6726 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6727 ? "client finished"
6728 : "server finished";
6729
6730#if defined(MBEDTLS_USE_PSA_CRYPTO)
6731 sha384_psa = psa_hash_operation_init();
6732
6733 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6734
6735 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6736 if( status != PSA_SUCCESS )
6737 {
6738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6739 return;
6740 }
6741
6742 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6743 if( status != PSA_SUCCESS )
6744 {
6745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6746 return;
6747 }
6748 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6749#else
6750 mbedtls_sha512_init( &sha512 );
6751
6752 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6753
6754 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6755
6756 /*
6757 * TLSv1.2:
6758 * hash = PRF( master, finished_label,
6759 * Hash( handshake ) )[0.11]
6760 */
6761
6762#if !defined(MBEDTLS_SHA512_ALT)
6763 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6764 sha512.state, sizeof( sha512.state ) );
6765#endif
6766 mbedtls_sha512_finish( &sha512, padbuf );
6767
6768 mbedtls_sha512_free( &sha512 );
6769#endif
6770
6771 ssl->handshake->tls_prf( session->master, 48, sender,
6772 padbuf, 48, buf, len );
6773
6774 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6775
6776 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6777
6778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6779}
6780#endif /* MBEDTLS_SHA384_C */
6781
Jerry Yuaef00152022-02-17 14:27:31 +08006782void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6783{
6784 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6785
6786 /*
6787 * Free our handshake params
6788 */
6789 mbedtls_ssl_handshake_free( ssl );
6790 mbedtls_free( ssl->handshake );
6791 ssl->handshake = NULL;
6792
6793 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006794 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006795 */
6796 if( ssl->transform )
6797 {
6798 mbedtls_ssl_transform_free( ssl->transform );
6799 mbedtls_free( ssl->transform );
6800 }
6801 ssl->transform = ssl->transform_negotiate;
6802 ssl->transform_negotiate = NULL;
6803
6804 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6805}
6806
Jerry Yu2a9fff52022-02-17 14:28:51 +08006807void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6808{
6809 int resume = ssl->handshake->resume;
6810
6811 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6812
6813#if defined(MBEDTLS_SSL_RENEGOTIATION)
6814 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6815 {
6816 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6817 ssl->renego_records_seen = 0;
6818 }
6819#endif
6820
6821 /*
6822 * Free the previous session and switch in the current one
6823 */
6824 if( ssl->session )
6825 {
6826#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6827 /* RFC 7366 3.1: keep the EtM state */
6828 ssl->session_negotiate->encrypt_then_mac =
6829 ssl->session->encrypt_then_mac;
6830#endif
6831
6832 mbedtls_ssl_session_free( ssl->session );
6833 mbedtls_free( ssl->session );
6834 }
6835 ssl->session = ssl->session_negotiate;
6836 ssl->session_negotiate = NULL;
6837
6838 /*
6839 * Add cache entry
6840 */
6841 if( ssl->conf->f_set_cache != NULL &&
6842 ssl->session->id_len != 0 &&
6843 resume == 0 )
6844 {
6845 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6846 ssl->session->id,
6847 ssl->session->id_len,
6848 ssl->session ) != 0 )
6849 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6850 }
6851
6852#if defined(MBEDTLS_SSL_PROTO_DTLS)
6853 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6854 ssl->handshake->flight != NULL )
6855 {
6856 /* Cancel handshake timer */
6857 mbedtls_ssl_set_timer( ssl, 0 );
6858
6859 /* Keep last flight around in case we need to resend it:
6860 * we need the handshake and transform structures for that */
6861 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6862 }
6863 else
6864#endif
6865 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6866
6867 ssl->state++;
6868
6869 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6870}
6871
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006872int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6873{
6874 int ret, hash_len;
6875
6876 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6877
6878 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6879
6880 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6881
6882 /*
6883 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6884 * may define some other value. Currently (early 2016), no defined
6885 * ciphersuite does this (and this is unlikely to change as activity has
6886 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6887 */
6888 hash_len = 12;
6889
6890#if defined(MBEDTLS_SSL_RENEGOTIATION)
6891 ssl->verify_data_len = hash_len;
6892 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6893#endif
6894
6895 ssl->out_msglen = 4 + hash_len;
6896 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6897 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6898
6899 /*
6900 * In case of session resuming, invert the client and server
6901 * ChangeCipherSpec messages order.
6902 */
6903 if( ssl->handshake->resume != 0 )
6904 {
6905#if defined(MBEDTLS_SSL_CLI_C)
6906 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6907 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6908#endif
6909#if defined(MBEDTLS_SSL_SRV_C)
6910 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6911 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6912#endif
6913 }
6914 else
6915 ssl->state++;
6916
6917 /*
6918 * Switch to our negotiated transform and session parameters for outbound
6919 * data.
6920 */
6921 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6922
6923#if defined(MBEDTLS_SSL_PROTO_DTLS)
6924 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6925 {
6926 unsigned char i;
6927
6928 /* Remember current epoch settings for resending */
6929 ssl->handshake->alt_transform_out = ssl->transform_out;
6930 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6931 sizeof( ssl->handshake->alt_out_ctr ) );
6932
6933 /* Set sequence_number to zero */
6934 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6935
6936
6937 /* Increment epoch */
6938 for( i = 2; i > 0; i-- )
6939 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6940 break;
6941
6942 /* The loop goes to its end iff the counter is wrapping */
6943 if( i == 0 )
6944 {
6945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6946 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6947 }
6948 }
6949 else
6950#endif /* MBEDTLS_SSL_PROTO_DTLS */
6951 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6952
6953 ssl->transform_out = ssl->transform_negotiate;
6954 ssl->session_out = ssl->session_negotiate;
6955
6956#if defined(MBEDTLS_SSL_PROTO_DTLS)
6957 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6958 mbedtls_ssl_send_flight_completed( ssl );
6959#endif
6960
6961 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6962 {
6963 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6964 return( ret );
6965 }
6966
6967#if defined(MBEDTLS_SSL_PROTO_DTLS)
6968 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6969 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6970 {
6971 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6972 return( ret );
6973 }
6974#endif
6975
6976 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6977
6978 return( 0 );
6979}
6980
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006981#define SSL_MAX_HASH_LEN 12
6982
6983int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6984{
6985 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6986 unsigned int hash_len = 12;
6987 unsigned char buf[SSL_MAX_HASH_LEN];
6988
6989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6990
6991 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6992
6993 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6994 {
6995 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6996 goto exit;
6997 }
6998
6999 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7000 {
7001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7002 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7003 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7004 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7005 goto exit;
7006 }
7007
7008 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7009 {
7010 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7011 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7012 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7013 goto exit;
7014 }
7015
7016 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7017 {
7018 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7019 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7020 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7021 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7022 goto exit;
7023 }
7024
7025 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7026 buf, hash_len ) != 0 )
7027 {
7028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7029 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7030 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7031 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7032 goto exit;
7033 }
7034
7035#if defined(MBEDTLS_SSL_RENEGOTIATION)
7036 ssl->verify_data_len = hash_len;
7037 memcpy( ssl->peer_verify_data, buf, hash_len );
7038#endif
7039
7040 if( ssl->handshake->resume != 0 )
7041 {
7042#if defined(MBEDTLS_SSL_CLI_C)
7043 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7044 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7045#endif
7046#if defined(MBEDTLS_SSL_SRV_C)
7047 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7048 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7049#endif
7050 }
7051 else
7052 ssl->state++;
7053
7054#if defined(MBEDTLS_SSL_PROTO_DTLS)
7055 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7056 mbedtls_ssl_recv_flight_completed( ssl );
7057#endif
7058
7059 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7060
7061exit:
7062 mbedtls_platform_zeroize( buf, hash_len );
7063 return( ret );
7064}
7065
Jerry Yu392112c2022-02-17 14:34:10 +08007066#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7067/*
7068 * Helper to get TLS 1.2 PRF from ciphersuite
7069 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7070 */
7071static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7072{
7073#if defined(MBEDTLS_SHA384_C)
7074 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7075 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7076
7077 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7078 return( tls_prf_sha384 );
7079#else
7080 (void) ciphersuite_id;
7081#endif
7082 return( tls_prf_sha256 );
7083}
7084#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007085
7086static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7087{
7088 ((void) tls_prf);
7089#if defined(MBEDTLS_SHA384_C)
7090 if( tls_prf == tls_prf_sha384 )
7091 {
7092 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7093 }
7094 else
7095#endif
7096#if defined(MBEDTLS_SHA256_C)
7097 if( tls_prf == tls_prf_sha256 )
7098 {
7099 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7100 }
7101 else
7102#endif
7103 return( MBEDTLS_SSL_TLS_PRF_NONE );
7104}
7105
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007106/*
7107 * Populate a transform structure with session keys and all the other
7108 * necessary information.
7109 *
7110 * Parameters:
7111 * - [in/out]: transform: structure to populate
7112 * [in] must be just initialised with mbedtls_ssl_transform_init()
7113 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7114 * - [in] ciphersuite
7115 * - [in] master
7116 * - [in] encrypt_then_mac
7117 * - [in] compression
7118 * - [in] tls_prf: pointer to PRF to use for key derivation
7119 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007120 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007121 * - [in] endpoint: client or server
7122 * - [in] ssl: used for:
7123 * - ssl->conf->{f,p}_export_keys
7124 * [in] optionally used for:
7125 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7126 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007127MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007128static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7129 int ciphersuite,
7130 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007131#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007132 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007134 ssl_tls_prf_t tls_prf,
7135 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007136 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007137 unsigned endpoint,
7138 const mbedtls_ssl_context *ssl )
7139{
7140 int ret = 0;
7141 unsigned char keyblk[256];
7142 unsigned char *key1;
7143 unsigned char *key2;
7144 unsigned char *mac_enc;
7145 unsigned char *mac_dec;
7146 size_t mac_key_len = 0;
7147 size_t iv_copy_len;
7148 size_t keylen;
7149 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007150 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007151#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007152 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007153 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007154#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007155
7156#if defined(MBEDTLS_USE_PSA_CRYPTO)
7157 psa_key_type_t key_type;
7158 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7159 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007160 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007161 size_t key_bits;
7162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7163#endif
7164
7165#if !defined(MBEDTLS_DEBUG_C) && \
7166 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7167 if( ssl->f_export_keys == NULL )
7168 {
7169 ssl = NULL; /* make sure we don't use it except for these cases */
7170 (void) ssl;
7171 }
7172#endif
7173
7174 /*
7175 * Some data just needs copying into the structure
7176 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007177#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007178 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007179#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007180 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007181
7182#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7183 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7184#endif
7185
7186#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007187 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007188 {
7189 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7190 * generation separate. This should never happen. */
7191 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7192 }
7193#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7194
7195 /*
7196 * Get various info structures
7197 */
7198 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7199 if( ciphersuite_info == NULL )
7200 {
7201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7202 ciphersuite ) );
7203 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7204 }
7205
Neil Armstrongab555e02022-04-04 11:07:59 +02007206 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007207#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007208 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007209#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007210 ciphersuite_info );
7211
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007212 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7213 transform->taglen =
7214 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7215
7216#if defined(MBEDTLS_USE_PSA_CRYPTO)
7217 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7218 transform->taglen,
7219 &alg,
7220 &key_type,
7221 &key_bits ) ) != PSA_SUCCESS )
7222 {
7223 ret = psa_ssl_status_to_mbedtls( status );
7224 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7225 goto end;
7226 }
7227#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007228 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7229 if( cipher_info == NULL )
7230 {
7231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7232 ciphersuite_info->cipher ) );
7233 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7234 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007235#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007236
Neil Armstronge4512952022-03-08 09:08:22 +01007237#if defined(MBEDTLS_USE_PSA_CRYPTO)
7238 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7239 if( mac_alg == 0 )
7240 {
7241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7242 (unsigned) ciphersuite_info->mac ) );
7243 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7244 }
7245#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007246 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7247 if( md_info == NULL )
7248 {
7249 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7250 (unsigned) ciphersuite_info->mac ) );
7251 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7252 }
Neil Armstronge4512952022-03-08 09:08:22 +01007253#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007254
7255#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7256 /* Copy own and peer's CID if the use of the CID
7257 * extension has been negotiated. */
7258 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7259 {
7260 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7261
7262 transform->in_cid_len = ssl->own_cid_len;
7263 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7264 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7265 transform->in_cid_len );
7266
7267 transform->out_cid_len = ssl->handshake->peer_cid_len;
7268 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7269 ssl->handshake->peer_cid_len );
7270 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7271 transform->out_cid_len );
7272 }
7273#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7274
7275 /*
7276 * Compute key block using the PRF
7277 */
7278 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7279 if( ret != 0 )
7280 {
7281 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7282 return( ret );
7283 }
7284
7285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7286 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7287 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7288 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7289 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7290
7291 /*
7292 * Determine the appropriate key, IV and MAC length.
7293 */
7294
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007295#if defined(MBEDTLS_USE_PSA_CRYPTO)
7296 keylen = PSA_BITS_TO_BYTES(key_bits);
7297#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007298 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007299#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007300
7301#if defined(MBEDTLS_GCM_C) || \
7302 defined(MBEDTLS_CCM_C) || \
7303 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007304 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007305 {
7306 size_t explicit_ivlen;
7307
7308 transform->maclen = 0;
7309 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007310
7311 /* All modes haves 96-bit IVs, but the length of the static parts vary
7312 * with mode and version:
7313 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7314 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7315 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7316 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7317 * sequence number).
7318 */
7319 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007320#if defined(MBEDTLS_USE_PSA_CRYPTO)
7321 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7322#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007323 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007324#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007325 transform->fixed_ivlen = 12;
7326 else
7327 transform->fixed_ivlen = 4;
7328
7329 /* Minimum length of encrypted record */
7330 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7331 transform->minlen = explicit_ivlen + transform->taglen;
7332 }
7333 else
7334#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7335#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007336 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7337 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7338 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007339 {
Neil Armstronge4512952022-03-08 09:08:22 +01007340#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007341 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007342#else
7343 size_t block_size = cipher_info->block_size;
7344#endif /* MBEDTLS_USE_PSA_CRYPTO */
7345
7346#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007347 /* Get MAC length */
7348 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7349#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007350 /* Initialize HMAC contexts */
7351 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7352 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7353 {
7354 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7355 goto end;
7356 }
7357
7358 /* Get MAC length */
7359 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007360#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007361 transform->maclen = mac_key_len;
7362
7363 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007364#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007365 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007366#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007367 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007368#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007369
7370 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007371 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007372 transform->minlen = transform->maclen;
7373 else
7374 {
7375 /*
7376 * GenericBlockCipher:
7377 * 1. if EtM is in use: one block plus MAC
7378 * otherwise: * first multiple of blocklen greater than maclen
7379 * 2. IV
7380 */
7381#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007382 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007383 {
7384 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007385 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007386 }
7387 else
7388#endif
7389 {
7390 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007391 + block_size
7392 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007393 }
7394
Glenn Strauss07c64162022-03-14 12:34:51 -04007395 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007396 {
7397 transform->minlen += transform->ivlen;
7398 }
7399 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007400 {
7401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7402 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7403 goto end;
7404 }
7405 }
7406 }
7407 else
7408#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7409 {
7410 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7411 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7412 }
7413
7414 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7415 (unsigned) keylen,
7416 (unsigned) transform->minlen,
7417 (unsigned) transform->ivlen,
7418 (unsigned) transform->maclen ) );
7419
7420 /*
7421 * Finally setup the cipher contexts, IVs and MAC secrets.
7422 */
7423#if defined(MBEDTLS_SSL_CLI_C)
7424 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7425 {
7426 key1 = keyblk + mac_key_len * 2;
7427 key2 = keyblk + mac_key_len * 2 + keylen;
7428
7429 mac_enc = keyblk;
7430 mac_dec = keyblk + mac_key_len;
7431
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007432 iv_copy_len = ( transform->fixed_ivlen ) ?
7433 transform->fixed_ivlen : transform->ivlen;
7434 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7435 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7436 iv_copy_len );
7437 }
7438 else
7439#endif /* MBEDTLS_SSL_CLI_C */
7440#if defined(MBEDTLS_SSL_SRV_C)
7441 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7442 {
7443 key1 = keyblk + mac_key_len * 2 + keylen;
7444 key2 = keyblk + mac_key_len * 2;
7445
7446 mac_enc = keyblk + mac_key_len;
7447 mac_dec = keyblk;
7448
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007449 iv_copy_len = ( transform->fixed_ivlen ) ?
7450 transform->fixed_ivlen : transform->ivlen;
7451 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7452 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7453 iv_copy_len );
7454 }
7455 else
7456#endif /* MBEDTLS_SSL_SRV_C */
7457 {
7458 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7459 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7460 goto end;
7461 }
7462
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007463 if( ssl != NULL && ssl->f_export_keys != NULL )
7464 {
7465 ssl->f_export_keys( ssl->p_export_keys,
7466 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7467 master, 48,
7468 randbytes + 32,
7469 randbytes,
7470 tls_prf_get_type( tls_prf ) );
7471 }
7472
7473#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007474 transform->psa_alg = alg;
7475
7476 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7477 {
7478 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7479 psa_set_key_algorithm( &attributes, alg );
7480 psa_set_key_type( &attributes, key_type );
7481
7482 if( ( status = psa_import_key( &attributes,
7483 key1,
7484 PSA_BITS_TO_BYTES( key_bits ),
7485 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7486 {
7487 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7488 ret = psa_ssl_status_to_mbedtls( status );
7489 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7490 goto end;
7491 }
7492
7493 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7494
7495 if( ( status = psa_import_key( &attributes,
7496 key2,
7497 PSA_BITS_TO_BYTES( key_bits ),
7498 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7499 {
7500 ret = psa_ssl_status_to_mbedtls( status );
7501 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7502 goto end;
7503 }
7504 }
7505#else
7506 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7507 cipher_info ) ) != 0 )
7508 {
7509 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7510 goto end;
7511 }
7512
7513 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7514 cipher_info ) ) != 0 )
7515 {
7516 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7517 goto end;
7518 }
7519
7520 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7521 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7522 MBEDTLS_ENCRYPT ) ) != 0 )
7523 {
7524 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7525 goto end;
7526 }
7527
7528 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7529 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7530 MBEDTLS_DECRYPT ) ) != 0 )
7531 {
7532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7533 goto end;
7534 }
7535
7536#if defined(MBEDTLS_CIPHER_MODE_CBC)
7537 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7538 {
7539 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7540 MBEDTLS_PADDING_NONE ) ) != 0 )
7541 {
7542 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7543 goto end;
7544 }
7545
7546 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7547 MBEDTLS_PADDING_NONE ) ) != 0 )
7548 {
7549 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7550 goto end;
7551 }
7552 }
7553#endif /* MBEDTLS_CIPHER_MODE_CBC */
7554#endif /* MBEDTLS_USE_PSA_CRYPTO */
7555
Neil Armstrong29c0c042022-03-17 17:47:28 +01007556#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7557 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7558 For AEAD-based ciphersuites, there is nothing to do here. */
7559 if( mac_key_len != 0 )
7560 {
7561#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007562 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007563
7564 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007565 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007566 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7567
7568 if( ( status = psa_import_key( &attributes,
7569 mac_enc, mac_key_len,
7570 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7571 {
7572 ret = psa_ssl_status_to_mbedtls( status );
7573 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7574 goto end;
7575 }
7576
Ronald Cronfb39f152022-03-25 14:36:28 +01007577 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7578 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7579 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007580 /* mbedtls_ct_hmac() requires the key to be exportable */
7581 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7582 PSA_KEY_USAGE_VERIFY_HASH );
7583 else
7584 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7585
7586 if( ( status = psa_import_key( &attributes,
7587 mac_dec, mac_key_len,
7588 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7589 {
7590 ret = psa_ssl_status_to_mbedtls( status );
7591 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7592 goto end;
7593 }
7594#else
7595 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7596 if( ret != 0 )
7597 goto end;
7598 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7599 if( ret != 0 )
7600 goto end;
7601#endif /* MBEDTLS_USE_PSA_CRYPTO */
7602 }
7603#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7604
7605 ((void) mac_dec);
7606 ((void) mac_enc);
7607
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007608end:
7609 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7610 return( ret );
7611}
7612
Jerry Yuee40f9d2022-02-17 14:55:16 +08007613#if defined(MBEDTLS_USE_PSA_CRYPTO)
7614int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7615 unsigned char *hash, size_t *hashlen,
7616 unsigned char *data, size_t data_len,
7617 mbedtls_md_type_t md_alg )
7618{
7619 psa_status_t status;
7620 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7621 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7622
7623 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7624
7625 if( ( status = psa_hash_setup( &hash_operation,
7626 hash_alg ) ) != PSA_SUCCESS )
7627 {
7628 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7629 goto exit;
7630 }
7631
7632 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7633 64 ) ) != PSA_SUCCESS )
7634 {
7635 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7636 goto exit;
7637 }
7638
7639 if( ( status = psa_hash_update( &hash_operation,
7640 data, data_len ) ) != PSA_SUCCESS )
7641 {
7642 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7643 goto exit;
7644 }
7645
7646 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7647 hashlen ) ) != PSA_SUCCESS )
7648 {
7649 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7650 goto exit;
7651 }
7652
7653exit:
7654 if( status != PSA_SUCCESS )
7655 {
7656 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7657 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7658 switch( status )
7659 {
7660 case PSA_ERROR_NOT_SUPPORTED:
7661 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7662 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7663 case PSA_ERROR_BUFFER_TOO_SMALL:
7664 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7665 case PSA_ERROR_INSUFFICIENT_MEMORY:
7666 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7667 default:
7668 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7669 }
7670 }
7671 return( 0 );
7672}
7673
7674#else
7675
7676int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7677 unsigned char *hash, size_t *hashlen,
7678 unsigned char *data, size_t data_len,
7679 mbedtls_md_type_t md_alg )
7680{
7681 int ret = 0;
7682 mbedtls_md_context_t ctx;
7683 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7684 *hashlen = mbedtls_md_get_size( md_info );
7685
7686 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7687
7688 mbedtls_md_init( &ctx );
7689
7690 /*
7691 * digitally-signed struct {
7692 * opaque client_random[32];
7693 * opaque server_random[32];
7694 * ServerDHParams params;
7695 * };
7696 */
7697 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7698 {
7699 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7700 goto exit;
7701 }
7702 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7703 {
7704 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7705 goto exit;
7706 }
7707 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7708 {
7709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7710 goto exit;
7711 }
7712 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7713 {
7714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7715 goto exit;
7716 }
7717 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7718 {
7719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7720 goto exit;
7721 }
7722
7723exit:
7724 mbedtls_md_free( &ctx );
7725
7726 if( ret != 0 )
7727 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7728 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7729
7730 return( ret );
7731}
7732#endif /* MBEDTLS_USE_PSA_CRYPTO */
7733
Jerry Yud9d91da2022-02-17 14:57:06 +08007734#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7735
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007736/* Find the preferred hash for a given signature algorithm. */
7737unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7738 mbedtls_ssl_context *ssl,
7739 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007740{
Gabor Mezei078e8032022-04-27 21:17:56 +02007741 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007742 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007743
7744 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007745 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007746
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007747 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007748 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007749 unsigned int hash_alg_received =
7750 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7751 received_sig_algs[i] );
7752 unsigned int sig_alg_received =
7753 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7754 received_sig_algs[i] );
7755
7756 if( sig_alg == sig_alg_received )
7757 {
7758#if defined(MBEDTLS_USE_PSA_CRYPTO)
7759 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7760 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007761 psa_algorithm_t psa_hash_alg =
7762 mbedtls_psa_translate_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007763
Neil Armstrong96eceb82022-06-30 18:05:05 +02007764 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7765 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7766 PSA_ALG_ECDSA( psa_hash_alg ),
7767 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007768 continue;
7769
Neil Armstrong96eceb82022-06-30 18:05:05 +02007770 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02007771 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7772 PSA_ALG_RSA_PKCS1V15_SIGN(
7773 psa_hash_alg ),
7774 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007775 continue;
7776 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007777#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02007778
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007779 return( hash_alg_received );
7780 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007781 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007782
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007783 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007784}
7785
7786#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7787
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007788/* Serialization of TLS 1.2 sessions:
7789 *
7790 * struct {
7791 * uint64 start_time;
7792 * uint8 ciphersuite[2]; // defined by the standard
7793 * uint8 compression; // 0 or 1
7794 * uint8 session_id_len; // at most 32
7795 * opaque session_id[32];
7796 * opaque master[48]; // fixed length in the standard
7797 * uint32 verify_result;
7798 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7799 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7800 * uint32 ticket_lifetime;
7801 * uint8 mfl_code; // up to 255 according to standard
7802 * uint8 encrypt_then_mac; // 0 or 1
7803 * } serialized_session_tls12;
7804 *
7805 */
7806static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7807 unsigned char *buf,
7808 size_t buf_len )
7809{
7810 unsigned char *p = buf;
7811 size_t used = 0;
7812
7813#if defined(MBEDTLS_HAVE_TIME)
7814 uint64_t start;
7815#endif
7816#if defined(MBEDTLS_X509_CRT_PARSE_C)
7817#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7818 size_t cert_len;
7819#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7820#endif /* MBEDTLS_X509_CRT_PARSE_C */
7821
7822 /*
7823 * Time
7824 */
7825#if defined(MBEDTLS_HAVE_TIME)
7826 used += 8;
7827
7828 if( used <= buf_len )
7829 {
7830 start = (uint64_t) session->start;
7831
7832 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7833 p += 8;
7834 }
7835#endif /* MBEDTLS_HAVE_TIME */
7836
7837 /*
7838 * Basic mandatory fields
7839 */
7840 used += 2 /* ciphersuite */
7841 + 1 /* compression */
7842 + 1 /* id_len */
7843 + sizeof( session->id )
7844 + sizeof( session->master )
7845 + 4; /* verify_result */
7846
7847 if( used <= buf_len )
7848 {
7849 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7850 p += 2;
7851
7852 *p++ = MBEDTLS_BYTE_0( session->compression );
7853
7854 *p++ = MBEDTLS_BYTE_0( session->id_len );
7855 memcpy( p, session->id, 32 );
7856 p += 32;
7857
7858 memcpy( p, session->master, 48 );
7859 p += 48;
7860
7861 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7862 p += 4;
7863 }
7864
7865 /*
7866 * Peer's end-entity certificate
7867 */
7868#if defined(MBEDTLS_X509_CRT_PARSE_C)
7869#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7870 if( session->peer_cert == NULL )
7871 cert_len = 0;
7872 else
7873 cert_len = session->peer_cert->raw.len;
7874
7875 used += 3 + cert_len;
7876
7877 if( used <= buf_len )
7878 {
7879 *p++ = MBEDTLS_BYTE_2( cert_len );
7880 *p++ = MBEDTLS_BYTE_1( cert_len );
7881 *p++ = MBEDTLS_BYTE_0( cert_len );
7882
7883 if( session->peer_cert != NULL )
7884 {
7885 memcpy( p, session->peer_cert->raw.p, cert_len );
7886 p += cert_len;
7887 }
7888 }
7889#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7890 if( session->peer_cert_digest != NULL )
7891 {
7892 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7893 if( used <= buf_len )
7894 {
7895 *p++ = (unsigned char) session->peer_cert_digest_type;
7896 *p++ = (unsigned char) session->peer_cert_digest_len;
7897 memcpy( p, session->peer_cert_digest,
7898 session->peer_cert_digest_len );
7899 p += session->peer_cert_digest_len;
7900 }
7901 }
7902 else
7903 {
7904 used += 2;
7905 if( used <= buf_len )
7906 {
7907 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7908 *p++ = 0;
7909 }
7910 }
7911#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7912#endif /* MBEDTLS_X509_CRT_PARSE_C */
7913
7914 /*
7915 * Session ticket if any, plus associated data
7916 */
7917#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7918 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7919
7920 if( used <= buf_len )
7921 {
7922 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7923 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7924 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7925
7926 if( session->ticket != NULL )
7927 {
7928 memcpy( p, session->ticket, session->ticket_len );
7929 p += session->ticket_len;
7930 }
7931
7932 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7933 p += 4;
7934 }
7935#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7936
7937 /*
7938 * Misc extension-related info
7939 */
7940#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7941 used += 1;
7942
7943 if( used <= buf_len )
7944 *p++ = session->mfl_code;
7945#endif
7946
7947#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7948 used += 1;
7949
7950 if( used <= buf_len )
7951 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7952#endif
7953
7954 return( used );
7955}
7956
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007957MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007958static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7959 const unsigned char *buf,
7960 size_t len )
7961{
7962#if defined(MBEDTLS_HAVE_TIME)
7963 uint64_t start;
7964#endif
7965#if defined(MBEDTLS_X509_CRT_PARSE_C)
7966#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7967 size_t cert_len;
7968#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7969#endif /* MBEDTLS_X509_CRT_PARSE_C */
7970
7971 const unsigned char *p = buf;
7972 const unsigned char * const end = buf + len;
7973
7974 /*
7975 * Time
7976 */
7977#if defined(MBEDTLS_HAVE_TIME)
7978 if( 8 > (size_t)( end - p ) )
7979 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7980
7981 start = ( (uint64_t) p[0] << 56 ) |
7982 ( (uint64_t) p[1] << 48 ) |
7983 ( (uint64_t) p[2] << 40 ) |
7984 ( (uint64_t) p[3] << 32 ) |
7985 ( (uint64_t) p[4] << 24 ) |
7986 ( (uint64_t) p[5] << 16 ) |
7987 ( (uint64_t) p[6] << 8 ) |
7988 ( (uint64_t) p[7] );
7989 p += 8;
7990
7991 session->start = (time_t) start;
7992#endif /* MBEDTLS_HAVE_TIME */
7993
7994 /*
7995 * Basic mandatory fields
7996 */
7997 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7998 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7999
8000 session->ciphersuite = ( p[0] << 8 ) | p[1];
8001 p += 2;
8002
8003 session->compression = *p++;
8004
8005 session->id_len = *p++;
8006 memcpy( session->id, p, 32 );
8007 p += 32;
8008
8009 memcpy( session->master, p, 48 );
8010 p += 48;
8011
8012 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8013 ( (uint32_t) p[1] << 16 ) |
8014 ( (uint32_t) p[2] << 8 ) |
8015 ( (uint32_t) p[3] );
8016 p += 4;
8017
8018 /* Immediately clear invalid pointer values that have been read, in case
8019 * we exit early before we replaced them with valid ones. */
8020#if defined(MBEDTLS_X509_CRT_PARSE_C)
8021#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8022 session->peer_cert = NULL;
8023#else
8024 session->peer_cert_digest = NULL;
8025#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8026#endif /* MBEDTLS_X509_CRT_PARSE_C */
8027#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8028 session->ticket = NULL;
8029#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8030
8031 /*
8032 * Peer certificate
8033 */
8034#if defined(MBEDTLS_X509_CRT_PARSE_C)
8035#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8036 /* Deserialize CRT from the end of the ticket. */
8037 if( 3 > (size_t)( end - p ) )
8038 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8039
8040 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8041 p += 3;
8042
8043 if( cert_len != 0 )
8044 {
8045 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8046
8047 if( cert_len > (size_t)( end - p ) )
8048 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8049
8050 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8051
8052 if( session->peer_cert == NULL )
8053 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8054
8055 mbedtls_x509_crt_init( session->peer_cert );
8056
8057 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8058 p, cert_len ) ) != 0 )
8059 {
8060 mbedtls_x509_crt_free( session->peer_cert );
8061 mbedtls_free( session->peer_cert );
8062 session->peer_cert = NULL;
8063 return( ret );
8064 }
8065
8066 p += cert_len;
8067 }
8068#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8069 /* Deserialize CRT digest from the end of the ticket. */
8070 if( 2 > (size_t)( end - p ) )
8071 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8072
8073 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8074 session->peer_cert_digest_len = (size_t) *p++;
8075
8076 if( session->peer_cert_digest_len != 0 )
8077 {
8078 const mbedtls_md_info_t *md_info =
8079 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8080 if( md_info == NULL )
8081 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8082 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8083 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8084
8085 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8086 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8087
8088 session->peer_cert_digest =
8089 mbedtls_calloc( 1, session->peer_cert_digest_len );
8090 if( session->peer_cert_digest == NULL )
8091 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8092
8093 memcpy( session->peer_cert_digest, p,
8094 session->peer_cert_digest_len );
8095 p += session->peer_cert_digest_len;
8096 }
8097#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8098#endif /* MBEDTLS_X509_CRT_PARSE_C */
8099
8100 /*
8101 * Session ticket and associated data
8102 */
8103#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8104 if( 3 > (size_t)( end - p ) )
8105 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8106
8107 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8108 p += 3;
8109
8110 if( session->ticket_len != 0 )
8111 {
8112 if( session->ticket_len > (size_t)( end - p ) )
8113 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8114
8115 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8116 if( session->ticket == NULL )
8117 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8118
8119 memcpy( session->ticket, p, session->ticket_len );
8120 p += session->ticket_len;
8121 }
8122
8123 if( 4 > (size_t)( end - p ) )
8124 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8125
8126 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8127 ( (uint32_t) p[1] << 16 ) |
8128 ( (uint32_t) p[2] << 8 ) |
8129 ( (uint32_t) p[3] );
8130 p += 4;
8131#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8132
8133 /*
8134 * Misc extension-related info
8135 */
8136#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8137 if( 1 > (size_t)( end - p ) )
8138 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8139
8140 session->mfl_code = *p++;
8141#endif
8142
8143#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8144 if( 1 > (size_t)( end - p ) )
8145 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8146
8147 session->encrypt_then_mac = *p++;
8148#endif
8149
8150 /* Done, should have consumed entire buffer */
8151 if( p != end )
8152 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8153
8154 return( 0 );
8155}
Jerry Yudc7bd172022-02-17 13:44:15 +08008156#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8157
XiaokangQian75d40ef2022-04-20 11:05:24 +00008158int mbedtls_ssl_validate_ciphersuite(
8159 const mbedtls_ssl_context *ssl,
8160 const mbedtls_ssl_ciphersuite_t *suite_info,
8161 mbedtls_ssl_protocol_version min_tls_version,
8162 mbedtls_ssl_protocol_version max_tls_version )
8163{
8164 (void) ssl;
8165
8166 if( suite_info == NULL )
8167 return( -1 );
8168
8169 if( ( suite_info->min_tls_version > max_tls_version ) ||
8170 ( suite_info->max_tls_version < min_tls_version ) )
8171 {
8172 return( -1 );
8173 }
8174
XiaokangQian060d8672022-04-21 09:24:56 +00008175#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008176#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8177 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8178 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8179 {
8180 return( -1 );
8181 }
8182#endif
8183
8184 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8185#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8186 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8187 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8188 {
8189 return( -1 );
8190 }
8191#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8192#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8193
8194 return( 0 );
8195}
8196
XiaokangQianeaf36512022-04-24 09:07:44 +00008197#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8198/*
8199 * Function for writing a signature algorithm extension.
8200 *
8201 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8202 * value (TLS 1.3 RFC8446):
8203 * enum {
8204 * ....
8205 * ecdsa_secp256r1_sha256( 0x0403 ),
8206 * ecdsa_secp384r1_sha384( 0x0503 ),
8207 * ecdsa_secp521r1_sha512( 0x0603 ),
8208 * ....
8209 * } SignatureScheme;
8210 *
8211 * struct {
8212 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8213 * } SignatureSchemeList;
8214 *
8215 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8216 * value (TLS 1.2 RFC5246):
8217 * enum {
8218 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8219 * sha512(6), (255)
8220 * } HashAlgorithm;
8221 *
8222 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8223 * SignatureAlgorithm;
8224 *
8225 * struct {
8226 * HashAlgorithm hash;
8227 * SignatureAlgorithm signature;
8228 * } SignatureAndHashAlgorithm;
8229 *
8230 * SignatureAndHashAlgorithm
8231 * supported_signature_algorithms<2..2^16-2>;
8232 *
8233 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8234 * generalization of the TLS 1.2 signature algorithm extension.
8235 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8236 * `SignatureScheme` field of TLS 1.3
8237 *
8238 */
8239int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8240 const unsigned char *end, size_t *out_len )
8241{
8242 unsigned char *p = buf;
8243 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8244 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8245
8246 *out_len = 0;
8247
8248 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8249
8250 /* Check if we have space for header and length field:
8251 * - extension_type (2 bytes)
8252 * - extension_data_length (2 bytes)
8253 * - supported_signature_algorithms_length (2 bytes)
8254 */
8255 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8256 p += 6;
8257
8258 /*
8259 * Write supported_signature_algorithms
8260 */
8261 supported_sig_alg = p;
8262 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8263 if( sig_alg == NULL )
8264 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8265
8266 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8267 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008268 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8269 *sig_alg,
8270 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008271 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8272 continue;
8273 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8274 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8275 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008276 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008277 *sig_alg,
8278 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008279 }
8280
8281 /* Length of supported_signature_algorithms */
8282 supported_sig_alg_len = p - supported_sig_alg;
8283 if( supported_sig_alg_len == 0 )
8284 {
8285 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8286 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8287 }
8288
XiaokangQianeaf36512022-04-24 09:07:44 +00008289 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008290 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008291 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8292
XiaokangQianeaf36512022-04-24 09:07:44 +00008293 *out_len = p - buf;
8294
8295#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8296 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8297#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8298 return( 0 );
8299}
8300#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8301
XiaokangQian40a35232022-05-07 09:02:40 +00008302#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008303/*
8304 * mbedtls_ssl_parse_server_name_ext
8305 *
8306 * Structure of server_name extension:
8307 *
8308 * enum {
8309 * host_name(0), (255)
8310 * } NameType;
8311 * opaque HostName<1..2^16-1>;
8312 *
8313 * struct {
8314 * NameType name_type;
8315 * select (name_type) {
8316 * case host_name: HostName;
8317 * } name;
8318 * } ServerName;
8319 * struct {
8320 * ServerName server_name_list<1..2^16-1>
8321 * } ServerNameList;
8322 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008323MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008324int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8325 const unsigned char *buf,
8326 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008327{
8328 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8329 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008330 size_t server_name_list_len, hostname_len;
8331 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008332
XiaokangQianf2a94202022-05-20 06:44:24 +00008333 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008334
8335 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008336 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008337 p += 2;
8338
XiaokangQian9b2b7712022-05-17 02:57:00 +00008339 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8340 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008341 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008342 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008343 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008344 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008345 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8346 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008347
8348 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8349 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008350 /* sni_name is intended to be used only during the parsing of the
8351 * ClientHello message (it is reset to NULL before the end of
8352 * the message parsing). Thus it is ok to just point to the
8353 * reception buffer and not make a copy of it.
8354 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008355 ssl->handshake->sni_name = p + 3;
8356 ssl->handshake->sni_name_len = hostname_len;
8357 if( ssl->conf->f_sni == NULL )
8358 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008359 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008360 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008361 if( ret != 0 )
8362 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008363 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008364 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8365 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008366 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8367 }
8368 return( 0 );
8369 }
8370
8371 p += hostname_len + 3;
8372 }
8373
8374 return( 0 );
8375}
8376#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8377
XiaokangQianacb39922022-06-17 10:18:48 +00008378#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008379MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008380int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8381 const unsigned char *buf,
8382 const unsigned char *end )
8383{
8384 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008385 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008386 const unsigned char *protocol_name_list;
8387 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008388 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008389
8390 /* If ALPN not configured, just ignore the extension */
8391 if( ssl->conf->alpn_list == NULL )
8392 return( 0 );
8393
8394 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008395 * RFC7301, section 3.1
8396 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008397 *
XiaokangQianc7403452022-06-23 03:24:12 +00008398 * struct {
8399 * ProtocolName protocol_name_list<2..2^16-1>
8400 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008401 */
8402
XiaokangQianc7403452022-06-23 03:24:12 +00008403 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008404 * protocol_name_list_len 2 bytes
8405 * protocol_name_len 1 bytes
8406 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008407 */
XiaokangQianacb39922022-06-17 10:18:48 +00008408 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8409
XiaokangQianc7403452022-06-23 03:24:12 +00008410 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008411 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008412 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008413 protocol_name_list = p;
8414 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008415
8416 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008417 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008418 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008419 protocol_name_len = *p++;
8420 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8421 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008422 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008423 {
8424 MBEDTLS_SSL_PEND_FATAL_ALERT(
8425 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8426 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008427 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008428 }
8429
8430 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008431 }
8432
8433 /* Use our order of preference */
8434 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8435 {
8436 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008437 p = protocol_name_list;
8438 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008439 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008440 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008441 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008442 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008443 {
8444 ssl->alpn_chosen = *alpn;
8445 return( 0 );
8446 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008447
8448 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008449 }
8450 }
8451
XiaokangQian95d5f542022-06-24 02:29:26 +00008452 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008453 MBEDTLS_SSL_PEND_FATAL_ALERT(
8454 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8455 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8456 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8457}
8458
8459int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8460 unsigned char *buf,
8461 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008462 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008463{
8464 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008465 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008466 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008467
8468 if( ssl->alpn_chosen == NULL )
8469 {
8470 return( 0 );
8471 }
8472
XiaokangQian95d5f542022-06-24 02:29:26 +00008473 protocol_name_len = strlen( ssl->alpn_chosen );
8474 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008475
8476 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8477 /*
8478 * 0 . 1 ext identifier
8479 * 2 . 3 ext length
8480 * 4 . 5 protocol list length
8481 * 6 . 6 protocol name length
8482 * 7 . 7+n protocol name
8483 */
8484 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8485
XiaokangQian95d5f542022-06-24 02:29:26 +00008486 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008487
XiaokangQian95d5f542022-06-24 02:29:26 +00008488 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8489 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008490 /* Note: the length of the chosen protocol has been checked to be less
8491 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8492 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008493 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008494
XiaokangQian95d5f542022-06-24 02:29:26 +00008495 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008496 return ( 0 );
8497}
8498#endif /* MBEDTLS_SSL_ALPN */
8499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008500#endif /* MBEDTLS_SSL_TLS_C */