blob: 65e43a1677458be2bd59dc79450d6250337f1731 [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"
Chris Jones84a773f2021-03-05 18:38:47 +000041#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000042#include "mbedtls/debug.h"
43#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050044#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010045#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020046#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020047
Rich Evans00ab4702015-02-06 13:43:58 +000048#include <string.h>
49
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050050#if defined(MBEDTLS_USE_PSA_CRYPTO)
51#include "mbedtls/psa_util.h"
52#include "psa/crypto.h"
53#endif
54
Janos Follath23bdca02016-10-07 14:47:14 +010055#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000056#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020057#endif
58
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020059#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010060
Hanno Beckera0e20d02019-05-15 14:03:01 +010061#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010062/* Top-level Connection ID API */
63
Hanno Becker8367ccc2019-05-14 11:30:10 +010064int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
65 size_t len,
66 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010067{
68 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
69 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
70
Hanno Becker611ac772019-05-14 11:45:26 +010071 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
72 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
73 {
74 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
75 }
76
77 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010078 conf->cid_len = len;
79 return( 0 );
80}
81
Hanno Beckerf8542cf2019-04-09 15:22:03 +010082int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
83 int enable,
84 unsigned char const *own_cid,
85 size_t own_cid_len )
86{
Hanno Becker76a79ab2019-05-03 14:38:32 +010087 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
88 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
89
Hanno Beckerca092242019-04-25 16:01:49 +010090 ssl->negotiate_cid = enable;
91 if( enable == MBEDTLS_SSL_CID_DISABLED )
92 {
93 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
94 return( 0 );
95 }
96 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +010098
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100100 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
102 (unsigned) own_cid_len,
103 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100104 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
105 }
106
107 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100108 /* Truncation is not an issue here because
109 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
110 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100111
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100112 return( 0 );
113}
114
115int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
116 int *enabled,
117 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
118 size_t *peer_cid_len )
119{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100120 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100121
Hanno Becker76a79ab2019-05-03 14:38:32 +0100122 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
123 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
124 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100126 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100127
Hanno Beckerc5f24222019-05-03 12:54:52 +0100128 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
129 * were used, but client and server requested the empty CID.
130 * This is indistinguishable from not using the CID extension
131 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100132 if( ssl->transform_in->in_cid_len == 0 &&
133 ssl->transform_in->out_cid_len == 0 )
134 {
135 return( 0 );
136 }
137
Hanno Becker615ef172019-05-22 16:50:35 +0100138 if( peer_cid_len != NULL )
139 {
140 *peer_cid_len = ssl->transform_in->out_cid_len;
141 if( peer_cid != NULL )
142 {
143 memcpy( peer_cid, ssl->transform_in->out_cid,
144 ssl->transform_in->out_cid_len );
145 }
146 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100147
148 *enabled = MBEDTLS_SSL_CID_ENABLED;
149
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 return( 0 );
151}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100152#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200157/*
158 * Convert max_fragment_length codes to length.
159 * RFC 6066 says:
160 * enum{
161 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
162 * } MaxFragmentLength;
163 * and we add 0 -> extension unused
164 */
Angus Grattond8213d02016-05-25 20:56:48 +1000165static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200166{
Angus Grattond8213d02016-05-25 20:56:48 +1000167 switch( mfl )
168 {
169 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
170 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
171 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
172 return 512;
173 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
174 return 1024;
175 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
176 return 2048;
177 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
178 return 4096;
179 default:
180 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
181 }
182}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200184
Hanno Becker52055ae2019-02-06 14:30:46 +0000185int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
186 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200187{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188 mbedtls_ssl_session_free( dst );
189 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200190
吴敬辉0b716112021-11-29 10:46:35 +0800191#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
192 dst->ticket = NULL;
193#endif
194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000196
197#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200198 if( src->peer_cert != NULL )
199 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200201
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200202 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200203 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200204 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200209 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200210 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200212 dst->peer_cert = NULL;
213 return( ret );
214 }
215 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000216#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000217 if( src->peer_cert_digest != NULL )
218 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000219 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000220 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000221 if( dst->peer_cert_digest == NULL )
222 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
223
224 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
225 src->peer_cert_digest_len );
226 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000227 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000228 }
229#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200232
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200234 if( src->ticket != NULL )
235 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200236 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200237 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200238 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200239
240 memcpy( dst->ticket, src->ticket, src->ticket_len );
241 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200242#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200243
244 return( 0 );
245}
246
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500247#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
248static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
249{
250 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
251 if( resized_buffer == NULL )
252 return -1;
253
254 /* We want to copy len_new bytes when downsizing the buffer, and
255 * len_old bytes when upsizing, so we choose the smaller of two sizes,
256 * to fit one buffer into another. Size checks, ensuring that no data is
257 * lost, are done outside of this function. */
258 memcpy( resized_buffer, *buffer,
259 ( len_new < *len_old ) ? len_new : *len_old );
260 mbedtls_platform_zeroize( *buffer, *len_old );
261 mbedtls_free( *buffer );
262
263 *buffer = resized_buffer;
264 *len_old = len_new;
265
266 return 0;
267}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200268
269static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500270 size_t in_buf_new_len,
271 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200272{
273 int modified = 0;
274 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
275 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
276 if( ssl->in_buf != NULL )
277 {
278 written_in = ssl->in_msg - ssl->in_buf;
279 iv_offset_in = ssl->in_iv - ssl->in_buf;
280 len_offset_in = ssl->in_len - ssl->in_buf;
281 if( downsizing ?
282 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
283 ssl->in_buf_len < in_buf_new_len )
284 {
285 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
286 {
287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
288 }
289 else
290 {
Paul Elliottb7449902021-03-10 18:14:58 +0000291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
292 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200293 modified = 1;
294 }
295 }
296 }
297
298 if( ssl->out_buf != NULL )
299 {
300 written_out = ssl->out_msg - ssl->out_buf;
301 iv_offset_out = ssl->out_iv - ssl->out_buf;
302 len_offset_out = ssl->out_len - ssl->out_buf;
303 if( downsizing ?
304 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
305 ssl->out_buf_len < out_buf_new_len )
306 {
307 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
308 {
309 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
310 }
311 else
312 {
Paul Elliottb7449902021-03-10 18:14:58 +0000313 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
314 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200315 modified = 1;
316 }
317 }
318 }
319 if( modified )
320 {
321 /* Update pointers here to avoid doing it twice. */
322 mbedtls_ssl_reset_in_out_pointers( ssl );
323 /* Fields below might not be properly updated with record
324 * splitting or with CID, so they are manually updated here. */
325 ssl->out_msg = ssl->out_buf + written_out;
326 ssl->out_len = ssl->out_buf + len_offset_out;
327 ssl->out_iv = ssl->out_buf + iv_offset_out;
328
329 ssl->in_msg = ssl->in_buf + written_in;
330 ssl->in_len = ssl->in_buf + len_offset_in;
331 ssl->in_iv = ssl->in_buf + iv_offset_in;
332 }
333}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500334#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
335
Jerry Yudb8c48a2022-01-27 14:54:54 +0800336#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800337
338#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
339typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
340 const char *label,
341 const unsigned char *random, size_t rlen,
342 unsigned char *dstbuf, size_t dlen );
343
344static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
345
346#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
347
348/* Type for the TLS PRF */
349typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
350 const unsigned char *, size_t,
351 unsigned char *, size_t);
352
353static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
354 int ciphersuite,
355 const unsigned char master[48],
356#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
357 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
358 int encrypt_then_mac,
359#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
360 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
361 ssl_tls_prf_t tls_prf,
362 const unsigned char randbytes[64],
363 int minor_ver,
364 unsigned endpoint,
365 const mbedtls_ssl_context *ssl );
366
367#if defined(MBEDTLS_SHA256_C)
368static int tls_prf_sha256( const unsigned char *secret, size_t slen,
369 const char *label,
370 const unsigned char *random, size_t rlen,
371 unsigned char *dstbuf, size_t dlen );
372static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
373static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
374
375#endif /* MBEDTLS_SHA256_C */
376
377#if defined(MBEDTLS_SHA384_C)
378static int tls_prf_sha384( const unsigned char *secret, size_t slen,
379 const char *label,
380 const unsigned char *random, size_t rlen,
381 unsigned char *dstbuf, size_t dlen );
382
383static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
384static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
385#endif /* MBEDTLS_SHA384_C */
386
387static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
388 unsigned char *buf,
389 size_t buf_len );
390static int ssl_session_load_tls12( mbedtls_ssl_session *session,
391 const unsigned char *buf,
392 size_t len );
393#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
394
Jerry Yu53d23e22022-02-09 16:25:09 +0800395static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
396
Jerry Yudb8c48a2022-01-27 14:54:54 +0800397#if defined(MBEDTLS_SHA256_C)
398static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800399#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800400
401#if defined(MBEDTLS_SHA384_C)
402static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800403#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000404
Ron Eldor51d3ab52019-05-12 14:54:30 +0300405int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
406 const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen )
410{
411 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
412
413 switch( prf )
414 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300415#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200416#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300417 case MBEDTLS_SSL_TLS_PRF_SHA384:
418 tls_prf = tls_prf_sha384;
419 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200420#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300421#if defined(MBEDTLS_SHA256_C)
422 case MBEDTLS_SSL_TLS_PRF_SHA256:
423 tls_prf = tls_prf_sha256;
424 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300425#endif /* MBEDTLS_SHA256_C */
426#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300427 default:
428 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
429 }
430
431 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
432}
433
Jerry Yu53d23e22022-02-09 16:25:09 +0800434#if defined(MBEDTLS_SSL_PROTO_TLS1_2) || \
435 defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
436static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
437{
438 ((void) tls_prf);
439#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
440#if defined(MBEDTLS_SHA384_C)
441 if( tls_prf == tls_prf_sha384 )
442 {
443 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
444 }
445 else
446#endif
447#if defined(MBEDTLS_SHA256_C)
448 if( tls_prf == tls_prf_sha256 )
449 {
450 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
451 }
452 else
453#endif
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455 return( MBEDTLS_SSL_TLS_PRF_NONE );
456}
457
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200458/* Type for the TLS PRF */
459typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
460 const unsigned char *, size_t,
461 unsigned char *, size_t);
462
Manuel Pégourié-Gonnarde59ae232019-04-30 11:41:40 +0200463/*
Manuel Pégourié-Gonnardcba40d92019-05-06 12:55:40 +0200464 * Populate a transform structure with session keys and all the other
465 * necessary information.
Manuel Pégourié-Gonnarde59ae232019-04-30 11:41:40 +0200466 *
Manuel Pégourié-Gonnardcba40d92019-05-06 12:55:40 +0200467 * Parameters:
468 * - [in/out]: transform: structure to populate
469 * [in] must be just initialised with mbedtls_ssl_transform_init()
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200470 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200471 * - [in] ciphersuite
472 * - [in] master
473 * - [in] encrypt_then_mac
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200474 * - [in] compression
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200475 * - [in] tls_prf: pointer to PRF to use for key derivation
476 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200477 * - [in] minor_ver: SSL/TLS minor version
478 * - [in] endpoint: client or server
Andrzej Kurek5902cd62021-09-28 10:00:32 -0400479 * - [in] ssl: used for:
480 * - ssl->conf->{f,p}_export_keys
481 * [in] optionally used for:
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200482 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
Manuel Pégourié-Gonnarde59ae232019-04-30 11:41:40 +0200483 */
Hanno Beckerbd257552021-03-22 06:59:27 +0000484static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200485 int ciphersuite,
486 const unsigned char master[48],
Hanno Beckerbd257552021-03-22 06:59:27 +0000487#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
488 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200489 int encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +0000490#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
491 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200492 ssl_tls_prf_t tls_prf,
493 const unsigned char randbytes[64],
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200494 int minor_ver,
495 unsigned endpoint,
Mateusz Starzyke204dbf2021-03-15 17:57:20 +0100496 const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +0000497{
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200498 int ret = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +0000499 unsigned char keyblk[256];
500 unsigned char *key1;
501 unsigned char *key2;
Paul Bakker68884e32013-01-07 18:20:04 +0100502 unsigned char *mac_enc;
503 unsigned char *mac_dec;
sander-visser3888b032020-05-06 21:49:46 +0200504 size_t mac_key_len = 0;
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200505 size_t iv_copy_len;
Gilles Peskine88d681c2021-09-01 11:19:33 +0200506 size_t keylen;
Hanno Beckere694c3e2017-12-27 21:34:08 +0000507 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200508 const mbedtls_cipher_info_t *cipher_info;
509 const mbedtls_md_info_t *md_info;
Paul Bakker68884e32013-01-07 18:20:04 +0100510
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100511#if defined(MBEDTLS_USE_PSA_CRYPTO)
512 psa_key_type_t key_type;
513 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
514 psa_algorithm_t alg;
515 size_t key_bits;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100516 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100517#endif
518
Andrzej Kurek324f72e2021-09-29 04:21:21 -0400519#if !defined(MBEDTLS_DEBUG_C) && \
520 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kureka72fe642021-09-29 15:57:30 -0400521 if( ssl->f_export_keys == NULL )
522 {
523 ssl = NULL; /* make sure we don't use it except for these cases */
524 (void) ssl;
525 }
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200526#endif
527
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +0200528 /*
529 * Some data just needs copying into the structure
530 */
Jaeden Amero2de07f12019-06-05 13:32:08 +0100531#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000532 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200533 transform->encrypt_then_mac = encrypt_then_mac;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000534#endif
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200535 transform->minor_ver = minor_ver;
Hanno Beckere694c3e2017-12-27 21:34:08 +0000536
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +0200537#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
538 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
539#endif
540
Ronald Cron6f135e12021-12-08 16:57:54 +0100541#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerc0da10d2021-04-21 05:32:23 +0100542 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
543 {
544 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
545 * generation separate. This should never happen. */
546 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
547 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100548#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerc0da10d2021-04-21 05:32:23 +0100549
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200550 /*
551 * Get various info structures
552 */
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200553 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200554 if( ciphersuite_info == NULL )
555 {
556 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200557 ciphersuite ) );
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200558 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
559 }
560
Hanno Beckere694c3e2017-12-27 21:34:08 +0000561 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Paul Bakker68884e32013-01-07 18:20:04 +0100562 if( cipher_info == NULL )
563 {
Paul Elliott9f352112020-12-09 14:55:45 +0000564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
Hanno Beckere694c3e2017-12-27 21:34:08 +0000565 ciphersuite_info->cipher ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker68884e32013-01-07 18:20:04 +0100567 }
568
Hanno Beckere694c3e2017-12-27 21:34:08 +0000569 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
Paul Bakker68884e32013-01-07 18:20:04 +0100570 if( md_info == NULL )
571 {
Paul Elliott9f352112020-12-09 14:55:45 +0000572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
Paul Elliott3891caf2020-12-17 18:42:40 +0000573 (unsigned) ciphersuite_info->mac ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker68884e32013-01-07 18:20:04 +0100575 }
576
Hanno Beckera0e20d02019-05-15 14:03:01 +0100577#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4bf74652019-04-26 16:22:27 +0100578 /* Copy own and peer's CID if the use of the CID
579 * extension has been negotiated. */
580 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
581 {
582 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
Hanno Becker8a7f9722019-04-30 13:52:29 +0100583
Hanno Becker05154c32019-05-03 15:23:51 +0100584 transform->in_cid_len = ssl->own_cid_len;
Hanno Becker05154c32019-05-03 15:23:51 +0100585 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
Hanno Becker1c1f0462019-05-03 12:55:51 +0100586 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
Hanno Becker4bf74652019-04-26 16:22:27 +0100587 transform->in_cid_len );
Hanno Beckerd1f20352019-05-15 10:21:55 +0100588
589 transform->out_cid_len = ssl->handshake->peer_cid_len;
590 memcpy( transform->out_cid, ssl->handshake->peer_cid,
591 ssl->handshake->peer_cid_len );
592 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
593 transform->out_cid_len );
Hanno Becker4bf74652019-04-26 16:22:27 +0100594 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100595#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4bf74652019-04-26 16:22:27 +0100596
Paul Bakker5121ce52009-01-03 21:22:43 +0000597 /*
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200598 * Compute key block using the PRF
Paul Bakker5121ce52009-01-03 21:22:43 +0000599 */
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200600 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
Manuel Pégourié-Gonnarde9608182015-03-26 11:47:47 +0100601 if( ret != 0 )
602 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
Manuel Pégourié-Gonnarde9608182015-03-26 11:47:47 +0100604 return( ret );
605 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
Manuel Pégourié-Gonnardd91efa42019-05-20 10:27:20 +0200608 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200609 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
Manuel Pégourié-Gonnard9b108c22019-05-06 13:32:17 +0200610 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000612
Paul Bakker5121ce52009-01-03 21:22:43 +0000613 /*
614 * Determine the appropriate key, IV and MAC length.
615 */
Paul Bakker68884e32013-01-07 18:20:04 +0100616
Gilles Peskinee720dbe2021-07-19 17:37:46 +0200617 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200618
Hanno Becker8031d062018-01-03 15:32:31 +0000619#if defined(MBEDTLS_GCM_C) || \
620 defined(MBEDTLS_CCM_C) || \
621 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskinee720dbe2021-07-19 17:37:46 +0200622 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
623 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
624 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakker5121ce52009-01-03 21:22:43 +0000625 {
Hanno Beckerf704bef2018-11-16 15:21:18 +0000626 size_t explicit_ivlen;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200627
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200628 transform->maclen = 0;
Hanno Becker81c7b182017-11-09 18:39:33 +0000629 mac_key_len = 0;
Hanno Beckere694c3e2017-12-27 21:34:08 +0000630 transform->taglen =
631 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200632
Hanno Becker447558d2020-05-28 07:36:33 +0100633 /* All modes haves 96-bit IVs, but the length of the static parts vary
634 * with mode and version:
635 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
636 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
Hanno Beckerf93c2d72020-05-28 07:39:43 +0100637 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
638 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
639 * sequence number).
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200640 */
Paul Bakker68884e32013-01-07 18:20:04 +0100641 transform->ivlen = 12;
Gilles Peskinee720dbe2021-07-19 17:37:46 +0200642 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200643 transform->fixed_ivlen = 12;
644 else
Hanno Beckerc0da10d2021-04-21 05:32:23 +0100645 transform->fixed_ivlen = 4;
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200646
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200647 /* Minimum length of encrypted record */
648 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
Hanno Beckere694c3e2017-12-27 21:34:08 +0000649 transform->minlen = explicit_ivlen + transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +0100650 }
651 else
Hanno Becker8031d062018-01-03 15:32:31 +0000652#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000653#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskinee720dbe2021-07-19 17:37:46 +0200654 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
655 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
Paul Bakker68884e32013-01-07 18:20:04 +0100656 {
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200657 /* Initialize HMAC contexts */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
659 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
Paul Bakker68884e32013-01-07 18:20:04 +0100660 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
Ron Eldore6992702019-05-07 18:27:13 +0300662 goto end;
Paul Bakker68884e32013-01-07 18:20:04 +0100663 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000664
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200665 /* Get MAC length */
Hanno Becker81c7b182017-11-09 18:39:33 +0000666 mac_key_len = mbedtls_md_get_size( md_info );
667 transform->maclen = mac_key_len;
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200668
Manuel Pégourié-Gonnarde800cd82014-06-18 15:34:40 +0200669 /* IV length */
Paul Bakker68884e32013-01-07 18:20:04 +0100670 transform->ivlen = cipher_info->iv_size;
Paul Bakker5121ce52009-01-03 21:22:43 +0000671
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200672 /* Minimum length */
Gilles Peskinee720dbe2021-07-19 17:37:46 +0200673 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200674 transform->minlen = transform->maclen;
675 else
Paul Bakker68884e32013-01-07 18:20:04 +0100676 {
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200677 /*
678 * GenericBlockCipher:
Manuel Pégourié-Gonnard169dd6a2014-11-04 16:15:39 +0100679 * 1. if EtM is in use: one block plus MAC
680 * otherwise: * first multiple of blocklen greater than maclen
TRodziewicz2abf03c2021-06-25 14:40:09 +0200681 * 2. IV
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200682 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6fa57bf2019-05-10 10:50:04 +0200684 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard169dd6a2014-11-04 16:15:39 +0100685 {
686 transform->minlen = transform->maclen
687 + cipher_info->block_size;
688 }
689 else
690#endif
691 {
692 transform->minlen = transform->maclen
693 + cipher_info->block_size
694 - transform->maclen % cipher_info->block_size;
695 }
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200696
TRodziewicz0f82ec62021-05-12 17:49:18 +0200697#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
698 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200699 {
700 transform->minlen += transform->ivlen;
701 }
702 else
703#endif
704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Ron Eldore6992702019-05-07 18:27:13 +0300706 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
707 goto end;
Manuel Pégourié-Gonnardeaa76f72014-06-18 16:06:02 +0200708 }
Paul Bakker68884e32013-01-07 18:20:04 +0100709 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000710 }
Hanno Becker8031d062018-01-03 15:32:31 +0000711 else
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000712#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Becker8031d062018-01-03 15:32:31 +0000713 {
714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
715 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
716 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000717
Hanno Becker88aaf652017-12-27 08:17:40 +0000718 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
719 (unsigned) keylen,
720 (unsigned) transform->minlen,
721 (unsigned) transform->ivlen,
722 (unsigned) transform->maclen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000723
724 /*
725 * Finally setup the cipher contexts, IVs and MAC secrets.
726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200727#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200728 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
Paul Bakker5121ce52009-01-03 21:22:43 +0000729 {
Hanno Becker81c7b182017-11-09 18:39:33 +0000730 key1 = keyblk + mac_key_len * 2;
Hanno Becker88aaf652017-12-27 08:17:40 +0000731 key2 = keyblk + mac_key_len * 2 + keylen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000732
Paul Bakker68884e32013-01-07 18:20:04 +0100733 mac_enc = keyblk;
Hanno Becker81c7b182017-11-09 18:39:33 +0000734 mac_dec = keyblk + mac_key_len;
Paul Bakker5121ce52009-01-03 21:22:43 +0000735
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000736 /*
737 * This is not used in TLS v1.1.
738 */
Paul Bakker48916f92012-09-16 19:57:18 +0000739 iv_copy_len = ( transform->fixed_ivlen ) ?
740 transform->fixed_ivlen : transform->ivlen;
Hanno Becker88aaf652017-12-27 08:17:40 +0000741 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
742 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
Paul Bakkerca4ab492012-04-18 14:23:57 +0000743 iv_copy_len );
Paul Bakker5121ce52009-01-03 21:22:43 +0000744 }
745 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746#endif /* MBEDTLS_SSL_CLI_C */
747#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardc864f6a2019-05-06 13:48:22 +0200748 if( endpoint == MBEDTLS_SSL_IS_SERVER )
Paul Bakker5121ce52009-01-03 21:22:43 +0000749 {
Hanno Becker88aaf652017-12-27 08:17:40 +0000750 key1 = keyblk + mac_key_len * 2 + keylen;
Hanno Becker81c7b182017-11-09 18:39:33 +0000751 key2 = keyblk + mac_key_len * 2;
Paul Bakker5121ce52009-01-03 21:22:43 +0000752
Hanno Becker81c7b182017-11-09 18:39:33 +0000753 mac_enc = keyblk + mac_key_len;
Paul Bakker68884e32013-01-07 18:20:04 +0100754 mac_dec = keyblk;
Paul Bakker5121ce52009-01-03 21:22:43 +0000755
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000756 /*
757 * This is not used in TLS v1.1.
758 */
Paul Bakker48916f92012-09-16 19:57:18 +0000759 iv_copy_len = ( transform->fixed_ivlen ) ?
760 transform->fixed_ivlen : transform->ivlen;
Hanno Becker88aaf652017-12-27 08:17:40 +0000761 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
762 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
Paul Bakkerca4ab492012-04-18 14:23:57 +0000763 iv_copy_len );
Paul Bakker5121ce52009-01-03 21:22:43 +0000764 }
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +0100765 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +0100767 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Ron Eldore6992702019-05-07 18:27:13 +0300769 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
770 goto end;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +0100771 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000772
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200773#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
TRodziewicz0f82ec62021-05-12 17:49:18 +0200774#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200775 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
776 For AEAD-based ciphersuites, there is nothing to do here. */
777 if( mac_key_len != 0 )
Paul Bakker68884e32013-01-07 18:20:04 +0100778 {
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100779 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
780 if( ret != 0 )
781 goto end;
782 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
783 if( ret != 0 )
784 goto end;
Paul Bakker68884e32013-01-07 18:20:04 +0100785 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200786#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000787#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker68884e32013-01-07 18:20:04 +0100788
Hanno Beckerd56ed242018-01-03 15:32:51 +0000789 ((void) mac_dec);
790 ((void) mac_enc);
Paul Bakker05ef8352012-05-08 09:17:57 +0000791
Andrzej Kureka72fe642021-09-29 15:57:30 -0400792 if( ssl != NULL && ssl->f_export_keys != NULL )
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100793 {
Hanno Becker7e6c1782021-06-08 09:24:55 +0100794 ssl->f_export_keys( ssl->p_export_keys,
795 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
796 master, 48,
797 randbytes + 32,
798 randbytes,
799 tls_prf_get_type( tls_prf ) );
Ron Eldorf5cc10d2019-05-07 18:33:40 +0300800 }
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100801
Hanno Beckerf704bef2018-11-16 15:21:18 +0000802#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +0100803 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100804 transform->taglen,
805 &alg,
806 &key_type,
807 &key_bits ) ) != PSA_SUCCESS )
808 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100809 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +0100810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100811 goto end;
812 }
813
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100814 transform->psa_alg = alg;
815
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100816 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100817 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100818 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
819 psa_set_key_algorithm( &attributes, alg );
820 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +0100821
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100822 if( ( status = psa_import_key( &attributes,
823 key1,
824 PSA_BITS_TO_BYTES( key_bits ),
825 &transform->psa_key_enc ) ) != PSA_SUCCESS )
826 {
827 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
828 ret = psa_ssl_status_to_mbedtls( status );
829 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
830 goto end;
831 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +0100832
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100833 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
834
835 if( ( status = psa_import_key( &attributes,
836 key2,
837 PSA_BITS_TO_BYTES( key_bits ),
838 &transform->psa_key_dec ) ) != PSA_SUCCESS )
839 {
840 ret = psa_ssl_status_to_mbedtls( status );
841 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
842 goto end;
843 }
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100844 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100845#else
846 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
847 cipher_info ) ) != 0 )
848 {
849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
850 goto end;
851 }
852
853 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
854 cipher_info ) ) != 0 )
855 {
856 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
857 goto end;
858 }
859
860 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
861 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
862 MBEDTLS_ENCRYPT ) ) != 0 )
863 {
864 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
865 goto end;
866 }
867
868 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
869 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
870 MBEDTLS_DECRYPT ) ) != 0 )
871 {
872 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
873 goto end;
874 }
Przemyslaw Stekielffccda42022-01-11 14:44:01 +0100875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskinee720dbe2021-07-19 17:37:46 +0200877 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnard88665912013-10-25 18:42:44 +0200878 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
880 MBEDTLS_PADDING_NONE ) ) != 0 )
Manuel Pégourié-Gonnard126a66f2013-10-25 18:33:32 +0200881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
Ron Eldore6992702019-05-07 18:27:13 +0300883 goto end;
Manuel Pégourié-Gonnard126a66f2013-10-25 18:33:32 +0200884 }
Manuel Pégourié-Gonnard88665912013-10-25 18:42:44 +0200885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
887 MBEDTLS_PADDING_NONE ) ) != 0 )
Manuel Pégourié-Gonnard88665912013-10-25 18:42:44 +0200888 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
Ron Eldore6992702019-05-07 18:27:13 +0300890 goto end;
Manuel Pégourié-Gonnard88665912013-10-25 18:42:44 +0200891 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000892 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893#endif /* MBEDTLS_CIPHER_MODE_CBC */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100894#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000895
Ron Eldore6992702019-05-07 18:27:13 +0300896end:
Ron Eldora9f9a732019-05-07 18:29:02 +0300897 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
Ron Eldore6992702019-05-07 18:27:13 +0300898 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +0000899}
Jerry Yu53d23e22022-02-09 16:25:09 +0800900#endif /* MBEDTLS_SSL_PROTO_TLS1_2 || MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Paul Bakker5121ce52009-01-03 21:22:43 +0000901
Jerry Yuc73c6182022-02-08 20:29:25 +0800902#if defined(MBEDTLS_X509_CRT_PARSE_C)
903static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
904{
905#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
906 if( session->peer_cert != NULL )
907 {
908 mbedtls_x509_crt_free( session->peer_cert );
909 mbedtls_free( session->peer_cert );
910 session->peer_cert = NULL;
911 }
912#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
913 if( session->peer_cert_digest != NULL )
914 {
915 /* Zeroization is not necessary. */
916 mbedtls_free( session->peer_cert_digest );
917 session->peer_cert_digest = NULL;
918 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
919 session->peer_cert_digest_len = 0;
920 }
921#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
922}
923#endif /* MBEDTLS_X509_CRT_PARSE_C */
924
925void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
926 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
927{
928 ((void) ciphersuite_info);
929
930#if defined(MBEDTLS_SHA384_C)
931 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
932 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
933 else
934#endif
935#if defined(MBEDTLS_SHA256_C)
936 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
937 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
938 else
939#endif
940 {
941 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
942 return;
943 }
944}
945
946void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
947{
948 ((void) ssl);
949#if defined(MBEDTLS_SHA256_C)
950#if defined(MBEDTLS_USE_PSA_CRYPTO)
951 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
952 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
953#else
954 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
955#endif
956#endif
957#if defined(MBEDTLS_SHA384_C)
958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
960 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
961#else
962 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
963#endif
964#endif
965}
966
967static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
968 const unsigned char *buf, size_t len )
969{
970#if defined(MBEDTLS_SHA256_C)
971#if defined(MBEDTLS_USE_PSA_CRYPTO)
972 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
973#else
974 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
975#endif
976#endif
977#if defined(MBEDTLS_SHA384_C)
978#if defined(MBEDTLS_USE_PSA_CRYPTO)
979 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
980#else
981 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
982#endif
983#endif
984}
985
986#if defined(MBEDTLS_SHA256_C)
987static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
988 const unsigned char *buf, size_t len )
989{
990#if defined(MBEDTLS_USE_PSA_CRYPTO)
991 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
992#else
993 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
994#endif
995}
996#endif
997
998#if defined(MBEDTLS_SHA384_C)
999static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
1000 const unsigned char *buf, size_t len )
1001{
1002#if defined(MBEDTLS_USE_PSA_CRYPTO)
1003 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
1004#else
1005 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
1006#endif
1007}
1008#endif
1009
Jerry Yubef175d2022-01-28 10:52:05 +08001010#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard1b00c4f2019-04-30 11:54:22 +02001011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012#if defined(MBEDTLS_SHA256_C)
Paul Bakkerca4ab492012-04-18 14:23:57 +00001013static void ssl_calc_finished_tls_sha256(
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
Paul Bakker1ef83d62012-04-11 12:09:53 +00001015{
1016 int len = 12;
Paul Bakker3c2122f2013-06-24 19:03:14 +02001017 const char *sender;
Paul Bakker1ef83d62012-04-11 12:09:53 +00001018 unsigned char padbuf[32];
Andrzej Kurekeb342242019-01-29 09:14:33 -05001019#if defined(MBEDTLS_USE_PSA_CRYPTO)
1020 size_t hash_size;
Jaeden Amero34973232019-02-20 10:32:28 +00001021 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
Andrzej Kurekeb342242019-01-29 09:14:33 -05001022 psa_status_t status;
1023#else
1024 mbedtls_sha256_context sha256;
1025#endif
Paul Bakker1ef83d62012-04-11 12:09:53 +00001026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 mbedtls_ssl_session *session = ssl->session_negotiate;
Paul Bakker48916f92012-09-16 19:57:18 +00001028 if( !session )
1029 session = ssl->session;
1030
Andrzej Kurekeb342242019-01-29 09:14:33 -05001031 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
1032 ? "client finished"
1033 : "server finished";
1034
1035#if defined(MBEDTLS_USE_PSA_CRYPTO)
1036 sha256_psa = psa_hash_operation_init();
1037
1038 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
1039
1040 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
1041 if( status != PSA_SUCCESS )
1042 {
1043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
1044 return;
1045 }
1046
1047 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
1048 if( status != PSA_SUCCESS )
1049 {
1050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
1051 return;
1052 }
1053 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
1054#else
1055
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02001056 mbedtls_sha256_init( &sha256 );
1057
Manuel Pégourié-Gonnardc0bf01e2015-07-06 16:11:18 +02001058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001059
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02001060 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001061
1062 /*
1063 * TLSv1.2:
1064 * hash = PRF( master, finished_label,
1065 * Hash( handshake ) )[0.11]
1066 */
1067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068#if !defined(MBEDTLS_SHA256_ALT)
1069 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
Manuel Pégourié-Gonnardc0bf01e2015-07-06 16:11:18 +02001070 sha256.state, sizeof( sha256.state ) );
Paul Bakker90995b52013-06-24 19:20:35 +02001071#endif
Paul Bakker1ef83d62012-04-11 12:09:53 +00001072
TRodziewicz26371e42021-06-08 16:45:41 +02001073 mbedtls_sha256_finish( &sha256, padbuf );
Andrzej Kurekeb342242019-01-29 09:14:33 -05001074 mbedtls_sha256_free( &sha256 );
1075#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker1ef83d62012-04-11 12:09:53 +00001076
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +02001077 ssl->handshake->tls_prf( session->master, 48, sender,
Paul Bakker48916f92012-09-16 19:57:18 +00001078 padbuf, 32, buf, len );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001081
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05001082 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001085}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086#endif /* MBEDTLS_SHA256_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +00001087
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02001088#if defined(MBEDTLS_SHA384_C)
Rodrigo Dias Corread596ca82020-11-25 00:42:28 -03001089
Paul Bakkerca4ab492012-04-18 14:23:57 +00001090static void ssl_calc_finished_tls_sha384(
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001092{
1093 int len = 12;
Paul Bakker3c2122f2013-06-24 19:03:14 +02001094 const char *sender;
Rodrigo Dias Corread596ca82020-11-25 00:42:28 -03001095 unsigned char padbuf[48];
Andrzej Kurekeb342242019-01-29 09:14:33 -05001096#if defined(MBEDTLS_USE_PSA_CRYPTO)
1097 size_t hash_size;
Jaeden Amero34973232019-02-20 10:32:28 +00001098 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
Andrzej Kurekeb342242019-01-29 09:14:33 -05001099 psa_status_t status;
1100#else
1101 mbedtls_sha512_context sha512;
1102#endif
Paul Bakkerca4ab492012-04-18 14:23:57 +00001103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 mbedtls_ssl_session *session = ssl->session_negotiate;
Paul Bakker48916f92012-09-16 19:57:18 +00001105 if( !session )
1106 session = ssl->session;
1107
Andrzej Kurekeb342242019-01-29 09:14:33 -05001108 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
1109 ? "client finished"
1110 : "server finished";
1111
1112#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05001113 sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -05001114
1115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
1116
Andrzej Kurek972fba52019-01-30 03:29:12 -05001117 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05001118 if( status != PSA_SUCCESS )
1119 {
1120 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
1121 return;
1122 }
1123
Andrzej Kurek972fba52019-01-30 03:29:12 -05001124 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
Andrzej Kurekeb342242019-01-29 09:14:33 -05001125 if( status != PSA_SUCCESS )
1126 {
1127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
1128 return;
1129 }
1130 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
1131#else
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02001132 mbedtls_sha512_init( &sha512 );
1133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001135
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02001136 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001137
1138 /*
1139 * TLSv1.2:
1140 * hash = PRF( master, finished_label,
1141 * Hash( handshake ) )[0.11]
1142 */
1143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if !defined(MBEDTLS_SHA512_ALT)
Manuel Pégourié-Gonnardc0bf01e2015-07-06 16:11:18 +02001145 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
1146 sha512.state, sizeof( sha512.state ) );
Paul Bakker90995b52013-06-24 19:20:35 +02001147#endif
TRodziewicz26371e42021-06-08 16:45:41 +02001148 mbedtls_sha512_finish( &sha512, padbuf );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001149
Andrzej Kurekeb342242019-01-29 09:14:33 -05001150 mbedtls_sha512_free( &sha512 );
1151#endif
Paul Bakkerca4ab492012-04-18 14:23:57 +00001152
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +02001153 ssl->handshake->tls_prf( session->master, 48, sender,
Paul Bakker48916f92012-09-16 19:57:18 +00001154 padbuf, 48, buf, len );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001157
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05001158 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +00001161}
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02001162#endif /* MBEDTLS_SHA384_C */
Jerry Yuc73c6182022-02-08 20:29:25 +08001163
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001164void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00001165{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00001167
1168 /*
1169 * Free our handshake params
1170 */
Gilles Peskine9b562d52018-04-25 20:32:43 +02001171 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 mbedtls_free( ssl->handshake );
Paul Bakker48916f92012-09-16 19:57:18 +00001173 ssl->handshake = NULL;
1174
1175 /*
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001176 * Free the previous transform and swith in the current one
Paul Bakker48916f92012-09-16 19:57:18 +00001177 */
1178 if( ssl->transform )
1179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180 mbedtls_ssl_transform_free( ssl->transform );
1181 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00001182 }
1183 ssl->transform = ssl->transform_negotiate;
1184 ssl->transform_negotiate = NULL;
1185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001187}
1188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001190{
1191 int resume = ssl->handshake->resume;
1192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195#if defined(MBEDTLS_SSL_RENEGOTIATION)
1196 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001197 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001199 ssl->renego_records_seen = 0;
1200 }
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001201#endif
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001202
1203 /*
1204 * Free the previous session and switch in the current one
1205 */
Paul Bakker0a597072012-09-25 21:55:46 +00001206 if( ssl->session )
1207 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard1a034732014-11-04 17:36:18 +01001209 /* RFC 7366 3.1: keep the EtM state */
1210 ssl->session_negotiate->encrypt_then_mac =
1211 ssl->session->encrypt_then_mac;
1212#endif
1213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214 mbedtls_ssl_session_free( ssl->session );
1215 mbedtls_free( ssl->session );
Paul Bakker0a597072012-09-25 21:55:46 +00001216 }
1217 ssl->session = ssl->session_negotiate;
Paul Bakker48916f92012-09-16 19:57:18 +00001218 ssl->session_negotiate = NULL;
1219
Paul Bakker0a597072012-09-25 21:55:46 +00001220 /*
1221 * Add cache entry
1222 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001223 if( ssl->conf->f_set_cache != NULL &&
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +02001224 ssl->session->id_len != 0 &&
Manuel Pégourié-Gonnardc086cce2013-08-02 14:13:02 +02001225 resume == 0 )
1226 {
Hanno Beckerccdaf6e2021-04-15 09:26:17 +01001227 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
1228 ssl->session->id,
1229 ssl->session->id_len,
1230 ssl->session ) != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
Manuel Pégourié-Gonnardc086cce2013-08-02 14:13:02 +02001232 }
Paul Bakker0a597072012-09-25 21:55:46 +00001233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001235 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001236 ssl->handshake->flight != NULL )
1237 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001238 /* Cancel handshake timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001239 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001240
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001241 /* Keep last flight around in case we need to resend it:
1242 * we need the handshake and transform structures for that */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001244 }
1245 else
1246#endif
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001247 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02001248
Paul Bakker48916f92012-09-16 19:57:18 +00001249 ssl->state++;
1250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001251 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00001252}
1253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
Paul Bakker1ef83d62012-04-11 12:09:53 +00001255{
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02001256 int ret, hash_len;
Paul Bakker1ef83d62012-04-11 12:09:53 +00001257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001259
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001260 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
Paul Bakker92be97b2013-01-02 17:30:03 +01001261
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001262 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
Paul Bakker1ef83d62012-04-11 12:09:53 +00001263
Manuel Pégourié-Gonnard214a8482016-02-22 11:27:26 +01001264 /*
1265 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
1266 * may define some other value. Currently (early 2016), no defined
1267 * ciphersuite does this (and this is unlikely to change as activity has
1268 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
1269 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001270 hash_len = 12;
Paul Bakker5121ce52009-01-03 21:22:43 +00001271
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001273 ssl->verify_data_len = hash_len;
1274 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001275#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001276
Paul Bakker5121ce52009-01-03 21:22:43 +00001277 ssl->out_msglen = 4 + hash_len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
1279 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
Paul Bakker5121ce52009-01-03 21:22:43 +00001280
1281 /*
1282 * In case of session resuming, invert the client and server
1283 * ChangeCipherSpec messages order.
1284 */
Paul Bakker0a597072012-09-25 21:55:46 +00001285 if( ssl->handshake->resume != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001286 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001288 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01001290#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001292 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01001294#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 }
1296 else
1297 ssl->state++;
1298
Paul Bakker48916f92012-09-16 19:57:18 +00001299 /*
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001300 * Switch to our negotiated transform and session parameters for outbound
1301 * data.
Paul Bakker48916f92012-09-16 19:57:18 +00001302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
Manuel Pégourié-Gonnard5afb1672014-02-16 18:33:22 +01001304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001306 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02001307 {
1308 unsigned char i;
1309
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001310 /* Remember current epoch settings for resending */
1311 ssl->handshake->alt_transform_out = ssl->transform_out;
Jerry Yud9a94fe2021-09-28 18:58:59 +08001312 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
Jerry Yud96a5c22021-09-29 17:46:51 +08001313 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001314
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02001315 /* Set sequence_number to zero */
Jerry Yufd320e92021-10-08 21:52:41 +08001316 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
Jerry Yud9a94fe2021-09-28 18:58:59 +08001317
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02001318
1319 /* Increment epoch */
1320 for( i = 2; i > 0; i-- )
Hanno Becker19859472018-08-06 09:40:20 +01001321 if( ++ssl->cur_out_ctr[i - 1] != 0 )
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02001322 break;
1323
1324 /* The loop goes to its end iff the counter is wrapping */
1325 if( i == 0 )
1326 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
1328 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02001329 }
1330 }
1331 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001332#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08001333 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001334
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001335 ssl->transform_out = ssl->transform_negotiate;
1336 ssl->session_out = ssl->session_negotiate;
1337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001339 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001340 mbedtls_ssl_send_flight_completed( ssl );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02001341#endif
1342
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02001343 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001344 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02001345 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001346 return( ret );
1347 }
1348
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001349#if defined(MBEDTLS_SSL_PROTO_DTLS)
1350 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
1351 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
1352 {
1353 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
1354 return( ret );
1355 }
1356#endif
1357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001359
1360 return( 0 );
1361}
1362
Manuel Pégourié-Gonnardca6440b2014-09-10 12:39:54 +00001363#define SSL_MAX_HASH_LEN 12
Manuel Pégourié-Gonnardca6440b2014-09-10 12:39:54 +00001364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001366{
Janos Follath865b3eb2019-12-16 11:46:15 +00001367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea4174312021-12-13 14:38:40 +01001368 unsigned int hash_len = 12;
Manuel Pégourié-Gonnardca6440b2014-09-10 12:39:54 +00001369 unsigned char buf[SSL_MAX_HASH_LEN];
Paul Bakker5121ce52009-01-03 21:22:43 +00001370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001372
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001373 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374
Hanno Becker327c93b2018-08-15 13:56:18 +01001375 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001376 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01001378 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00001379 }
1380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00001382 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001384 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1385 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01001386 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
1387 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00001388 }
1389
Hanno Beckera0ca87e2021-06-24 10:27:37 +01001390 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
1391 {
1392 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1393 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01001394 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
1395 goto exit;
Hanno Beckera0ca87e2021-06-24 10:27:37 +01001396 }
1397
1398 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
Paul Bakker5121ce52009-01-03 21:22:43 +00001399 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001400 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001401 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1402 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01001403 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
1404 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00001405 }
1406
Gabor Mezei90437e32021-10-20 11:59:27 +02001407 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
Manuel Pégourié-Gonnard4abc3272014-09-10 12:02:46 +00001408 buf, hash_len ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001411 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
Dave Rodgman43fcb8d2021-06-28 21:49:15 +01001412 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01001413 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1414 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00001415 }
1416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001418 ssl->verify_data_len = hash_len;
1419 memcpy( ssl->peer_verify_data, buf, hash_len );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001420#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001421
Paul Bakker0a597072012-09-25 21:55:46 +00001422 if( ssl->handshake->resume != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001423 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001425 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001429 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01001431#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001432 }
1433 else
1434 ssl->state++;
1435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001437 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438 mbedtls_ssl_recv_flight_completed( ssl );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001439#endif
1440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001441 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001442
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01001443exit:
1444 mbedtls_platform_zeroize( buf, hash_len );
1445 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
1447
Jerry Yuc73c6182022-02-08 20:29:25 +08001448#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001451{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05001455#if defined(MBEDTLS_USE_PSA_CRYPTO)
1456 handshake->fin_sha256_psa = psa_hash_operation_init();
1457 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
1458#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +02001460 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001461#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05001462#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02001463#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05001464#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05001465 handshake->fin_sha384_psa = psa_hash_operation_init();
1466 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -05001467#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +02001469 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001470#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05001471#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001472
1473 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +01001474
1475#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01001476 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01001477 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
1478#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480#if defined(MBEDTLS_DHM_C)
1481 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001482#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_ECDH_C)
1484 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001485#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001486#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001487 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001488#if defined(MBEDTLS_SSL_CLI_C)
1489 handshake->ecjpake_cache = NULL;
1490 handshake->ecjpake_cache_len = 0;
1491#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001492#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001493
Gilles Peskineeccd8882020-03-10 12:19:08 +01001494#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02001495 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001496#endif
1497
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001498#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1499 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1500#endif
Hanno Becker75173122019-02-06 16:18:31 +00001501
1502#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1503 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1504 mbedtls_pk_init( &handshake->peer_pubkey );
1505#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001506}
1507
Hanno Beckera18d1322018-01-03 14:27:32 +00001508void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001509{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +02001511
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001512#if defined(MBEDTLS_USE_PSA_CRYPTO)
1513 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1514 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001515#else
1516 mbedtls_cipher_init( &transform->cipher_ctx_enc );
1517 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001518#endif
1519
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001520#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521 mbedtls_md_init( &transform->md_ctx_enc );
1522 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00001523#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001524}
1525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001527{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001529}
1530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00001532{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001533 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +00001534 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001536 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001538 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +02001539 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001540
1541 /*
1542 * Either the pointers are now NULL or cleared properly and can be freed.
1543 * Now allocate missing structures.
1544 */
1545 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001546 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001547 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001548 }
Paul Bakker48916f92012-09-16 19:57:18 +00001549
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001550 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001551 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001552 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001553 }
Paul Bakker48916f92012-09-16 19:57:18 +00001554
Paul Bakker82788fb2014-10-20 13:59:19 +02001555 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001556 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001557 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001558 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001559#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1560 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001561
Andrzej Kurek4a063792020-10-21 15:08:44 +02001562 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1563 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001564#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001565
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001566 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +00001567 if( ssl->handshake == NULL ||
1568 ssl->transform_negotiate == NULL ||
1569 ssl->session_negotiate == NULL )
1570 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02001571 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573 mbedtls_free( ssl->handshake );
1574 mbedtls_free( ssl->transform_negotiate );
1575 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001576
1577 ssl->handshake = NULL;
1578 ssl->transform_negotiate = NULL;
1579 ssl->session_negotiate = NULL;
1580
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001581 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +00001582 }
1583
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001584 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +00001586 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +02001587 ssl_handshake_params_init( ssl->handshake );
1588
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001590 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1591 {
1592 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001593
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001594 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
1595 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
1596 else
1597 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001598
Hanno Becker0f57a652020-02-05 10:37:26 +00001599 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001600 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001601#endif
1602
Brett Warrene0edc842021-08-17 09:53:13 +01001603/*
1604 * curve_list is translated to IANA TLS group identifiers here because
1605 * mbedtls_ssl_conf_curves returns void and so can't return
1606 * any error codes.
1607 */
1608#if defined(MBEDTLS_ECP_C)
1609#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1610 /* Heap allocate and translate curve_list from internal to IANA group ids */
1611 if ( ssl->conf->curve_list != NULL )
1612 {
1613 size_t length;
1614 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1615
1616 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
1617 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
1618
1619 /* Leave room for zero termination */
1620 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
1621 if ( group_list == NULL )
1622 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1623
1624 for( size_t i = 0; i < length; i++ )
1625 {
1626 const mbedtls_ecp_curve_info *info =
1627 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
1628 if ( info == NULL )
1629 {
1630 mbedtls_free( group_list );
1631 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1632 }
1633 group_list[i] = info->tls_id;
1634 }
1635
1636 group_list[length] = 0;
1637
1638 ssl->handshake->group_list = group_list;
1639 ssl->handshake->group_list_heap_allocated = 1;
1640 }
1641 else
1642 {
1643 ssl->handshake->group_list = ssl->conf->group_list;
1644 ssl->handshake->group_list_heap_allocated = 0;
1645 }
1646#endif /* MBEDTLS_DEPRECATED_REMOVED */
1647#endif /* MBEDTLS_ECP_C */
1648
Jerry Yuf017ee42022-01-12 15:49:48 +08001649#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1650#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001651#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001652 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1653 signature algorithms IANA identifiers. */
1654 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +08001655 ssl->conf->sig_hashes != NULL )
1656 {
1657 const int *md;
1658 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001659 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001660 uint16_t *p;
1661
Jerry Yub476a442022-01-21 18:14:45 +08001662#if defined(static_assert)
1663 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1664 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
1665 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +08001666#endif
1667
Jerry Yuf017ee42022-01-12 15:49:48 +08001668 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
1669 {
1670 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
1671 continue;
Jerry Yub476a442022-01-21 18:14:45 +08001672#if defined(MBEDTLS_ECDSA_C)
1673 sig_algs_len += sizeof( uint16_t );
1674#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001675
Jerry Yub476a442022-01-21 18:14:45 +08001676#if defined(MBEDTLS_RSA_C)
1677 sig_algs_len += sizeof( uint16_t );
1678#endif
1679 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
1680 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +08001681 }
1682
Jerry Yub476a442022-01-21 18:14:45 +08001683 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +08001684 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1685
Jerry Yub476a442022-01-21 18:14:45 +08001686 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
1687 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +08001688 if( ssl->handshake->sig_algs == NULL )
1689 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1690
1691 p = (uint16_t *)ssl->handshake->sig_algs;
1692 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
1693 {
1694 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
1695 if( hash == MBEDTLS_SSL_HASH_NONE )
1696 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001697#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08001698 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
1699 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001700#endif
1701#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08001702 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
1703 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001704#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001705 }
1706 *p = MBEDTLS_TLS1_3_SIG_NONE;
1707 ssl->handshake->sig_algs_heap_allocated = 1;
1708 }
1709 else
Jerry Yua69269a2022-01-17 21:06:01 +08001710#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001711 {
1712 ssl->handshake->sig_algs = ssl->conf->sig_algs;
1713 ssl->handshake->sig_algs_heap_allocated = 0;
1714 }
1715#endif /* MBEDTLS_DEPRECATED_REMOVED */
1716#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +00001717 return( 0 );
1718}
1719
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001720#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001721/* Dummy cookie callbacks for defaults */
1722static int ssl_cookie_write_dummy( void *ctx,
1723 unsigned char **p, unsigned char *end,
1724 const unsigned char *cli_id, size_t cli_id_len )
1725{
1726 ((void) ctx);
1727 ((void) p);
1728 ((void) end);
1729 ((void) cli_id);
1730 ((void) cli_id_len);
1731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001733}
1734
1735static int ssl_cookie_check_dummy( void *ctx,
1736 const unsigned char *cookie, size_t cookie_len,
1737 const unsigned char *cli_id, size_t cli_id_len )
1738{
1739 ((void) ctx);
1740 ((void) cookie);
1741 ((void) cookie_len);
1742 ((void) cli_id);
1743 ((void) cli_id_len);
1744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001746}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001747#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001748
Paul Bakker5121ce52009-01-03 21:22:43 +00001749/*
1750 * Initialize an SSL context
1751 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001752void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
1753{
1754 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
1755}
1756
Jerry Yu60835a82021-08-04 10:13:52 +08001757static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
1758{
Ronald Cron6f135e12021-12-08 16:57:54 +01001759#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001760 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
1761 {
1762 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1763 {
1764 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported" ) );
1765 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1766 }
1767 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
1768 return( 0 );
1769 }
1770#endif
1771
1772#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1773 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
1774 {
1775 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
1776 return( 0 );
1777 }
1778#endif
1779
Ronald Cron6f135e12021-12-08 16:57:54 +01001780#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001781 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( ssl->conf ) )
1782 {
1783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Hybrid TLS 1.2 + TLS 1.3 configurations are not yet supported" ) );
1784 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1785 }
1786#endif
1787
1788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
1789 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1790}
1791
1792static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1793{
1794 int ret;
1795 ret = ssl_conf_version_check( ssl );
1796 if( ret != 0 )
1797 return( ret );
1798
1799 /* Space for further checks */
1800
1801 return( 0 );
1802}
1803
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001804/*
1805 * Setup an SSL context
1806 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001807
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001808int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001809 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001810{
Janos Follath865b3eb2019-12-16 11:46:15 +00001811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001812 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1813 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001814
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001815 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001816
Jerry Yu60835a82021-08-04 10:13:52 +08001817 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1818 return( ret );
1819
Paul Bakker62f2dee2012-09-28 07:31:51 +00001820 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001821 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001822 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001823
1824 /* Set to NULL in case of an error condition */
1825 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001826
Darryl Greenb33cc762019-11-28 14:29:44 +00001827#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1828 ssl->in_buf_len = in_buf_len;
1829#endif
1830 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001831 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001832 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001833 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001834 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001835 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001836 }
1837
Darryl Greenb33cc762019-11-28 14:29:44 +00001838#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1839 ssl->out_buf_len = out_buf_len;
1840#endif
1841 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001842 if( ssl->out_buf == NULL )
1843 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001844 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001845 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001846 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001847 }
1848
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001849 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001850
Johan Pascalb62bb512015-12-03 21:56:45 +01001851#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001852 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001853#endif
1854
Paul Bakker48916f92012-09-16 19:57:18 +00001855 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001856 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001857
1858 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001859
1860error:
1861 mbedtls_free( ssl->in_buf );
1862 mbedtls_free( ssl->out_buf );
1863
1864 ssl->conf = NULL;
1865
Darryl Greenb33cc762019-11-28 14:29:44 +00001866#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1867 ssl->in_buf_len = 0;
1868 ssl->out_buf_len = 0;
1869#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001870 ssl->in_buf = NULL;
1871 ssl->out_buf = NULL;
1872
1873 ssl->in_hdr = NULL;
1874 ssl->in_ctr = NULL;
1875 ssl->in_len = NULL;
1876 ssl->in_iv = NULL;
1877 ssl->in_msg = NULL;
1878
1879 ssl->out_hdr = NULL;
1880 ssl->out_ctr = NULL;
1881 ssl->out_len = NULL;
1882 ssl->out_iv = NULL;
1883 ssl->out_msg = NULL;
1884
k-stachowiak9f7798e2018-07-31 16:52:32 +02001885 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001886}
1887
1888/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001889 * Reset an initialized and used SSL context for re-use while retaining
1890 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001891 *
1892 * If partial is non-zero, keep data in the input buffer and client ID.
1893 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001894 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001895void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1896 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001897{
Darryl Greenb33cc762019-11-28 14:29:44 +00001898#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1899 size_t in_buf_len = ssl->in_buf_len;
1900 size_t out_buf_len = ssl->out_buf_len;
1901#else
1902 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1903 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1904#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001905
Hanno Beckerb0302c42021-08-03 09:39:42 +01001906#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1907 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001908#endif
1909
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001910 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001911 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001912
Hanno Beckerb0302c42021-08-03 09:39:42 +01001913 mbedtls_ssl_reset_in_out_pointers( ssl );
1914
1915 /* Reset incoming message parsing */
1916 ssl->in_offt = NULL;
1917 ssl->nb_zero = 0;
1918 ssl->in_msgtype = 0;
1919 ssl->in_msglen = 0;
1920 ssl->in_hslen = 0;
1921 ssl->keep_current_message = 0;
1922 ssl->transform_in = NULL;
1923
1924#if defined(MBEDTLS_SSL_PROTO_DTLS)
1925 ssl->next_record_offset = 0;
1926 ssl->in_epoch = 0;
1927#endif
1928
1929 /* Keep current datagram if partial == 1 */
1930 if( partial == 0 )
1931 {
1932 ssl->in_left = 0;
1933 memset( ssl->in_buf, 0, in_buf_len );
1934 }
1935
1936 /* Reset outgoing message writing */
1937 ssl->out_msgtype = 0;
1938 ssl->out_msglen = 0;
1939 ssl->out_left = 0;
1940 memset( ssl->out_buf, 0, out_buf_len );
1941 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1942 ssl->transform_out = NULL;
1943
1944#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1945 mbedtls_ssl_dtls_replay_reset( ssl );
1946#endif
1947
XiaokangQian2b01dc32022-01-21 02:53:13 +00001948#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001949 if( ssl->transform )
1950 {
1951 mbedtls_ssl_transform_free( ssl->transform );
1952 mbedtls_free( ssl->transform );
1953 ssl->transform = NULL;
1954 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001955#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1956
XiaokangQian2b01dc32022-01-21 02:53:13 +00001957#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1958 mbedtls_ssl_transform_free( ssl->transform_application );
1959 mbedtls_free( ssl->transform_application );
1960 ssl->transform_application = NULL;
1961
1962 if( ssl->handshake != NULL )
1963 {
1964 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1965 mbedtls_free( ssl->handshake->transform_earlydata );
1966 ssl->handshake->transform_earlydata = NULL;
1967
1968 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1969 mbedtls_free( ssl->handshake->transform_handshake );
1970 ssl->handshake->transform_handshake = NULL;
1971 }
1972
XiaokangQian2b01dc32022-01-21 02:53:13 +00001973#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001974}
1975
1976int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1977{
1978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1979
1980 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1981
XiaokangQian78b1fa72022-01-19 06:56:30 +00001982 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001983
1984 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985#if defined(MBEDTLS_SSL_RENEGOTIATION)
1986 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001987 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001988
1989 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1991 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001992#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001994
Hanno Beckerb0302c42021-08-03 09:39:42 +01001995 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001996 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001997 if( ssl->session )
1998 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999 mbedtls_ssl_session_free( ssl->session );
2000 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01002001 ssl->session = NULL;
2002 }
2003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002005 ssl->alpn_chosen = NULL;
2006#endif
2007
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002008#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01002009#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002010 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01002011#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002012 {
2013 mbedtls_free( ssl->cli_id );
2014 ssl->cli_id = NULL;
2015 ssl->cli_id_len = 0;
2016 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002017#endif
2018
Paul Bakker48916f92012-09-16 19:57:18 +00002019 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2020 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002021
2022 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00002023}
2024
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02002025/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002026 * Reset an initialized and used SSL context for re-use while retaining
2027 * all application-set variables, function pointers and data.
2028 */
2029int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
2030{
Hanno Becker43aefe22020-02-05 10:44:56 +00002031 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002032}
2033
2034/*
Paul Bakker5121ce52009-01-03 21:22:43 +00002035 * SSL set accessors
2036 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002037void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00002038{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002039 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00002040}
2041
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002042void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002043{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002044 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002045}
2046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002048void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002049{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002050 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002051}
2052#endif
2053
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002054void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002055{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002056 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002057}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002059#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002060
Hanno Becker1841b0a2018-08-24 11:13:57 +01002061void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2062 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01002063{
2064 ssl->disable_datagram_packing = !allow_packing;
2065}
2066
2067void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
2068 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002069{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002070 conf->hs_timeout_min = min;
2071 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002072}
2073#endif
2074
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002075void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00002076{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002077 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00002078}
2079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002081void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002082 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002083 void *p_vrfy )
2084{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002085 conf->f_vrfy = f_vrfy;
2086 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002087}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002089
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002090void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002091 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00002092 void *p_rng )
2093{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01002094 conf->f_rng = f_rng;
2095 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00002096}
2097
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002098void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02002099 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00002100 void *p_dbg )
2101{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002102 conf->f_dbg = f_dbg;
2103 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00002104}
2105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002106void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002107 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00002108 mbedtls_ssl_send_t *f_send,
2109 mbedtls_ssl_recv_t *f_recv,
2110 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002111{
2112 ssl->p_bio = p_bio;
2113 ssl->f_send = f_send;
2114 ssl->f_recv = f_recv;
2115 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002116}
2117
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002118#if defined(MBEDTLS_SSL_PROTO_DTLS)
2119void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
2120{
2121 ssl->mtu = mtu;
2122}
2123#endif
2124
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002125void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002126{
2127 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002128}
2129
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002130void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
2131 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00002132 mbedtls_ssl_set_timer_t *f_set_timer,
2133 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002134{
2135 ssl->p_timer = p_timer;
2136 ssl->f_set_timer = f_set_timer;
2137 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002138
2139 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00002140 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002141}
2142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002144void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01002145 void *p_cache,
2146 mbedtls_ssl_cache_get_t *f_get_cache,
2147 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00002148{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002149 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002150 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002151 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00002152}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155#if defined(MBEDTLS_SSL_CLI_C)
2156int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00002157{
Janos Follath865b3eb2019-12-16 11:46:15 +00002158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002159
2160 if( ssl == NULL ||
2161 session == NULL ||
2162 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002163 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002166 }
2167
Hanno Beckere810bbc2021-05-14 16:01:05 +01002168 if( ssl->handshake->resume == 1 )
2169 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2170
Hanno Becker52055ae2019-02-06 14:30:46 +00002171 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
2172 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002173 return( ret );
2174
Paul Bakker0a597072012-09-25 21:55:46 +00002175 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002176
2177 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002178}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002180
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002181void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
2182 const int *ciphersuites )
2183{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01002184 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00002185}
2186
Ronald Cron6f135e12021-12-08 16:57:54 +01002187#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08002188void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01002189 const int kex_modes )
2190{
Xiaofei Bai746f9482021-11-12 08:53:56 +00002191 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01002192}
Ronald Cron6f135e12021-12-08 16:57:54 +01002193#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01002194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002196void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002197 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002198{
2199 conf->cert_profile = profile;
2200}
2201
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002202/* Append a new keycert entry to a (possibly empty) list */
2203static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
2204 mbedtls_x509_crt *cert,
2205 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002206{
niisato8ee24222018-06-25 19:05:48 +09002207 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002208
niisato8ee24222018-06-25 19:05:48 +09002209 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
2210 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002211 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002212
niisato8ee24222018-06-25 19:05:48 +09002213 new_cert->cert = cert;
2214 new_cert->key = key;
2215 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002216
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002217 /* Update head is the list was null, else add to the end */
2218 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01002219 {
niisato8ee24222018-06-25 19:05:48 +09002220 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01002221 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002222 else
2223 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002224 mbedtls_ssl_key_cert *cur = *head;
2225 while( cur->next != NULL )
2226 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09002227 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002228 }
2229
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002230 return( 0 );
2231}
2232
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002233int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002234 mbedtls_x509_crt *own_cert,
2235 mbedtls_pk_context *pk_key )
2236{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002237 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002238}
2239
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002240void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002241 mbedtls_x509_crt *ca_chain,
2242 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002243{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002244 conf->ca_chain = ca_chain;
2245 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00002246
2247#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2248 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
2249 * cannot be used together. */
2250 conf->f_ca_cb = NULL;
2251 conf->p_ca_cb = NULL;
2252#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00002253}
Hanno Becker5adaad92019-03-27 16:54:37 +00002254
2255#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2256void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00002257 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00002258 void *p_ca_cb )
2259{
2260 conf->f_ca_cb = f_ca_cb;
2261 conf->p_ca_cb = p_ca_cb;
2262
2263 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
2264 * cannot be used together. */
2265 conf->ca_chain = NULL;
2266 conf->ca_crl = NULL;
2267}
2268#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00002270
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002271#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2272int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2273 mbedtls_x509_crt *own_cert,
2274 mbedtls_pk_context *pk_key )
2275{
2276 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
2277 own_cert, pk_key ) );
2278}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002279
2280void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2281 mbedtls_x509_crt *ca_chain,
2282 mbedtls_x509_crl *ca_crl )
2283{
2284 ssl->handshake->sni_ca_chain = ca_chain;
2285 ssl->handshake->sni_ca_crl = ca_crl;
2286}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002287
2288void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2289 int authmode )
2290{
2291 ssl->handshake->sni_authmode = authmode;
2292}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002293#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2294
Hanno Becker8927c832019-04-03 12:52:50 +01002295#if defined(MBEDTLS_X509_CRT_PARSE_C)
2296void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
2297 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2298 void *p_vrfy )
2299{
2300 ssl->f_vrfy = f_vrfy;
2301 ssl->p_vrfy = p_vrfy;
2302}
2303#endif
2304
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002305#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002306/*
2307 * Set EC J-PAKE password for current handshake
2308 */
2309int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2310 const unsigned char *pw,
2311 size_t pw_len )
2312{
2313 mbedtls_ecjpake_role role;
2314
Janos Follath8eb64132016-06-03 15:40:57 +01002315 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002316 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2317
2318 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
2319 role = MBEDTLS_ECJPAKE_SERVER;
2320 else
2321 role = MBEDTLS_ECJPAKE_CLIENT;
2322
2323 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
2324 role,
2325 MBEDTLS_MD_SHA256,
2326 MBEDTLS_ECP_DP_SECP256R1,
2327 pw, pw_len ) );
2328}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002329#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002330
Gilles Peskineeccd8882020-03-10 12:19:08 +01002331#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002332
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002333static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
2334{
2335#if defined(MBEDTLS_USE_PSA_CRYPTO)
2336 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
2337 return( 1 );
2338#endif /* MBEDTLS_USE_PSA_CRYPTO */
2339
2340 if( conf->psk != NULL )
2341 return( 1 );
2342
2343 return( 0 );
2344}
2345
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002346static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
2347{
2348 /* Remove reference to existing PSK, if any. */
2349#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02002350 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002351 {
2352 /* The maintenance of the PSK key slot is the
2353 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002354 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002355 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00002356 /* This and the following branch should never
2357 * be taken simultaenously as we maintain the
2358 * invariant that raw and opaque PSKs are never
2359 * configured simultaneously. As a safeguard,
2360 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002361#endif /* MBEDTLS_USE_PSA_CRYPTO */
2362 if( conf->psk != NULL )
2363 {
2364 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
2365
2366 mbedtls_free( conf->psk );
2367 conf->psk = NULL;
2368 conf->psk_len = 0;
2369 }
2370
2371 /* Remove reference to PSK identity, if any. */
2372 if( conf->psk_identity != NULL )
2373 {
2374 mbedtls_free( conf->psk_identity );
2375 conf->psk_identity = NULL;
2376 conf->psk_identity_len = 0;
2377 }
2378}
2379
Hanno Becker7390c712018-11-15 13:33:04 +00002380/* This function assumes that PSK identity in the SSL config is unset.
2381 * It checks that the provided identity is well-formed and attempts
2382 * to make a copy of it in the SSL config.
2383 * On failure, the PSK identity in the config remains unset. */
2384static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
2385 unsigned char const *psk_identity,
2386 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002387{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002388 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00002389 if( psk_identity == NULL ||
2390 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10002391 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002392 {
2393 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2394 }
2395
Hanno Becker7390c712018-11-15 13:33:04 +00002396 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
2397 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002398 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02002399
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002400 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002401 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02002402
2403 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02002404}
2405
Hanno Becker7390c712018-11-15 13:33:04 +00002406int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
2407 const unsigned char *psk, size_t psk_len,
2408 const unsigned char *psk_identity, size_t psk_identity_len )
2409{
Janos Follath865b3eb2019-12-16 11:46:15 +00002410 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002411
2412 /* We currently only support one PSK, raw or opaque. */
2413 if( ssl_conf_psk_is_configured( conf ) )
2414 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00002415
2416 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002417 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00002418 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002419 if( psk_len == 0 )
2420 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2421 if( psk_len > MBEDTLS_PSK_MAX_LEN )
2422 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2423
Hanno Becker7390c712018-11-15 13:33:04 +00002424 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
2425 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2426 conf->psk_len = psk_len;
2427 memcpy( conf->psk, psk, conf->psk_len );
2428
2429 /* Check and set PSK Identity */
2430 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
2431 if( ret != 0 )
2432 ssl_conf_remove_psk( conf );
2433
2434 return( ret );
2435}
2436
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002437static void ssl_remove_psk( mbedtls_ssl_context *ssl )
2438{
2439#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02002440 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002441 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02002442 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002443 }
2444 else
2445#endif /* MBEDTLS_USE_PSA_CRYPTO */
2446 if( ssl->handshake->psk != NULL )
2447 {
2448 mbedtls_platform_zeroize( ssl->handshake->psk,
2449 ssl->handshake->psk_len );
2450 mbedtls_free( ssl->handshake->psk );
2451 ssl->handshake->psk_len = 0;
2452 }
2453}
2454
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002455int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2456 const unsigned char *psk, size_t psk_len )
2457{
2458 if( psk == NULL || ssl->handshake == NULL )
2459 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2460
2461 if( psk_len > MBEDTLS_PSK_MAX_LEN )
2462 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2463
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002464 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002465
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002466 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002467 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002468
2469 ssl->handshake->psk_len = psk_len;
2470 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
2471
2472 return( 0 );
2473}
2474
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002475#if defined(MBEDTLS_USE_PSA_CRYPTO)
2476int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01002477 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002478 const unsigned char *psk_identity,
2479 size_t psk_identity_len )
2480{
Janos Follath865b3eb2019-12-16 11:46:15 +00002481 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002482
2483 /* We currently only support one PSK, raw or opaque. */
2484 if( ssl_conf_psk_is_configured( conf ) )
2485 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002486
Hanno Becker7390c712018-11-15 13:33:04 +00002487 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002488 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00002489 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002490 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002491
2492 /* Check and set PSK Identity */
2493 ret = ssl_conf_set_psk_identity( conf, psk_identity,
2494 psk_identity_len );
2495 if( ret != 0 )
2496 ssl_conf_remove_psk( conf );
2497
2498 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002499}
2500
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002501int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
2502 mbedtls_svc_key_id_t psk )
2503{
2504 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
2505 ( ssl->handshake == NULL ) )
2506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2507
2508 ssl_remove_psk( ssl );
2509 ssl->handshake->psk_opaque = psk;
2510 return( 0 );
2511}
2512#endif /* MBEDTLS_USE_PSA_CRYPTO */
2513
2514void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
2515 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2516 size_t),
2517 void *p_psk )
2518{
2519 conf->f_psk = f_psk;
2520 conf->p_psk = p_psk;
2521}
2522#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
2523
2524#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002525psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002526 size_t taglen,
2527 psa_algorithm_t *alg,
2528 psa_key_type_t *key_type,
2529 size_t *key_size )
2530{
2531 switch ( mbedtls_cipher_type )
2532 {
2533 case MBEDTLS_CIPHER_AES_128_CBC:
2534 *alg = PSA_ALG_CBC_NO_PADDING;
2535 *key_type = PSA_KEY_TYPE_AES;
2536 *key_size = 128;
2537 break;
2538 case MBEDTLS_CIPHER_AES_128_CCM:
2539 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2540 *key_type = PSA_KEY_TYPE_AES;
2541 *key_size = 128;
2542 break;
2543 case MBEDTLS_CIPHER_AES_128_GCM:
2544 *alg = PSA_ALG_GCM;
2545 *key_type = PSA_KEY_TYPE_AES;
2546 *key_size = 128;
2547 break;
2548 case MBEDTLS_CIPHER_AES_192_CCM:
2549 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2550 *key_type = PSA_KEY_TYPE_AES;
2551 *key_size = 192;
2552 break;
2553 case MBEDTLS_CIPHER_AES_192_GCM:
2554 *alg = PSA_ALG_GCM;
2555 *key_type = PSA_KEY_TYPE_AES;
2556 *key_size = 192;
2557 break;
2558 case MBEDTLS_CIPHER_AES_256_CBC:
2559 *alg = PSA_ALG_CBC_NO_PADDING;
2560 *key_type = PSA_KEY_TYPE_AES;
2561 *key_size = 256;
2562 break;
2563 case MBEDTLS_CIPHER_AES_256_CCM:
2564 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2565 *key_type = PSA_KEY_TYPE_AES;
2566 *key_size = 256;
2567 break;
2568 case MBEDTLS_CIPHER_AES_256_GCM:
2569 *alg = PSA_ALG_GCM;
2570 *key_type = PSA_KEY_TYPE_AES;
2571 *key_size = 256;
2572 break;
2573 case MBEDTLS_CIPHER_ARIA_128_CBC:
2574 *alg = PSA_ALG_CBC_NO_PADDING;
2575 *key_type = PSA_KEY_TYPE_ARIA;
2576 *key_size = 128;
2577 break;
2578 case MBEDTLS_CIPHER_ARIA_128_CCM:
2579 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2580 *key_type = PSA_KEY_TYPE_ARIA;
2581 *key_size = 128;
2582 break;
2583 case MBEDTLS_CIPHER_ARIA_128_GCM:
2584 *alg = PSA_ALG_GCM;
2585 *key_type = PSA_KEY_TYPE_ARIA;
2586 *key_size = 128;
2587 break;
2588 case MBEDTLS_CIPHER_ARIA_192_CCM:
2589 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2590 *key_type = PSA_KEY_TYPE_ARIA;
2591 *key_size = 192;
2592 break;
2593 case MBEDTLS_CIPHER_ARIA_192_GCM:
2594 *alg = PSA_ALG_GCM;
2595 *key_type = PSA_KEY_TYPE_ARIA;
2596 *key_size = 192;
2597 break;
2598 case MBEDTLS_CIPHER_ARIA_256_CBC:
2599 *alg = PSA_ALG_CBC_NO_PADDING;
2600 *key_type = PSA_KEY_TYPE_ARIA;
2601 *key_size = 256;
2602 break;
2603 case MBEDTLS_CIPHER_ARIA_256_CCM:
2604 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2605 *key_type = PSA_KEY_TYPE_ARIA;
2606 *key_size = 256;
2607 break;
2608 case MBEDTLS_CIPHER_ARIA_256_GCM:
2609 *alg = PSA_ALG_GCM;
2610 *key_type = PSA_KEY_TYPE_ARIA;
2611 *key_size = 256;
2612 break;
2613 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2614 *alg = PSA_ALG_CBC_NO_PADDING;
2615 *key_type = PSA_KEY_TYPE_CAMELLIA;
2616 *key_size = 128;
2617 break;
2618 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2619 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2620 *key_type = PSA_KEY_TYPE_CAMELLIA;
2621 *key_size = 128;
2622 break;
2623 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2624 *alg = PSA_ALG_GCM;
2625 *key_type = PSA_KEY_TYPE_CAMELLIA;
2626 *key_size = 128;
2627 break;
2628 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2629 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2630 *key_type = PSA_KEY_TYPE_CAMELLIA;
2631 *key_size = 192;
2632 break;
2633 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2634 *alg = PSA_ALG_GCM;
2635 *key_type = PSA_KEY_TYPE_CAMELLIA;
2636 *key_size = 192;
2637 break;
2638 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2639 *alg = PSA_ALG_CBC_NO_PADDING;
2640 *key_type = PSA_KEY_TYPE_CAMELLIA;
2641 *key_size = 256;
2642 break;
2643 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2644 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2645 *key_type = PSA_KEY_TYPE_CAMELLIA;
2646 *key_size = 256;
2647 break;
2648 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2649 *alg = PSA_ALG_GCM;
2650 *key_type = PSA_KEY_TYPE_CAMELLIA;
2651 *key_size = 256;
2652 break;
2653 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2654 *alg = PSA_ALG_CHACHA20_POLY1305;
2655 *key_type = PSA_KEY_TYPE_CHACHA20;
2656 *key_size = 256;
2657 break;
2658 case MBEDTLS_CIPHER_NULL:
2659 *alg = MBEDTLS_SSL_NULL_CIPHER;
2660 *key_type = 0;
2661 *key_size = 0;
2662 break;
2663 default:
2664 return PSA_ERROR_NOT_SUPPORTED;
2665 }
2666
2667 return PSA_SUCCESS;
2668}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002669#endif /* MBEDTLS_USE_PSA_CRYPTO */
2670
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002671#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002672int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2673 const unsigned char *dhm_P, size_t P_len,
2674 const unsigned char *dhm_G, size_t G_len )
2675{
Janos Follath865b3eb2019-12-16 11:46:15 +00002676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002677
Glenn Strausscee11292021-12-20 01:43:17 -05002678 mbedtls_mpi_free( &conf->dhm_P );
2679 mbedtls_mpi_free( &conf->dhm_G );
2680
Hanno Beckera90658f2017-10-04 15:29:08 +01002681 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2682 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2683 {
2684 mbedtls_mpi_free( &conf->dhm_P );
2685 mbedtls_mpi_free( &conf->dhm_G );
2686 return( ret );
2687 }
2688
2689 return( 0 );
2690}
Paul Bakker5121ce52009-01-03 21:22:43 +00002691
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002692int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002693{
Janos Follath865b3eb2019-12-16 11:46:15 +00002694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002695
Glenn Strausscee11292021-12-20 01:43:17 -05002696 mbedtls_mpi_free( &conf->dhm_P );
2697 mbedtls_mpi_free( &conf->dhm_G );
2698
Gilles Peskinee5702482021-06-11 21:59:08 +02002699 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2700 &conf->dhm_P ) ) != 0 ||
2701 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2702 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002703 {
2704 mbedtls_mpi_free( &conf->dhm_P );
2705 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002706 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002707 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002708
2709 return( 0 );
2710}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002711#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002712
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002713#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2714/*
2715 * Set the minimum length for Diffie-Hellman parameters
2716 */
2717void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2718 unsigned int bitlen )
2719{
2720 conf->dhm_min_bitlen = bitlen;
2721}
2722#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2723
Gilles Peskineeccd8882020-03-10 12:19:08 +01002724#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002725#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002726/*
2727 * Set allowed/preferred hashes for handshake signatures
2728 */
2729void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2730 const int *hashes )
2731{
2732 conf->sig_hashes = hashes;
2733}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002734#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002735
Jerry Yuf017ee42022-01-12 15:49:48 +08002736/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002737void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2738 const uint16_t* sig_algs )
2739{
Jerry Yuf017ee42022-01-12 15:49:48 +08002740#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2741 conf->sig_hashes = NULL;
2742#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2743 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002744}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002745#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002746
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002747#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002748#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002749/*
2750 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002751 *
2752 * mbedtls_ssl_setup() takes the provided list
2753 * and translates it to a list of IANA TLS group identifiers,
2754 * stored in ssl->handshake->group_list.
2755 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002756 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002757void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002758 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002759{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002760 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002761 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002762}
Brett Warrene0edc842021-08-17 09:53:13 +01002763#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002764#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002765
Brett Warrene0edc842021-08-17 09:53:13 +01002766/*
2767 * Set the allowed groups
2768 */
2769void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2770 const uint16_t *group_list )
2771{
2772#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2773 conf->curve_list = NULL;
2774#endif
2775 conf->group_list = group_list;
2776}
2777
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002778#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002780{
Hanno Becker947194e2017-04-07 13:25:49 +01002781 /* Initialize to suppress unnecessary compiler warning */
2782 size_t hostname_len = 0;
2783
2784 /* Check if new hostname is valid before
2785 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002786 if( hostname != NULL )
2787 {
2788 hostname_len = strlen( hostname );
2789
2790 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2791 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2792 }
2793
2794 /* Now it's clear that we will overwrite the old hostname,
2795 * so we can free it safely */
2796
2797 if( ssl->hostname != NULL )
2798 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002799 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002800 mbedtls_free( ssl->hostname );
2801 }
2802
2803 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002804
Paul Bakker5121ce52009-01-03 21:22:43 +00002805 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002806 {
2807 ssl->hostname = NULL;
2808 }
2809 else
2810 {
2811 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002812 if( ssl->hostname == NULL )
2813 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002814
Hanno Becker947194e2017-04-07 13:25:49 +01002815 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002816
Hanno Becker947194e2017-04-07 13:25:49 +01002817 ssl->hostname[hostname_len] = '\0';
2818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819
2820 return( 0 );
2821}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002822#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002824#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002825void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002827 const unsigned char *, size_t),
2828 void *p_sni )
2829{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002830 conf->f_sni = f_sni;
2831 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002832}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002836int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002837{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002838 size_t cur_len, tot_len;
2839 const char **p;
2840
2841 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002842 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2843 * MUST NOT be truncated."
2844 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002845 */
2846 tot_len = 0;
2847 for( p = protos; *p != NULL; p++ )
2848 {
2849 cur_len = strlen( *p );
2850 tot_len += cur_len;
2851
Ronald Cron8216dd32020-04-23 16:41:44 +02002852 if( ( cur_len == 0 ) ||
2853 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2854 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002856 }
2857
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002858 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002859
2860 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002861}
2862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002863const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002864{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002865 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002866}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002868
Johan Pascalb62bb512015-12-03 21:56:45 +01002869#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002870void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2871 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002872{
2873 conf->dtls_srtp_mki_support = support_mki_value;
2874}
2875
Ron Eldoref72faf2018-07-12 11:54:20 +03002876int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2877 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002878 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002879{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002880 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002881 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002882 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002883 }
Ron Eldor591f1622018-01-22 12:30:04 +02002884
2885 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002886 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002887 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002888 }
Ron Eldor591f1622018-01-22 12:30:04 +02002889
2890 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2891 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002892 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002893}
2894
Ron Eldoref72faf2018-07-12 11:54:20 +03002895int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002896 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002897{
Johan Pascal253d0262020-09-22 13:04:45 +02002898 const mbedtls_ssl_srtp_profile *p;
2899 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002900
Johan Pascal253d0262020-09-22 13:04:45 +02002901 /* check the profiles list: all entry must be valid,
2902 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002903 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2904 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2905 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002906 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002907 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002908 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002909 list_size++;
2910 }
2911 else
2912 {
2913 /* unsupported value, stop parsing and set the size to an error value */
2914 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002915 }
2916 }
2917
Johan Pascal5ef72d22020-10-28 17:05:47 +01002918 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002919 {
Johan Pascal253d0262020-09-22 13:04:45 +02002920 conf->dtls_srtp_profile_list = NULL;
2921 conf->dtls_srtp_profile_list_len = 0;
2922 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2923 }
2924
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002925 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002926 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002927
2928 return( 0 );
2929}
2930
Johan Pascal5ef72d22020-10-28 17:05:47 +01002931void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2932 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002933{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002934 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2935 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002936 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002937 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002938 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002939 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002940 else
2941 {
2942 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002943 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2944 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002945 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002946}
Johan Pascalb62bb512015-12-03 21:56:45 +01002947#endif /* MBEDTLS_SSL_DTLS_SRTP */
2948
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002949void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002950{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002951 conf->max_major_ver = major;
2952 conf->max_minor_ver = minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002953}
2954
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002955void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002956{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002957 conf->min_major_ver = major;
2958 conf->min_minor_ver = minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002959}
2960
Janos Follath088ce432017-04-10 12:42:31 +01002961#if defined(MBEDTLS_SSL_SRV_C)
2962void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2963 char cert_req_ca_list )
2964{
2965 conf->cert_req_ca_list = cert_req_ca_list;
2966}
2967#endif
2968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002970void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002971{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002972 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002973}
2974#endif
2975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002977void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002978{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002979 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002980}
2981#endif
2982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002984int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002985{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002987 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002988 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002990 }
2991
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002992 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002993
2994 return( 0 );
2995}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002997
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002998void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002999{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003000 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003001}
3002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003004void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003005{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003006 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003007}
3008
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003009void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003010{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003011 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003012}
3013
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003014void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003015 const unsigned char period[8] )
3016{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003017 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003018}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003022#if defined(MBEDTLS_SSL_CLI_C)
3023void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003024{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003025 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003026}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003027#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003028
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003029#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003030void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
3031 mbedtls_ssl_ticket_write_t *f_ticket_write,
3032 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3033 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02003034{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003035 conf->f_ticket_write = f_ticket_write;
3036 conf->f_ticket_parse = f_ticket_parse;
3037 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003038}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003039#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003041
Hanno Becker7e6c1782021-06-08 09:24:55 +01003042void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
3043 mbedtls_ssl_export_keys_t *f_export_keys,
3044 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003045{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003046 ssl->f_export_keys = f_export_keys;
3047 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003048}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003049
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003050#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003051void mbedtls_ssl_conf_async_private_cb(
3052 mbedtls_ssl_config *conf,
3053 mbedtls_ssl_async_sign_t *f_async_sign,
3054 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3055 mbedtls_ssl_async_resume_t *f_async_resume,
3056 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003057 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003058{
3059 conf->f_async_sign_start = f_async_sign;
3060 conf->f_async_decrypt_start = f_async_decrypt;
3061 conf->f_async_resume = f_async_resume;
3062 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003063 conf->p_async_config_data = async_config_data;
3064}
3065
Gilles Peskine8f97af72018-04-26 11:46:10 +02003066void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
3067{
3068 return( conf->p_async_config_data );
3069}
3070
Gilles Peskine1febfef2018-04-30 11:54:39 +02003071void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003072{
3073 if( ssl->handshake == NULL )
3074 return( NULL );
3075 else
3076 return( ssl->handshake->user_async_ctx );
3077}
3078
Gilles Peskine1febfef2018-04-30 11:54:39 +02003079void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003080 void *ctx )
3081{
3082 if( ssl->handshake != NULL )
3083 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003084}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003085#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003086
Paul Bakker5121ce52009-01-03 21:22:43 +00003087/*
3088 * SSL get accessors
3089 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003090uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003091{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003092 if( ssl->session != NULL )
3093 return( ssl->session->verify_result );
3094
3095 if( ssl->session_negotiate != NULL )
3096 return( ssl->session_negotiate->verify_result );
3097
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02003098 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00003099}
3100
Glenn Strauss8f526902022-01-13 00:04:49 -05003101int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
3102{
3103 if( ssl == NULL || ssl->session == NULL )
3104 return( 0 );
3105
3106 return( ssl->session->ciphersuite );
3107}
3108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00003110{
Paul Bakker926c8e42013-03-06 10:23:34 +01003111 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003112 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01003113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00003115}
3116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00003118{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003120 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003121 {
3122 switch( ssl->minor_ver )
3123 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 case MBEDTLS_SSL_MINOR_VERSION_3:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003125 return( "DTLSv1.2" );
3126
3127 default:
3128 return( "unknown (DTLS)" );
3129 }
3130 }
3131#endif
3132
Paul Bakker43ca69c2011-01-15 17:35:19 +00003133 switch( ssl->minor_ver )
3134 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 case MBEDTLS_SSL_MINOR_VERSION_3:
Paul Bakker1ef83d62012-04-11 12:09:53 +00003136 return( "TLSv1.2" );
3137
Paul Bakker43ca69c2011-01-15 17:35:19 +00003138 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003139 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003140 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003141}
3142
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003143#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003144size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
3145{
David Horstmann95d516f2021-05-04 18:36:56 +01003146 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003147 size_t read_mfl;
3148
3149 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
3150 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3151 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
3152 {
3153 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
3154 }
3155
3156 /* Check if a smaller max length was negotiated */
3157 if( ssl->session_out != NULL )
3158 {
3159 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
3160 if( read_mfl < max_len )
3161 {
3162 max_len = read_mfl;
3163 }
3164 }
3165
3166 // During a handshake, use the value being negotiated
3167 if( ssl->session_negotiate != NULL )
3168 {
3169 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
3170 if( read_mfl < max_len )
3171 {
3172 max_len = read_mfl;
3173 }
3174 }
3175
3176 return( max_len );
3177}
3178
3179size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003180{
3181 size_t max_len;
3182
3183 /*
3184 * Assume mfl_code is correct since it was checked when set
3185 */
Angus Grattond8213d02016-05-25 20:56:48 +10003186 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003187
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003188 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003189 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10003190 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003191 {
Angus Grattond8213d02016-05-25 20:56:48 +10003192 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003193 }
3194
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003195 /* During a handshake, use the value being negotiated */
3196 if( ssl->session_negotiate != NULL &&
3197 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
3198 {
3199 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
3200 }
3201
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003202 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003203}
3204#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3205
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003206#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00003207size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003208{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003209 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
3210 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3211 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3212 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
3213 return ( 0 );
3214
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003215 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
3216 return( ssl->mtu );
3217
3218 if( ssl->mtu == 0 )
3219 return( ssl->handshake->mtu );
3220
3221 return( ssl->mtu < ssl->handshake->mtu ?
3222 ssl->mtu : ssl->handshake->mtu );
3223}
3224#endif /* MBEDTLS_SSL_PROTO_DTLS */
3225
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003226int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
3227{
3228 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3229
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003230#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3231 !defined(MBEDTLS_SSL_PROTO_DTLS)
3232 (void) ssl;
3233#endif
3234
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003235#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003236 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003237
3238 if( max_len > mfl )
3239 max_len = mfl;
3240#endif
3241
3242#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00003243 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003244 {
Hanno Becker89490712020-02-05 10:50:12 +00003245 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003246 const int ret = mbedtls_ssl_get_record_expansion( ssl );
3247 const size_t overhead = (size_t) ret;
3248
3249 if( ret < 0 )
3250 return( ret );
3251
3252 if( mtu <= overhead )
3253 {
3254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
3255 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3256 }
3257
3258 if( max_len > mtu - overhead )
3259 max_len = mtu - overhead;
3260 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003261#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003262
Hanno Becker0defedb2018-08-10 12:35:02 +01003263#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3264 !defined(MBEDTLS_SSL_PROTO_DTLS)
3265 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003266#endif
3267
3268 return( (int) max_len );
3269}
3270
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003271int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
3272{
3273 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3274
3275#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3276 (void) ssl;
3277#endif
3278
3279#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3280 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
3281
3282 if( max_len > mfl )
3283 max_len = mfl;
3284#endif
3285
3286 return( (int) max_len );
3287}
3288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289#if defined(MBEDTLS_X509_CRT_PARSE_C)
3290const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00003291{
3292 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003293 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00003294
Hanno Beckere6824572019-02-07 13:18:46 +00003295#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003296 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00003297#else
3298 return( NULL );
3299#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003300}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00003304int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
3305 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003306{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003307 int ret;
3308
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003309 if( ssl == NULL ||
3310 dst == NULL ||
3311 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003312 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003315 }
3316
Hanno Beckere810bbc2021-05-14 16:01:05 +01003317 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3318 * idempotent: Each session can only be exported once.
3319 *
3320 * (This is in preparation for TLS 1.3 support where we will
3321 * need the ability to export multiple sessions (aka tickets),
3322 * which will be achieved by calling mbedtls_ssl_get_session()
3323 * multiple times until it fails.)
3324 *
3325 * Check whether we have already exported the current session,
3326 * and fail if so.
3327 */
3328 if( ssl->session->exported == 1 )
3329 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3330
3331 ret = mbedtls_ssl_session_copy( dst, ssl->session );
3332 if( ret != 0 )
3333 return( ret );
3334
3335 /* Remember that we've exported the session. */
3336 ssl->session->exported = 1;
3337 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003338}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003340
Paul Bakker5121ce52009-01-03 21:22:43 +00003341/*
Hanno Beckera835da52019-05-16 12:39:07 +01003342 * Define ticket header determining Mbed TLS version
3343 * and structure of the ticket.
3344 */
3345
Hanno Becker94ef3b32019-05-16 12:50:45 +01003346/*
Hanno Becker50b59662019-05-28 14:30:45 +01003347 * Define bitflag determining compile-time settings influencing
3348 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003349 */
3350
Hanno Becker50b59662019-05-28 14:30:45 +01003351#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003352#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003353#else
Hanno Becker3e088662019-05-29 11:10:18 +01003354#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003355#endif /* MBEDTLS_HAVE_TIME */
3356
3357#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003358#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003359#else
Hanno Becker3e088662019-05-29 11:10:18 +01003360#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003361#endif /* MBEDTLS_X509_CRT_PARSE_C */
3362
3363#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003364#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003365#else
Hanno Becker3e088662019-05-29 11:10:18 +01003366#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003367#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3368
3369#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003370#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003371#else
Hanno Becker3e088662019-05-29 11:10:18 +01003372#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003373#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3374
Hanno Becker94ef3b32019-05-16 12:50:45 +01003375#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003376#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003377#else
Hanno Becker3e088662019-05-29 11:10:18 +01003378#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003379#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3380
Hanno Becker94ef3b32019-05-16 12:50:45 +01003381#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3382#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3383#else
3384#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3385#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3386
Hanno Becker3e088662019-05-29 11:10:18 +01003387#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3388#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3389#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3390#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003391#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3392#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003393
Hanno Becker50b59662019-05-28 14:30:45 +01003394#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01003395 ( (uint16_t) ( \
3396 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
3397 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
3398 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
3399 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01003400 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01003401 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01003402
Hanno Beckerf8787072019-05-16 12:41:07 +01003403static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003404 MBEDTLS_VERSION_MAJOR,
3405 MBEDTLS_VERSION_MINOR,
3406 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003407 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3408 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01003409};
Hanno Beckera835da52019-05-16 12:39:07 +01003410
3411/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003412 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003413 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003414 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003415 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003416 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003417 * opaque mbedtls_version[3]; // library version: major, minor, patch
3418 * opaque session_format[2]; // library-version specific 16-bit field
3419 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003420 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003421 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003422 * Note: When updating the format, remember to keep
3423 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003424 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003425 * // In this version, `session_format` determines
3426 * // the setting of those compile-time
3427 * // configuration options which influence
3428 * // the structure of mbedtls_ssl_session.
3429 *
Hanno Beckerfa0d61e2021-08-02 08:56:14 +01003430 * uint8_t minor_ver; // Protocol-version. Possible values:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003431 * // - TLS 1.2 (MBEDTLS_SSL_MINOR_VERSION_3)
3432 *
3433 * select (serialized_session.minor_ver) {
3434 *
3435 * case MBEDTLS_SSL_MINOR_VERSION_3: // TLS 1.2
3436 * serialized_session_tls12 data;
3437 *
3438 * };
3439 *
3440 * } serialized_session;
3441 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003442 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003443
3444#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3445/* Serialization of TLS 1.2 sessions:
3446 *
3447 * struct {
3448 * uint64 start_time;
3449 * uint8 ciphersuite[2]; // defined by the standard
3450 * uint8 compression; // 0 or 1
3451 * uint8 session_id_len; // at most 32
3452 * opaque session_id[32];
3453 * opaque master[48]; // fixed length in the standard
3454 * uint32 verify_result;
3455 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3456 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3457 * uint32 ticket_lifetime;
3458 * uint8 mfl_code; // up to 255 according to standard
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003459 * uint8 encrypt_then_mac; // 0 or 1
3460 * } serialized_session_tls12;
3461 *
3462 */
3463static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
3464 unsigned char *buf,
3465 size_t buf_len )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003466{
3467 unsigned char *p = buf;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003468 size_t used = 0;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003469
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003470#if defined(MBEDTLS_HAVE_TIME)
3471 uint64_t start;
3472#endif
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003473#if defined(MBEDTLS_X509_CRT_PARSE_C)
3474#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3475 size_t cert_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003476#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3477#endif /* MBEDTLS_X509_CRT_PARSE_C */
3478
Hanno Beckera835da52019-05-16 12:39:07 +01003479 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003480 * Time
3481 */
3482#if defined(MBEDTLS_HAVE_TIME)
3483 used += 8;
3484
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003485 if( used <= buf_len )
3486 {
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003487 start = (uint64_t) session->start;
3488
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003489 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
3490 p += 8;
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003491 }
3492#endif /* MBEDTLS_HAVE_TIME */
3493
3494 /*
3495 * Basic mandatory fields
3496 */
3497 used += 2 /* ciphersuite */
3498 + 1 /* compression */
3499 + 1 /* id_len */
3500 + sizeof( session->id )
3501 + sizeof( session->master )
3502 + 4; /* verify_result */
3503
3504 if( used <= buf_len )
3505 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003506 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
3507 p += 2;
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003508
Joe Subbiani2194dc42021-07-14 12:31:31 +01003509 *p++ = MBEDTLS_BYTE_0( session->compression );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003510
Joe Subbiani2194dc42021-07-14 12:31:31 +01003511 *p++ = MBEDTLS_BYTE_0( session->id_len );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003512 memcpy( p, session->id, 32 );
3513 p += 32;
3514
3515 memcpy( p, session->master, 48 );
3516 p += 48;
3517
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003518 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
3519 p += 4;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003520 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003521
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003522 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003523 * Peer's end-entity certificate
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003524 */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003525#if defined(MBEDTLS_X509_CRT_PARSE_C)
3526#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3527 if( session->peer_cert == NULL )
3528 cert_len = 0;
3529 else
3530 cert_len = session->peer_cert->raw.len;
3531
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003532 used += 3 + cert_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003533
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003534 if( used <= buf_len )
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003535 {
Joe Subbiani2194dc42021-07-14 12:31:31 +01003536 *p++ = MBEDTLS_BYTE_2( cert_len );
3537 *p++ = MBEDTLS_BYTE_1( cert_len );
3538 *p++ = MBEDTLS_BYTE_0( cert_len );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003539
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003540 if( session->peer_cert != NULL )
3541 {
3542 memcpy( p, session->peer_cert->raw.p, cert_len );
3543 p += cert_len;
3544 }
3545 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003546#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003547 if( session->peer_cert_digest != NULL )
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003548 {
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003549 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3550 if( used <= buf_len )
3551 {
3552 *p++ = (unsigned char) session->peer_cert_digest_type;
3553 *p++ = (unsigned char) session->peer_cert_digest_len;
3554 memcpy( p, session->peer_cert_digest,
3555 session->peer_cert_digest_len );
3556 p += session->peer_cert_digest_len;
3557 }
3558 }
3559 else
3560 {
3561 used += 2;
3562 if( used <= buf_len )
3563 {
3564 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3565 *p++ = 0;
3566 }
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003567 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003568#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3569#endif /* MBEDTLS_X509_CRT_PARSE_C */
3570
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003571 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003572 * Session ticket if any, plus associated data
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003573 */
3574#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003575 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003576
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003577 if( used <= buf_len )
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003578 {
Joe Subbiani2194dc42021-07-14 12:31:31 +01003579 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
3580 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
3581 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003582
3583 if( session->ticket != NULL )
3584 {
3585 memcpy( p, session->ticket, session->ticket_len );
3586 p += session->ticket_len;
3587 }
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003588
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003589 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
3590 p += 4;
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003591 }
3592#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3593
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003594 /*
3595 * Misc extension-related info
3596 */
3597#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3598 used += 1;
3599
3600 if( used <= buf_len )
3601 *p++ = session->mfl_code;
3602#endif
3603
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003604#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3605 used += 1;
3606
3607 if( used <= buf_len )
Joe Subbiani2194dc42021-07-14 12:31:31 +01003608 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003609#endif
3610
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611 return( used );
3612}
3613#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003614
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003615static int ssl_session_save( const mbedtls_ssl_session *session,
3616 unsigned char omit_header,
3617 unsigned char *buf,
3618 size_t buf_len,
3619 size_t *olen )
3620{
3621 unsigned char *p = buf;
3622 size_t used = 0;
3623
3624 if( !omit_header )
3625 {
3626 /*
3627 * Add Mbed TLS version identifier
3628 */
3629
3630 used += sizeof( ssl_serialized_session_header );
3631
3632 if( used <= buf_len )
3633 {
3634 memcpy( p, ssl_serialized_session_header,
3635 sizeof( ssl_serialized_session_header ) );
3636 p += sizeof( ssl_serialized_session_header );
3637 }
3638 }
3639
3640 /*
3641 * TLS version identifier
3642 */
3643 used += 1;
3644 if( used <= buf_len )
3645 {
3646 *p++ = session->minor_ver;
3647 }
3648
3649 /* Forward to version-specific serialization routine. */
3650 switch( session->minor_ver )
3651 {
3652#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3653 case MBEDTLS_SSL_MINOR_VERSION_3:
3654 {
3655 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
3656 used += ssl_session_save_tls12( session, p, remaining_len );
3657 break;
3658 }
3659#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3660
3661 default:
3662 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3663 }
3664
3665 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003666 if( used > buf_len )
3667 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003668
3669 return( 0 );
3670}
3671
3672/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003673 * Public wrapper for ssl_session_save()
3674 */
3675int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3676 unsigned char *buf,
3677 size_t buf_len,
3678 size_t *olen )
3679{
3680 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3681}
Jerry Yuc3091b12021-12-23 14:57:39 +08003682#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003683/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003684 * Deserialize session, see mbedtls_ssl_session_save() for format.
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003685 *
3686 * This internal version is wrapped by a public function that cleans up in
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003687 * case of error, and has an extra option omit_header.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003688 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003689static int ssl_session_load_tls12( mbedtls_ssl_session *session,
3690 const unsigned char *buf,
3691 size_t len )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003692{
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003693#if defined(MBEDTLS_HAVE_TIME)
3694 uint64_t start;
3695#endif
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003696#if defined(MBEDTLS_X509_CRT_PARSE_C)
3697#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3698 size_t cert_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003699#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3700#endif /* MBEDTLS_X509_CRT_PARSE_C */
3701
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003702 const unsigned char *p = buf;
3703 const unsigned char * const end = buf + len;
Hanno Beckera835da52019-05-16 12:39:07 +01003704
3705 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003706 * Time
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003707 */
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003708#if defined(MBEDTLS_HAVE_TIME)
3709 if( 8 > (size_t)( end - p ) )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003710 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3711
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003712 start = ( (uint64_t) p[0] << 56 ) |
3713 ( (uint64_t) p[1] << 48 ) |
3714 ( (uint64_t) p[2] << 40 ) |
3715 ( (uint64_t) p[3] << 32 ) |
3716 ( (uint64_t) p[4] << 24 ) |
3717 ( (uint64_t) p[5] << 16 ) |
3718 ( (uint64_t) p[6] << 8 ) |
3719 ( (uint64_t) p[7] );
3720 p += 8;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003721
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003722 session->start = (time_t) start;
3723#endif /* MBEDTLS_HAVE_TIME */
3724
3725 /*
3726 * Basic mandatory fields
3727 */
3728 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
3729 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3730
3731 session->ciphersuite = ( p[0] << 8 ) | p[1];
3732 p += 2;
3733
3734 session->compression = *p++;
3735
3736 session->id_len = *p++;
3737 memcpy( session->id, p, 32 );
3738 p += 32;
3739
3740 memcpy( session->master, p, 48 );
3741 p += 48;
3742
3743 session->verify_result = ( (uint32_t) p[0] << 24 ) |
3744 ( (uint32_t) p[1] << 16 ) |
3745 ( (uint32_t) p[2] << 8 ) |
3746 ( (uint32_t) p[3] );
3747 p += 4;
3748
3749 /* Immediately clear invalid pointer values that have been read, in case
3750 * we exit early before we replaced them with valid ones. */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003751#if defined(MBEDTLS_X509_CRT_PARSE_C)
3752#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3753 session->peer_cert = NULL;
3754#else
3755 session->peer_cert_digest = NULL;
3756#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3757#endif /* MBEDTLS_X509_CRT_PARSE_C */
3758#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3759 session->ticket = NULL;
3760#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3761
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003762 /*
3763 * Peer certificate
3764 */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003765#if defined(MBEDTLS_X509_CRT_PARSE_C)
3766#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3767 /* Deserialize CRT from the end of the ticket. */
3768 if( 3 > (size_t)( end - p ) )
3769 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3770
3771 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
3772 p += 3;
3773
3774 if( cert_len != 0 )
3775 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003777
3778 if( cert_len > (size_t)( end - p ) )
3779 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3780
3781 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
3782
3783 if( session->peer_cert == NULL )
3784 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
3785
3786 mbedtls_x509_crt_init( session->peer_cert );
3787
3788 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
3789 p, cert_len ) ) != 0 )
3790 {
3791 mbedtls_x509_crt_free( session->peer_cert );
3792 mbedtls_free( session->peer_cert );
3793 session->peer_cert = NULL;
3794 return( ret );
3795 }
3796
3797 p += cert_len;
3798 }
3799#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3800 /* Deserialize CRT digest from the end of the ticket. */
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003801 if( 2 > (size_t)( end - p ) )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003802 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3803
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003804 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3805 session->peer_cert_digest_len = (size_t) *p++;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003806
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003807 if( session->peer_cert_digest_len != 0 )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003808 {
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003809 const mbedtls_md_info_t *md_info =
3810 mbedtls_md_info_from_type( session->peer_cert_digest_type );
3811 if( md_info == NULL )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003813 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
3814 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003815
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003816 if( session->peer_cert_digest_len > (size_t)( end - p ) )
3817 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3818
3819 session->peer_cert_digest =
3820 mbedtls_calloc( 1, session->peer_cert_digest_len );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003821 if( session->peer_cert_digest == NULL )
3822 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
3823
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003824 memcpy( session->peer_cert_digest, p,
3825 session->peer_cert_digest_len );
3826 p += session->peer_cert_digest_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003827 }
3828#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3829#endif /* MBEDTLS_X509_CRT_PARSE_C */
3830
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003831 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003832 * Session ticket and associated data
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003833 */
3834#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3835 if( 3 > (size_t)( end - p ) )
3836 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3837
3838 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
3839 p += 3;
3840
3841 if( session->ticket_len != 0 )
3842 {
3843 if( session->ticket_len > (size_t)( end - p ) )
3844 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3845
3846 session->ticket = mbedtls_calloc( 1, session->ticket_len );
3847 if( session->ticket == NULL )
3848 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
3849
3850 memcpy( session->ticket, p, session->ticket_len );
3851 p += session->ticket_len;
3852 }
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003853
3854 if( 4 > (size_t)( end - p ) )
3855 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3856
3857 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
3858 ( (uint32_t) p[1] << 16 ) |
3859 ( (uint32_t) p[2] << 8 ) |
3860 ( (uint32_t) p[3] );
3861 p += 4;
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003862#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3863
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003864 /*
3865 * Misc extension-related info
3866 */
3867#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3868 if( 1 > (size_t)( end - p ) )
3869 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3870
3871 session->mfl_code = *p++;
3872#endif
3873
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02003874#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3875 if( 1 > (size_t)( end - p ) )
3876 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3877
3878 session->encrypt_then_mac = *p++;
3879#endif
3880
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003881 /* Done, should have consumed entire buffer */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003882 if( p != end )
3883 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3884
3885 return( 0 );
3886}
Jerry Yuc5aef882021-12-23 20:15:02 +08003887#endif /*MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003888static int ssl_session_load( mbedtls_ssl_session *session,
3889 unsigned char omit_header,
3890 const unsigned char *buf,
3891 size_t len )
3892{
3893 const unsigned char *p = buf;
3894 const unsigned char * const end = buf + len;
3895
3896 if( !omit_header )
3897 {
3898 /*
3899 * Check Mbed TLS version identifier
3900 */
3901
3902 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3903 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3904
3905 if( memcmp( p, ssl_serialized_session_header,
3906 sizeof( ssl_serialized_session_header ) ) != 0 )
3907 {
3908 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3909 }
3910 p += sizeof( ssl_serialized_session_header );
3911 }
3912
3913 /*
3914 * TLS version identifier
3915 */
3916 if( 1 > (size_t)( end - p ) )
3917 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3918 session->minor_ver = *p++;
3919
3920 /* Dispatch according to TLS version. */
3921 switch( session->minor_ver )
3922 {
3923#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3924 case MBEDTLS_SSL_MINOR_VERSION_3: /* TLS 1.2 */
3925 {
3926 size_t remaining_len = ( end - p );
3927 return( ssl_session_load_tls12( session, p, remaining_len ) );
3928 }
3929#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3930
3931 default:
3932 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3933 }
3934}
3935
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003936/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003937 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003938 */
3939int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3940 const unsigned char *buf,
3941 size_t len )
3942{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003943 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003944
3945 if( ret != 0 )
3946 mbedtls_ssl_session_free( session );
3947
3948 return( ret );
3949}
3950
3951/*
Paul Bakker1961b702013-01-25 14:49:24 +01003952 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003953 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003954static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3955{
3956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3957
3958 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3959 return( ret );
3960
3961#if defined(MBEDTLS_SSL_PROTO_DTLS)
3962 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3963 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3964 {
3965 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3966 return( ret );
3967 }
3968#endif /* MBEDTLS_SSL_PROTO_DTLS */
3969
3970 return( ret );
3971}
3972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003973int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003974{
Hanno Becker41934dd2021-08-07 19:13:43 +01003975 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003976
Hanno Becker41934dd2021-08-07 19:13:43 +01003977 if( ssl == NULL ||
3978 ssl->conf == NULL ||
3979 ssl->handshake == NULL ||
3980 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
3981 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003982 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003983 }
3984
3985 ret = ssl_prepare_handshake_step( ssl );
3986 if( ret != 0 )
3987 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003988
Jerry Yue7047812021-09-13 19:26:39 +08003989 ret = mbedtls_ssl_handle_pending_alert( ssl );
3990 if( ret != 0 )
3991 goto cleanup;
3992
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003993#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003994 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003995 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003996#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003997 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yuf4436812021-08-26 22:59:56 +08003998 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003999#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08004000
4001#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4002 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
4003 ret = mbedtls_ssl_handshake_client_step( ssl );
4004#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4005 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004006#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004008 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08004009 {
Ronald Cron6f135e12021-12-08 16:57:54 +01004010#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08004011 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08004012 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01004013#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08004014
4015#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4016 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
4017 ret = mbedtls_ssl_handshake_server_step( ssl );
4018#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4019 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004020#endif
4021
Jerry Yue7047812021-09-13 19:26:39 +08004022 if( ret != 0 )
4023 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004024 /* handshake_step return error. And it is same
4025 * with alert_reason.
4026 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08004027 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08004028 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08004029 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08004030 goto cleanup;
4031 }
4032 }
4033
4034cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01004035 return( ret );
4036}
4037
4038/*
4039 * Perform the SSL handshake
4040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004041int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01004042{
4043 int ret = 0;
4044
Hanno Beckera817ea42020-10-20 15:20:23 +01004045 /* Sanity checks */
4046
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004047 if( ssl == NULL || ssl->conf == NULL )
4048 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4049
Hanno Beckera817ea42020-10-20 15:20:23 +01004050#if defined(MBEDTLS_SSL_PROTO_DTLS)
4051 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4052 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
4053 {
4054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
4055 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
4056 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4057 }
4058#endif /* MBEDTLS_SSL_PROTO_DTLS */
4059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01004061
Hanno Beckera817ea42020-10-20 15:20:23 +01004062 /* Main handshake loop */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004063 while( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker1961b702013-01-25 14:49:24 +01004064 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004065 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01004066
4067 if( ret != 0 )
4068 break;
4069 }
4070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004072
4073 return( ret );
4074}
4075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004076#if defined(MBEDTLS_SSL_RENEGOTIATION)
4077#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004078/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004079 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004081static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004082{
Janos Follath865b3eb2019-12-16 11:46:15 +00004083 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004086
4087 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004088 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4089 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004090
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004091 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004092 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004093 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004094 return( ret );
4095 }
4096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004097 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004098
4099 return( 0 );
4100}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004101#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004102
4103/*
4104 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004105 * - any side: calling mbedtls_ssl_renegotiate(),
4106 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4107 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004108 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004109 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004110 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004111 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00004112int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00004113{
Janos Follath865b3eb2019-12-16 11:46:15 +00004114 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004117
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004118 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
4119 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00004120
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004121 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4122 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004123#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004124 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004125 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004126 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004127 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004128 ssl->handshake->out_msg_seq = 1;
4129 else
4130 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004131 }
4132#endif
4133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004134 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4135 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004137 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00004138 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004139 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00004140 return( ret );
4141 }
4142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004144
4145 return( 0 );
4146}
4147
4148/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004149 * Renegotiate current connection on client,
4150 * or request renegotiation on server
4151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004152int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004153{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004154 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004155
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004156 if( ssl == NULL || ssl->conf == NULL )
4157 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004159#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004160 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004161 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004162 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004163 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
4164 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004166 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004167
4168 /* Did we already try/start sending HelloRequest? */
4169 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004170 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004171
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004172 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004173 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004174#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004176#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004177 /*
4178 * On client, either start the renegotiation process or,
4179 * if already in progress, continue the handshake
4180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004181 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004183 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
4184 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004185
Hanno Becker40cdaa12020-02-05 10:48:27 +00004186 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004187 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00004188 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004189 return( ret );
4190 }
4191 }
4192 else
4193 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004194 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004195 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004196 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004197 return( ret );
4198 }
4199 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004200#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004201
Paul Bakker37ce0ff2013-10-31 14:32:04 +01004202 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004203}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004204#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004206#if defined(MBEDTLS_X509_CRT_PARSE_C)
4207static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004208{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004209 mbedtls_ssl_key_cert *cur = key_cert, *next;
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004210
4211 while( cur != NULL )
4212 {
4213 next = cur->next;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004214 mbedtls_free( cur );
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004215 cur = next;
4216 }
4217}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004218#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004219
Gilles Peskine9b562d52018-04-25 20:32:43 +02004220void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00004221{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004222 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4223
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004224 if( handshake == NULL )
4225 return;
4226
Brett Warrene0edc842021-08-17 09:53:13 +01004227#if defined(MBEDTLS_ECP_C)
4228#if !defined(MBEDTLS_DEPRECATED_REMOVED)
4229 if ( ssl->handshake->group_list_heap_allocated )
4230 mbedtls_free( (void*) handshake->group_list );
4231 handshake->group_list = NULL;
4232#endif /* MBEDTLS_DEPRECATED_REMOVED */
4233#endif /* MBEDTLS_ECP_C */
4234
Jerry Yuf017ee42022-01-12 15:49:48 +08004235#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4236#if !defined(MBEDTLS_DEPRECATED_REMOVED)
4237 if ( ssl->handshake->sig_algs_heap_allocated )
4238 mbedtls_free( (void*) handshake->sig_algs );
4239 handshake->sig_algs = NULL;
4240#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004241#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4242 if( ssl->handshake->certificate_request_context )
4243 {
4244 mbedtls_free( (void*) handshake->certificate_request_context );
4245 }
4246#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08004247#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4248
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004249#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
4250 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
4251 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02004252 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004253 handshake->async_in_progress = 0;
4254 }
4255#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4256
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004257#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004258#if defined(MBEDTLS_USE_PSA_CRYPTO)
4259 psa_hash_abort( &handshake->fin_sha256_psa );
4260#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004261 mbedtls_sha256_free( &handshake->fin_sha256 );
4262#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004263#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02004264#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004265#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05004266 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05004267#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004268 mbedtls_sha512_free( &handshake->fin_sha512 );
4269#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004270#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004271
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004272#if defined(MBEDTLS_DHM_C)
4273 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00004274#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004275#if defined(MBEDTLS_ECDH_C)
4276 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02004277#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004278#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004279 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004280#if defined(MBEDTLS_SSL_CLI_C)
4281 mbedtls_free( handshake->ecjpake_cache );
4282 handshake->ecjpake_cache = NULL;
4283 handshake->ecjpake_cache_len = 0;
4284#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004285#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004286
Janos Follath4ae5c292016-02-10 11:27:43 +00004287#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4288 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004289 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004290 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004291#endif
4292
Gilles Peskineeccd8882020-03-10 12:19:08 +01004293#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004294 if( handshake->psk != NULL )
4295 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004296 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004297 mbedtls_free( handshake->psk );
4298 }
4299#endif
4300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004301#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4302 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004303 /*
4304 * Free only the linked list wrapper, not the keys themselves
4305 * since the belong to the SNI callback
4306 */
4307 if( handshake->sni_key_cert != NULL )
4308 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004309 mbedtls_ssl_key_cert *cur = handshake->sni_key_cert, *next;
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004310
4311 while( cur != NULL )
4312 {
4313 next = cur->next;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004314 mbedtls_free( cur );
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004315 cur = next;
4316 }
4317 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004319
Gilles Peskineeccd8882020-03-10 12:19:08 +01004320#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02004321 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00004322 if( handshake->ecrs_peer_cert != NULL )
4323 {
4324 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
4325 mbedtls_free( handshake->ecrs_peer_cert );
4326 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004327#endif
4328
Hanno Becker75173122019-02-06 16:18:31 +00004329#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4330 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4331 mbedtls_pk_free( &handshake->peer_pubkey );
4332#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4333
XiaokangQian34909742022-01-27 02:25:04 +00004334#if defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004335 mbedtls_free( handshake->verify_cookie );
XiaokangQian8499b6c2022-01-27 09:00:11 +00004336#endif /* MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 */
4337
4338#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00004339 mbedtls_ssl_flight_free( handshake->flight );
4340 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00004341#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004342
Hanno Becker4a63ed42019-01-08 11:39:35 +00004343#if defined(MBEDTLS_ECDH_C) && \
4344 defined(MBEDTLS_USE_PSA_CRYPTO)
4345 psa_destroy_key( handshake->ecdh_psa_privkey );
4346#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
4347
Ronald Cron6f135e12021-12-08 16:57:54 +01004348#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08004349 mbedtls_ssl_transform_free( handshake->transform_handshake );
4350 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08004351 mbedtls_free( handshake->transform_earlydata );
4352 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01004353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004354
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004355
4356#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4357 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4358 * processes datagrams and the fact that a datagram is allowed to have
4359 * several records in it, it is possible that the I/O buffers are not
4360 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02004361 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
4362 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004363#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004364
Jerry Yuba9c7272021-10-30 11:54:10 +08004365 /* mbedtls_platform_zeroize MUST be last one in this function */
4366 mbedtls_platform_zeroize( handshake,
4367 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004368}
4369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004370void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00004371{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004372 if( session == NULL )
4373 return;
4374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004375#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00004376 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02004377#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004378
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004379#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004380 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02004381#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004382
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004383 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004384}
4385
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004386#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004387
4388#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4389#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4390#else
4391#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4392#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4393
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004394#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004395
4396#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4397#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4398#else
4399#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4400#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4401
4402#if defined(MBEDTLS_SSL_ALPN)
4403#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4404#else
4405#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4406#endif /* MBEDTLS_SSL_ALPN */
4407
4408#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4409#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4410#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4411#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4412
4413#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
4414 ( (uint32_t) ( \
4415 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
4416 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
4417 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
4418 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
4419 0u ) )
4420
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004421static unsigned char ssl_serialized_context_header[] = {
4422 MBEDTLS_VERSION_MAJOR,
4423 MBEDTLS_VERSION_MINOR,
4424 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01004425 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4426 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4427 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
4428 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
4429 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004430};
4431
Paul Bakker5121ce52009-01-03 21:22:43 +00004432/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004433 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004434 *
4435 * The format of the serialized data is:
4436 * (in the presentation language of TLS, RFC 8446 section 3)
4437 *
4438 * // header
4439 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004440 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004441 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004442 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004443 * Note: When updating the format, remember to keep these
4444 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004445 *
4446 * // session sub-structure
4447 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4448 * // transform sub-structure
4449 * uint8 random[64]; // ServerHello.random+ClientHello.random
4450 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4451 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4452 * // fields from ssl_context
4453 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4454 * uint64 in_window_top; // DTLS: last validated record seq_num
4455 * uint64 in_window; // DTLS: bitmask for replay protection
4456 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4457 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4458 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4459 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4460 *
4461 * Note that many fields of the ssl_context or sub-structures are not
4462 * serialized, as they fall in one of the following categories:
4463 *
4464 * 1. forced value (eg in_left must be 0)
4465 * 2. pointer to dynamically-allocated memory (eg session, transform)
4466 * 3. value can be re-derived from other data (eg session keys from MS)
4467 * 4. value was temporary (eg content of input buffer)
4468 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004469 */
4470int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4471 unsigned char *buf,
4472 size_t buf_len,
4473 size_t *olen )
4474{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004475 unsigned char *p = buf;
4476 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004477 size_t session_len;
4478 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004479
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004480 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004481 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4482 * this function's documentation.
4483 *
4484 * These are due to assumptions/limitations in the implementation. Some of
4485 * them are likely to stay (no handshake in progress) some might go away
4486 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004487 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004488 /* The initial handshake must be over */
4489 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004490 {
4491 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004492 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004493 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004494 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004495 {
4496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004498 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004499 /* Double-check that sub-structures are indeed ready */
4500 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004501 {
4502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004503 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004504 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004505 /* There must be no pending incoming or outgoing data */
4506 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004507 {
4508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004509 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004510 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004511 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004512 {
4513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004514 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004515 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004516 /* Protocol must be DLTS, not TLS */
4517 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004518 {
4519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004520 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004521 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004522 /* Version must be 1.2 */
4523 if( ssl->major_ver != MBEDTLS_SSL_MAJOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004524 {
4525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004526 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004527 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004528 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004529 {
4530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004531 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004532 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004533 /* We must be using an AEAD ciphersuite */
4534 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004535 {
4536 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004537 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004538 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004539 /* Renegotiation must not be enabled */
4540#if defined(MBEDTLS_SSL_RENEGOTIATION)
4541 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004542 {
4543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004544 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004545 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004546#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004547
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004548 /*
4549 * Version and format identifier
4550 */
4551 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004552
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004553 if( used <= buf_len )
4554 {
4555 memcpy( p, ssl_serialized_context_header,
4556 sizeof( ssl_serialized_context_header ) );
4557 p += sizeof( ssl_serialized_context_header );
4558 }
4559
4560 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004561 * Session (length + data)
4562 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004563 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004564 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
4565 return( ret );
4566
4567 used += 4 + session_len;
4568 if( used <= buf_len )
4569 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004570 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
4571 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004572
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004573 ret = ssl_session_save( ssl->session, 1,
4574 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004575 if( ret != 0 )
4576 return( ret );
4577
4578 p += session_len;
4579 }
4580
4581 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004582 * Transform
4583 */
4584 used += sizeof( ssl->transform->randbytes );
4585 if( used <= buf_len )
4586 {
4587 memcpy( p, ssl->transform->randbytes,
4588 sizeof( ssl->transform->randbytes ) );
4589 p += sizeof( ssl->transform->randbytes );
4590 }
4591
4592#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4593 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
4594 if( used <= buf_len )
4595 {
4596 *p++ = ssl->transform->in_cid_len;
4597 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
4598 p += ssl->transform->in_cid_len;
4599
4600 *p++ = ssl->transform->out_cid_len;
4601 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
4602 p += ssl->transform->out_cid_len;
4603 }
4604#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4605
4606 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004607 * Saved fields from top-level ssl_context structure
4608 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004609 used += 4;
4610 if( used <= buf_len )
4611 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004612 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
4613 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004614 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004615
4616#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4617 used += 16;
4618 if( used <= buf_len )
4619 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004620 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
4621 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004622
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004623 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
4624 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004625 }
4626#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4627
4628#if defined(MBEDTLS_SSL_PROTO_DTLS)
4629 used += 1;
4630 if( used <= buf_len )
4631 {
4632 *p++ = ssl->disable_datagram_packing;
4633 }
4634#endif /* MBEDTLS_SSL_PROTO_DTLS */
4635
Jerry Yuae0b2e22021-10-08 15:21:19 +08004636 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004637 if( used <= buf_len )
4638 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004639 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
4640 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004641 }
4642
4643#if defined(MBEDTLS_SSL_PROTO_DTLS)
4644 used += 2;
4645 if( used <= buf_len )
4646 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004647 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
4648 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004649 }
4650#endif /* MBEDTLS_SSL_PROTO_DTLS */
4651
4652#if defined(MBEDTLS_SSL_ALPN)
4653 {
4654 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02004655 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004656 : 0;
4657
4658 used += 1 + alpn_len;
4659 if( used <= buf_len )
4660 {
4661 *p++ = alpn_len;
4662
4663 if( ssl->alpn_chosen != NULL )
4664 {
4665 memcpy( p, ssl->alpn_chosen, alpn_len );
4666 p += alpn_len;
4667 }
4668 }
4669 }
4670#endif /* MBEDTLS_SSL_ALPN */
4671
4672 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004673 * Done
4674 */
4675 *olen = used;
4676
4677 if( used > buf_len )
4678 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004679
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004680 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
4681
Hanno Becker43aefe22020-02-05 10:44:56 +00004682 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004683}
4684
4685/*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686 * Helper to get TLS 1.2 PRF from ciphersuite
4687 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
4688 */
4689typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
4690 const char *label,
4691 const unsigned char *random, size_t rlen,
4692 unsigned char *dstbuf, size_t dlen );
4693static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
4694{
Jerry Yuc3091b12021-12-23 14:57:39 +08004695#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02004696#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
4698 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
4699
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004700 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
4701 return( tls_prf_sha384 );
Jarno Lamsab7b486c2019-08-21 15:30:44 +03004702#else
4703 (void) ciphersuite_id;
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004704#endif
4705 return( tls_prf_sha256 );
Jerry Yu53d23e22022-02-09 16:25:09 +08004706#else /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuc5aef882021-12-23 20:15:02 +08004707 (void) ciphersuite_id;
4708 return( NULL );
Jerry Yu53d23e22022-02-09 16:25:09 +08004709#endif /* !MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuc3091b12021-12-23 14:57:39 +08004710
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004711}
4712
4713/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004714 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004715 *
4716 * This internal version is wrapped by a public function that cleans up in
4717 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004718 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004719static int ssl_context_load( mbedtls_ssl_context *ssl,
4720 const unsigned char *buf,
4721 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004722{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004723 const unsigned char *p = buf;
4724 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004725 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004727
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004728 /*
4729 * The context should have been freshly setup or reset.
4730 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004731 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004732 * renegotiating, or if the user mistakenly loaded a session first.)
4733 */
4734 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4735 ssl->session != NULL )
4736 {
4737 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4738 }
4739
4740 /*
4741 * We can't check that the config matches the initial one, but we can at
4742 * least check it matches the requirements for serializing.
4743 */
4744 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4745 ssl->conf->max_major_ver < MBEDTLS_SSL_MAJOR_VERSION_3 ||
4746 ssl->conf->min_major_ver > MBEDTLS_SSL_MAJOR_VERSION_3 ||
4747 ssl->conf->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 ||
4748 ssl->conf->min_minor_ver > MBEDTLS_SSL_MINOR_VERSION_3 ||
4749#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004750 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004751#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004752 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004753 {
4754 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4755 }
4756
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004757 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
4758
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004759 /*
4760 * Check version identifier
4761 */
4762 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
4763 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4764
4765 if( memcmp( p, ssl_serialized_context_header,
4766 sizeof( ssl_serialized_context_header ) ) != 0 )
4767 {
4768 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
4769 }
4770 p += sizeof( ssl_serialized_context_header );
4771
4772 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004773 * Session
4774 */
4775 if( (size_t)( end - p ) < 4 )
4776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4777
4778 session_len = ( (size_t) p[0] << 24 ) |
4779 ( (size_t) p[1] << 16 ) |
4780 ( (size_t) p[2] << 8 ) |
4781 ( (size_t) p[3] );
4782 p += 4;
4783
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004784 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004785 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004786 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004787 ssl->session_in = ssl->session;
4788 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004789 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004790
4791 if( (size_t)( end - p ) < session_len )
4792 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4793
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004794 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004795 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004796 {
4797 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004798 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004799 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004800
4801 p += session_len;
4802
4803 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004804 * Transform
4805 */
4806
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004807 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004808 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004809 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004810 ssl->transform_in = ssl->transform;
4811 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004812 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004813
4814 /* Read random bytes and populate structure */
4815 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4816 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4817
Hanno Beckerbd257552021-03-22 06:59:27 +00004818 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004819 ssl->session->ciphersuite,
4820 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00004821#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
4822 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004823 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00004824#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
4825 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004826 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4827 p, /* currently pointing to randbytes */
4828 MBEDTLS_SSL_MINOR_VERSION_3, /* (D)TLS 1.2 is forced */
4829 ssl->conf->endpoint,
4830 ssl );
4831 if( ret != 0 )
4832 return( ret );
4833
4834 p += sizeof( ssl->transform->randbytes );
4835
4836#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4837 /* Read connection IDs and store them */
4838 if( (size_t)( end - p ) < 1 )
4839 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4840
4841 ssl->transform->in_cid_len = *p++;
4842
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004843 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004844 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4845
4846 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4847 p += ssl->transform->in_cid_len;
4848
4849 ssl->transform->out_cid_len = *p++;
4850
4851 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4852 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4853
4854 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4855 p += ssl->transform->out_cid_len;
4856#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4857
4858 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004859 * Saved fields from top-level ssl_context structure
4860 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004861 if( (size_t)( end - p ) < 4 )
4862 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4863
4864 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4865 ( (uint32_t) p[1] << 16 ) |
4866 ( (uint32_t) p[2] << 8 ) |
4867 ( (uint32_t) p[3] );
4868 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004869
4870#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4871 if( (size_t)( end - p ) < 16 )
4872 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4873
4874 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4875 ( (uint64_t) p[1] << 48 ) |
4876 ( (uint64_t) p[2] << 40 ) |
4877 ( (uint64_t) p[3] << 32 ) |
4878 ( (uint64_t) p[4] << 24 ) |
4879 ( (uint64_t) p[5] << 16 ) |
4880 ( (uint64_t) p[6] << 8 ) |
4881 ( (uint64_t) p[7] );
4882 p += 8;
4883
4884 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4885 ( (uint64_t) p[1] << 48 ) |
4886 ( (uint64_t) p[2] << 40 ) |
4887 ( (uint64_t) p[3] << 32 ) |
4888 ( (uint64_t) p[4] << 24 ) |
4889 ( (uint64_t) p[5] << 16 ) |
4890 ( (uint64_t) p[6] << 8 ) |
4891 ( (uint64_t) p[7] );
4892 p += 8;
4893#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4894
4895#if defined(MBEDTLS_SSL_PROTO_DTLS)
4896 if( (size_t)( end - p ) < 1 )
4897 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4898
4899 ssl->disable_datagram_packing = *p++;
4900#endif /* MBEDTLS_SSL_PROTO_DTLS */
4901
Jerry Yud9a94fe2021-09-28 18:58:59 +08004902 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004903 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004904 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4905 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004906
4907#if defined(MBEDTLS_SSL_PROTO_DTLS)
4908 if( (size_t)( end - p ) < 2 )
4909 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4910
4911 ssl->mtu = ( p[0] << 8 ) | p[1];
4912 p += 2;
4913#endif /* MBEDTLS_SSL_PROTO_DTLS */
4914
4915#if defined(MBEDTLS_SSL_ALPN)
4916 {
4917 uint8_t alpn_len;
4918 const char **cur;
4919
4920 if( (size_t)( end - p ) < 1 )
4921 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4922
4923 alpn_len = *p++;
4924
4925 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4926 {
4927 /* alpn_chosen should point to an item in the configured list */
4928 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4929 {
4930 if( strlen( *cur ) == alpn_len &&
4931 memcmp( p, cur, alpn_len ) == 0 )
4932 {
4933 ssl->alpn_chosen = *cur;
4934 break;
4935 }
4936 }
4937 }
4938
4939 /* can only happen on conf mismatch */
4940 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4941 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4942
4943 p += alpn_len;
4944 }
4945#endif /* MBEDTLS_SSL_ALPN */
4946
4947 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004948 * Forced fields from top-level ssl_context structure
4949 *
4950 * Most of them already set to the correct value by mbedtls_ssl_init() and
4951 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4952 */
4953 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
4954
4955 ssl->major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
4956 ssl->minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
4957
Hanno Becker361b10d2019-08-30 10:42:49 +01004958 /* Adjust pointers for header fields of outgoing records to
4959 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004960 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004961
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004962#if defined(MBEDTLS_SSL_PROTO_DTLS)
4963 ssl->in_epoch = 1;
4964#endif
4965
4966 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4967 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004968 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4969 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004970 if( ssl->handshake != NULL )
4971 {
4972 mbedtls_ssl_handshake_free( ssl );
4973 mbedtls_free( ssl->handshake );
4974 ssl->handshake = NULL;
4975 }
4976
4977 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004978 * Done - should have consumed entire buffer
4979 */
4980 if( p != end )
4981 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004982
4983 return( 0 );
4984}
4985
4986/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004987 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004988 */
4989int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4990 const unsigned char *buf,
4991 size_t len )
4992{
4993 int ret = ssl_context_load( context, buf, len );
4994
4995 if( ret != 0 )
4996 mbedtls_ssl_free( context );
4997
4998 return( ret );
4999}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005000#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005001
5002/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005003 * Free an SSL context
5004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005006{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005007 if( ssl == NULL )
5008 return;
5009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005011
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01005012 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005013 {
sander-visserb8aa2072020-05-06 22:05:13 +02005014#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5015 size_t out_buf_len = ssl->out_buf_len;
5016#else
5017 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5018#endif
5019
Darryl Greenb33cc762019-11-28 14:29:44 +00005020 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005022 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005023 }
5024
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01005025 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005026 {
sander-visserb8aa2072020-05-06 22:05:13 +02005027#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5028 size_t in_buf_len = ssl->in_buf_len;
5029#else
5030 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5031#endif
5032
Darryl Greenb33cc762019-11-28 14:29:44 +00005033 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005034 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005035 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005036 }
5037
Paul Bakker48916f92012-09-16 19:57:18 +00005038 if( ssl->transform )
5039 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040 mbedtls_ssl_transform_free( ssl->transform );
5041 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00005042 }
5043
5044 if( ssl->handshake )
5045 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02005046 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005047 mbedtls_ssl_transform_free( ssl->transform_negotiate );
5048 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00005049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005050 mbedtls_free( ssl->handshake );
5051 mbedtls_free( ssl->transform_negotiate );
5052 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00005053 }
5054
Ronald Cron6f135e12021-12-08 16:57:54 +01005055#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01005056 mbedtls_ssl_transform_free( ssl->transform_application );
5057 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01005058#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005059
Paul Bakkerc0463502013-02-14 11:19:38 +01005060 if( ssl->session )
5061 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005062 mbedtls_ssl_session_free( ssl->session );
5063 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01005064 }
5065
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005066#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02005067 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005068 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005069 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005070 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00005071 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005072#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005073
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005074#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005075 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005076#endif
5077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00005079
Paul Bakker86f04f42013-02-14 11:20:09 +01005080 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005081 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005082}
5083
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005084/*
5085 * Initialze mbedtls_ssl_config
5086 */
5087void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
5088{
5089 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
5090}
5091
Gilles Peskineeccd8882020-03-10 12:19:08 +01005092#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08005093#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02005094/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02005095 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
5096 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005097 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
5098 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01005099static int ssl_preset_default_hashes[] = {
5100#if defined(MBEDTLS_SHA512_C)
5101 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005102#endif
5103#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01005104 MBEDTLS_MD_SHA384,
5105#endif
5106#if defined(MBEDTLS_SHA256_C)
5107 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005108#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01005109 MBEDTLS_MD_NONE
5110};
Jerry Yuf017ee42022-01-12 15:49:48 +08005111#endif /* !MBEDTLS_DEPRECATED_REMOVED */
5112#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01005113
Gilles Peskineae270bf2021-06-02 00:05:29 +02005114/* The selection should be the same as mbedtls_x509_crt_profile_default in
5115 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005116 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005117 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005118 * about this list.
5119 */
Brett Warrene0edc842021-08-17 09:53:13 +01005120static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02005121#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005122 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005123#endif
5124#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005125 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005126#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02005127#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005128 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005129#endif
5130#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005131 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005132#endif
5133#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005134 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005135#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02005136#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005137 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005138#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02005139#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005140 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005141#endif
5142#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005143 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005144#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005145 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005146};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005147
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005148static int ssl_preset_suiteb_ciphersuites[] = {
5149 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5150 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5151 0
5152};
5153
Gilles Peskineeccd8882020-03-10 12:19:08 +01005154#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08005155#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005156static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08005157#if defined(MBEDTLS_SHA256_C)
5158 MBEDTLS_MD_SHA256,
5159#endif
Jerry Yu713013f2022-01-17 18:16:35 +08005160#if defined(MBEDTLS_SHA384_C)
5161 MBEDTLS_MD_SHA384,
5162#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005163 MBEDTLS_MD_NONE
5164};
Jerry Yuf017ee42022-01-12 15:49:48 +08005165#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005166
Jerry Yu909df7b2022-01-22 11:56:27 +08005167/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005168 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005169 * rules SHOULD be upheld.
5170 * - No duplicate entries.
5171 * - But if there is a good reason, do not change the order of the algorithms.
5172 * - ssl_tls12_present* is for TLS 1.2 use only.
5173 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005174 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005175static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005176
Jerry Yued5e9f42022-01-26 11:21:34 +08005177#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
5178 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5179 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
5180#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
5181 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005182
Jerry Yu909df7b2022-01-22 11:56:27 +08005183#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
5184 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5185 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
5186#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
5187 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
5188
Jerry Yued5e9f42022-01-26 11:21:34 +08005189#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
5190 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5191 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
5192#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
5193 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005194
Jerry Yu909df7b2022-01-22 11:56:27 +08005195#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
5196 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5197#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
5198
Jerry Yu53037892022-01-25 11:02:06 +08005199#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
5200 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
5201#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
5202
Jerry Yu909df7b2022-01-22 11:56:27 +08005203 MBEDTLS_TLS1_3_SIG_NONE
5204};
5205
5206/* NOTICE: see above */
5207#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5208static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08005209#if defined(MBEDTLS_SHA512_C)
5210 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
5211#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005212#if defined(MBEDTLS_SHA384_C)
5213 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
5214#endif
5215#if defined(MBEDTLS_SHA256_C)
5216 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
5217#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005218 MBEDTLS_TLS1_3_SIG_NONE
5219};
5220#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5221/* NOTICE: see above */
5222static uint16_t ssl_preset_suiteb_sig_algs[] = {
5223
Jerry Yu909df7b2022-01-22 11:56:27 +08005224#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
5225 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5226 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
5227#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
5228 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5229
Jerry Yu53037892022-01-25 11:02:06 +08005230#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
5231 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5232 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
5233#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
5234 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005235
5236#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
5237 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5238#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005239
Jerry Yu53037892022-01-25 11:02:06 +08005240#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
5241 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
5242#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
5243
Jerry Yu713013f2022-01-17 18:16:35 +08005244 MBEDTLS_TLS1_3_SIG_NONE
5245};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005246
Jerry Yu909df7b2022-01-22 11:56:27 +08005247/* NOTICE: see above */
5248#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5249static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08005250#if defined(MBEDTLS_SHA256_C)
5251 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
5252#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08005253#if defined(MBEDTLS_SHA384_C)
5254 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
5255#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00005256 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005257};
Jerry Yu909df7b2022-01-22 11:56:27 +08005258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5259
Jerry Yu1a8b4812022-01-20 17:56:50 +08005260#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005261
Brett Warrene0edc842021-08-17 09:53:13 +01005262static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005263#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005264 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005265#endif
5266#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005267 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005268#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005269 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005270};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005271
Jerry Yu1a8b4812022-01-20 17:56:50 +08005272#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005273/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005274 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08005275static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005276{
5277 size_t i, j;
5278 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005279
Jerry Yuf377d642022-01-25 10:43:59 +08005280 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005281 {
Jerry Yuf377d642022-01-25 10:43:59 +08005282 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005283 {
Jerry Yuf377d642022-01-25 10:43:59 +08005284 if( sig_algs[i] != sig_algs[j] )
5285 continue;
5286 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
5287 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5288 sig_algs[i], j, i );
5289 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005290 }
5291 }
5292 return( ret );
5293}
5294
5295#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5296
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005297/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005298 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005299 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005300int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005301 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005302{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005303#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005304 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005305#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005306
Jerry Yu1a8b4812022-01-20 17:56:50 +08005307#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08005308 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005309 {
5310 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
5311 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5312 }
5313
Jerry Yuf377d642022-01-25 10:43:59 +08005314 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005315 {
5316 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
5317 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5318 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005319
5320#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08005321 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08005322 {
Jerry Yu909df7b2022-01-22 11:56:27 +08005323 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08005324 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5325 }
5326
Jerry Yuf377d642022-01-25 10:43:59 +08005327 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08005328 {
Jerry Yu909df7b2022-01-22 11:56:27 +08005329 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08005330 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5331 }
5332#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005333#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5334
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005335 /* Use the functions here so that they are covered in tests,
5336 * but otherwise access member directly for efficiency */
5337 mbedtls_ssl_conf_endpoint( conf, endpoint );
5338 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005339
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005340 /*
5341 * Things that are common to all presets
5342 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005343#if defined(MBEDTLS_SSL_CLI_C)
5344 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
5345 {
5346 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5347#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5348 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5349#endif
5350 }
5351#endif
5352
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005353#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5354 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5355#endif
5356
5357#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5358 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5359#endif
5360
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005361#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005362 conf->f_cookie_write = ssl_cookie_write_dummy;
5363 conf->f_cookie_check = ssl_cookie_check_dummy;
5364#endif
5365
5366#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5367 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5368#endif
5369
Janos Follath088ce432017-04-10 12:42:31 +01005370#if defined(MBEDTLS_SSL_SRV_C)
5371 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005372 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005373#endif
5374
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005375#if defined(MBEDTLS_SSL_PROTO_DTLS)
5376 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5377 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5378#endif
5379
5380#if defined(MBEDTLS_SSL_RENEGOTIATION)
5381 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00005382 memset( conf->renego_period, 0x00, 2 );
5383 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005384#endif
5385
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005386#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01005387 if( endpoint == MBEDTLS_SSL_IS_SERVER )
5388 {
5389 const unsigned char dhm_p[] =
5390 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5391 const unsigned char dhm_g[] =
5392 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005393
Hanno Beckere2defad2021-07-24 05:59:17 +01005394 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
5395 dhm_p, sizeof( dhm_p ),
5396 dhm_g, sizeof( dhm_g ) ) ) != 0 )
5397 {
5398 return( ret );
5399 }
5400 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005401#endif
5402
Ronald Cron6f135e12021-12-08 16:57:54 +01005403#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01005404 /*
5405 * Allow all TLS 1.3 key exchange modes by default.
5406 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005407 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005408#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005409
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005410 /*
5411 * Preset-specific defaults
5412 */
5413 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005414 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005415 /*
5416 * NSA Suite B
5417 */
5418 case MBEDTLS_SSL_PRESET_SUITEB:
5419 conf->min_major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
5420 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3; /* TLS 1.2 */
5421 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08005422#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
5423 /* Hybrid TLS 1.2/1.3 is not supported yet */
5424 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
5425#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005426 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08005427#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005428
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005429 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005430
5431#if defined(MBEDTLS_X509_CRT_PARSE_C)
5432 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005433#endif
5434
Gilles Peskineeccd8882020-03-10 12:19:08 +01005435#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08005436#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005437 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08005438#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005439#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5440 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
5441 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
5442 else
5443#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5444 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005445#endif
5446
Brett Warrene0edc842021-08-17 09:53:13 +01005447#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5448 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005449#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005450 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005451 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005452
5453 /*
5454 * Default
5455 */
5456 default:
Ron Eldor5e9f14d2017-05-28 10:46:38 +03005457 conf->min_major_ver = ( MBEDTLS_SSL_MIN_MAJOR_VERSION >
5458 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION ) ?
5459 MBEDTLS_SSL_MIN_MAJOR_VERSION :
5460 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION;
5461 conf->min_minor_ver = ( MBEDTLS_SSL_MIN_MINOR_VERSION >
5462 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION ) ?
5463 MBEDTLS_SSL_MIN_MINOR_VERSION :
5464 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005465 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08005466#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
5467 /* Hybrid TLS 1.2/1.3 is not supported yet */
5468 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
5469#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005470 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08005471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005472
5473#if defined(MBEDTLS_SSL_PROTO_DTLS)
5474 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
TRodziewiczef73f012021-05-13 14:53:36 +02005475 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005476#endif
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005477 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005478
5479#if defined(MBEDTLS_X509_CRT_PARSE_C)
5480 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5481#endif
5482
Gilles Peskineeccd8882020-03-10 12:19:08 +01005483#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08005484#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01005485 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08005486#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005487#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5488 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
5489 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
5490 else
5491#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5492 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01005493#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005494
Brett Warrene0edc842021-08-17 09:53:13 +01005495#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5496 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005497#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005498 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005499
5500#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5501 conf->dhm_min_bitlen = 1024;
5502#endif
5503 }
5504
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005505 return( 0 );
5506}
5507
5508/*
5509 * Free mbedtls_ssl_config
5510 */
5511void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
5512{
5513#if defined(MBEDTLS_DHM_C)
5514 mbedtls_mpi_free( &conf->dhm_P );
5515 mbedtls_mpi_free( &conf->dhm_G );
5516#endif
5517
Gilles Peskineeccd8882020-03-10 12:19:08 +01005518#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005519 if( conf->psk != NULL )
5520 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005521 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005522 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00005523 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005524 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005525 }
5526
5527 if( conf->psk_identity != NULL )
5528 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005529 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09005530 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00005531 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005532 conf->psk_identity_len = 0;
5533 }
5534#endif
5535
5536#if defined(MBEDTLS_X509_CRT_PARSE_C)
5537 ssl_key_cert_free( conf->key_cert );
5538#endif
5539
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005540 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005541}
5542
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005543#if defined(MBEDTLS_PK_C) && \
5544 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005545/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005548unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005549{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550#if defined(MBEDTLS_RSA_C)
5551 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
5552 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554#if defined(MBEDTLS_ECDSA_C)
5555 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
5556 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005557#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005558 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005559}
5560
Hanno Becker7e5437a2017-04-28 17:15:26 +01005561unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
5562{
5563 switch( type ) {
5564 case MBEDTLS_PK_RSA:
5565 return( MBEDTLS_SSL_SIG_RSA );
5566 case MBEDTLS_PK_ECDSA:
5567 case MBEDTLS_PK_ECKEY:
5568 return( MBEDTLS_SSL_SIG_ECDSA );
5569 default:
5570 return( MBEDTLS_SSL_SIG_ANON );
5571 }
5572}
5573
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005574mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005575{
5576 switch( sig )
5577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005578#if defined(MBEDTLS_RSA_C)
5579 case MBEDTLS_SSL_SIG_RSA:
5580 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005581#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582#if defined(MBEDTLS_ECDSA_C)
5583 case MBEDTLS_SSL_SIG_ECDSA:
5584 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005585#endif
5586 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005588 }
5589}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005590#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005591
Hanno Becker7e5437a2017-04-28 17:15:26 +01005592#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01005593 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005594
5595/* Find an entry in a signature-hash set matching a given hash algorithm. */
5596mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
5597 mbedtls_pk_type_t sig_alg )
5598{
5599 switch( sig_alg )
5600 {
5601 case MBEDTLS_PK_RSA:
5602 return( set->rsa );
5603 case MBEDTLS_PK_ECDSA:
5604 return( set->ecdsa );
5605 default:
5606 return( MBEDTLS_MD_NONE );
5607 }
5608}
5609
5610/* Add a signature-hash-pair to a signature-hash set */
5611void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
5612 mbedtls_pk_type_t sig_alg,
5613 mbedtls_md_type_t md_alg )
5614{
5615 switch( sig_alg )
5616 {
5617 case MBEDTLS_PK_RSA:
5618 if( set->rsa == MBEDTLS_MD_NONE )
5619 set->rsa = md_alg;
5620 break;
5621
5622 case MBEDTLS_PK_ECDSA:
5623 if( set->ecdsa == MBEDTLS_MD_NONE )
5624 set->ecdsa = md_alg;
5625 break;
5626
5627 default:
5628 break;
5629 }
5630}
5631
5632/* Allow exactly one hash algorithm for each signature. */
5633void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
5634 mbedtls_md_type_t md_alg )
5635{
5636 set->rsa = md_alg;
5637 set->ecdsa = md_alg;
5638}
5639
5640#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01005641 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Hanno Becker7e5437a2017-04-28 17:15:26 +01005642
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005643/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005644 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005646mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005647{
5648 switch( hash )
5649 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005650#if defined(MBEDTLS_MD5_C)
5651 case MBEDTLS_SSL_HASH_MD5:
5652 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005653#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005654#if defined(MBEDTLS_SHA1_C)
5655 case MBEDTLS_SSL_HASH_SHA1:
5656 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005657#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005658#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005659 case MBEDTLS_SSL_HASH_SHA224:
5660 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005661#endif
5662#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005663 case MBEDTLS_SSL_HASH_SHA256:
5664 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005665#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005666#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005667 case MBEDTLS_SSL_HASH_SHA384:
5668 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005669#endif
5670#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671 case MBEDTLS_SSL_HASH_SHA512:
5672 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005673#endif
5674 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005675 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005676 }
5677}
5678
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005679/*
5680 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5681 */
5682unsigned char mbedtls_ssl_hash_from_md_alg( int md )
5683{
5684 switch( md )
5685 {
5686#if defined(MBEDTLS_MD5_C)
5687 case MBEDTLS_MD_MD5:
5688 return( MBEDTLS_SSL_HASH_MD5 );
5689#endif
5690#if defined(MBEDTLS_SHA1_C)
5691 case MBEDTLS_MD_SHA1:
5692 return( MBEDTLS_SSL_HASH_SHA1 );
5693#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005694#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005695 case MBEDTLS_MD_SHA224:
5696 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005697#endif
5698#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005699 case MBEDTLS_MD_SHA256:
5700 return( MBEDTLS_SSL_HASH_SHA256 );
5701#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005702#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005703 case MBEDTLS_MD_SHA384:
5704 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005705#endif
5706#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005707 case MBEDTLS_MD_SHA512:
5708 return( MBEDTLS_SSL_HASH_SHA512 );
5709#endif
5710 default:
5711 return( MBEDTLS_SSL_HASH_NONE );
5712 }
5713}
5714
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005715/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005716 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005717 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005718 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005719int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005720{
Brett Warrene0edc842021-08-17 09:53:13 +01005721 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005722
Brett Warrene0edc842021-08-17 09:53:13 +01005723 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005724 return( -1 );
5725
Brett Warrene0edc842021-08-17 09:53:13 +01005726 for( ; *group_list != 0; group_list++ )
5727 {
5728 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005729 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01005730 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005731
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005732 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005733}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005734
5735#if defined(MBEDTLS_ECP_C)
5736/*
5737 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5738 */
5739int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
5740{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01005741 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005742 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
5743}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005744#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746#if defined(MBEDTLS_X509_CRT_PARSE_C)
5747int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
5748 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005749 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02005750 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005751{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005752 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005753 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005754 const char *ext_oid;
5755 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005757 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005758 {
5759 /* Server part of the key exchange */
5760 switch( ciphersuite->key_exchange )
5761 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005762 case MBEDTLS_KEY_EXCHANGE_RSA:
5763 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005764 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005765 break;
5766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005767 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5768 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5769 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5770 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005771 break;
5772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005773 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5774 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005775 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005776 break;
5777
5778 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005779 case MBEDTLS_KEY_EXCHANGE_NONE:
5780 case MBEDTLS_KEY_EXCHANGE_PSK:
5781 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5782 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005783 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005784 usage = 0;
5785 }
5786 }
5787 else
5788 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005789 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5790 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005791 }
5792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005794 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005795 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005796 ret = -1;
5797 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005799 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005800 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005801 ext_oid = MBEDTLS_OID_SERVER_AUTH;
5802 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005803 }
5804 else
5805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005806 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5807 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005808 }
5809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005810 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005811 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005812 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005813 ret = -1;
5814 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005815
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005816 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005817}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005819
Simon Butcher99000142016-10-13 17:21:01 +01005820int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5821{
5822#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5823 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Becker541af852021-05-14 16:49:01 +01005824 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01005825
5826 switch( md )
5827 {
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02005828#if defined(MBEDTLS_SHA384_C)
Simon Butcher99000142016-10-13 17:21:01 +01005829 case MBEDTLS_SSL_HASH_SHA384:
5830 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5831 break;
5832#endif
5833#if defined(MBEDTLS_SHA256_C)
5834 case MBEDTLS_SSL_HASH_SHA256:
5835 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5836 break;
5837#endif
5838 default:
Hanno Becker541af852021-05-14 16:49:01 +01005839 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01005840 }
5841
5842 return 0;
5843#else /* !MBEDTLS_SSL_PROTO_TLS1_2 */
5844 (void) ssl;
5845 (void) md;
5846
Hanno Becker541af852021-05-14 16:49:01 +01005847 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01005848#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5849}
5850
TRodziewicz0f82ec62021-05-12 17:49:18 +02005851#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005852
5853#if defined(MBEDTLS_USE_PSA_CRYPTO)
5854int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
5855 unsigned char *hash, size_t *hashlen,
5856 unsigned char *data, size_t data_len,
5857 mbedtls_md_type_t md_alg )
5858{
Andrzej Kurek814feff2019-01-14 04:35:19 -05005859 psa_status_t status;
Jaeden Amero34973232019-02-20 10:32:28 +00005860 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005861 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
5862
Hanno Becker4c8c7aa2019-04-10 09:25:41 +01005863 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
Andrzej Kurek814feff2019-01-14 04:35:19 -05005864
5865 if( ( status = psa_hash_setup( &hash_operation,
5866 hash_alg ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005867 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05005868 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005869 goto exit;
5870 }
5871
Andrzej Kurek814feff2019-01-14 04:35:19 -05005872 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
5873 64 ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005874 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05005875 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005876 goto exit;
5877 }
5878
Andrzej Kurek814feff2019-01-14 04:35:19 -05005879 if( ( status = psa_hash_update( &hash_operation,
5880 data, data_len ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005881 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05005882 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005883 goto exit;
5884 }
5885
Ronald Cron69a63422021-10-18 09:47:58 +02005886 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
Andrzej Kurek814feff2019-01-14 04:35:19 -05005887 hashlen ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005888 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05005889 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005890 goto exit;
5891 }
5892
5893exit:
Andrzej Kurek814feff2019-01-14 04:35:19 -05005894 if( status != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005895 {
5896 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5897 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Andrzej Kurek814feff2019-01-14 04:35:19 -05005898 switch( status )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005899 {
5900 case PSA_ERROR_NOT_SUPPORTED:
5901 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
Andrzej Kurek814feff2019-01-14 04:35:19 -05005902 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005903 case PSA_ERROR_BUFFER_TOO_SMALL:
5904 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
5905 case PSA_ERROR_INSUFFICIENT_MEMORY:
5906 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
5907 default:
TRodziewiczb579ccd2021-04-13 14:28:28 +02005908 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005909 }
5910 }
5911 return( 0 );
5912}
5913
5914#else
5915
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01005916int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02005917 unsigned char *hash, size_t *hashlen,
5918 unsigned char *data, size_t data_len,
5919 mbedtls_md_type_t md_alg )
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01005920{
5921 int ret = 0;
5922 mbedtls_md_context_t ctx;
5923 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
Gilles Peskineca1d7422018-04-24 11:53:22 +02005924 *hashlen = mbedtls_md_get_size( md_info );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01005925
Hanno Becker4c8c7aa2019-04-10 09:25:41 +01005926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
Andrzej Kurek814feff2019-01-14 04:35:19 -05005927
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01005928 mbedtls_md_init( &ctx );
5929
5930 /*
5931 * digitally-signed struct {
5932 * opaque client_random[32];
5933 * opaque server_random[32];
5934 * ServerDHParams params;
5935 * };
5936 */
5937 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
5938 {
5939 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
5940 goto exit;
5941 }
5942 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
5943 {
5944 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
5945 goto exit;
5946 }
5947 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
5948 {
5949 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
5950 goto exit;
5951 }
5952 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
5953 {
5954 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
5955 goto exit;
5956 }
Gilles Peskineca1d7422018-04-24 11:53:22 +02005957 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01005958 {
5959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
5960 goto exit;
5961 }
5962
5963exit:
5964 mbedtls_md_free( &ctx );
5965
5966 if( ret != 0 )
5967 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5968 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
5969
5970 return( ret );
5971}
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05005972#endif /* MBEDTLS_USE_PSA_CRYPTO */
5973
TRodziewicz0f82ec62021-05-12 17:49:18 +02005974#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01005975
Jerry Yu148165c2021-09-24 23:20:59 +08005976#if defined(MBEDTLS_USE_PSA_CRYPTO)
5977int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5978 const mbedtls_md_type_t md,
5979 unsigned char *dst,
5980 size_t dst_len,
5981 size_t *olen )
5982{
Ronald Cronf6893e12022-01-07 22:09:01 +01005983 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5984 psa_hash_operation_t *hash_operation_to_clone;
5985 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5986
Jerry Yu148165c2021-09-24 23:20:59 +08005987 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005988
5989 switch( md )
5990 {
5991#if defined(MBEDTLS_SHA384_C)
5992 case MBEDTLS_MD_SHA384:
5993 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5994 break;
5995#endif
5996
5997#if defined(MBEDTLS_SHA256_C)
5998 case MBEDTLS_MD_SHA256:
5999 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6000 break;
6001#endif
6002
6003 default:
6004 goto exit;
6005 }
6006
6007 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
6008 if( status != PSA_SUCCESS )
6009 goto exit;
6010
6011 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
6012 if( status != PSA_SUCCESS )
6013 goto exit;
6014
6015exit:
Ronald Cronb788c042022-02-15 09:14:15 +01006016 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08006017}
6018#else /* MBEDTLS_USE_PSA_CRYPTO */
6019
Jerry Yu24c0ec32021-09-09 14:21:07 +08006020#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08006021static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
6022 unsigned char *dst,
6023 size_t dst_len,
6024 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08006025{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006026 int ret;
6027 mbedtls_sha512_context sha512;
6028
6029 if( dst_len < 48 )
6030 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6031
6032 mbedtls_sha512_init( &sha512 );
6033 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6034
6035 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
6036 {
6037 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
6038 goto exit;
6039 }
6040
6041 *olen = 48;
6042
6043exit:
6044
6045 mbedtls_sha512_free( &sha512 );
6046 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08006047}
6048#endif /* MBEDTLS_SHA384_C */
6049
6050#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08006051static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
6052 unsigned char *dst,
6053 size_t dst_len,
6054 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08006055{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006056 int ret;
6057 mbedtls_sha256_context sha256;
6058
6059 if( dst_len < 32 )
6060 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6061
6062 mbedtls_sha256_init( &sha256 );
6063 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08006064
Jerry Yu24c0ec32021-09-09 14:21:07 +08006065 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
6066 {
6067 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
6068 goto exit;
6069 }
6070
6071 *olen = 32;
6072
6073exit:
6074
6075 mbedtls_sha256_free( &sha256 );
6076 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08006077}
6078#endif /* MBEDTLS_SHA256_C */
6079
Jerry Yu000f9762021-09-14 11:12:51 +08006080int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
6081 const mbedtls_md_type_t md,
6082 unsigned char *dst,
6083 size_t dst_len,
6084 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08006085{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006086 switch( md )
6087 {
6088
Jerry Yu24c0ec32021-09-09 14:21:07 +08006089#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006090 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08006091 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08006092#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006093
Jerry Yu24c0ec32021-09-09 14:21:07 +08006094#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006095 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08006096 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08006097#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006098
6099 default:
6100 break;
6101 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006102 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08006103}
XiaokangQian647719a2021-12-07 09:16:29 +00006104
Jerry Yu148165c2021-09-24 23:20:59 +08006105#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006106
Jerry Yu1ea9d102021-12-21 13:41:49 +08006107#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
6108 defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
6109 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jerry Yuba073422021-12-20 22:22:15 +08006110/*
Jerry Yub925f212022-01-12 11:17:02 +08006111 * Function for writing a supported groups (TLS 1.3) or supported elliptic
6112 * curves (TLS 1.2) extension.
Jerry Yuba073422021-12-20 22:22:15 +08006113 *
Jerry Yub925f212022-01-12 11:17:02 +08006114 * The "extension_data" field of a supported groups extension contains a
6115 * "NamedGroupList" value (TLS 1.3 RFC8446):
Jerry Yuba073422021-12-20 22:22:15 +08006116 * enum {
6117 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
6118 * x25519(0x001D), x448(0x001E),
6119 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
6120 * ffdhe6144(0x0103), ffdhe8192(0x0104),
6121 * ffdhe_private_use(0x01FC..0x01FF),
6122 * ecdhe_private_use(0xFE00..0xFEFF),
6123 * (0xFFFF)
6124 * } NamedGroup;
6125 * struct {
6126 * NamedGroup named_group_list<2..2^16-1>;
6127 * } NamedGroupList;
Jerry Yub925f212022-01-12 11:17:02 +08006128 *
6129 * The "extension_data" field of a supported elliptic curves extension contains
6130 * a "NamedCurveList" value (TLS 1.2 RFC 8422):
Jerry Yu63282b42022-01-11 15:43:53 +08006131 * enum {
6132 * deprecated(1..22),
6133 * secp256r1 (23), secp384r1 (24), secp521r1 (25),
6134 * x25519(29), x448(30),
6135 * reserved (0xFE00..0xFEFF),
6136 * deprecated(0xFF01..0xFF02),
6137 * (0xFFFF)
6138 * } NamedCurve;
6139 * struct {
6140 * NamedCurve named_curve_list<2..2^16-1>
6141 * } NamedCurveList;
6142 *
Jerry Yub925f212022-01-12 11:17:02 +08006143 * The TLS 1.3 supported groups extension was defined to be a compatible
6144 * generalization of the TLS 1.2 supported elliptic curves extension. They both
6145 * share the same extension identifier.
Jerry Yu63282b42022-01-11 15:43:53 +08006146 *
Jerry Yub925f212022-01-12 11:17:02 +08006147 * DHE groups are not supported yet.
Jerry Yuba073422021-12-20 22:22:15 +08006148 */
Jerry Yuba073422021-12-20 22:22:15 +08006149int mbedtls_ssl_write_supported_groups_ext( mbedtls_ssl_context *ssl,
6150 unsigned char *buf,
Jerry Yu17532612021-12-20 22:32:09 +08006151 const unsigned char *end,
Jerry Yuba073422021-12-20 22:22:15 +08006152 size_t *out_len )
6153{
6154 unsigned char *p = buf ;
6155 unsigned char *named_group_list; /* Start of named_group_list */
6156 size_t named_group_list_len; /* Length of named_group_list */
6157 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
6158
6159 *out_len = 0;
Jerry Yuf46b0162022-01-11 16:28:00 +08006160
Jerry Yuba073422021-12-20 22:22:15 +08006161 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported_groups extension" ) );
6162
6163 /* Check if we have space for header and length fields:
6164 * - extension_type (2 bytes)
6165 * - extension_data_length (2 bytes)
6166 * - named_group_list_length (2 bytes)
6167 */
6168 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
6169 p += 6;
6170
6171 named_group_list = p;
6172
6173 if( group_list == NULL )
6174 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
6175
Jerry Yu1510cea2022-01-12 10:56:49 +08006176 for( ; *group_list != 0; group_list++ )
Jerry Yuba073422021-12-20 22:22:15 +08006177 {
Jerry Yu1510cea2022-01-12 10:56:49 +08006178 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got supported group(%04x)", *group_list ) );
Jerry Yu63282b42022-01-11 15:43:53 +08006179
Jerry Yu1ea9d102021-12-21 13:41:49 +08006180#if defined(MBEDTLS_ECP_C)
Jerry Yu1510cea2022-01-12 10:56:49 +08006181 if( ( mbedtls_ssl_conf_is_tls13_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08006182 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) ) ||
Jerry Yu1510cea2022-01-12 10:56:49 +08006183 ( mbedtls_ssl_conf_is_tls12_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08006184 mbedtls_ssl_tls12_named_group_is_ecdhe( *group_list ) ) )
Jerry Yuba073422021-12-20 22:22:15 +08006185 {
Jerry Yu3ad14ac2022-01-11 17:13:16 +08006186 const mbedtls_ecp_curve_info *curve_info;
6187 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
Jerry Yub925f212022-01-12 11:17:02 +08006188 if( curve_info == NULL )
Jerry Yu3ad14ac2022-01-11 17:13:16 +08006189 continue;
Jerry Yub925f212022-01-12 11:17:02 +08006190 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
6191 MBEDTLS_PUT_UINT16_BE( *group_list, p, 0 );
6192 p += 2;
6193 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NamedGroup: %s ( %x )",
6194 curve_info->name, *group_list ) );
Jerry Yuba073422021-12-20 22:22:15 +08006195 }
Jerry Yu63282b42022-01-11 15:43:53 +08006196#endif /* MBEDTLS_ECP_C */
6197 /* Add DHE groups here */
Jerry Yuba073422021-12-20 22:22:15 +08006198
6199 }
6200
Jerry Yu1510cea2022-01-12 10:56:49 +08006201 /* Length of named_group_list */
Jerry Yuba073422021-12-20 22:22:15 +08006202 named_group_list_len = p - named_group_list;
6203 if( named_group_list_len == 0 )
6204 {
6205 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No group available." ) );
6206 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6207 }
6208
6209 /* Write extension_type */
6210 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_GROUPS, buf, 0 );
6211 /* Write extension_data_length */
6212 MBEDTLS_PUT_UINT16_BE( named_group_list_len + 2, buf, 2 );
6213 /* Write length of named_group_list */
6214 MBEDTLS_PUT_UINT16_BE( named_group_list_len, buf, 4 );
6215
Jerry Yu7f029d82022-01-11 11:08:53 +08006216 MBEDTLS_SSL_DEBUG_BUF( 3, "Supported groups extension",
6217 buf + 4, named_group_list_len + 2 );
Jerry Yuba073422021-12-20 22:22:15 +08006218
6219 *out_len = p - buf;
6220
6221#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
6222 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
6223#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6224
6225 return( 0 );
6226}
6227
Jerry Yu1ea9d102021-12-21 13:41:49 +08006228#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED ||
6229 MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C ||
6230 MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jerry Yuba073422021-12-20 22:22:15 +08006231
Jerry Yuf017ee42022-01-12 15:49:48 +08006232#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6233/*
Jerry Yu7ddc38c2022-01-19 11:08:05 +08006234 * Function for writing a signature algorithm extension.
Jerry Yuf017ee42022-01-12 15:49:48 +08006235 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08006236 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
Jerry Yu7ddc38c2022-01-19 11:08:05 +08006237 * value (TLS 1.3 RFC8446):
6238 * enum {
6239 * ....
6240 * ecdsa_secp256r1_sha256( 0x0403 ),
6241 * ecdsa_secp384r1_sha384( 0x0503 ),
6242 * ecdsa_secp521r1_sha512( 0x0603 ),
6243 * ....
6244 * } SignatureScheme;
Jerry Yuf017ee42022-01-12 15:49:48 +08006245 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08006246 * struct {
6247 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6248 * } SignatureSchemeList;
Jerry Yuf017ee42022-01-12 15:49:48 +08006249 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08006250 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6251 * value (TLS 1.2 RFC5246):
Jerry Yu7ddc38c2022-01-19 11:08:05 +08006252 * enum {
6253 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6254 * sha512(6), (255)
6255 * } HashAlgorithm;
6256 *
6257 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6258 * SignatureAlgorithm;
6259 *
6260 * struct {
6261 * HashAlgorithm hash;
6262 * SignatureAlgorithm signature;
6263 * } SignatureAndHashAlgorithm;
6264 *
6265 * SignatureAndHashAlgorithm
6266 * supported_signature_algorithms<2..2^16-2>;
6267 *
6268 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6269 * generalization of the TLS 1.2 signature algorithm extension.
6270 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6271 * `SignatureScheme` field of TLS 1.3
6272 *
Jerry Yuf017ee42022-01-12 15:49:48 +08006273 */
6274int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
6275 const unsigned char *end, size_t *out_len )
6276{
6277 unsigned char *p = buf;
6278 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
6279 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
6280
6281 *out_len = 0;
6282
6283 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
6284
6285 /* Check if we have space for header and length field:
6286 * - extension_type (2 bytes)
6287 * - extension_data_length (2 bytes)
6288 * - supported_signature_algorithms_length (2 bytes)
6289 */
6290 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
6291 p += 6;
6292
6293 /*
6294 * Write supported_signature_algorithms
6295 */
6296 supported_sig_alg = p;
Jerry Yu6106fdc2022-01-12 16:36:14 +08006297 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
6298 if( sig_alg == NULL )
6299 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
6300
6301 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
Jerry Yuf017ee42022-01-12 15:49:48 +08006302 {
Jerry Yu1bab3012022-01-19 17:43:22 +08006303 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
6304 continue;
Jerry Yuf017ee42022-01-12 15:49:48 +08006305 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
6306 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
6307 p += 2;
6308 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x]", *sig_alg ) );
6309 }
6310
6311 /* Length of supported_signature_algorithms */
6312 supported_sig_alg_len = p - supported_sig_alg;
6313 if( supported_sig_alg_len == 0 )
6314 {
6315 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
6316 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6317 }
6318
6319 /* Write extension_type */
6320 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
6321 /* Write extension_data_length */
6322 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
6323 /* Write length of supported_signature_algorithms */
6324 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
6325
6326 /* Output the total length of signature algorithms extension. */
6327 *out_len = p - buf;
6328
6329#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
6330 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
6331#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6332 return( 0 );
6333}
6334#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yuc73c6182022-02-08 20:29:25 +08006335
Jerry Yuc5aef882021-12-23 20:15:02 +08006336#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6337int mbedtls_ssl_write_hostname_ext( mbedtls_ssl_context *ssl,
6338 unsigned char *buf,
6339 const unsigned char *end,
6340 size_t *olen )
6341{
6342 unsigned char *p = buf;
6343 size_t hostname_len;
6344
6345 *olen = 0;
6346
6347 if( ssl->hostname == NULL )
6348 return( 0 );
6349
6350 MBEDTLS_SSL_DEBUG_MSG( 3,
6351 ( "client hello, adding server name extension: %s",
6352 ssl->hostname ) );
6353
6354 hostname_len = strlen( ssl->hostname );
6355
6356 MBEDTLS_SSL_CHK_BUF_PTR( p, end, hostname_len + 9 );
6357
6358 /*
6359 * Sect. 3, RFC 6066 (TLS Extensions Definitions)
6360 *
6361 * In order to provide any of the server names, clients MAY include an
6362 * extension of type "server_name" in the (extended) client hello. The
6363 * "extension_data" field of this extension SHALL contain
6364 * "ServerNameList" where:
6365 *
6366 * struct {
6367 * NameType name_type;
6368 * select (name_type) {
6369 * case host_name: HostName;
6370 * } name;
6371 * } ServerName;
6372 *
6373 * enum {
6374 * host_name(0), (255)
6375 * } NameType;
6376 *
6377 * opaque HostName<1..2^16-1>;
6378 *
6379 * struct {
6380 * ServerName server_name_list<1..2^16-1>
6381 * } ServerNameList;
6382 *
6383 */
6384 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SERVERNAME, p, 0 );
6385 p += 2;
6386
6387 MBEDTLS_PUT_UINT16_BE( hostname_len + 5, p, 0 );
6388 p += 2;
6389
6390 MBEDTLS_PUT_UINT16_BE( hostname_len + 3, p, 0 );
6391 p += 2;
6392
6393 *p++ = MBEDTLS_BYTE_0( MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME );
6394
6395 MBEDTLS_PUT_UINT16_BE( hostname_len, p, 0 );
6396 p += 2;
6397
6398 memcpy( p, ssl->hostname, hostname_len );
6399
6400 *olen = hostname_len + 9;
6401
6402 return( 0 );
6403}
6404#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Jerry Yuf017ee42022-01-12 15:49:48 +08006405
Jerry Yudc7bd172022-02-17 13:44:15 +08006406
6407#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6408
6409#if defined(MBEDTLS_USE_PSA_CRYPTO)
6410
6411static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
6412 mbedtls_svc_key_id_t key,
6413 psa_algorithm_t alg,
6414 const unsigned char* seed, size_t seed_length,
6415 const unsigned char* label, size_t label_length,
6416 size_t capacity )
6417{
6418 psa_status_t status;
6419
6420 status = psa_key_derivation_setup( derivation, alg );
6421 if( status != PSA_SUCCESS )
6422 return( status );
6423
6424 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
6425 {
6426 status = psa_key_derivation_input_bytes( derivation,
6427 PSA_KEY_DERIVATION_INPUT_SEED,
6428 seed, seed_length );
6429 if( status != PSA_SUCCESS )
6430 return( status );
6431
6432 if( mbedtls_svc_key_id_is_null( key ) )
6433 {
6434 status = psa_key_derivation_input_bytes(
6435 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
6436 NULL, 0 );
6437 }
6438 else
6439 {
6440 status = psa_key_derivation_input_key(
6441 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
6442 }
6443 if( status != PSA_SUCCESS )
6444 return( status );
6445
6446 status = psa_key_derivation_input_bytes( derivation,
6447 PSA_KEY_DERIVATION_INPUT_LABEL,
6448 label, label_length );
6449 if( status != PSA_SUCCESS )
6450 return( status );
6451 }
6452 else
6453 {
6454 return( PSA_ERROR_NOT_SUPPORTED );
6455 }
6456
6457 status = psa_key_derivation_set_capacity( derivation, capacity );
6458 if( status != PSA_SUCCESS )
6459 return( status );
6460
6461 return( PSA_SUCCESS );
6462}
6463
6464static int tls_prf_generic( mbedtls_md_type_t md_type,
6465 const unsigned char *secret, size_t slen,
6466 const char *label,
6467 const unsigned char *random, size_t rlen,
6468 unsigned char *dstbuf, size_t dlen )
6469{
6470 psa_status_t status;
6471 psa_algorithm_t alg;
6472 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6473 psa_key_derivation_operation_t derivation =
6474 PSA_KEY_DERIVATION_OPERATION_INIT;
6475
6476 if( md_type == MBEDTLS_MD_SHA384 )
6477 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
6478 else
6479 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
6480
6481 /* Normally a "secret" should be long enough to be impossible to
6482 * find by brute force, and in particular should not be empty. But
6483 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6484 * and for this use case it makes sense to have a 0-length "secret".
6485 * Since the key API doesn't allow importing a key of length 0,
6486 * keep master_key=0, which setup_psa_key_derivation() understands
6487 * to mean a 0-length "secret" input. */
6488 if( slen != 0 )
6489 {
6490 psa_key_attributes_t key_attributes = psa_key_attributes_init();
6491 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
6492 psa_set_key_algorithm( &key_attributes, alg );
6493 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
6494
6495 status = psa_import_key( &key_attributes, secret, slen, &master_key );
6496 if( status != PSA_SUCCESS )
6497 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6498 }
6499
6500 status = setup_psa_key_derivation( &derivation,
6501 master_key, alg,
6502 random, rlen,
6503 (unsigned char const *) label,
6504 (size_t) strlen( label ),
6505 dlen );
6506 if( status != PSA_SUCCESS )
6507 {
6508 psa_key_derivation_abort( &derivation );
6509 psa_destroy_key( master_key );
6510 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6511 }
6512
6513 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
6514 if( status != PSA_SUCCESS )
6515 {
6516 psa_key_derivation_abort( &derivation );
6517 psa_destroy_key( master_key );
6518 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6519 }
6520
6521 status = psa_key_derivation_abort( &derivation );
6522 if( status != PSA_SUCCESS )
6523 {
6524 psa_destroy_key( master_key );
6525 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6526 }
6527
6528 if( ! mbedtls_svc_key_id_is_null( master_key ) )
6529 status = psa_destroy_key( master_key );
6530 if( status != PSA_SUCCESS )
6531 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6532
6533 return( 0 );
6534}
6535
6536#else /* MBEDTLS_USE_PSA_CRYPTO */
6537
6538static int tls_prf_generic( mbedtls_md_type_t md_type,
6539 const unsigned char *secret, size_t slen,
6540 const char *label,
6541 const unsigned char *random, size_t rlen,
6542 unsigned char *dstbuf, size_t dlen )
6543{
6544 size_t nb;
6545 size_t i, j, k, md_len;
6546 unsigned char *tmp;
6547 size_t tmp_len = 0;
6548 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6549 const mbedtls_md_info_t *md_info;
6550 mbedtls_md_context_t md_ctx;
6551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6552
6553 mbedtls_md_init( &md_ctx );
6554
6555 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
6556 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6557
6558 md_len = mbedtls_md_get_size( md_info );
6559
6560 tmp_len = md_len + strlen( label ) + rlen;
6561 tmp = mbedtls_calloc( 1, tmp_len );
6562 if( tmp == NULL )
6563 {
6564 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6565 goto exit;
6566 }
6567
6568 nb = strlen( label );
6569 memcpy( tmp + md_len, label, nb );
6570 memcpy( tmp + md_len + nb, random, rlen );
6571 nb += rlen;
6572
6573 /*
6574 * Compute P_<hash>(secret, label + random)[0..dlen]
6575 */
6576 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
6577 goto exit;
6578
6579 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
6580 if( ret != 0 )
6581 goto exit;
6582 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
6583 if( ret != 0 )
6584 goto exit;
6585 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
6586 if( ret != 0 )
6587 goto exit;
6588
6589 for( i = 0; i < dlen; i += md_len )
6590 {
6591 ret = mbedtls_md_hmac_reset ( &md_ctx );
6592 if( ret != 0 )
6593 goto exit;
6594 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
6595 if( ret != 0 )
6596 goto exit;
6597 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
6598 if( ret != 0 )
6599 goto exit;
6600
6601 ret = mbedtls_md_hmac_reset ( &md_ctx );
6602 if( ret != 0 )
6603 goto exit;
6604 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
6605 if( ret != 0 )
6606 goto exit;
6607 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
6608 if( ret != 0 )
6609 goto exit;
6610
6611 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
6612
6613 for( j = 0; j < k; j++ )
6614 dstbuf[i + j] = h_i[j];
6615 }
6616
6617exit:
6618 mbedtls_md_free( &md_ctx );
6619
6620 mbedtls_platform_zeroize( tmp, tmp_len );
6621 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
6622
6623 mbedtls_free( tmp );
6624
6625 return( ret );
6626}
6627#endif /* MBEDTLS_USE_PSA_CRYPTO */
6628
6629#if defined(MBEDTLS_SHA256_C)
6630static int tls_prf_sha256( const unsigned char *secret, size_t slen,
6631 const char *label,
6632 const unsigned char *random, size_t rlen,
6633 unsigned char *dstbuf, size_t dlen )
6634{
6635 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
6636 label, random, rlen, dstbuf, dlen ) );
6637}
6638#endif /* MBEDTLS_SHA256_C */
6639
6640#if defined(MBEDTLS_SHA384_C)
6641static int tls_prf_sha384( const unsigned char *secret, size_t slen,
6642 const char *label,
6643 const unsigned char *random, size_t rlen,
6644 unsigned char *dstbuf, size_t dlen )
6645{
6646 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
6647 label, random, rlen, dstbuf, dlen ) );
6648}
6649#endif /* MBEDTLS_SHA384_C */
6650
Jerry Yuf009d862022-02-17 14:01:37 +08006651/*
6652 * Set appropriate PRF function and other SSL / TLS1.2 functions
6653 *
6654 * Inputs:
6655 * - SSL/TLS minor version
6656 * - hash associated with the ciphersuite (only used by TLS 1.2)
6657 *
6658 * Outputs:
6659 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6660 */
6661static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
6662 int minor_ver,
6663 mbedtls_md_type_t hash )
6664{
6665
6666#if defined(MBEDTLS_SHA384_C)
6667 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
6668 hash == MBEDTLS_MD_SHA384 )
6669 {
6670 handshake->tls_prf = tls_prf_sha384;
6671 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6672 handshake->calc_finished = ssl_calc_finished_tls_sha384;
6673 }
6674 else
6675#endif
6676#if defined(MBEDTLS_SHA256_C)
6677 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
6678 {
6679 handshake->tls_prf = tls_prf_sha256;
6680 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6681 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6682 }
6683 else
6684#endif
6685 {
6686 (void) hash;
6687 (void) minor_ver;
6688 (void) handshake;
6689 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6690 }
6691
6692 return( 0 );
6693}
Jerry Yud6ab2352022-02-17 14:03:43 +08006694
6695#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
6696 defined(MBEDTLS_USE_PSA_CRYPTO)
6697static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
6698{
6699 if( ssl->conf->f_psk != NULL )
6700 {
6701 /* If we've used a callback to select the PSK,
6702 * the static configuration is irrelevant. */
6703 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
6704 return( 1 );
6705
6706 return( 0 );
6707 }
6708
6709 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
6710 return( 1 );
6711
6712 return( 0 );
6713}
6714#endif /* MBEDTLS_USE_PSA_CRYPTO &&
6715 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6716
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006717/*
6718 * Compute master secret if needed
6719 *
6720 * Parameters:
6721 * [in/out] handshake
6722 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6723 * (PSA-PSK) ciphersuite_info, psk_opaque
6724 * [out] premaster (cleared)
6725 * [out] master
6726 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6727 * debug: conf->f_dbg, conf->p_dbg
6728 * EMS: passed to calc_verify (debug + session_negotiate)
6729 * PSA-PSA: minor_ver, conf
6730 */
6731static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
6732 unsigned char *master,
6733 const mbedtls_ssl_context *ssl )
6734{
6735 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6736
6737 /* cf. RFC 5246, Section 8.1:
6738 * "The master secret is always exactly 48 bytes in length." */
6739 size_t const master_secret_len = 48;
6740
6741#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6742 unsigned char session_hash[48];
6743#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6744
6745 /* The label for the KDF used for key expansion.
6746 * This is either "master secret" or "extended master secret"
6747 * depending on whether the Extended Master Secret extension
6748 * is used. */
6749 char const *lbl = "master secret";
6750
6751 /* The salt for the KDF used for key expansion.
6752 * - If the Extended Master Secret extension is not used,
6753 * this is ClientHello.Random + ServerHello.Random
6754 * (see Sect. 8.1 in RFC 5246).
6755 * - If the Extended Master Secret extension is used,
6756 * this is the transcript of the handshake so far.
6757 * (see Sect. 4 in RFC 7627). */
6758 unsigned char const *salt = handshake->randbytes;
6759 size_t salt_len = 64;
6760
6761#if !defined(MBEDTLS_DEBUG_C) && \
6762 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6763 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
6764 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
6765 ssl = NULL; /* make sure we don't use it except for those cases */
6766 (void) ssl;
6767#endif
6768
6769 if( handshake->resume != 0 )
6770 {
6771 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
6772 return( 0 );
6773 }
6774
6775#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6776 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
6777 {
6778 lbl = "extended master secret";
6779 salt = session_hash;
6780 handshake->calc_verify( ssl, session_hash, &salt_len );
6781
6782 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
6783 session_hash, salt_len );
6784 }
6785#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
6786
6787#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
6788 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
6789 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
6790 ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
6791 ssl_use_opaque_psk( ssl ) == 1 )
6792 {
6793 /* Perform PSK-to-MS expansion in a single step. */
6794 psa_status_t status;
6795 psa_algorithm_t alg;
6796 mbedtls_svc_key_id_t psk;
6797 psa_key_derivation_operation_t derivation =
6798 PSA_KEY_DERIVATION_OPERATION_INIT;
6799 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6800
6801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
6802
6803 psk = mbedtls_ssl_get_opaque_psk( ssl );
6804
6805 if( hash_alg == MBEDTLS_MD_SHA384 )
6806 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
6807 else
6808 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
6809
6810 status = setup_psa_key_derivation( &derivation, psk, alg,
6811 salt, salt_len,
6812 (unsigned char const *) lbl,
6813 (size_t) strlen( lbl ),
6814 master_secret_len );
6815 if( status != PSA_SUCCESS )
6816 {
6817 psa_key_derivation_abort( &derivation );
6818 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6819 }
6820
6821 status = psa_key_derivation_output_bytes( &derivation,
6822 master,
6823 master_secret_len );
6824 if( status != PSA_SUCCESS )
6825 {
6826 psa_key_derivation_abort( &derivation );
6827 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6828 }
6829
6830 status = psa_key_derivation_abort( &derivation );
6831 if( status != PSA_SUCCESS )
6832 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6833 }
6834 else
6835#endif
6836 {
6837 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
6838 lbl, salt, salt_len,
6839 master,
6840 master_secret_len );
6841 if( ret != 0 )
6842 {
6843 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6844 return( ret );
6845 }
6846
6847 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
6848 handshake->premaster,
6849 handshake->pmslen );
6850
6851 mbedtls_platform_zeroize( handshake->premaster,
6852 sizeof(handshake->premaster) );
6853 }
6854
6855 return( 0 );
6856}
6857
Jerry Yud62f87e2022-02-17 14:09:02 +08006858int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
6859{
6860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6861 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6862 ssl->handshake->ciphersuite_info;
6863
6864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
6865
6866 /* Set PRF, calc_verify and calc_finished function pointers */
6867 ret = ssl_set_handshake_prfs( ssl->handshake,
6868 ssl->minor_ver,
6869 ciphersuite_info->mac );
6870 if( ret != 0 )
6871 {
6872 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
6873 return( ret );
6874 }
6875
6876 /* Compute master secret if needed */
6877 ret = ssl_compute_master( ssl->handshake,
6878 ssl->session_negotiate->master,
6879 ssl );
6880 if( ret != 0 )
6881 {
6882 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
6883 return( ret );
6884 }
6885
6886 /* Swap the client and server random values:
6887 * - MS derivation wanted client+server (RFC 5246 8.1)
6888 * - key derivation wants server+client (RFC 5246 6.3) */
6889 {
6890 unsigned char tmp[64];
6891 memcpy( tmp, ssl->handshake->randbytes, 64 );
6892 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
6893 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
6894 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
6895 }
6896
6897 /* Populate transform structure */
6898 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
6899 ssl->session_negotiate->ciphersuite,
6900 ssl->session_negotiate->master,
6901#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6902 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6903 ssl->session_negotiate->encrypt_then_mac,
6904#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6905 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6906 ssl->handshake->tls_prf,
6907 ssl->handshake->randbytes,
6908 ssl->minor_ver,
6909 ssl->conf->endpoint,
6910 ssl );
6911 if( ret != 0 )
6912 {
6913 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
6914 return( ret );
6915 }
6916
6917 /* We no longer need Server/ClientHello.random values */
6918 mbedtls_platform_zeroize( ssl->handshake->randbytes,
6919 sizeof( ssl->handshake->randbytes ) );
6920
6921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
6922
6923 return( 0 );
6924}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006925
6926#if defined(MBEDTLS_SHA256_C)
6927void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
6928 unsigned char *hash,
6929 size_t *hlen )
6930{
6931#if defined(MBEDTLS_USE_PSA_CRYPTO)
6932 size_t hash_size;
6933 psa_status_t status;
6934 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6935
6936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
6937 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6938 if( status != PSA_SUCCESS )
6939 {
6940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6941 return;
6942 }
6943
6944 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
6945 if( status != PSA_SUCCESS )
6946 {
6947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6948 return;
6949 }
6950
6951 *hlen = 32;
6952 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
6953 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
6954#else
6955 mbedtls_sha256_context sha256;
6956
6957 mbedtls_sha256_init( &sha256 );
6958
6959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
6960
6961 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6962 mbedtls_sha256_finish( &sha256, hash );
6963
6964 *hlen = 32;
6965
6966 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
6967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
6968
6969 mbedtls_sha256_free( &sha256 );
6970#endif /* MBEDTLS_USE_PSA_CRYPTO */
6971 return;
6972}
6973#endif /* MBEDTLS_SHA256_C */
6974
Jerry Yuc1cb3842022-02-17 14:13:48 +08006975#if defined(MBEDTLS_SHA384_C)
6976void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
6977 unsigned char *hash,
6978 size_t *hlen )
6979{
6980#if defined(MBEDTLS_USE_PSA_CRYPTO)
6981 size_t hash_size;
6982 psa_status_t status;
6983 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6984
6985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
6986 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6987 if( status != PSA_SUCCESS )
6988 {
6989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6990 return;
6991 }
6992
6993 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
6994 if( status != PSA_SUCCESS )
6995 {
6996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6997 return;
6998 }
6999
7000 *hlen = 48;
7001 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
7002 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
7003#else
7004 mbedtls_sha512_context sha512;
7005
7006 mbedtls_sha512_init( &sha512 );
7007
7008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
7009
7010 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
7011 mbedtls_sha512_finish( &sha512, hash );
7012
7013 *hlen = 48;
7014
7015 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
7016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
7017
7018 mbedtls_sha512_free( &sha512 );
7019#endif /* MBEDTLS_USE_PSA_CRYPTO */
7020 return;
7021}
7022#endif /* MBEDTLS_SHA384_C */
7023
Jerry Yuce3dca42022-02-17 14:16:37 +08007024#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
7025int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
7026{
7027 unsigned char *p = ssl->handshake->premaster;
7028 unsigned char *end = p + sizeof( ssl->handshake->premaster );
7029 const unsigned char *psk = NULL;
7030 size_t psk_len = 0;
7031
7032 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
7033 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
7034 {
7035 /*
7036 * This should never happen because the existence of a PSK is always
7037 * checked before calling this function
7038 */
7039 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7040 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7041 }
7042
7043 /*
7044 * PMS = struct {
7045 * opaque other_secret<0..2^16-1>;
7046 * opaque psk<0..2^16-1>;
7047 * };
7048 * with "other_secret" depending on the particular key exchange
7049 */
7050#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
7051 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
7052 {
7053 if( end - p < 2 )
7054 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7055
7056 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
7057 p += 2;
7058
7059 if( end < p || (size_t)( end - p ) < psk_len )
7060 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7061
7062 memset( p, 0, psk_len );
7063 p += psk_len;
7064 }
7065 else
7066#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7067#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
7068 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
7069 {
7070 /*
7071 * other_secret already set by the ClientKeyExchange message,
7072 * and is 48 bytes long
7073 */
7074 if( end - p < 2 )
7075 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7076
7077 *p++ = 0;
7078 *p++ = 48;
7079 p += 48;
7080 }
7081 else
7082#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7083#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
7084 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
7085 {
7086 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7087 size_t len;
7088
7089 /* Write length only when we know the actual value */
7090 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
7091 p + 2, end - ( p + 2 ), &len,
7092 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
7093 {
7094 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
7095 return( ret );
7096 }
7097 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
7098 p += 2 + len;
7099
7100 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
7101 }
7102 else
7103#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
7104#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
7105 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
7106 {
7107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7108 size_t zlen;
7109
7110 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
7111 p + 2, end - ( p + 2 ),
7112 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
7113 {
7114 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
7115 return( ret );
7116 }
7117
7118 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
7119 p += 2 + zlen;
7120
7121 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
7122 MBEDTLS_DEBUG_ECDH_Z );
7123 }
7124 else
7125#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
7126 {
7127 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7128 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7129 }
7130
7131 /* opaque psk<0..2^16-1>; */
7132 if( end - p < 2 )
7133 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7134
7135 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
7136 p += 2;
7137
7138 if( end < p || (size_t)( end - p ) < psk_len )
7139 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7140
7141 memcpy( p, psk, psk_len );
7142 p += psk_len;
7143
7144 ssl->handshake->pmslen = p - ssl->handshake->premaster;
7145
7146 return( 0 );
7147}
7148#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007149
7150#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
7151static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
7152
7153#if defined(MBEDTLS_SSL_PROTO_DTLS)
7154int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
7155{
7156 /* If renegotiation is not enforced, retransmit until we would reach max
7157 * timeout if we were using the usual handshake doubling scheme */
7158 if( ssl->conf->renego_max_records < 0 )
7159 {
7160 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7161 unsigned char doublings = 1;
7162
7163 while( ratio != 0 )
7164 {
7165 ++doublings;
7166 ratio >>= 1;
7167 }
7168
7169 if( ++ssl->renego_records_seen > doublings )
7170 {
7171 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
7172 return( 0 );
7173 }
7174 }
7175
7176 return( ssl_write_hello_request( ssl ) );
7177}
7178#endif
7179#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007180
7181
7182/*
7183 * Handshake functions
7184 */
7185#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7186/* No certificate support -> dummy functions */
7187int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
7188{
7189 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7190 ssl->handshake->ciphersuite_info;
7191
7192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
7193
7194 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
7195 {
7196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
7197 ssl->state++;
7198 return( 0 );
7199 }
7200
7201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7202 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7203}
7204
7205int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
7206{
7207 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7208 ssl->handshake->ciphersuite_info;
7209
7210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
7211
7212 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
7213 {
7214 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
7215 ssl->state++;
7216 return( 0 );
7217 }
7218
7219 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7220 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7221}
7222
7223#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7224/* Some certificate support -> implement write and parse */
7225
7226int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
7227{
7228 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7229 size_t i, n;
7230 const mbedtls_x509_crt *crt;
7231 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7232 ssl->handshake->ciphersuite_info;
7233
7234 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
7235
7236 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
7237 {
7238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
7239 ssl->state++;
7240 return( 0 );
7241 }
7242
7243#if defined(MBEDTLS_SSL_CLI_C)
7244 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7245 {
7246 if( ssl->handshake->client_auth == 0 )
7247 {
7248 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
7249 ssl->state++;
7250 return( 0 );
7251 }
7252 }
7253#endif /* MBEDTLS_SSL_CLI_C */
7254#if defined(MBEDTLS_SSL_SRV_C)
7255 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7256 {
7257 if( mbedtls_ssl_own_cert( ssl ) == NULL )
7258 {
7259 /* Should never happen because we shouldn't have picked the
7260 * ciphersuite if we don't have a certificate. */
7261 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7262 }
7263 }
7264#endif
7265
7266 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
7267
7268 /*
7269 * 0 . 0 handshake type
7270 * 1 . 3 handshake length
7271 * 4 . 6 length of all certs
7272 * 7 . 9 length of cert. 1
7273 * 10 . n-1 peer certificate
7274 * n . n+2 length of cert. 2
7275 * n+3 . ... upper level cert, etc.
7276 */
7277 i = 7;
7278 crt = mbedtls_ssl_own_cert( ssl );
7279
7280 while( crt != NULL )
7281 {
7282 n = crt->raw.len;
7283 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
7284 {
7285 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
7286 " > %" MBEDTLS_PRINTF_SIZET,
7287 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
7288 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
7289 }
7290
7291 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
7292 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
7293 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
7294
7295 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
7296 i += n; crt = crt->next;
7297 }
7298
7299 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
7300 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
7301 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
7302
7303 ssl->out_msglen = i;
7304 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7305 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7306
7307 ssl->state++;
7308
7309 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7310 {
7311 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7312 return( ret );
7313 }
7314
7315 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
7316
7317 return( ret );
7318}
7319
7320#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7321
7322#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7323static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
7324 unsigned char *crt_buf,
7325 size_t crt_buf_len )
7326{
7327 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7328
7329 if( peer_crt == NULL )
7330 return( -1 );
7331
7332 if( peer_crt->raw.len != crt_buf_len )
7333 return( -1 );
7334
7335 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
7336}
7337#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7338static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
7339 unsigned char *crt_buf,
7340 size_t crt_buf_len )
7341{
7342 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7343 unsigned char const * const peer_cert_digest =
7344 ssl->session->peer_cert_digest;
7345 mbedtls_md_type_t const peer_cert_digest_type =
7346 ssl->session->peer_cert_digest_type;
7347 mbedtls_md_info_t const * const digest_info =
7348 mbedtls_md_info_from_type( peer_cert_digest_type );
7349 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7350 size_t digest_len;
7351
7352 if( peer_cert_digest == NULL || digest_info == NULL )
7353 return( -1 );
7354
7355 digest_len = mbedtls_md_get_size( digest_info );
7356 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
7357 return( -1 );
7358
7359 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
7360 if( ret != 0 )
7361 return( -1 );
7362
7363 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
7364}
7365#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7366#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7367
7368/*
7369 * Once the certificate message is read, parse it into a cert chain and
7370 * perform basic checks, but leave actual verification to the caller
7371 */
7372static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
7373 mbedtls_x509_crt *chain )
7374{
7375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7376#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7377 int crt_cnt=0;
7378#endif
7379 size_t i, n;
7380 uint8_t alert;
7381
7382 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7383 {
7384 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
7385 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7386 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7387 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
7388 }
7389
7390 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
7391 {
7392 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7393 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7394 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
7395 }
7396
7397 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
7398 {
7399 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
7400 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7401 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7402 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
7403 }
7404
7405 i = mbedtls_ssl_hs_hdr_len( ssl );
7406
7407 /*
7408 * Same message structure as in mbedtls_ssl_write_certificate()
7409 */
7410 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
7411
7412 if( ssl->in_msg[i] != 0 ||
7413 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
7414 {
7415 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
7416 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7417 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7418 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
7419 }
7420
7421 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7422 i += 3;
7423
7424 /* Iterate through and parse the CRTs in the provided chain. */
7425 while( i < ssl->in_hslen )
7426 {
7427 /* Check that there's room for the next CRT's length fields. */
7428 if ( i + 3 > ssl->in_hslen ) {
7429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
7430 mbedtls_ssl_send_alert_message( ssl,
7431 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7432 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7433 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
7434 }
7435 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7436 * anything beyond 2**16 ~ 64K. */
7437 if( ssl->in_msg[i] != 0 )
7438 {
7439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
7440 mbedtls_ssl_send_alert_message( ssl,
7441 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7442 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
7443 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
7444 }
7445
7446 /* Read length of the next CRT in the chain. */
7447 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
7448 | (unsigned int) ssl->in_msg[i + 2];
7449 i += 3;
7450
7451 if( n < 128 || i + n > ssl->in_hslen )
7452 {
7453 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
7454 mbedtls_ssl_send_alert_message( ssl,
7455 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7456 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7457 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
7458 }
7459
7460 /* Check if we're handling the first CRT in the chain. */
7461#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7462 if( crt_cnt++ == 0 &&
7463 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
7464 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7465 {
7466 /* During client-side renegotiation, check that the server's
7467 * end-CRTs hasn't changed compared to the initial handshake,
7468 * mitigating the triple handshake attack. On success, reuse
7469 * the original end-CRT instead of parsing it again. */
7470 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
7471 if( ssl_check_peer_crt_unchanged( ssl,
7472 &ssl->in_msg[i],
7473 n ) != 0 )
7474 {
7475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
7476 mbedtls_ssl_send_alert_message( ssl,
7477 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7478 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
7479 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
7480 }
7481
7482 /* Now we can safely free the original chain. */
7483 ssl_clear_peer_cert( ssl->session );
7484 }
7485#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7486
7487 /* Parse the next certificate in the chain. */
7488#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7489 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
7490#else
7491 /* If we don't need to store the CRT chain permanently, parse
7492 * it in-place from the input buffer instead of making a copy. */
7493 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
7494#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7495 switch( ret )
7496 {
7497 case 0: /*ok*/
7498 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7499 /* Ignore certificate with an unknown algorithm: maybe a
7500 prior certificate was already trusted. */
7501 break;
7502
7503 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7504 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7505 goto crt_parse_der_failed;
7506
7507 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7508 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7509 goto crt_parse_der_failed;
7510
7511 default:
7512 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
7513 crt_parse_der_failed:
7514 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
7515 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
7516 return( ret );
7517 }
7518
7519 i += n;
7520 }
7521
7522 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
7523 return( 0 );
7524}
7525
7526#if defined(MBEDTLS_SSL_SRV_C)
7527static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
7528{
7529 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7530 return( -1 );
7531
7532 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
7533 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7534 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
7535 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
7536 {
7537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
7538 return( 0 );
7539 }
7540 return( -1 );
7541}
7542#endif /* MBEDTLS_SSL_SRV_C */
7543
7544/* Check if a certificate message is expected.
7545 * Return either
7546 * - SSL_CERTIFICATE_EXPECTED, or
7547 * - SSL_CERTIFICATE_SKIP
7548 * indicating whether a Certificate message is expected or not.
7549 */
7550#define SSL_CERTIFICATE_EXPECTED 0
7551#define SSL_CERTIFICATE_SKIP 1
7552static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
7553 int authmode )
7554{
7555 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7556 ssl->handshake->ciphersuite_info;
7557
7558 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
7559 return( SSL_CERTIFICATE_SKIP );
7560
7561#if defined(MBEDTLS_SSL_SRV_C)
7562 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7563 {
7564 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
7565 return( SSL_CERTIFICATE_SKIP );
7566
7567 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
7568 {
7569 ssl->session_negotiate->verify_result =
7570 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
7571 return( SSL_CERTIFICATE_SKIP );
7572 }
7573 }
7574#else
7575 ((void) authmode);
7576#endif /* MBEDTLS_SSL_SRV_C */
7577
7578 return( SSL_CERTIFICATE_EXPECTED );
7579}
7580
7581static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
7582 int authmode,
7583 mbedtls_x509_crt *chain,
7584 void *rs_ctx )
7585{
7586 int ret = 0;
7587 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7588 ssl->handshake->ciphersuite_info;
7589 int have_ca_chain = 0;
7590
7591 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7592 void *p_vrfy;
7593
7594 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
7595 return( 0 );
7596
7597 if( ssl->f_vrfy != NULL )
7598 {
7599 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
7600 f_vrfy = ssl->f_vrfy;
7601 p_vrfy = ssl->p_vrfy;
7602 }
7603 else
7604 {
7605 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
7606 f_vrfy = ssl->conf->f_vrfy;
7607 p_vrfy = ssl->conf->p_vrfy;
7608 }
7609
7610 /*
7611 * Main check: verify certificate
7612 */
7613#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
7614 if( ssl->conf->f_ca_cb != NULL )
7615 {
7616 ((void) rs_ctx);
7617 have_ca_chain = 1;
7618
7619 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
7620 ret = mbedtls_x509_crt_verify_with_ca_cb(
7621 chain,
7622 ssl->conf->f_ca_cb,
7623 ssl->conf->p_ca_cb,
7624 ssl->conf->cert_profile,
7625 ssl->hostname,
7626 &ssl->session_negotiate->verify_result,
7627 f_vrfy, p_vrfy );
7628 }
7629 else
7630#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7631 {
7632 mbedtls_x509_crt *ca_chain;
7633 mbedtls_x509_crl *ca_crl;
7634
7635#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7636 if( ssl->handshake->sni_ca_chain != NULL )
7637 {
7638 ca_chain = ssl->handshake->sni_ca_chain;
7639 ca_crl = ssl->handshake->sni_ca_crl;
7640 }
7641 else
7642#endif
7643 {
7644 ca_chain = ssl->conf->ca_chain;
7645 ca_crl = ssl->conf->ca_crl;
7646 }
7647
7648 if( ca_chain != NULL )
7649 have_ca_chain = 1;
7650
7651 ret = mbedtls_x509_crt_verify_restartable(
7652 chain,
7653 ca_chain, ca_crl,
7654 ssl->conf->cert_profile,
7655 ssl->hostname,
7656 &ssl->session_negotiate->verify_result,
7657 f_vrfy, p_vrfy, rs_ctx );
7658 }
7659
7660 if( ret != 0 )
7661 {
7662 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
7663 }
7664
7665#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7666 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
7667 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
7668#endif
7669
7670 /*
7671 * Secondary checks: always done, but change 'ret' only if it was 0
7672 */
7673
7674#if defined(MBEDTLS_ECP_C)
7675 {
7676 const mbedtls_pk_context *pk = &chain->pk;
7677
7678 /* If certificate uses an EC key, make sure the curve is OK */
7679 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
7680 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
7681 {
7682 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
7683
7684 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
7685 if( ret == 0 )
7686 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
7687 }
7688 }
7689#endif /* MBEDTLS_ECP_C */
7690
7691 if( mbedtls_ssl_check_cert_usage( chain,
7692 ciphersuite_info,
7693 ! ssl->conf->endpoint,
7694 &ssl->session_negotiate->verify_result ) != 0 )
7695 {
7696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
7697 if( ret == 0 )
7698 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
7699 }
7700
7701 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7702 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7703 * with details encoded in the verification flags. All other kinds
7704 * of error codes, including those from the user provided f_vrfy
7705 * functions, are treated as fatal and lead to a failure of
7706 * ssl_parse_certificate even if verification was optional. */
7707 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7708 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7709 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
7710 {
7711 ret = 0;
7712 }
7713
7714 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
7715 {
7716 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
7717 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7718 }
7719
7720 if( ret != 0 )
7721 {
7722 uint8_t alert;
7723
7724 /* The certificate may have been rejected for several reasons.
7725 Pick one and send the corresponding alert. Which alert to send
7726 may be a subject of debate in some cases. */
7727 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
7728 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
7729 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
7730 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
7731 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
7732 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7733 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
7734 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7735 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
7736 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7737 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
7738 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7739 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
7740 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7741 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
7742 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
7743 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
7744 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
7745 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
7746 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
7747 else
7748 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
7749 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7750 alert );
7751 }
7752
7753#if defined(MBEDTLS_DEBUG_C)
7754 if( ssl->session_negotiate->verify_result != 0 )
7755 {
7756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
7757 (unsigned int) ssl->session_negotiate->verify_result ) );
7758 }
7759 else
7760 {
7761 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
7762 }
7763#endif /* MBEDTLS_DEBUG_C */
7764
7765 return( ret );
7766}
7767
7768#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7769static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
7770 unsigned char *start, size_t len )
7771{
7772 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7773 /* Remember digest of the peer's end-CRT. */
7774 ssl->session_negotiate->peer_cert_digest =
7775 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
7776 if( ssl->session_negotiate->peer_cert_digest == NULL )
7777 {
7778 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
7779 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
7780 mbedtls_ssl_send_alert_message( ssl,
7781 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7782 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7783
7784 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7785 }
7786
7787 ret = mbedtls_md( mbedtls_md_info_from_type(
7788 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
7789 start, len,
7790 ssl->session_negotiate->peer_cert_digest );
7791
7792 ssl->session_negotiate->peer_cert_digest_type =
7793 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7794 ssl->session_negotiate->peer_cert_digest_len =
7795 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7796
7797 return( ret );
7798}
7799
7800static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
7801 unsigned char *start, size_t len )
7802{
7803 unsigned char *end = start + len;
7804 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7805
7806 /* Make a copy of the peer's raw public key. */
7807 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
7808 ret = mbedtls_pk_parse_subpubkey( &start, end,
7809 &ssl->handshake->peer_pubkey );
7810 if( ret != 0 )
7811 {
7812 /* We should have parsed the public key before. */
7813 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7814 }
7815
7816 return( 0 );
7817}
7818#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7819
7820int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
7821{
7822 int ret = 0;
7823 int crt_expected;
7824#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7825 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7826 ? ssl->handshake->sni_authmode
7827 : ssl->conf->authmode;
7828#else
7829 const int authmode = ssl->conf->authmode;
7830#endif
7831 void *rs_ctx = NULL;
7832 mbedtls_x509_crt *chain = NULL;
7833
7834 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
7835
7836 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
7837 if( crt_expected == SSL_CERTIFICATE_SKIP )
7838 {
7839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
7840 goto exit;
7841 }
7842
7843#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7844 if( ssl->handshake->ecrs_enabled &&
7845 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
7846 {
7847 chain = ssl->handshake->ecrs_peer_cert;
7848 ssl->handshake->ecrs_peer_cert = NULL;
7849 goto crt_verify;
7850 }
7851#endif
7852
7853 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7854 {
7855 /* mbedtls_ssl_read_record may have sent an alert already. We
7856 let it decide whether to alert. */
7857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7858 goto exit;
7859 }
7860
7861#if defined(MBEDTLS_SSL_SRV_C)
7862 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
7863 {
7864 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7865
7866 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
7867 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
7868
7869 goto exit;
7870 }
7871#endif /* MBEDTLS_SSL_SRV_C */
7872
7873 /* Clear existing peer CRT structure in case we tried to
7874 * reuse a session but it failed, and allocate a new one. */
7875 ssl_clear_peer_cert( ssl->session_negotiate );
7876
7877 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7878 if( chain == NULL )
7879 {
7880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7881 sizeof( mbedtls_x509_crt ) ) );
7882 mbedtls_ssl_send_alert_message( ssl,
7883 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7884 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7885
7886 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7887 goto exit;
7888 }
7889 mbedtls_x509_crt_init( chain );
7890
7891 ret = ssl_parse_certificate_chain( ssl, chain );
7892 if( ret != 0 )
7893 goto exit;
7894
7895#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7896 if( ssl->handshake->ecrs_enabled)
7897 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
7898
7899crt_verify:
7900 if( ssl->handshake->ecrs_enabled)
7901 rs_ctx = &ssl->handshake->ecrs_ctx;
7902#endif
7903
7904 ret = ssl_parse_certificate_verify( ssl, authmode,
7905 chain, rs_ctx );
7906 if( ret != 0 )
7907 goto exit;
7908
7909#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7910 {
7911 unsigned char *crt_start, *pk_start;
7912 size_t crt_len, pk_len;
7913
7914 /* We parse the CRT chain without copying, so
7915 * these pointers point into the input buffer,
7916 * and are hence still valid after freeing the
7917 * CRT chain. */
7918
7919 crt_start = chain->raw.p;
7920 crt_len = chain->raw.len;
7921
7922 pk_start = chain->pk_raw.p;
7923 pk_len = chain->pk_raw.len;
7924
7925 /* Free the CRT structures before computing
7926 * digest and copying the peer's public key. */
7927 mbedtls_x509_crt_free( chain );
7928 mbedtls_free( chain );
7929 chain = NULL;
7930
7931 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
7932 if( ret != 0 )
7933 goto exit;
7934
7935 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
7936 if( ret != 0 )
7937 goto exit;
7938 }
7939#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7940 /* Pass ownership to session structure. */
7941 ssl->session_negotiate->peer_cert = chain;
7942 chain = NULL;
7943#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7944
7945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
7946
7947exit:
7948
7949 if( ret == 0 )
7950 ssl->state++;
7951
7952#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7953 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
7954 {
7955 ssl->handshake->ecrs_peer_cert = chain;
7956 chain = NULL;
7957 }
7958#endif
7959
7960 if( chain != NULL )
7961 {
7962 mbedtls_x509_crt_free( chain );
7963 mbedtls_free( chain );
7964 }
7965
7966 return( ret );
7967}
7968#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7969
Jerry Yudc7bd172022-02-17 13:44:15 +08007970#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007972#endif /* MBEDTLS_SSL_TLS_C */