blob: ce111f9e028e12faba88430444dda650542063af [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
Gilles Peskineeccd8882020-03-10 12:19:08 +01001012#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001014{
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001015 unsigned char *p = ssl->handshake->premaster;
1016 unsigned char *end = p + sizeof( ssl->handshake->premaster );
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001017 const unsigned char *psk = NULL;
Guilhem Bryant61b0fe62020-03-27 11:12:12 +00001018 size_t psk_len = 0;
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001019
Guilhem Bryantc5285d82020-03-25 17:08:15 +00001020 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
1021 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001022 {
Guilhem Bryantc5285d82020-03-25 17:08:15 +00001023 /*
1024 * This should never happen because the existence of a PSK is always
1025 * checked before calling this function
1026 */
Guilhem Bryant82194c82020-03-26 17:04:31 +00001027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Guilhem Bryant0c9b1952020-04-08 11:02:38 +01001028 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001029 }
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001030
1031 /*
1032 * PMS = struct {
1033 * opaque other_secret<0..2^16-1>;
1034 * opaque psk<0..2^16-1>;
1035 * };
1036 * with "other_secret" depending on the particular key exchange
1037 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
1039 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001040 {
Manuel Pégourié-Gonnardbc5e5082015-10-21 12:35:29 +02001041 if( end - p < 2 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001043
Joe Subbiania5cb0d22021-08-23 11:35:25 +01001044 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
1045 p += 2;
Manuel Pégourié-Gonnardbc5e5082015-10-21 12:35:29 +02001046
1047 if( end < p || (size_t)( end - p ) < psk_len )
1048 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1049
1050 memset( p, 0, psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001051 p += psk_len;
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001052 }
1053 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
1055#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
1056 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +02001057 {
1058 /*
1059 * other_secret already set by the ClientKeyExchange message,
1060 * and is 48 bytes long
1061 */
Philippe Antoine747fd532018-05-30 09:13:21 +02001062 if( end - p < 2 )
1063 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1064
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +02001065 *p++ = 0;
1066 *p++ = 48;
1067 p += 48;
1068 }
1069 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
1071#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
1072 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001073 {
Janos Follath865b3eb2019-12-16 11:46:15 +00001074 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard33352052015-06-02 16:17:08 +01001075 size_t len;
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001076
Manuel Pégourié-Gonnard8df68632014-06-23 17:56:08 +02001077 /* Write length only when we know the actual value */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
Manuel Pégourié-Gonnard33352052015-06-02 16:17:08 +01001079 p + 2, end - ( p + 2 ), &len,
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001080 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001081 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001083 return( ret );
1084 }
Joe Subbiania5cb0d22021-08-23 11:35:25 +01001085 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
1086 p += 2 + len;
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001089 }
1090 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
1092#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
1093 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001094 {
Janos Follath865b3eb2019-12-16 11:46:15 +00001095 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001096 size_t zlen;
1097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
Paul Bakker66d5d072014-06-17 16:39:18 +02001099 p + 2, end - ( p + 2 ),
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001100 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001101 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001103 return( ret );
1104 }
1105
Joe Subbiania5cb0d22021-08-23 11:35:25 +01001106 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
1107 p += 2 + zlen;
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001108
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001109 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
1110 MBEDTLS_DEBUG_ECDH_Z );
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001111 }
1112 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001114 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1116 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001117 }
1118
1119 /* opaque psk<0..2^16-1>; */
Manuel Pégourié-Gonnardbc5e5082015-10-21 12:35:29 +02001120 if( end - p < 2 )
1121 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardb2bf5a12014-03-25 16:28:12 +01001122
Joe Subbiania5cb0d22021-08-23 11:35:25 +01001123 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
1124 p += 2;
Manuel Pégourié-Gonnardbc5e5082015-10-21 12:35:29 +02001125
1126 if( end < p || (size_t)( end - p ) < psk_len )
1127 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1128
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001129 memcpy( p, psk, psk_len );
1130 p += psk_len;
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001131
1132 ssl->handshake->pmslen = p - ssl->handshake->premaster;
1133
1134 return( 0 );
1135}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001136#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardbd1ae242013-10-14 13:09:25 +02001137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
1139static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker786300f2020-02-05 10:46:40 +00001142int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001143{
1144 /* If renegotiation is not enforced, retransmit until we would reach max
1145 * timeout if we were using the usual handshake doubling scheme */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001146 if( ssl->conf->renego_max_records < 0 )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001147 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001148 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001149 unsigned char doublings = 1;
1150
1151 while( ratio != 0 )
1152 {
1153 ++doublings;
1154 ratio >>= 1;
1155 }
1156
1157 if( ++ssl->renego_records_seen > doublings )
1158 {
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02001159 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001160 return( 0 );
1161 }
1162 }
1163
1164 return( ssl_write_hello_request( ssl ) );
1165}
1166#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001168
Paul Bakker5121ce52009-01-03 21:22:43 +00001169/*
1170 * Handshake functions
1171 */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001172#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Gilles Peskinef9828522017-05-03 12:28:43 +02001173/* No certificate support -> dummy functions */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001175{
Hanno Beckere694c3e2017-12-27 21:34:08 +00001176 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1177 ssl->handshake->ciphersuite_info;
Paul Bakker5121ce52009-01-03 21:22:43 +00001178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001180
Hanno Becker7177a882019-02-05 13:36:46 +00001181 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001184 ssl->state++;
1185 return( 0 );
1186 }
1187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1189 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001190}
1191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001193{
Hanno Beckere694c3e2017-12-27 21:34:08 +00001194 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1195 ssl->handshake->ciphersuite_info;
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001198
Hanno Becker7177a882019-02-05 13:36:46 +00001199 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001200 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001202 ssl->state++;
1203 return( 0 );
1204 }
1205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1207 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001208}
Gilles Peskinef9828522017-05-03 12:28:43 +02001209
Gilles Peskineeccd8882020-03-10 12:19:08 +01001210#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Gilles Peskinef9828522017-05-03 12:28:43 +02001211/* Some certificate support -> implement write and parse */
1212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001214{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001216 size_t i, n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001217 const mbedtls_x509_crt *crt;
Hanno Beckere694c3e2017-12-27 21:34:08 +00001218 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1219 ssl->handshake->ciphersuite_info;
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001222
Hanno Becker7177a882019-02-05 13:36:46 +00001223 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001224 {
Johan Pascal4f099262020-09-22 10:59:26 +02001225 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
1226 ssl->state++;
1227 return( 0 );
Paul Bakker48f7a5d2013-04-19 14:30:58 +02001228 }
1229
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001231 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Paul Bakker5121ce52009-01-03 21:22:43 +00001232 {
Jerry Yufb28b882022-01-28 11:05:58 +08001233 if( ssl->handshake->client_auth == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001234 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001236 ssl->state++;
1237 return( 0 );
1238 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001239 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240#endif /* MBEDTLS_SSL_CLI_C */
1241#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001242 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00001243 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001244 if( mbedtls_ssl_own_cert( ssl ) == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001245 {
Hanno Becker9cfe6e92021-04-30 05:38:24 +01001246 /* Should never happen because we shouldn't have picked the
1247 * ciphersuite if we don't have a certificate. */
1248 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +00001249 }
1250 }
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01001251#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001254
1255 /*
1256 * 0 . 0 handshake type
1257 * 1 . 3 handshake length
1258 * 4 . 6 length of all certs
1259 * 7 . 9 length of cert. 1
1260 * 10 . n-1 peer certificate
1261 * n . n+2 length of cert. 2
1262 * n+3 . ... upper level cert, etc.
1263 */
1264 i = 7;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265 crt = mbedtls_ssl_own_cert( ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001266
Paul Bakker29087132010-03-21 21:03:34 +00001267 while( crt != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001268 {
1269 n = crt->raw.len;
Angus Grattond8213d02016-05-25 20:56:48 +10001270 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
Paul Bakker5121ce52009-01-03 21:22:43 +00001271 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
1273 " > %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00001274 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker91e1cc32021-04-30 05:28:49 +01001275 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001276 }
1277
Joe Subbianifbeb6922021-07-16 14:27:50 +01001278 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
1279 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
1280 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
Paul Bakker5121ce52009-01-03 21:22:43 +00001281
1282 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
1283 i += n; crt = crt->next;
1284 }
1285
Joe Subbianifbeb6922021-07-16 14:27:50 +01001286 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
1287 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
1288 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001289
1290 ssl->out_msglen = i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
1292 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
Paul Bakker5121ce52009-01-03 21:22:43 +00001293
Paul Bakker5121ce52009-01-03 21:22:43 +00001294 ssl->state++;
1295
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02001296 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001297 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02001298 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001299 return( ret );
1300 }
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001303
Paul Bakkered27a042013-04-18 22:46:23 +02001304 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001305}
1306
Hanno Becker84879e32019-01-31 07:44:03 +00001307#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Hanno Becker177475a2019-02-05 17:02:46 +00001308
1309#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001310static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
1311 unsigned char *crt_buf,
1312 size_t crt_buf_len )
1313{
1314 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
1315
1316 if( peer_crt == NULL )
1317 return( -1 );
1318
1319 if( peer_crt->raw.len != crt_buf_len )
1320 return( -1 );
1321
k-stachowiak95b68ef2019-09-16 12:21:00 +02001322 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001323}
Hanno Becker177475a2019-02-05 17:02:46 +00001324#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1325static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
1326 unsigned char *crt_buf,
1327 size_t crt_buf_len )
1328{
Janos Follath865b3eb2019-12-16 11:46:15 +00001329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker177475a2019-02-05 17:02:46 +00001330 unsigned char const * const peer_cert_digest =
1331 ssl->session->peer_cert_digest;
1332 mbedtls_md_type_t const peer_cert_digest_type =
1333 ssl->session->peer_cert_digest_type;
1334 mbedtls_md_info_t const * const digest_info =
1335 mbedtls_md_info_from_type( peer_cert_digest_type );
1336 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
1337 size_t digest_len;
1338
1339 if( peer_cert_digest == NULL || digest_info == NULL )
1340 return( -1 );
1341
1342 digest_len = mbedtls_md_get_size( digest_info );
1343 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
1344 return( -1 );
1345
1346 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
1347 if( ret != 0 )
1348 return( -1 );
1349
1350 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
1351}
1352#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker84879e32019-01-31 07:44:03 +00001353#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001354
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001355/*
1356 * Once the certificate message is read, parse it into a cert chain and
1357 * perform basic checks, but leave actual verification to the caller
1358 */
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001359static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
1360 mbedtls_x509_crt *chain )
Paul Bakker5121ce52009-01-03 21:22:43 +00001361{
Janos Follath865b3eb2019-12-16 11:46:15 +00001362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001363#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
1364 int crt_cnt=0;
1365#endif
Paul Bakker23986e52011-04-24 08:57:21 +00001366 size_t i, n;
Gilles Peskine064a85c2017-05-10 10:46:40 +02001367 uint8_t alert;
Paul Bakker5121ce52009-01-03 21:22:43 +00001368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001369 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00001370 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001372 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1373 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00001375 }
1376
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001377 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
1378 {
1379 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1380 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
1381 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1382 }
1383
1384 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001385 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001387 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1388 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001389 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +00001390 }
1391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392 i = mbedtls_ssl_hs_hdr_len( ssl );
Manuel Pégourié-Gonnardf49a7da2014-09-10 13:30:43 +00001393
Paul Bakker5121ce52009-01-03 21:22:43 +00001394 /*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 * Same message structure as in mbedtls_ssl_write_certificate()
Paul Bakker5121ce52009-01-03 21:22:43 +00001396 */
Manuel Pégourié-Gonnardf49a7da2014-09-10 13:30:43 +00001397 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
Paul Bakker5121ce52009-01-03 21:22:43 +00001398
Manuel Pégourié-Gonnardf49a7da2014-09-10 13:30:43 +00001399 if( ssl->in_msg[i] != 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001400 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
Paul Bakker5121ce52009-01-03 21:22:43 +00001401 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001402 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001403 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1404 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001405 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +00001406 }
1407
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001408 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
1409 i += 3;
1410
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001411 /* Iterate through and parse the CRTs in the provided chain. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001412 while( i < ssl->in_hslen )
1413 {
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001414 /* Check that there's room for the next CRT's length fields. */
Philippe Antoine747fd532018-05-30 09:13:21 +02001415 if ( i + 3 > ssl->in_hslen ) {
1416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
Hanno Beckere2734e22019-01-31 07:44:17 +00001417 mbedtls_ssl_send_alert_message( ssl,
1418 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1419 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
Dave Rodgman43fcb8d2021-06-28 21:49:15 +01001420 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Philippe Antoine747fd532018-05-30 09:13:21 +02001421 }
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001422 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
1423 * anything beyond 2**16 ~ 64K. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001424 if( ssl->in_msg[i] != 0 )
1425 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
Hanno Beckere2734e22019-01-31 07:44:17 +00001427 mbedtls_ssl_send_alert_message( ssl,
1428 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
Dave Rodgman43fcb8d2021-06-28 21:49:15 +01001429 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
1430 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
Paul Bakker5121ce52009-01-03 21:22:43 +00001431 }
1432
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001433 /* Read length of the next CRT in the chain. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001434 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
1435 | (unsigned int) ssl->in_msg[i + 2];
1436 i += 3;
1437
1438 if( n < 128 || i + n > ssl->in_hslen )
1439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001440 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
Hanno Beckere2734e22019-01-31 07:44:17 +00001441 mbedtls_ssl_send_alert_message( ssl,
1442 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1443 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001444 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +00001445 }
1446
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001447 /* Check if we're handling the first CRT in the chain. */
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001448#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
1449 if( crt_cnt++ == 0 &&
1450 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1451 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001452 {
Hanno Becker46f34d02019-02-08 14:00:04 +00001453 /* During client-side renegotiation, check that the server's
1454 * end-CRTs hasn't changed compared to the initial handshake,
1455 * mitigating the triple handshake attack. On success, reuse
1456 * the original end-CRT instead of parsing it again. */
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001457 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
1458 if( ssl_check_peer_crt_unchanged( ssl,
1459 &ssl->in_msg[i],
1460 n ) != 0 )
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001461 {
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
1463 mbedtls_ssl_send_alert_message( ssl,
1464 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
Dave Rodgman43fcb8d2021-06-28 21:49:15 +01001465 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
1466 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001467 }
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001468
1469 /* Now we can safely free the original chain. */
1470 ssl_clear_peer_cert( ssl->session );
1471 }
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001472#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
1473
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001474 /* Parse the next certificate in the chain. */
Hanno Becker0056eab2019-02-08 14:39:16 +00001475#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001476 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
Hanno Becker0056eab2019-02-08 14:39:16 +00001477#else
Hanno Becker353a6f02019-02-26 11:51:34 +00001478 /* If we don't need to store the CRT chain permanently, parse
Hanno Becker0056eab2019-02-08 14:39:16 +00001479 * it in-place from the input buffer instead of making a copy. */
1480 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
1481#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001482 switch( ret )
Paul Bakker5121ce52009-01-03 21:22:43 +00001483 {
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001484 case 0: /*ok*/
1485 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
1486 /* Ignore certificate with an unknown algorithm: maybe a
1487 prior certificate was already trusted. */
1488 break;
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001489
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001490 case MBEDTLS_ERR_X509_ALLOC_FAILED:
1491 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
1492 goto crt_parse_der_failed;
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001493
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001494 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
1495 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
1496 goto crt_parse_der_failed;
Gilles Peskine1cc8e342017-05-03 16:28:34 +02001497
Hanno Beckerdef9bdc2019-01-30 14:46:46 +00001498 default:
1499 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
1500 crt_parse_der_failed:
1501 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
1502 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
1503 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001504 }
1505
1506 i += n;
1507 }
1508
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001509 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001510 return( 0 );
1511}
1512
Hanno Becker4a55f632019-02-05 12:49:06 +00001513#if defined(MBEDTLS_SSL_SRV_C)
1514static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
1515{
1516 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
1517 return( -1 );
1518
Hanno Becker4a55f632019-02-05 12:49:06 +00001519 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
1520 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
1521 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
1522 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
1523 {
1524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
1525 return( 0 );
1526 }
Jerry Yuc3091b12021-12-23 14:57:39 +08001527 return( -1 );
Hanno Becker4a55f632019-02-05 12:49:06 +00001528}
1529#endif /* MBEDTLS_SSL_SRV_C */
1530
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001531/* Check if a certificate message is expected.
1532 * Return either
1533 * - SSL_CERTIFICATE_EXPECTED, or
1534 * - SSL_CERTIFICATE_SKIP
1535 * indicating whether a Certificate message is expected or not.
1536 */
1537#define SSL_CERTIFICATE_EXPECTED 0
1538#define SSL_CERTIFICATE_SKIP 1
1539static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
1540 int authmode )
1541{
1542 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Hanno Beckere694c3e2017-12-27 21:34:08 +00001543 ssl->handshake->ciphersuite_info;
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001544
1545 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
1546 return( SSL_CERTIFICATE_SKIP );
1547
1548#if defined(MBEDTLS_SSL_SRV_C)
1549 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1550 {
1551 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
1552 return( SSL_CERTIFICATE_SKIP );
1553
1554 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
1555 {
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001556 ssl->session_negotiate->verify_result =
1557 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
1558 return( SSL_CERTIFICATE_SKIP );
1559 }
1560 }
Hanno Becker84d9d272019-03-01 08:10:46 +00001561#else
1562 ((void) authmode);
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001563#endif /* MBEDTLS_SSL_SRV_C */
1564
1565 return( SSL_CERTIFICATE_EXPECTED );
1566}
1567
Hanno Becker68636192019-02-05 14:36:34 +00001568static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
1569 int authmode,
1570 mbedtls_x509_crt *chain,
1571 void *rs_ctx )
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001572{
Hanno Becker6bdfab22019-02-05 13:11:17 +00001573 int ret = 0;
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001574 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Hanno Beckere694c3e2017-12-27 21:34:08 +00001575 ssl->handshake->ciphersuite_info;
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001576 int have_ca_chain = 0;
Hanno Becker68636192019-02-05 14:36:34 +00001577
Hanno Becker8927c832019-04-03 12:52:50 +01001578 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
1579 void *p_vrfy;
1580
Hanno Becker68636192019-02-05 14:36:34 +00001581 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
1582 return( 0 );
1583
Hanno Becker8927c832019-04-03 12:52:50 +01001584 if( ssl->f_vrfy != NULL )
1585 {
Hanno Beckerefb440a2019-04-03 13:04:33 +01001586 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
Hanno Becker8927c832019-04-03 12:52:50 +01001587 f_vrfy = ssl->f_vrfy;
1588 p_vrfy = ssl->p_vrfy;
1589 }
1590 else
1591 {
Hanno Beckerefb440a2019-04-03 13:04:33 +01001592 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
Hanno Becker8927c832019-04-03 12:52:50 +01001593 f_vrfy = ssl->conf->f_vrfy;
1594 p_vrfy = ssl->conf->p_vrfy;
1595 }
1596
Hanno Becker68636192019-02-05 14:36:34 +00001597 /*
1598 * Main check: verify certificate
1599 */
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001600#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1601 if( ssl->conf->f_ca_cb != NULL )
1602 {
1603 ((void) rs_ctx);
1604 have_ca_chain = 1;
1605
1606 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
Jarno Lamsa9822c0d2019-04-01 16:59:48 +03001607 ret = mbedtls_x509_crt_verify_with_ca_cb(
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001608 chain,
1609 ssl->conf->f_ca_cb,
1610 ssl->conf->p_ca_cb,
1611 ssl->conf->cert_profile,
1612 ssl->hostname,
1613 &ssl->session_negotiate->verify_result,
Jaeden Amerofe710672019-04-16 15:03:12 +01001614 f_vrfy, p_vrfy );
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001615 }
1616 else
1617#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
1618 {
1619 mbedtls_x509_crt *ca_chain;
1620 mbedtls_x509_crl *ca_crl;
1621
1622#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1623 if( ssl->handshake->sni_ca_chain != NULL )
1624 {
1625 ca_chain = ssl->handshake->sni_ca_chain;
1626 ca_crl = ssl->handshake->sni_ca_crl;
1627 }
1628 else
1629#endif
1630 {
1631 ca_chain = ssl->conf->ca_chain;
1632 ca_crl = ssl->conf->ca_crl;
1633 }
1634
1635 if( ca_chain != NULL )
1636 have_ca_chain = 1;
1637
1638 ret = mbedtls_x509_crt_verify_restartable(
1639 chain,
1640 ca_chain, ca_crl,
1641 ssl->conf->cert_profile,
1642 ssl->hostname,
1643 &ssl->session_negotiate->verify_result,
Jaeden Amerofe710672019-04-16 15:03:12 +01001644 f_vrfy, p_vrfy, rs_ctx );
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001645 }
Hanno Becker68636192019-02-05 14:36:34 +00001646
1647 if( ret != 0 )
1648 {
1649 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
1650 }
1651
Gilles Peskineeccd8882020-03-10 12:19:08 +01001652#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Hanno Becker68636192019-02-05 14:36:34 +00001653 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
1654 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
1655#endif
1656
1657 /*
1658 * Secondary checks: always done, but change 'ret' only if it was 0
1659 */
1660
1661#if defined(MBEDTLS_ECP_C)
1662 {
1663 const mbedtls_pk_context *pk = &chain->pk;
1664
1665 /* If certificate uses an EC key, make sure the curve is OK */
1666 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
1667 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
1668 {
1669 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
1670
1671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
1672 if( ret == 0 )
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001673 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Hanno Becker68636192019-02-05 14:36:34 +00001674 }
1675 }
1676#endif /* MBEDTLS_ECP_C */
1677
1678 if( mbedtls_ssl_check_cert_usage( chain,
1679 ciphersuite_info,
1680 ! ssl->conf->endpoint,
1681 &ssl->session_negotiate->verify_result ) != 0 )
1682 {
1683 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
1684 if( ret == 0 )
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001685 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Hanno Becker68636192019-02-05 14:36:34 +00001686 }
1687
1688 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
1689 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
1690 * with details encoded in the verification flags. All other kinds
1691 * of error codes, including those from the user provided f_vrfy
1692 * functions, are treated as fatal and lead to a failure of
1693 * ssl_parse_certificate even if verification was optional. */
1694 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
1695 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
Hanno Becker9ed1ba52021-06-24 11:03:13 +01001696 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
Hanno Becker68636192019-02-05 14:36:34 +00001697 {
1698 ret = 0;
1699 }
1700
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001701 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
Hanno Becker68636192019-02-05 14:36:34 +00001702 {
1703 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
1704 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
1705 }
1706
1707 if( ret != 0 )
1708 {
1709 uint8_t alert;
1710
1711 /* The certificate may have been rejected for several reasons.
1712 Pick one and send the corresponding alert. Which alert to send
1713 may be a subject of debate in some cases. */
1714 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
1715 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
1716 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
1717 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
1718 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
1719 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
1720 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
1721 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
1722 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
1723 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
1724 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
1725 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
1726 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
1727 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
1728 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
1729 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
1730 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
1731 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
1732 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
1733 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
1734 else
1735 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
1736 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1737 alert );
1738 }
1739
1740#if defined(MBEDTLS_DEBUG_C)
1741 if( ssl->session_negotiate->verify_result != 0 )
1742 {
Paul Elliott3891caf2020-12-17 18:42:40 +00001743 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
Paul Elliott9f352112020-12-09 14:55:45 +00001744 (unsigned int) ssl->session_negotiate->verify_result ) );
Hanno Becker68636192019-02-05 14:36:34 +00001745 }
1746 else
1747 {
1748 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
1749 }
1750#endif /* MBEDTLS_DEBUG_C */
1751
1752 return( ret );
1753}
1754
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001755#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1756static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
1757 unsigned char *start, size_t len )
1758{
Janos Follath865b3eb2019-12-16 11:46:15 +00001759 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001760 /* Remember digest of the peer's end-CRT. */
1761 ssl->session_negotiate->peer_cert_digest =
1762 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
1763 if( ssl->session_negotiate->peer_cert_digest == NULL )
1764 {
1765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
irwir40883e92019-09-21 17:55:33 +03001766 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001767 mbedtls_ssl_send_alert_message( ssl,
1768 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1769 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
1770
1771 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1772 }
1773
1774 ret = mbedtls_md( mbedtls_md_info_from_type(
1775 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
1776 start, len,
1777 ssl->session_negotiate->peer_cert_digest );
1778
1779 ssl->session_negotiate->peer_cert_digest_type =
1780 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1781 ssl->session_negotiate->peer_cert_digest_len =
1782 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1783
1784 return( ret );
1785}
1786
1787static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
1788 unsigned char *start, size_t len )
1789{
1790 unsigned char *end = start + len;
Janos Follath865b3eb2019-12-16 11:46:15 +00001791 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001792
1793 /* Make a copy of the peer's raw public key. */
1794 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
1795 ret = mbedtls_pk_parse_subpubkey( &start, end,
1796 &ssl->handshake->peer_pubkey );
1797 if( ret != 0 )
1798 {
1799 /* We should have parsed the public key before. */
1800 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1801 }
1802
1803 return( 0 );
1804}
1805#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1806
Hanno Becker68636192019-02-05 14:36:34 +00001807int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
1808{
1809 int ret = 0;
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001810 int crt_expected;
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001811#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1812 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
1813 ? ssl->handshake->sni_authmode
1814 : ssl->conf->authmode;
1815#else
Johan Pascal4f099262020-09-22 10:59:26 +02001816 const int authmode = ssl->conf->authmode;
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001817#endif
Manuel Pégourié-Gonnard3bf49c42017-08-15 13:47:06 +02001818 void *rs_ctx = NULL;
Hanno Becker3dad3112019-02-05 17:19:52 +00001819 mbedtls_x509_crt *chain = NULL;
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001820
1821 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
1822
Hanno Becker28f2fcd2019-02-07 10:11:07 +00001823 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
1824 if( crt_expected == SSL_CERTIFICATE_SKIP )
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001825 {
1826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
Hanno Becker6bdfab22019-02-05 13:11:17 +00001827 goto exit;
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001828 }
1829
Gilles Peskineeccd8882020-03-10 12:19:08 +01001830#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard3bf49c42017-08-15 13:47:06 +02001831 if( ssl->handshake->ecrs_enabled &&
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +02001832 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
Manuel Pégourié-Gonnard3bf49c42017-08-15 13:47:06 +02001833 {
Hanno Becker3dad3112019-02-05 17:19:52 +00001834 chain = ssl->handshake->ecrs_peer_cert;
1835 ssl->handshake->ecrs_peer_cert = NULL;
Manuel Pégourié-Gonnard3bf49c42017-08-15 13:47:06 +02001836 goto crt_verify;
1837 }
1838#endif
1839
Manuel Pégourié-Gonnard125af942018-09-11 11:08:12 +02001840 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001841 {
1842 /* mbedtls_ssl_read_record may have sent an alert already. We
1843 let it decide whether to alert. */
1844 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Hanno Becker3dad3112019-02-05 17:19:52 +00001845 goto exit;
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001846 }
1847
Hanno Becker4a55f632019-02-05 12:49:06 +00001848#if defined(MBEDTLS_SSL_SRV_C)
1849 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
1850 {
1851 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
Hanno Becker4a55f632019-02-05 12:49:06 +00001852
irwird3085ab2020-04-21 22:26:05 +03001853 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
Hanno Becker6bdfab22019-02-05 13:11:17 +00001854 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Hanno Becker4a55f632019-02-05 12:49:06 +00001855
Hanno Becker6bdfab22019-02-05 13:11:17 +00001856 goto exit;
Hanno Becker4a55f632019-02-05 12:49:06 +00001857 }
1858#endif /* MBEDTLS_SSL_SRV_C */
1859
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001860 /* Clear existing peer CRT structure in case we tried to
1861 * reuse a session but it failed, and allocate a new one. */
Hanno Becker7a955a02019-02-05 13:08:01 +00001862 ssl_clear_peer_cert( ssl->session_negotiate );
Hanno Becker3dad3112019-02-05 17:19:52 +00001863
1864 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
1865 if( chain == NULL )
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001866 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001868 sizeof( mbedtls_x509_crt ) ) );
1869 mbedtls_ssl_send_alert_message( ssl,
1870 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
1871 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Hanno Becker7a955a02019-02-05 13:08:01 +00001872
Hanno Becker3dad3112019-02-05 17:19:52 +00001873 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
1874 goto exit;
1875 }
1876 mbedtls_x509_crt_init( chain );
1877
1878 ret = ssl_parse_certificate_chain( ssl, chain );
Hanno Beckerc7bd7802019-02-05 15:37:23 +00001879 if( ret != 0 )
Hanno Becker3dad3112019-02-05 17:19:52 +00001880 goto exit;
Manuel Pégourié-Gonnardfed37ed2017-08-15 13:27:41 +02001881
Gilles Peskineeccd8882020-03-10 12:19:08 +01001882#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard3bf49c42017-08-15 13:47:06 +02001883 if( ssl->handshake->ecrs_enabled)
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +02001884 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Manuel Pégourié-Gonnard3bf49c42017-08-15 13:47:06 +02001885
1886crt_verify:
1887 if( ssl->handshake->ecrs_enabled)
1888 rs_ctx = &ssl->handshake->ecrs_ctx;
1889#endif
1890
Hanno Becker68636192019-02-05 14:36:34 +00001891 ret = ssl_parse_certificate_verify( ssl, authmode,
Hanno Becker3dad3112019-02-05 17:19:52 +00001892 chain, rs_ctx );
Hanno Becker68636192019-02-05 14:36:34 +00001893 if( ret != 0 )
Hanno Becker3dad3112019-02-05 17:19:52 +00001894 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00001895
Hanno Becker6bbd94c2019-02-05 17:02:28 +00001896#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker6bbd94c2019-02-05 17:02:28 +00001897 {
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001898 unsigned char *crt_start, *pk_start;
1899 size_t crt_len, pk_len;
Hanno Becker3dad3112019-02-05 17:19:52 +00001900
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001901 /* We parse the CRT chain without copying, so
1902 * these pointers point into the input buffer,
1903 * and are hence still valid after freeing the
1904 * CRT chain. */
Hanno Becker6bbd94c2019-02-05 17:02:28 +00001905
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001906 crt_start = chain->raw.p;
1907 crt_len = chain->raw.len;
Hanno Becker6bbd94c2019-02-05 17:02:28 +00001908
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001909 pk_start = chain->pk_raw.p;
1910 pk_len = chain->pk_raw.len;
1911
1912 /* Free the CRT structures before computing
1913 * digest and copying the peer's public key. */
1914 mbedtls_x509_crt_free( chain );
1915 mbedtls_free( chain );
1916 chain = NULL;
1917
1918 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
Hanno Beckera2747532019-02-06 16:19:04 +00001919 if( ret != 0 )
Hanno Beckera2747532019-02-06 16:19:04 +00001920 goto exit;
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001921
1922 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
1923 if( ret != 0 )
1924 goto exit;
Hanno Beckera2747532019-02-06 16:19:04 +00001925 }
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001926#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1927 /* Pass ownership to session structure. */
Hanno Becker3dad3112019-02-05 17:19:52 +00001928 ssl->session_negotiate->peer_cert = chain;
1929 chain = NULL;
Hanno Becker6b8fbab2019-02-08 14:59:05 +00001930#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker3dad3112019-02-05 17:19:52 +00001931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001933
Hanno Becker6bdfab22019-02-05 13:11:17 +00001934exit:
1935
Hanno Becker3dad3112019-02-05 17:19:52 +00001936 if( ret == 0 )
1937 ssl->state++;
1938
Gilles Peskineeccd8882020-03-10 12:19:08 +01001939#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Hanno Becker3dad3112019-02-05 17:19:52 +00001940 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
1941 {
1942 ssl->handshake->ecrs_peer_cert = chain;
1943 chain = NULL;
1944 }
1945#endif
1946
1947 if( chain != NULL )
1948 {
1949 mbedtls_x509_crt_free( chain );
1950 mbedtls_free( chain );
1951 }
1952
Paul Bakker5121ce52009-01-03 21:22:43 +00001953 return( ret );
1954}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001955#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker5121ce52009-01-03 21:22:43 +00001956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957#if defined(MBEDTLS_SHA256_C)
Paul Bakkerca4ab492012-04-18 14:23:57 +00001958static void ssl_calc_finished_tls_sha256(
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
Paul Bakker1ef83d62012-04-11 12:09:53 +00001960{
1961 int len = 12;
Paul Bakker3c2122f2013-06-24 19:03:14 +02001962 const char *sender;
Paul Bakker1ef83d62012-04-11 12:09:53 +00001963 unsigned char padbuf[32];
Andrzej Kurekeb342242019-01-29 09:14:33 -05001964#if defined(MBEDTLS_USE_PSA_CRYPTO)
1965 size_t hash_size;
Jaeden Amero34973232019-02-20 10:32:28 +00001966 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
Andrzej Kurekeb342242019-01-29 09:14:33 -05001967 psa_status_t status;
1968#else
1969 mbedtls_sha256_context sha256;
1970#endif
Paul Bakker1ef83d62012-04-11 12:09:53 +00001971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 mbedtls_ssl_session *session = ssl->session_negotiate;
Paul Bakker48916f92012-09-16 19:57:18 +00001973 if( !session )
1974 session = ssl->session;
1975
Andrzej Kurekeb342242019-01-29 09:14:33 -05001976 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
1977 ? "client finished"
1978 : "server finished";
1979
1980#if defined(MBEDTLS_USE_PSA_CRYPTO)
1981 sha256_psa = psa_hash_operation_init();
1982
1983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
1984
1985 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
1986 if( status != PSA_SUCCESS )
1987 {
1988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
1989 return;
1990 }
1991
1992 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
1993 if( status != PSA_SUCCESS )
1994 {
1995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
1996 return;
1997 }
1998 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
1999#else
2000
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02002001 mbedtls_sha256_init( &sha256 );
2002
Manuel Pégourié-Gonnardc0bf01e2015-07-06 16:11:18 +02002003 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002004
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02002005 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002006
2007 /*
2008 * TLSv1.2:
2009 * hash = PRF( master, finished_label,
2010 * Hash( handshake ) )[0.11]
2011 */
2012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013#if !defined(MBEDTLS_SHA256_ALT)
2014 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
Manuel Pégourié-Gonnardc0bf01e2015-07-06 16:11:18 +02002015 sha256.state, sizeof( sha256.state ) );
Paul Bakker90995b52013-06-24 19:20:35 +02002016#endif
Paul Bakker1ef83d62012-04-11 12:09:53 +00002017
TRodziewicz26371e42021-06-08 16:45:41 +02002018 mbedtls_sha256_finish( &sha256, padbuf );
Andrzej Kurekeb342242019-01-29 09:14:33 -05002019 mbedtls_sha256_free( &sha256 );
2020#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker1ef83d62012-04-11 12:09:53 +00002021
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +02002022 ssl->handshake->tls_prf( session->master, 48, sender,
Paul Bakker48916f92012-09-16 19:57:18 +00002023 padbuf, 32, buf, len );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002026
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002027 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002030}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031#endif /* MBEDTLS_SHA256_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +00002032
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02002033#if defined(MBEDTLS_SHA384_C)
Rodrigo Dias Corread596ca82020-11-25 00:42:28 -03002034
Paul Bakkerca4ab492012-04-18 14:23:57 +00002035static void ssl_calc_finished_tls_sha384(
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
Paul Bakkerca4ab492012-04-18 14:23:57 +00002037{
2038 int len = 12;
Paul Bakker3c2122f2013-06-24 19:03:14 +02002039 const char *sender;
Rodrigo Dias Corread596ca82020-11-25 00:42:28 -03002040 unsigned char padbuf[48];
Andrzej Kurekeb342242019-01-29 09:14:33 -05002041#if defined(MBEDTLS_USE_PSA_CRYPTO)
2042 size_t hash_size;
Jaeden Amero34973232019-02-20 10:32:28 +00002043 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
Andrzej Kurekeb342242019-01-29 09:14:33 -05002044 psa_status_t status;
2045#else
2046 mbedtls_sha512_context sha512;
2047#endif
Paul Bakkerca4ab492012-04-18 14:23:57 +00002048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 mbedtls_ssl_session *session = ssl->session_negotiate;
Paul Bakker48916f92012-09-16 19:57:18 +00002050 if( !session )
2051 session = ssl->session;
2052
Andrzej Kurekeb342242019-01-29 09:14:33 -05002053 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
2054 ? "client finished"
2055 : "server finished";
2056
2057#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05002058 sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -05002059
2060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
2061
Andrzej Kurek972fba52019-01-30 03:29:12 -05002062 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05002063 if( status != PSA_SUCCESS )
2064 {
2065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
2066 return;
2067 }
2068
Andrzej Kurek972fba52019-01-30 03:29:12 -05002069 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
Andrzej Kurekeb342242019-01-29 09:14:33 -05002070 if( status != PSA_SUCCESS )
2071 {
2072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
2073 return;
2074 }
2075 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
2076#else
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02002077 mbedtls_sha512_init( &sha512 );
2078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002080
Manuel Pégourié-Gonnard001f2b62015-07-06 16:21:13 +02002081 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002082
2083 /*
2084 * TLSv1.2:
2085 * hash = PRF( master, finished_label,
2086 * Hash( handshake ) )[0.11]
2087 */
2088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089#if !defined(MBEDTLS_SHA512_ALT)
Manuel Pégourié-Gonnardc0bf01e2015-07-06 16:11:18 +02002090 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
2091 sha512.state, sizeof( sha512.state ) );
Paul Bakker90995b52013-06-24 19:20:35 +02002092#endif
TRodziewicz26371e42021-06-08 16:45:41 +02002093 mbedtls_sha512_finish( &sha512, padbuf );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002094
Andrzej Kurekeb342242019-01-29 09:14:33 -05002095 mbedtls_sha512_free( &sha512 );
2096#endif
Paul Bakkerca4ab492012-04-18 14:23:57 +00002097
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +02002098 ssl->handshake->tls_prf( session->master, 48, sender,
Paul Bakker48916f92012-09-16 19:57:18 +00002099 padbuf, 48, buf, len );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002102
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002103 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002104
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +00002106}
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02002107#endif /* MBEDTLS_SHA384_C */
Jerry Yuc73c6182022-02-08 20:29:25 +08002108
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00002109void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002110{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002112
2113 /*
2114 * Free our handshake params
2115 */
Gilles Peskine9b562d52018-04-25 20:32:43 +02002116 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 mbedtls_free( ssl->handshake );
Paul Bakker48916f92012-09-16 19:57:18 +00002118 ssl->handshake = NULL;
2119
2120 /*
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002121 * Free the previous transform and swith in the current one
Paul Bakker48916f92012-09-16 19:57:18 +00002122 */
2123 if( ssl->transform )
2124 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 mbedtls_ssl_transform_free( ssl->transform );
2126 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00002127 }
2128 ssl->transform = ssl->transform_negotiate;
2129 ssl->transform_negotiate = NULL;
2130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002132}
2133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002135{
2136 int resume = ssl->handshake->resume;
2137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140#if defined(MBEDTLS_SSL_RENEGOTIATION)
2141 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002144 ssl->renego_records_seen = 0;
2145 }
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002146#endif
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002147
2148 /*
2149 * Free the previous session and switch in the current one
2150 */
Paul Bakker0a597072012-09-25 21:55:46 +00002151 if( ssl->session )
2152 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard1a034732014-11-04 17:36:18 +01002154 /* RFC 7366 3.1: keep the EtM state */
2155 ssl->session_negotiate->encrypt_then_mac =
2156 ssl->session->encrypt_then_mac;
2157#endif
2158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002159 mbedtls_ssl_session_free( ssl->session );
2160 mbedtls_free( ssl->session );
Paul Bakker0a597072012-09-25 21:55:46 +00002161 }
2162 ssl->session = ssl->session_negotiate;
Paul Bakker48916f92012-09-16 19:57:18 +00002163 ssl->session_negotiate = NULL;
2164
Paul Bakker0a597072012-09-25 21:55:46 +00002165 /*
2166 * Add cache entry
2167 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002168 if( ssl->conf->f_set_cache != NULL &&
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +02002169 ssl->session->id_len != 0 &&
Manuel Pégourié-Gonnardc086cce2013-08-02 14:13:02 +02002170 resume == 0 )
2171 {
Hanno Beckerccdaf6e2021-04-15 09:26:17 +01002172 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
2173 ssl->session->id,
2174 ssl->session->id_len,
2175 ssl->session ) != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
Manuel Pégourié-Gonnardc086cce2013-08-02 14:13:02 +02002177 }
Paul Bakker0a597072012-09-25 21:55:46 +00002178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002180 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002181 ssl->handshake->flight != NULL )
2182 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002183 /* Cancel handshake timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002184 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002185
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002186 /* Keep last flight around in case we need to resend it:
2187 * we need the handshake and transform structures for that */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002189 }
2190 else
2191#endif
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00002192 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02002193
Paul Bakker48916f92012-09-16 19:57:18 +00002194 ssl->state++;
2195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002197}
2198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
Paul Bakker1ef83d62012-04-11 12:09:53 +00002200{
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02002201 int ret, hash_len;
Paul Bakker1ef83d62012-04-11 12:09:53 +00002202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002204
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002205 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
Paul Bakker92be97b2013-01-02 17:30:03 +01002206
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002207 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
Paul Bakker1ef83d62012-04-11 12:09:53 +00002208
Manuel Pégourié-Gonnard214a8482016-02-22 11:27:26 +01002209 /*
2210 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
2211 * may define some other value. Currently (early 2016), no defined
2212 * ciphersuite does this (and this is unlikely to change as activity has
2213 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
2214 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002215 hash_len = 12;
Paul Bakker5121ce52009-01-03 21:22:43 +00002216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00002218 ssl->verify_data_len = hash_len;
2219 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002220#endif
Paul Bakker48916f92012-09-16 19:57:18 +00002221
Paul Bakker5121ce52009-01-03 21:22:43 +00002222 ssl->out_msglen = 4 + hash_len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2224 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002225
2226 /*
2227 * In case of session resuming, invert the client and server
2228 * ChangeCipherSpec messages order.
2229 */
Paul Bakker0a597072012-09-25 21:55:46 +00002230 if( ssl->handshake->resume != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002231 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002233 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002234 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01002235#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002237 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01002239#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002240 }
2241 else
2242 ssl->state++;
2243
Paul Bakker48916f92012-09-16 19:57:18 +00002244 /*
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02002245 * Switch to our negotiated transform and session parameters for outbound
2246 * data.
Paul Bakker48916f92012-09-16 19:57:18 +00002247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
Manuel Pégourié-Gonnard5afb1672014-02-16 18:33:22 +01002249
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002251 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02002252 {
2253 unsigned char i;
2254
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002255 /* Remember current epoch settings for resending */
2256 ssl->handshake->alt_transform_out = ssl->transform_out;
Jerry Yud9a94fe2021-09-28 18:58:59 +08002257 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
Jerry Yud96a5c22021-09-29 17:46:51 +08002258 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002259
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02002260 /* Set sequence_number to zero */
Jerry Yufd320e92021-10-08 21:52:41 +08002261 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
Jerry Yud9a94fe2021-09-28 18:58:59 +08002262
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02002263
2264 /* Increment epoch */
2265 for( i = 2; i > 0; i-- )
Hanno Becker19859472018-08-06 09:40:20 +01002266 if( ++ssl->cur_out_ctr[i - 1] != 0 )
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02002267 break;
2268
2269 /* The loop goes to its end iff the counter is wrapping */
2270 if( i == 0 )
2271 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
2273 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard879a4f92014-07-11 22:31:12 +02002274 }
2275 }
2276 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08002278 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002279
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002280 ssl->transform_out = ssl->transform_negotiate;
2281 ssl->session_out = ssl->session_negotiate;
2282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002284 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285 mbedtls_ssl_send_flight_completed( ssl );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002286#endif
2287
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002288 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002289 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002290 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002291 return( ret );
2292 }
2293
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002294#if defined(MBEDTLS_SSL_PROTO_DTLS)
2295 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2296 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2297 {
2298 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
2299 return( ret );
2300 }
2301#endif
2302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002304
2305 return( 0 );
2306}
2307
Manuel Pégourié-Gonnardca6440b2014-09-10 12:39:54 +00002308#define SSL_MAX_HASH_LEN 12
Manuel Pégourié-Gonnardca6440b2014-09-10 12:39:54 +00002309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002311{
Janos Follath865b3eb2019-12-16 11:46:15 +00002312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea4174312021-12-13 14:38:40 +01002313 unsigned int hash_len = 12;
Manuel Pégourié-Gonnardca6440b2014-09-10 12:39:54 +00002314 unsigned char buf[SSL_MAX_HASH_LEN];
Paul Bakker5121ce52009-01-03 21:22:43 +00002315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002317
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002318 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002319
Hanno Becker327c93b2018-08-15 13:56:18 +01002320 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002321 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01002323 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00002324 }
2325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02002329 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
2330 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01002331 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
2332 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00002333 }
2334
Hanno Beckera0ca87e2021-06-24 10:27:37 +01002335 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
2336 {
2337 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
2338 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01002339 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
2340 goto exit;
Hanno Beckera0ca87e2021-06-24 10:27:37 +01002341 }
2342
2343 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
Paul Bakker5121ce52009-01-03 21:22:43 +00002344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02002346 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
2347 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01002348 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
2349 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 }
2351
Gabor Mezei90437e32021-10-20 11:59:27 +02002352 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
Manuel Pégourié-Gonnard4abc3272014-09-10 12:02:46 +00002353 buf, hash_len ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002354 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02002356 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
Dave Rodgman43fcb8d2021-06-28 21:49:15 +01002357 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01002358 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
2359 goto exit;
Paul Bakker5121ce52009-01-03 21:22:43 +00002360 }
2361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00002363 ssl->verify_data_len = hash_len;
2364 memcpy( ssl->peer_verify_data, buf, hash_len );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002365#endif
Paul Bakker48916f92012-09-16 19:57:18 +00002366
Paul Bakker0a597072012-09-25 21:55:46 +00002367 if( ssl->handshake->resume != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002368 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002370 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01002372#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002374 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Manuel Pégourié-Gonnardd16d1cb2014-11-20 18:15:05 +01002376#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002377 }
2378 else
2379 ssl->state++;
2380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002382 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383 mbedtls_ssl_recv_flight_completed( ssl );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002384#endif
2385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002387
Gilles Peskinef0fd4c32021-12-13 12:36:15 +01002388exit:
2389 mbedtls_platform_zeroize( buf, hash_len );
2390 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002391}
2392
Jerry Yuc73c6182022-02-08 20:29:25 +08002393#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002396{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002397 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05002400#if defined(MBEDTLS_USE_PSA_CRYPTO)
2401 handshake->fin_sha256_psa = psa_hash_operation_init();
2402 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
2403#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +02002405 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002406#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05002407#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02002408#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05002409#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05002410 handshake->fin_sha384_psa = psa_hash_operation_init();
2411 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -05002412#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +02002414 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002415#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05002416#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002417
2418 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +01002419
2420#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01002421 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01002422 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
2423#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425#if defined(MBEDTLS_DHM_C)
2426 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428#if defined(MBEDTLS_ECDH_C)
2429 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002430#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002431#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02002432 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02002433#if defined(MBEDTLS_SSL_CLI_C)
2434 handshake->ecjpake_cache = NULL;
2435 handshake->ecjpake_cache_len = 0;
2436#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02002437#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002438
Gilles Peskineeccd8882020-03-10 12:19:08 +01002439#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02002440 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02002441#endif
2442
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002443#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2444 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
2445#endif
Hanno Becker75173122019-02-06 16:18:31 +00002446
2447#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
2448 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
2449 mbedtls_pk_init( &handshake->peer_pubkey );
2450#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002451}
2452
Hanno Beckera18d1322018-01-03 14:27:32 +00002453void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002454{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +02002456
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01002457#if defined(MBEDTLS_USE_PSA_CRYPTO)
2458 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
2459 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01002460#else
2461 mbedtls_cipher_init( &transform->cipher_ctx_enc );
2462 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01002463#endif
2464
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002465#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 mbedtls_md_init( &transform->md_ctx_enc );
2467 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00002468#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002469}
2470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002472{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002474}
2475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002477{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002478 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +00002479 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002481 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002483 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +02002484 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002485
2486 /*
2487 * Either the pointers are now NULL or cleared properly and can be freed.
2488 * Now allocate missing structures.
2489 */
2490 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02002491 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002492 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02002493 }
Paul Bakker48916f92012-09-16 19:57:18 +00002494
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002495 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02002496 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002497 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02002498 }
Paul Bakker48916f92012-09-16 19:57:18 +00002499
Paul Bakker82788fb2014-10-20 13:59:19 +02002500 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02002501 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002502 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02002503 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05002504#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2505 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04002506
Andrzej Kurek4a063792020-10-21 15:08:44 +02002507 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
2508 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05002509#endif
Paul Bakker48916f92012-09-16 19:57:18 +00002510
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002511 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +00002512 if( ssl->handshake == NULL ||
2513 ssl->transform_negotiate == NULL ||
2514 ssl->session_negotiate == NULL )
2515 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002516 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002517
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518 mbedtls_free( ssl->handshake );
2519 mbedtls_free( ssl->transform_negotiate );
2520 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002521
2522 ssl->handshake = NULL;
2523 ssl->transform_negotiate = NULL;
2524 ssl->session_negotiate = NULL;
2525
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002526 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +00002527 }
2528
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002529 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +00002531 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +02002532 ssl_handshake_params_init( ssl->handshake );
2533
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02002535 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2536 {
2537 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002538
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02002539 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
2540 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
2541 else
2542 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002543
Hanno Becker0f57a652020-02-05 10:37:26 +00002544 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02002545 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002546#endif
2547
Brett Warrene0edc842021-08-17 09:53:13 +01002548/*
2549 * curve_list is translated to IANA TLS group identifiers here because
2550 * mbedtls_ssl_conf_curves returns void and so can't return
2551 * any error codes.
2552 */
2553#if defined(MBEDTLS_ECP_C)
2554#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2555 /* Heap allocate and translate curve_list from internal to IANA group ids */
2556 if ( ssl->conf->curve_list != NULL )
2557 {
2558 size_t length;
2559 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
2560
2561 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
2562 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
2563
2564 /* Leave room for zero termination */
2565 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
2566 if ( group_list == NULL )
2567 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2568
2569 for( size_t i = 0; i < length; i++ )
2570 {
2571 const mbedtls_ecp_curve_info *info =
2572 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
2573 if ( info == NULL )
2574 {
2575 mbedtls_free( group_list );
2576 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
2577 }
2578 group_list[i] = info->tls_id;
2579 }
2580
2581 group_list[length] = 0;
2582
2583 ssl->handshake->group_list = group_list;
2584 ssl->handshake->group_list_heap_allocated = 1;
2585 }
2586 else
2587 {
2588 ssl->handshake->group_list = ssl->conf->group_list;
2589 ssl->handshake->group_list_heap_allocated = 0;
2590 }
2591#endif /* MBEDTLS_DEPRECATED_REMOVED */
2592#endif /* MBEDTLS_ECP_C */
2593
Jerry Yuf017ee42022-01-12 15:49:48 +08002594#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2595#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08002596#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08002597 /* Heap allocate and translate sig_hashes from internal hash identifiers to
2598 signature algorithms IANA identifiers. */
2599 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +08002600 ssl->conf->sig_hashes != NULL )
2601 {
2602 const int *md;
2603 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08002604 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08002605 uint16_t *p;
2606
Jerry Yub476a442022-01-21 18:14:45 +08002607#if defined(static_assert)
2608 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
2609 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
2610 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +08002611#endif
2612
Jerry Yuf017ee42022-01-12 15:49:48 +08002613 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
2614 {
2615 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
2616 continue;
Jerry Yub476a442022-01-21 18:14:45 +08002617#if defined(MBEDTLS_ECDSA_C)
2618 sig_algs_len += sizeof( uint16_t );
2619#endif
Jerry Yua68dca22022-01-20 16:28:27 +08002620
Jerry Yub476a442022-01-21 18:14:45 +08002621#if defined(MBEDTLS_RSA_C)
2622 sig_algs_len += sizeof( uint16_t );
2623#endif
2624 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
2625 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +08002626 }
2627
Jerry Yub476a442022-01-21 18:14:45 +08002628 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +08002629 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
2630
Jerry Yub476a442022-01-21 18:14:45 +08002631 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
2632 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +08002633 if( ssl->handshake->sig_algs == NULL )
2634 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2635
2636 p = (uint16_t *)ssl->handshake->sig_algs;
2637 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
2638 {
2639 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
2640 if( hash == MBEDTLS_SSL_HASH_NONE )
2641 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +08002642#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08002643 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
2644 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08002645#endif
2646#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08002647 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
2648 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08002649#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08002650 }
2651 *p = MBEDTLS_TLS1_3_SIG_NONE;
2652 ssl->handshake->sig_algs_heap_allocated = 1;
2653 }
2654 else
Jerry Yua69269a2022-01-17 21:06:01 +08002655#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08002656 {
2657 ssl->handshake->sig_algs = ssl->conf->sig_algs;
2658 ssl->handshake->sig_algs_heap_allocated = 0;
2659 }
2660#endif /* MBEDTLS_DEPRECATED_REMOVED */
2661#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +00002662 return( 0 );
2663}
2664
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002665#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002666/* Dummy cookie callbacks for defaults */
2667static int ssl_cookie_write_dummy( void *ctx,
2668 unsigned char **p, unsigned char *end,
2669 const unsigned char *cli_id, size_t cli_id_len )
2670{
2671 ((void) ctx);
2672 ((void) p);
2673 ((void) end);
2674 ((void) cli_id);
2675 ((void) cli_id_len);
2676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002678}
2679
2680static int ssl_cookie_check_dummy( void *ctx,
2681 const unsigned char *cookie, size_t cookie_len,
2682 const unsigned char *cli_id, size_t cli_id_len )
2683{
2684 ((void) ctx);
2685 ((void) cookie);
2686 ((void) cookie_len);
2687 ((void) cli_id);
2688 ((void) cli_id_len);
2689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002691}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002692#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002693
Paul Bakker5121ce52009-01-03 21:22:43 +00002694/*
2695 * Initialize an SSL context
2696 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02002697void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
2698{
2699 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
2700}
2701
Jerry Yu60835a82021-08-04 10:13:52 +08002702static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
2703{
Ronald Cron6f135e12021-12-08 16:57:54 +01002704#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08002705 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
2706 {
2707 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2708 {
2709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported" ) );
2710 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2711 }
2712 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
2713 return( 0 );
2714 }
2715#endif
2716
2717#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2718 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2719 {
2720 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
2721 return( 0 );
2722 }
2723#endif
2724
Ronald Cron6f135e12021-12-08 16:57:54 +01002725#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08002726 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( ssl->conf ) )
2727 {
2728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Hybrid TLS 1.2 + TLS 1.3 configurations are not yet supported" ) );
2729 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2730 }
2731#endif
2732
2733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
2734 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
2735}
2736
2737static int ssl_conf_check(const mbedtls_ssl_context *ssl)
2738{
2739 int ret;
2740 ret = ssl_conf_version_check( ssl );
2741 if( ret != 0 )
2742 return( ret );
2743
2744 /* Space for further checks */
2745
2746 return( 0 );
2747}
2748
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02002749/*
2750 * Setup an SSL context
2751 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01002752
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02002753int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02002754 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00002755{
Janos Follath865b3eb2019-12-16 11:46:15 +00002756 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00002757 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2758 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00002759
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02002760 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00002761
Jerry Yu60835a82021-08-04 10:13:52 +08002762 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
2763 return( ret );
2764
Paul Bakker62f2dee2012-09-28 07:31:51 +00002765 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002766 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00002767 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02002768
2769 /* Set to NULL in case of an error condition */
2770 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02002771
Darryl Greenb33cc762019-11-28 14:29:44 +00002772#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2773 ssl->in_buf_len = in_buf_len;
2774#endif
2775 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10002776 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002777 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002778 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02002779 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02002780 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10002781 }
2782
Darryl Greenb33cc762019-11-28 14:29:44 +00002783#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2784 ssl->out_buf_len = out_buf_len;
2785#endif
2786 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10002787 if( ssl->out_buf == NULL )
2788 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02002790 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02002791 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00002792 }
2793
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002794 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02002795
Johan Pascalb62bb512015-12-03 21:56:45 +01002796#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02002797 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01002798#endif
2799
Paul Bakker48916f92012-09-16 19:57:18 +00002800 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02002801 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00002802
2803 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02002804
2805error:
2806 mbedtls_free( ssl->in_buf );
2807 mbedtls_free( ssl->out_buf );
2808
2809 ssl->conf = NULL;
2810
Darryl Greenb33cc762019-11-28 14:29:44 +00002811#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2812 ssl->in_buf_len = 0;
2813 ssl->out_buf_len = 0;
2814#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02002815 ssl->in_buf = NULL;
2816 ssl->out_buf = NULL;
2817
2818 ssl->in_hdr = NULL;
2819 ssl->in_ctr = NULL;
2820 ssl->in_len = NULL;
2821 ssl->in_iv = NULL;
2822 ssl->in_msg = NULL;
2823
2824 ssl->out_hdr = NULL;
2825 ssl->out_ctr = NULL;
2826 ssl->out_len = NULL;
2827 ssl->out_iv = NULL;
2828 ssl->out_msg = NULL;
2829
k-stachowiak9f7798e2018-07-31 16:52:32 +02002830 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002831}
2832
2833/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00002834 * Reset an initialized and used SSL context for re-use while retaining
2835 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002836 *
2837 * If partial is non-zero, keep data in the input buffer and client ID.
2838 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00002839 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00002840void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
2841 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00002842{
Darryl Greenb33cc762019-11-28 14:29:44 +00002843#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2844 size_t in_buf_len = ssl->in_buf_len;
2845 size_t out_buf_len = ssl->out_buf_len;
2846#else
2847 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2848 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2849#endif
Paul Bakker48916f92012-09-16 19:57:18 +00002850
Hanno Beckerb0302c42021-08-03 09:39:42 +01002851#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
2852 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01002853#endif
2854
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002855 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002856 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002857
Hanno Beckerb0302c42021-08-03 09:39:42 +01002858 mbedtls_ssl_reset_in_out_pointers( ssl );
2859
2860 /* Reset incoming message parsing */
2861 ssl->in_offt = NULL;
2862 ssl->nb_zero = 0;
2863 ssl->in_msgtype = 0;
2864 ssl->in_msglen = 0;
2865 ssl->in_hslen = 0;
2866 ssl->keep_current_message = 0;
2867 ssl->transform_in = NULL;
2868
2869#if defined(MBEDTLS_SSL_PROTO_DTLS)
2870 ssl->next_record_offset = 0;
2871 ssl->in_epoch = 0;
2872#endif
2873
2874 /* Keep current datagram if partial == 1 */
2875 if( partial == 0 )
2876 {
2877 ssl->in_left = 0;
2878 memset( ssl->in_buf, 0, in_buf_len );
2879 }
2880
2881 /* Reset outgoing message writing */
2882 ssl->out_msgtype = 0;
2883 ssl->out_msglen = 0;
2884 ssl->out_left = 0;
2885 memset( ssl->out_buf, 0, out_buf_len );
2886 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
2887 ssl->transform_out = NULL;
2888
2889#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
2890 mbedtls_ssl_dtls_replay_reset( ssl );
2891#endif
2892
XiaokangQian2b01dc32022-01-21 02:53:13 +00002893#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01002894 if( ssl->transform )
2895 {
2896 mbedtls_ssl_transform_free( ssl->transform );
2897 mbedtls_free( ssl->transform );
2898 ssl->transform = NULL;
2899 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00002900#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2901
XiaokangQian2b01dc32022-01-21 02:53:13 +00002902#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
2903 mbedtls_ssl_transform_free( ssl->transform_application );
2904 mbedtls_free( ssl->transform_application );
2905 ssl->transform_application = NULL;
2906
2907 if( ssl->handshake != NULL )
2908 {
2909 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
2910 mbedtls_free( ssl->handshake->transform_earlydata );
2911 ssl->handshake->transform_earlydata = NULL;
2912
2913 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
2914 mbedtls_free( ssl->handshake->transform_handshake );
2915 ssl->handshake->transform_handshake = NULL;
2916 }
2917
XiaokangQian2b01dc32022-01-21 02:53:13 +00002918#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01002919}
2920
2921int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
2922{
2923 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2924
2925 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
2926
XiaokangQian78b1fa72022-01-19 06:56:30 +00002927 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01002928
2929 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#if defined(MBEDTLS_SSL_RENEGOTIATION)
2931 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002932 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00002933
2934 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
2936 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002937#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00002939
Hanno Beckerb0302c42021-08-03 09:39:42 +01002940 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01002941 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01002942 if( ssl->session )
2943 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944 mbedtls_ssl_session_free( ssl->session );
2945 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01002946 ssl->session = NULL;
2947 }
2948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002950 ssl->alpn_chosen = NULL;
2951#endif
2952
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002953#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01002954#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002955 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01002956#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002957 {
2958 mbedtls_free( ssl->cli_id );
2959 ssl->cli_id = NULL;
2960 ssl->cli_id_len = 0;
2961 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002962#endif
2963
Paul Bakker48916f92012-09-16 19:57:18 +00002964 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2965 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002966
2967 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00002968}
2969
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02002970/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002971 * Reset an initialized and used SSL context for re-use while retaining
2972 * all application-set variables, function pointers and data.
2973 */
2974int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
2975{
Hanno Becker43aefe22020-02-05 10:44:56 +00002976 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02002977}
2978
2979/*
Paul Bakker5121ce52009-01-03 21:22:43 +00002980 * SSL set accessors
2981 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002982void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00002983{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002984 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00002985}
2986
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002987void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002988{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002990}
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002993void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002994{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002995 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002996}
2997#endif
2998
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002999void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003000{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003001 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003002}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01003005
Hanno Becker1841b0a2018-08-24 11:13:57 +01003006void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
3007 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01003008{
3009 ssl->disable_datagram_packing = !allow_packing;
3010}
3011
3012void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
3013 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003014{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003015 conf->hs_timeout_min = min;
3016 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003017}
3018#endif
3019
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003020void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00003021{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003022 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00003023}
3024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003026void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003027 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00003028 void *p_vrfy )
3029{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003030 conf->f_vrfy = f_vrfy;
3031 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00003032}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00003034
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003035void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00003036 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00003037 void *p_rng )
3038{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01003039 conf->f_rng = f_rng;
3040 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00003041}
3042
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003043void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02003044 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00003045 void *p_dbg )
3046{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003047 conf->f_dbg = f_dbg;
3048 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00003049}
3050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02003052 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00003053 mbedtls_ssl_send_t *f_send,
3054 mbedtls_ssl_recv_t *f_recv,
3055 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02003056{
3057 ssl->p_bio = p_bio;
3058 ssl->f_send = f_send;
3059 ssl->f_recv = f_recv;
3060 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01003061}
3062
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003063#if defined(MBEDTLS_SSL_PROTO_DTLS)
3064void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
3065{
3066 ssl->mtu = mtu;
3067}
3068#endif
3069
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003070void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01003071{
3072 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02003073}
3074
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02003075void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
3076 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00003077 mbedtls_ssl_set_timer_t *f_set_timer,
3078 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02003079{
3080 ssl->p_timer = p_timer;
3081 ssl->f_set_timer = f_set_timer;
3082 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02003083
3084 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00003085 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02003086}
3087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003089void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01003090 void *p_cache,
3091 mbedtls_ssl_cache_get_t *f_get_cache,
3092 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00003093{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01003094 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003095 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003096 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00003097}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003099
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100#if defined(MBEDTLS_SSL_CLI_C)
3101int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00003102{
Janos Follath865b3eb2019-12-16 11:46:15 +00003103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003104
3105 if( ssl == NULL ||
3106 session == NULL ||
3107 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003108 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003109 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003111 }
3112
Hanno Beckere810bbc2021-05-14 16:01:05 +01003113 if( ssl->handshake->resume == 1 )
3114 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3115
Hanno Becker52055ae2019-02-06 14:30:46 +00003116 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
3117 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003118 return( ret );
3119
Paul Bakker0a597072012-09-25 21:55:46 +00003120 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003121
3122 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00003123}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003125
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003126void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
3127 const int *ciphersuites )
3128{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01003129 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00003130}
3131
Ronald Cron6f135e12021-12-08 16:57:54 +01003132#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08003133void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01003134 const int kex_modes )
3135{
Xiaofei Bai746f9482021-11-12 08:53:56 +00003136 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01003137}
Ronald Cron6f135e12021-12-08 16:57:54 +01003138#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01003139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003141void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01003142 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003143{
3144 conf->cert_profile = profile;
3145}
3146
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003147/* Append a new keycert entry to a (possibly empty) list */
3148static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
3149 mbedtls_x509_crt *cert,
3150 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003151{
niisato8ee24222018-06-25 19:05:48 +09003152 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003153
niisato8ee24222018-06-25 19:05:48 +09003154 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
3155 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003156 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003157
niisato8ee24222018-06-25 19:05:48 +09003158 new_cert->cert = cert;
3159 new_cert->key = key;
3160 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003161
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003162 /* Update head is the list was null, else add to the end */
3163 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01003164 {
niisato8ee24222018-06-25 19:05:48 +09003165 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01003166 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003167 else
3168 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003169 mbedtls_ssl_key_cert *cur = *head;
3170 while( cur->next != NULL )
3171 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09003172 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003173 }
3174
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003175 return( 0 );
3176}
3177
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003178int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003179 mbedtls_x509_crt *own_cert,
3180 mbedtls_pk_context *pk_key )
3181{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02003182 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003183}
3184
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003185void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003186 mbedtls_x509_crt *ca_chain,
3187 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003188{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003189 conf->ca_chain = ca_chain;
3190 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00003191
3192#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3193 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
3194 * cannot be used together. */
3195 conf->f_ca_cb = NULL;
3196 conf->p_ca_cb = NULL;
3197#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00003198}
Hanno Becker5adaad92019-03-27 16:54:37 +00003199
3200#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3201void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00003202 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00003203 void *p_ca_cb )
3204{
3205 conf->f_ca_cb = f_ca_cb;
3206 conf->p_ca_cb = p_ca_cb;
3207
3208 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
3209 * cannot be used together. */
3210 conf->ca_chain = NULL;
3211 conf->ca_crl = NULL;
3212}
3213#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00003215
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003216#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3217int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
3218 mbedtls_x509_crt *own_cert,
3219 mbedtls_pk_context *pk_key )
3220{
3221 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
3222 own_cert, pk_key ) );
3223}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003224
3225void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
3226 mbedtls_x509_crt *ca_chain,
3227 mbedtls_x509_crl *ca_crl )
3228{
3229 ssl->handshake->sni_ca_chain = ca_chain;
3230 ssl->handshake->sni_ca_crl = ca_crl;
3231}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003232
3233void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
3234 int authmode )
3235{
3236 ssl->handshake->sni_authmode = authmode;
3237}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003238#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3239
Hanno Becker8927c832019-04-03 12:52:50 +01003240#if defined(MBEDTLS_X509_CRT_PARSE_C)
3241void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
3242 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
3243 void *p_vrfy )
3244{
3245 ssl->f_vrfy = f_vrfy;
3246 ssl->p_vrfy = p_vrfy;
3247}
3248#endif
3249
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003250#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003251/*
3252 * Set EC J-PAKE password for current handshake
3253 */
3254int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3255 const unsigned char *pw,
3256 size_t pw_len )
3257{
3258 mbedtls_ecjpake_role role;
3259
Janos Follath8eb64132016-06-03 15:40:57 +01003260 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003261 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3262
3263 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
3264 role = MBEDTLS_ECJPAKE_SERVER;
3265 else
3266 role = MBEDTLS_ECJPAKE_CLIENT;
3267
3268 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
3269 role,
3270 MBEDTLS_MD_SHA256,
3271 MBEDTLS_ECP_DP_SECP256R1,
3272 pw, pw_len ) );
3273}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003274#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003275
Gilles Peskineeccd8882020-03-10 12:19:08 +01003276#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003277
Hanno Becker2ed3dce2021-04-19 21:59:14 +01003278static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
3279{
3280#if defined(MBEDTLS_USE_PSA_CRYPTO)
3281 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
3282 return( 1 );
3283#endif /* MBEDTLS_USE_PSA_CRYPTO */
3284
3285 if( conf->psk != NULL )
3286 return( 1 );
3287
3288 return( 0 );
3289}
3290
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003291static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
3292{
3293 /* Remove reference to existing PSK, if any. */
3294#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02003295 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003296 {
3297 /* The maintenance of the PSK key slot is the
3298 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02003299 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003300 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00003301 /* This and the following branch should never
3302 * be taken simultaenously as we maintain the
3303 * invariant that raw and opaque PSKs are never
3304 * configured simultaneously. As a safeguard,
3305 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003306#endif /* MBEDTLS_USE_PSA_CRYPTO */
3307 if( conf->psk != NULL )
3308 {
3309 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
3310
3311 mbedtls_free( conf->psk );
3312 conf->psk = NULL;
3313 conf->psk_len = 0;
3314 }
3315
3316 /* Remove reference to PSK identity, if any. */
3317 if( conf->psk_identity != NULL )
3318 {
3319 mbedtls_free( conf->psk_identity );
3320 conf->psk_identity = NULL;
3321 conf->psk_identity_len = 0;
3322 }
3323}
3324
Hanno Becker7390c712018-11-15 13:33:04 +00003325/* This function assumes that PSK identity in the SSL config is unset.
3326 * It checks that the provided identity is well-formed and attempts
3327 * to make a copy of it in the SSL config.
3328 * On failure, the PSK identity in the config remains unset. */
3329static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
3330 unsigned char const *psk_identity,
3331 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003332{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02003333 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00003334 if( psk_identity == NULL ||
3335 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10003336 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02003337 {
3338 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3339 }
3340
Hanno Becker7390c712018-11-15 13:33:04 +00003341 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
3342 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003343 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02003344
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01003345 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01003346 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02003347
3348 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02003349}
3350
Hanno Becker7390c712018-11-15 13:33:04 +00003351int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
3352 const unsigned char *psk, size_t psk_len,
3353 const unsigned char *psk_identity, size_t psk_identity_len )
3354{
Janos Follath865b3eb2019-12-16 11:46:15 +00003355 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01003356
3357 /* We currently only support one PSK, raw or opaque. */
3358 if( ssl_conf_psk_is_configured( conf ) )
3359 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00003360
3361 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01003362 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00003363 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01003364 if( psk_len == 0 )
3365 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3366 if( psk_len > MBEDTLS_PSK_MAX_LEN )
3367 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3368
Hanno Becker7390c712018-11-15 13:33:04 +00003369 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
3370 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
3371 conf->psk_len = psk_len;
3372 memcpy( conf->psk, psk, conf->psk_len );
3373
3374 /* Check and set PSK Identity */
3375 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
3376 if( ret != 0 )
3377 ssl_conf_remove_psk( conf );
3378
3379 return( ret );
3380}
3381
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003382static void ssl_remove_psk( mbedtls_ssl_context *ssl )
3383{
3384#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02003385 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003386 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02003387 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003388 }
3389 else
3390#endif /* MBEDTLS_USE_PSA_CRYPTO */
3391 if( ssl->handshake->psk != NULL )
3392 {
3393 mbedtls_platform_zeroize( ssl->handshake->psk,
3394 ssl->handshake->psk_len );
3395 mbedtls_free( ssl->handshake->psk );
3396 ssl->handshake->psk_len = 0;
3397 }
3398}
3399
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003400int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
3401 const unsigned char *psk, size_t psk_len )
3402{
3403 if( psk == NULL || ssl->handshake == NULL )
3404 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3405
3406 if( psk_len > MBEDTLS_PSK_MAX_LEN )
3407 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3408
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003409 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003410
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02003411 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003412 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003413
3414 ssl->handshake->psk_len = psk_len;
3415 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
3416
3417 return( 0 );
3418}
3419
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003420#if defined(MBEDTLS_USE_PSA_CRYPTO)
3421int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01003422 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003423 const unsigned char *psk_identity,
3424 size_t psk_identity_len )
3425{
Janos Follath865b3eb2019-12-16 11:46:15 +00003426 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01003427
3428 /* We currently only support one PSK, raw or opaque. */
3429 if( ssl_conf_psk_is_configured( conf ) )
3430 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003431
Hanno Becker7390c712018-11-15 13:33:04 +00003432 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02003433 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00003434 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02003435 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00003436
3437 /* Check and set PSK Identity */
3438 ret = ssl_conf_set_psk_identity( conf, psk_identity,
3439 psk_identity_len );
3440 if( ret != 0 )
3441 ssl_conf_remove_psk( conf );
3442
3443 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003444}
3445
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01003446int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
3447 mbedtls_svc_key_id_t psk )
3448{
3449 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
3450 ( ssl->handshake == NULL ) )
3451 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3452
3453 ssl_remove_psk( ssl );
3454 ssl->handshake->psk_opaque = psk;
3455 return( 0 );
3456}
3457#endif /* MBEDTLS_USE_PSA_CRYPTO */
3458
3459void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
3460 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3461 size_t),
3462 void *p_psk )
3463{
3464 conf->f_psk = f_psk;
3465 conf->p_psk = p_psk;
3466}
3467#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
3468
3469#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01003470psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01003471 size_t taglen,
3472 psa_algorithm_t *alg,
3473 psa_key_type_t *key_type,
3474 size_t *key_size )
3475{
3476 switch ( mbedtls_cipher_type )
3477 {
3478 case MBEDTLS_CIPHER_AES_128_CBC:
3479 *alg = PSA_ALG_CBC_NO_PADDING;
3480 *key_type = PSA_KEY_TYPE_AES;
3481 *key_size = 128;
3482 break;
3483 case MBEDTLS_CIPHER_AES_128_CCM:
3484 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3485 *key_type = PSA_KEY_TYPE_AES;
3486 *key_size = 128;
3487 break;
3488 case MBEDTLS_CIPHER_AES_128_GCM:
3489 *alg = PSA_ALG_GCM;
3490 *key_type = PSA_KEY_TYPE_AES;
3491 *key_size = 128;
3492 break;
3493 case MBEDTLS_CIPHER_AES_192_CCM:
3494 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3495 *key_type = PSA_KEY_TYPE_AES;
3496 *key_size = 192;
3497 break;
3498 case MBEDTLS_CIPHER_AES_192_GCM:
3499 *alg = PSA_ALG_GCM;
3500 *key_type = PSA_KEY_TYPE_AES;
3501 *key_size = 192;
3502 break;
3503 case MBEDTLS_CIPHER_AES_256_CBC:
3504 *alg = PSA_ALG_CBC_NO_PADDING;
3505 *key_type = PSA_KEY_TYPE_AES;
3506 *key_size = 256;
3507 break;
3508 case MBEDTLS_CIPHER_AES_256_CCM:
3509 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3510 *key_type = PSA_KEY_TYPE_AES;
3511 *key_size = 256;
3512 break;
3513 case MBEDTLS_CIPHER_AES_256_GCM:
3514 *alg = PSA_ALG_GCM;
3515 *key_type = PSA_KEY_TYPE_AES;
3516 *key_size = 256;
3517 break;
3518 case MBEDTLS_CIPHER_ARIA_128_CBC:
3519 *alg = PSA_ALG_CBC_NO_PADDING;
3520 *key_type = PSA_KEY_TYPE_ARIA;
3521 *key_size = 128;
3522 break;
3523 case MBEDTLS_CIPHER_ARIA_128_CCM:
3524 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3525 *key_type = PSA_KEY_TYPE_ARIA;
3526 *key_size = 128;
3527 break;
3528 case MBEDTLS_CIPHER_ARIA_128_GCM:
3529 *alg = PSA_ALG_GCM;
3530 *key_type = PSA_KEY_TYPE_ARIA;
3531 *key_size = 128;
3532 break;
3533 case MBEDTLS_CIPHER_ARIA_192_CCM:
3534 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3535 *key_type = PSA_KEY_TYPE_ARIA;
3536 *key_size = 192;
3537 break;
3538 case MBEDTLS_CIPHER_ARIA_192_GCM:
3539 *alg = PSA_ALG_GCM;
3540 *key_type = PSA_KEY_TYPE_ARIA;
3541 *key_size = 192;
3542 break;
3543 case MBEDTLS_CIPHER_ARIA_256_CBC:
3544 *alg = PSA_ALG_CBC_NO_PADDING;
3545 *key_type = PSA_KEY_TYPE_ARIA;
3546 *key_size = 256;
3547 break;
3548 case MBEDTLS_CIPHER_ARIA_256_CCM:
3549 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3550 *key_type = PSA_KEY_TYPE_ARIA;
3551 *key_size = 256;
3552 break;
3553 case MBEDTLS_CIPHER_ARIA_256_GCM:
3554 *alg = PSA_ALG_GCM;
3555 *key_type = PSA_KEY_TYPE_ARIA;
3556 *key_size = 256;
3557 break;
3558 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
3559 *alg = PSA_ALG_CBC_NO_PADDING;
3560 *key_type = PSA_KEY_TYPE_CAMELLIA;
3561 *key_size = 128;
3562 break;
3563 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
3564 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3565 *key_type = PSA_KEY_TYPE_CAMELLIA;
3566 *key_size = 128;
3567 break;
3568 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
3569 *alg = PSA_ALG_GCM;
3570 *key_type = PSA_KEY_TYPE_CAMELLIA;
3571 *key_size = 128;
3572 break;
3573 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
3574 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3575 *key_type = PSA_KEY_TYPE_CAMELLIA;
3576 *key_size = 192;
3577 break;
3578 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
3579 *alg = PSA_ALG_GCM;
3580 *key_type = PSA_KEY_TYPE_CAMELLIA;
3581 *key_size = 192;
3582 break;
3583 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
3584 *alg = PSA_ALG_CBC_NO_PADDING;
3585 *key_type = PSA_KEY_TYPE_CAMELLIA;
3586 *key_size = 256;
3587 break;
3588 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
3589 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
3590 *key_type = PSA_KEY_TYPE_CAMELLIA;
3591 *key_size = 256;
3592 break;
3593 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
3594 *alg = PSA_ALG_GCM;
3595 *key_type = PSA_KEY_TYPE_CAMELLIA;
3596 *key_size = 256;
3597 break;
3598 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
3599 *alg = PSA_ALG_CHACHA20_POLY1305;
3600 *key_type = PSA_KEY_TYPE_CHACHA20;
3601 *key_size = 256;
3602 break;
3603 case MBEDTLS_CIPHER_NULL:
3604 *alg = MBEDTLS_SSL_NULL_CIPHER;
3605 *key_type = 0;
3606 *key_size = 0;
3607 break;
3608 default:
3609 return PSA_ERROR_NOT_SUPPORTED;
3610 }
3611
3612 return PSA_SUCCESS;
3613}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01003614#endif /* MBEDTLS_USE_PSA_CRYPTO */
3615
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003616#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01003617int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
3618 const unsigned char *dhm_P, size_t P_len,
3619 const unsigned char *dhm_G, size_t G_len )
3620{
Janos Follath865b3eb2019-12-16 11:46:15 +00003621 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01003622
Glenn Strausscee11292021-12-20 01:43:17 -05003623 mbedtls_mpi_free( &conf->dhm_P );
3624 mbedtls_mpi_free( &conf->dhm_G );
3625
Hanno Beckera90658f2017-10-04 15:29:08 +01003626 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
3627 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
3628 {
3629 mbedtls_mpi_free( &conf->dhm_P );
3630 mbedtls_mpi_free( &conf->dhm_G );
3631 return( ret );
3632 }
3633
3634 return( 0 );
3635}
Paul Bakker5121ce52009-01-03 21:22:43 +00003636
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003637int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00003638{
Janos Follath865b3eb2019-12-16 11:46:15 +00003639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00003640
Glenn Strausscee11292021-12-20 01:43:17 -05003641 mbedtls_mpi_free( &conf->dhm_P );
3642 mbedtls_mpi_free( &conf->dhm_G );
3643
Gilles Peskinee5702482021-06-11 21:59:08 +02003644 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
3645 &conf->dhm_P ) ) != 0 ||
3646 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
3647 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01003648 {
3649 mbedtls_mpi_free( &conf->dhm_P );
3650 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00003651 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01003652 }
Paul Bakker1b57b062011-01-06 15:48:19 +00003653
3654 return( 0 );
3655}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003656#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00003657
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003658#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3659/*
3660 * Set the minimum length for Diffie-Hellman parameters
3661 */
3662void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
3663 unsigned int bitlen )
3664{
3665 conf->dhm_min_bitlen = bitlen;
3666}
3667#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3668
Gilles Peskineeccd8882020-03-10 12:19:08 +01003669#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003670#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003671/*
3672 * Set allowed/preferred hashes for handshake signatures
3673 */
3674void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
3675 const int *hashes )
3676{
3677 conf->sig_hashes = hashes;
3678}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003679#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01003680
Jerry Yuf017ee42022-01-12 15:49:48 +08003681/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01003682void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
3683 const uint16_t* sig_algs )
3684{
Jerry Yuf017ee42022-01-12 15:49:48 +08003685#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3686 conf->sig_hashes = NULL;
3687#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3688 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01003689}
Gilles Peskineeccd8882020-03-10 12:19:08 +01003690#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003691
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003692#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01003693#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003694/*
3695 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01003696 *
3697 * mbedtls_ssl_setup() takes the provided list
3698 * and translates it to a list of IANA TLS group identifiers,
3699 * stored in ssl->handshake->group_list.
3700 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003701 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003702void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003703 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003704{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003705 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003706 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003707}
Brett Warrene0edc842021-08-17 09:53:13 +01003708#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01003709#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003710
Brett Warrene0edc842021-08-17 09:53:13 +01003711/*
3712 * Set the allowed groups
3713 */
3714void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
3715 const uint16_t *group_list )
3716{
3717#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
3718 conf->curve_list = NULL;
3719#endif
3720 conf->group_list = group_list;
3721}
3722
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003723#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003724int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00003725{
Hanno Becker947194e2017-04-07 13:25:49 +01003726 /* Initialize to suppress unnecessary compiler warning */
3727 size_t hostname_len = 0;
3728
3729 /* Check if new hostname is valid before
3730 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01003731 if( hostname != NULL )
3732 {
3733 hostname_len = strlen( hostname );
3734
3735 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
3736 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3737 }
3738
3739 /* Now it's clear that we will overwrite the old hostname,
3740 * so we can free it safely */
3741
3742 if( ssl->hostname != NULL )
3743 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003744 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01003745 mbedtls_free( ssl->hostname );
3746 }
3747
3748 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003749
Paul Bakker5121ce52009-01-03 21:22:43 +00003750 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01003751 {
3752 ssl->hostname = NULL;
3753 }
3754 else
3755 {
3756 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01003757 if( ssl->hostname == NULL )
3758 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003759
Hanno Becker947194e2017-04-07 13:25:49 +01003760 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003761
Hanno Becker947194e2017-04-07 13:25:49 +01003762 ssl->hostname[hostname_len] = '\0';
3763 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003764
3765 return( 0 );
3766}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003767#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003768
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003769#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003770void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003771 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003772 const unsigned char *, size_t),
3773 void *p_sni )
3774{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003775 conf->f_sni = f_sni;
3776 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003777}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003779
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003781int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003782{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003783 size_t cur_len, tot_len;
3784 const char **p;
3785
3786 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003787 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3788 * MUST NOT be truncated."
3789 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003790 */
3791 tot_len = 0;
3792 for( p = protos; *p != NULL; p++ )
3793 {
3794 cur_len = strlen( *p );
3795 tot_len += cur_len;
3796
Ronald Cron8216dd32020-04-23 16:41:44 +02003797 if( ( cur_len == 0 ) ||
3798 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
3799 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003801 }
3802
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003803 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003804
3805 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003806}
3807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003809{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003810 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003811}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003812#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003813
Johan Pascalb62bb512015-12-03 21:56:45 +01003814#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03003815void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3816 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02003817{
3818 conf->dtls_srtp_mki_support = support_mki_value;
3819}
3820
Ron Eldoref72faf2018-07-12 11:54:20 +03003821int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
3822 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02003823 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02003824{
Johan Pascal5ef72d22020-10-28 17:05:47 +01003825 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02003826 {
Johan Pascald576fdb2020-09-22 10:39:53 +02003827 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02003828 }
Ron Eldor591f1622018-01-22 12:30:04 +02003829
3830 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02003831 {
Johan Pascald576fdb2020-09-22 10:39:53 +02003832 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02003833 }
Ron Eldor591f1622018-01-22 12:30:04 +02003834
3835 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
3836 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02003837 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02003838}
3839
Ron Eldoref72faf2018-07-12 11:54:20 +03003840int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02003841 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01003842{
Johan Pascal253d0262020-09-22 13:04:45 +02003843 const mbedtls_ssl_srtp_profile *p;
3844 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003845
Johan Pascal253d0262020-09-22 13:04:45 +02003846 /* check the profiles list: all entry must be valid,
3847 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02003848 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3849 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3850 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02003851 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01003852 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02003853 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003854 list_size++;
3855 }
3856 else
3857 {
3858 /* unsupported value, stop parsing and set the size to an error value */
3859 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003860 }
3861 }
3862
Johan Pascal5ef72d22020-10-28 17:05:47 +01003863 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02003864 {
Johan Pascal253d0262020-09-22 13:04:45 +02003865 conf->dtls_srtp_profile_list = NULL;
3866 conf->dtls_srtp_profile_list_len = 0;
3867 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3868 }
3869
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003870 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003871 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003872
3873 return( 0 );
3874}
3875
Johan Pascal5ef72d22020-10-28 17:05:47 +01003876void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
3877 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01003878{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003879 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3880 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01003881 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01003882 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003883 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01003884 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01003885 else
3886 {
3887 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01003888 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3889 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01003890 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003891}
Johan Pascalb62bb512015-12-03 21:56:45 +01003892#endif /* MBEDTLS_SSL_DTLS_SRTP */
3893
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003894void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00003895{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003896 conf->max_major_ver = major;
3897 conf->max_minor_ver = minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003898}
3899
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003900void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00003901{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003902 conf->min_major_ver = major;
3903 conf->min_minor_ver = minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003904}
3905
Janos Follath088ce432017-04-10 12:42:31 +01003906#if defined(MBEDTLS_SSL_SRV_C)
3907void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3908 char cert_req_ca_list )
3909{
3910 conf->cert_req_ca_list = cert_req_ca_list;
3911}
3912#endif
3913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003914#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003915void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003916{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003917 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003918}
3919#endif
3920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003921#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003922void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003923{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003924 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003925}
3926#endif
3927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003928#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003929int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003930{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003931 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10003932 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003933 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003934 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003935 }
3936
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003937 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003938
3939 return( 0 );
3940}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003941#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003942
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003943void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00003944{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003945 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003946}
3947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003948#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003949void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003950{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003951 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003952}
3953
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003954void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003955{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003956 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003957}
3958
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003959void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003960 const unsigned char period[8] )
3961{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003962 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003963}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003964#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003966#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003967#if defined(MBEDTLS_SSL_CLI_C)
3968void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003969{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003970 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003971}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003972#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003973
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003974#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003975void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
3976 mbedtls_ssl_ticket_write_t *f_ticket_write,
3977 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3978 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02003979{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003980 conf->f_ticket_write = f_ticket_write;
3981 conf->f_ticket_parse = f_ticket_parse;
3982 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003983}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003984#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003986
Hanno Becker7e6c1782021-06-08 09:24:55 +01003987void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
3988 mbedtls_ssl_export_keys_t *f_export_keys,
3989 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003990{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003991 ssl->f_export_keys = f_export_keys;
3992 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003993}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003994
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003995#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003996void mbedtls_ssl_conf_async_private_cb(
3997 mbedtls_ssl_config *conf,
3998 mbedtls_ssl_async_sign_t *f_async_sign,
3999 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
4000 mbedtls_ssl_async_resume_t *f_async_resume,
4001 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004002 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01004003{
4004 conf->f_async_sign_start = f_async_sign;
4005 conf->f_async_decrypt_start = f_async_decrypt;
4006 conf->f_async_resume = f_async_resume;
4007 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004008 conf->p_async_config_data = async_config_data;
4009}
4010
Gilles Peskine8f97af72018-04-26 11:46:10 +02004011void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
4012{
4013 return( conf->p_async_config_data );
4014}
4015
Gilles Peskine1febfef2018-04-30 11:54:39 +02004016void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004017{
4018 if( ssl->handshake == NULL )
4019 return( NULL );
4020 else
4021 return( ssl->handshake->user_async_ctx );
4022}
4023
Gilles Peskine1febfef2018-04-30 11:54:39 +02004024void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004025 void *ctx )
4026{
4027 if( ssl->handshake != NULL )
4028 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01004029}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02004030#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01004031
Paul Bakker5121ce52009-01-03 21:22:43 +00004032/*
4033 * SSL get accessors
4034 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004035uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004036{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00004037 if( ssl->session != NULL )
4038 return( ssl->session->verify_result );
4039
4040 if( ssl->session_negotiate != NULL )
4041 return( ssl->session_negotiate->verify_result );
4042
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02004043 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00004044}
4045
Glenn Strauss8f526902022-01-13 00:04:49 -05004046int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
4047{
4048 if( ssl == NULL || ssl->session == NULL )
4049 return( 0 );
4050
4051 return( ssl->session->ciphersuite );
4052}
4053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00004055{
Paul Bakker926c8e42013-03-06 10:23:34 +01004056 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02004057 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01004058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004059 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00004060}
4061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004062const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00004063{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004064#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004065 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01004066 {
4067 switch( ssl->minor_ver )
4068 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004069 case MBEDTLS_SSL_MINOR_VERSION_3:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01004070 return( "DTLSv1.2" );
4071
4072 default:
4073 return( "unknown (DTLS)" );
4074 }
4075 }
4076#endif
4077
Paul Bakker43ca69c2011-01-15 17:35:19 +00004078 switch( ssl->minor_ver )
4079 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004080 case MBEDTLS_SSL_MINOR_VERSION_3:
Paul Bakker1ef83d62012-04-11 12:09:53 +00004081 return( "TLSv1.2" );
4082
Paul Bakker43ca69c2011-01-15 17:35:19 +00004083 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01004084 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00004085 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00004086}
4087
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004088#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004089size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
4090{
David Horstmann95d516f2021-05-04 18:36:56 +01004091 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004092 size_t read_mfl;
4093
4094 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
4095 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4096 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
4097 {
4098 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
4099 }
4100
4101 /* Check if a smaller max length was negotiated */
4102 if( ssl->session_out != NULL )
4103 {
4104 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
4105 if( read_mfl < max_len )
4106 {
4107 max_len = read_mfl;
4108 }
4109 }
4110
4111 // During a handshake, use the value being negotiated
4112 if( ssl->session_negotiate != NULL )
4113 {
4114 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
4115 if( read_mfl < max_len )
4116 {
4117 max_len = read_mfl;
4118 }
4119 }
4120
4121 return( max_len );
4122}
4123
4124size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004125{
4126 size_t max_len;
4127
4128 /*
4129 * Assume mfl_code is correct since it was checked when set
4130 */
Angus Grattond8213d02016-05-25 20:56:48 +10004131 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004132
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02004133 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004134 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10004135 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004136 {
Angus Grattond8213d02016-05-25 20:56:48 +10004137 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004138 }
4139
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02004140 /* During a handshake, use the value being negotiated */
4141 if( ssl->session_negotiate != NULL &&
4142 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
4143 {
4144 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
4145 }
4146
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004147 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02004148}
4149#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4150
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02004151#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00004152size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02004153{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04004154 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
4155 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4156 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
4157 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
4158 return ( 0 );
4159
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02004160 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
4161 return( ssl->mtu );
4162
4163 if( ssl->mtu == 0 )
4164 return( ssl->handshake->mtu );
4165
4166 return( ssl->mtu < ssl->handshake->mtu ?
4167 ssl->mtu : ssl->handshake->mtu );
4168}
4169#endif /* MBEDTLS_SSL_PROTO_DTLS */
4170
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004171int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
4172{
4173 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
4174
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02004175#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
4176 !defined(MBEDTLS_SSL_PROTO_DTLS)
4177 (void) ssl;
4178#endif
4179
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004180#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004181 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004182
4183 if( max_len > mfl )
4184 max_len = mfl;
4185#endif
4186
4187#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00004188 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004189 {
Hanno Becker89490712020-02-05 10:50:12 +00004190 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004191 const int ret = mbedtls_ssl_get_record_expansion( ssl );
4192 const size_t overhead = (size_t) ret;
4193
4194 if( ret < 0 )
4195 return( ret );
4196
4197 if( mtu <= overhead )
4198 {
4199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
4200 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4201 }
4202
4203 if( max_len > mtu - overhead )
4204 max_len = mtu - overhead;
4205 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02004206#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004207
Hanno Becker0defedb2018-08-10 12:35:02 +01004208#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
4209 !defined(MBEDTLS_SSL_PROTO_DTLS)
4210 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004211#endif
4212
4213 return( (int) max_len );
4214}
4215
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004216int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
4217{
4218 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
4219
4220#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4221 (void) ssl;
4222#endif
4223
4224#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4225 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
4226
4227 if( max_len > mfl )
4228 max_len = mfl;
4229#endif
4230
4231 return( (int) max_len );
4232}
4233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004234#if defined(MBEDTLS_X509_CRT_PARSE_C)
4235const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00004236{
4237 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02004238 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00004239
Hanno Beckere6824572019-02-07 13:18:46 +00004240#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02004241 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00004242#else
4243 return( NULL );
4244#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00004245}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004246#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00004247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004248#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00004249int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
4250 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004251{
Hanno Beckere810bbc2021-05-14 16:01:05 +01004252 int ret;
4253
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004254 if( ssl == NULL ||
4255 dst == NULL ||
4256 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004257 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004258 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004260 }
4261
Hanno Beckere810bbc2021-05-14 16:01:05 +01004262 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
4263 * idempotent: Each session can only be exported once.
4264 *
4265 * (This is in preparation for TLS 1.3 support where we will
4266 * need the ability to export multiple sessions (aka tickets),
4267 * which will be achieved by calling mbedtls_ssl_get_session()
4268 * multiple times until it fails.)
4269 *
4270 * Check whether we have already exported the current session,
4271 * and fail if so.
4272 */
4273 if( ssl->session->exported == 1 )
4274 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4275
4276 ret = mbedtls_ssl_session_copy( dst, ssl->session );
4277 if( ret != 0 )
4278 return( ret );
4279
4280 /* Remember that we've exported the session. */
4281 ssl->session->exported = 1;
4282 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004283}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004284#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004285
Paul Bakker5121ce52009-01-03 21:22:43 +00004286/*
Hanno Beckera835da52019-05-16 12:39:07 +01004287 * Define ticket header determining Mbed TLS version
4288 * and structure of the ticket.
4289 */
4290
Hanno Becker94ef3b32019-05-16 12:50:45 +01004291/*
Hanno Becker50b59662019-05-28 14:30:45 +01004292 * Define bitflag determining compile-time settings influencing
4293 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004294 */
4295
Hanno Becker50b59662019-05-28 14:30:45 +01004296#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004297#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004298#else
Hanno Becker3e088662019-05-29 11:10:18 +01004299#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004300#endif /* MBEDTLS_HAVE_TIME */
4301
4302#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004303#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004304#else
Hanno Becker3e088662019-05-29 11:10:18 +01004305#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004306#endif /* MBEDTLS_X509_CRT_PARSE_C */
4307
4308#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004309#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004310#else
Hanno Becker3e088662019-05-29 11:10:18 +01004311#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004312#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4313
4314#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004315#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004316#else
Hanno Becker3e088662019-05-29 11:10:18 +01004317#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004318#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4319
Hanno Becker94ef3b32019-05-16 12:50:45 +01004320#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004321#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004322#else
Hanno Becker3e088662019-05-29 11:10:18 +01004323#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004324#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4325
Hanno Becker94ef3b32019-05-16 12:50:45 +01004326#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4327#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4328#else
4329#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4330#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4331
Hanno Becker3e088662019-05-29 11:10:18 +01004332#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4333#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4334#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4335#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004336#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4337#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01004338
Hanno Becker50b59662019-05-28 14:30:45 +01004339#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01004340 ( (uint16_t) ( \
4341 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
4342 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
4343 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
4344 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01004345 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01004346 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01004347
Hanno Beckerf8787072019-05-16 12:41:07 +01004348static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004349 MBEDTLS_VERSION_MAJOR,
4350 MBEDTLS_VERSION_MINOR,
4351 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01004352 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4353 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01004354};
Hanno Beckera835da52019-05-16 12:39:07 +01004355
4356/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004357 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004358 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004359 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004360 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004361 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004362 * opaque mbedtls_version[3]; // library version: major, minor, patch
4363 * opaque session_format[2]; // library-version specific 16-bit field
4364 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004365 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004366 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004367 * Note: When updating the format, remember to keep
4368 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004369 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004370 * // In this version, `session_format` determines
4371 * // the setting of those compile-time
4372 * // configuration options which influence
4373 * // the structure of mbedtls_ssl_session.
4374 *
Hanno Beckerfa0d61e2021-08-02 08:56:14 +01004375 * uint8_t minor_ver; // Protocol-version. Possible values:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004376 * // - TLS 1.2 (MBEDTLS_SSL_MINOR_VERSION_3)
4377 *
4378 * select (serialized_session.minor_ver) {
4379 *
4380 * case MBEDTLS_SSL_MINOR_VERSION_3: // TLS 1.2
4381 * serialized_session_tls12 data;
4382 *
4383 * };
4384 *
4385 * } serialized_session;
4386 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004387 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004388
4389#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4390/* Serialization of TLS 1.2 sessions:
4391 *
4392 * struct {
4393 * uint64 start_time;
4394 * uint8 ciphersuite[2]; // defined by the standard
4395 * uint8 compression; // 0 or 1
4396 * uint8 session_id_len; // at most 32
4397 * opaque session_id[32];
4398 * opaque master[48]; // fixed length in the standard
4399 * uint32 verify_result;
4400 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4401 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4402 * uint32 ticket_lifetime;
4403 * uint8 mfl_code; // up to 255 according to standard
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004404 * uint8 encrypt_then_mac; // 0 or 1
4405 * } serialized_session_tls12;
4406 *
4407 */
4408static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
4409 unsigned char *buf,
4410 size_t buf_len )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004411{
4412 unsigned char *p = buf;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004413 size_t used = 0;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004414
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004415#if defined(MBEDTLS_HAVE_TIME)
4416 uint64_t start;
4417#endif
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004418#if defined(MBEDTLS_X509_CRT_PARSE_C)
4419#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4420 size_t cert_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004421#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4422#endif /* MBEDTLS_X509_CRT_PARSE_C */
4423
Hanno Beckera835da52019-05-16 12:39:07 +01004424 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004425 * Time
4426 */
4427#if defined(MBEDTLS_HAVE_TIME)
4428 used += 8;
4429
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004430 if( used <= buf_len )
4431 {
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004432 start = (uint64_t) session->start;
4433
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004434 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
4435 p += 8;
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004436 }
4437#endif /* MBEDTLS_HAVE_TIME */
4438
4439 /*
4440 * Basic mandatory fields
4441 */
4442 used += 2 /* ciphersuite */
4443 + 1 /* compression */
4444 + 1 /* id_len */
4445 + sizeof( session->id )
4446 + sizeof( session->master )
4447 + 4; /* verify_result */
4448
4449 if( used <= buf_len )
4450 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004451 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
4452 p += 2;
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004453
Joe Subbiani2194dc42021-07-14 12:31:31 +01004454 *p++ = MBEDTLS_BYTE_0( session->compression );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004455
Joe Subbiani2194dc42021-07-14 12:31:31 +01004456 *p++ = MBEDTLS_BYTE_0( session->id_len );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004457 memcpy( p, session->id, 32 );
4458 p += 32;
4459
4460 memcpy( p, session->master, 48 );
4461 p += 48;
4462
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004463 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
4464 p += 4;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004465 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004466
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004467 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004468 * Peer's end-entity certificate
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004469 */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004470#if defined(MBEDTLS_X509_CRT_PARSE_C)
4471#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4472 if( session->peer_cert == NULL )
4473 cert_len = 0;
4474 else
4475 cert_len = session->peer_cert->raw.len;
4476
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004477 used += 3 + cert_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004478
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004479 if( used <= buf_len )
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004480 {
Joe Subbiani2194dc42021-07-14 12:31:31 +01004481 *p++ = MBEDTLS_BYTE_2( cert_len );
4482 *p++ = MBEDTLS_BYTE_1( cert_len );
4483 *p++ = MBEDTLS_BYTE_0( cert_len );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004484
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004485 if( session->peer_cert != NULL )
4486 {
4487 memcpy( p, session->peer_cert->raw.p, cert_len );
4488 p += cert_len;
4489 }
4490 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004492 if( session->peer_cert_digest != NULL )
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004493 {
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004494 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
4495 if( used <= buf_len )
4496 {
4497 *p++ = (unsigned char) session->peer_cert_digest_type;
4498 *p++ = (unsigned char) session->peer_cert_digest_len;
4499 memcpy( p, session->peer_cert_digest,
4500 session->peer_cert_digest_len );
4501 p += session->peer_cert_digest_len;
4502 }
4503 }
4504 else
4505 {
4506 used += 2;
4507 if( used <= buf_len )
4508 {
4509 *p++ = (unsigned char) MBEDTLS_MD_NONE;
4510 *p++ = 0;
4511 }
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004512 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004513#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4514#endif /* MBEDTLS_X509_CRT_PARSE_C */
4515
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004516 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004517 * Session ticket if any, plus associated data
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004518 */
4519#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004520 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004521
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004522 if( used <= buf_len )
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004523 {
Joe Subbiani2194dc42021-07-14 12:31:31 +01004524 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
4525 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
4526 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004527
4528 if( session->ticket != NULL )
4529 {
4530 memcpy( p, session->ticket, session->ticket_len );
4531 p += session->ticket_len;
4532 }
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004533
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004534 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
4535 p += 4;
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004536 }
4537#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
4538
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004539 /*
4540 * Misc extension-related info
4541 */
4542#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4543 used += 1;
4544
4545 if( used <= buf_len )
4546 *p++ = session->mfl_code;
4547#endif
4548
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004549#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4550 used += 1;
4551
4552 if( used <= buf_len )
Joe Subbiani2194dc42021-07-14 12:31:31 +01004553 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004554#endif
4555
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004556 return( used );
4557}
4558#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004559
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004560static int ssl_session_save( const mbedtls_ssl_session *session,
4561 unsigned char omit_header,
4562 unsigned char *buf,
4563 size_t buf_len,
4564 size_t *olen )
4565{
4566 unsigned char *p = buf;
4567 size_t used = 0;
4568
4569 if( !omit_header )
4570 {
4571 /*
4572 * Add Mbed TLS version identifier
4573 */
4574
4575 used += sizeof( ssl_serialized_session_header );
4576
4577 if( used <= buf_len )
4578 {
4579 memcpy( p, ssl_serialized_session_header,
4580 sizeof( ssl_serialized_session_header ) );
4581 p += sizeof( ssl_serialized_session_header );
4582 }
4583 }
4584
4585 /*
4586 * TLS version identifier
4587 */
4588 used += 1;
4589 if( used <= buf_len )
4590 {
4591 *p++ = session->minor_ver;
4592 }
4593
4594 /* Forward to version-specific serialization routine. */
4595 switch( session->minor_ver )
4596 {
4597#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4598 case MBEDTLS_SSL_MINOR_VERSION_3:
4599 {
4600 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
4601 used += ssl_session_save_tls12( session, p, remaining_len );
4602 break;
4603 }
4604#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4605
4606 default:
4607 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4608 }
4609
4610 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02004611 if( used > buf_len )
4612 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004613
4614 return( 0 );
4615}
4616
4617/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004618 * Public wrapper for ssl_session_save()
4619 */
4620int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
4621 unsigned char *buf,
4622 size_t buf_len,
4623 size_t *olen )
4624{
4625 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
4626}
Jerry Yuc3091b12021-12-23 14:57:39 +08004627#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004628/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004629 * Deserialize session, see mbedtls_ssl_session_save() for format.
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004630 *
4631 * This internal version is wrapped by a public function that cleans up in
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004632 * case of error, and has an extra option omit_header.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004633 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004634static int ssl_session_load_tls12( mbedtls_ssl_session *session,
4635 const unsigned char *buf,
4636 size_t len )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004637{
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004638#if defined(MBEDTLS_HAVE_TIME)
4639 uint64_t start;
4640#endif
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004641#if defined(MBEDTLS_X509_CRT_PARSE_C)
4642#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4643 size_t cert_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004644#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4645#endif /* MBEDTLS_X509_CRT_PARSE_C */
4646
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004647 const unsigned char *p = buf;
4648 const unsigned char * const end = buf + len;
Hanno Beckera835da52019-05-16 12:39:07 +01004649
4650 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004651 * Time
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004652 */
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004653#if defined(MBEDTLS_HAVE_TIME)
4654 if( 8 > (size_t)( end - p ) )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004655 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4656
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004657 start = ( (uint64_t) p[0] << 56 ) |
4658 ( (uint64_t) p[1] << 48 ) |
4659 ( (uint64_t) p[2] << 40 ) |
4660 ( (uint64_t) p[3] << 32 ) |
4661 ( (uint64_t) p[4] << 24 ) |
4662 ( (uint64_t) p[5] << 16 ) |
4663 ( (uint64_t) p[6] << 8 ) |
4664 ( (uint64_t) p[7] );
4665 p += 8;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004666
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004667 session->start = (time_t) start;
4668#endif /* MBEDTLS_HAVE_TIME */
4669
4670 /*
4671 * Basic mandatory fields
4672 */
4673 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
4674 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4675
4676 session->ciphersuite = ( p[0] << 8 ) | p[1];
4677 p += 2;
4678
4679 session->compression = *p++;
4680
4681 session->id_len = *p++;
4682 memcpy( session->id, p, 32 );
4683 p += 32;
4684
4685 memcpy( session->master, p, 48 );
4686 p += 48;
4687
4688 session->verify_result = ( (uint32_t) p[0] << 24 ) |
4689 ( (uint32_t) p[1] << 16 ) |
4690 ( (uint32_t) p[2] << 8 ) |
4691 ( (uint32_t) p[3] );
4692 p += 4;
4693
4694 /* Immediately clear invalid pointer values that have been read, in case
4695 * we exit early before we replaced them with valid ones. */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004696#if defined(MBEDTLS_X509_CRT_PARSE_C)
4697#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4698 session->peer_cert = NULL;
4699#else
4700 session->peer_cert_digest = NULL;
4701#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4702#endif /* MBEDTLS_X509_CRT_PARSE_C */
4703#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
4704 session->ticket = NULL;
4705#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
4706
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004707 /*
4708 * Peer certificate
4709 */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004710#if defined(MBEDTLS_X509_CRT_PARSE_C)
4711#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4712 /* Deserialize CRT from the end of the ticket. */
4713 if( 3 > (size_t)( end - p ) )
4714 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4715
4716 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
4717 p += 3;
4718
4719 if( cert_len != 0 )
4720 {
Janos Follath865b3eb2019-12-16 11:46:15 +00004721 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004722
4723 if( cert_len > (size_t)( end - p ) )
4724 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4725
4726 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
4727
4728 if( session->peer_cert == NULL )
4729 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
4730
4731 mbedtls_x509_crt_init( session->peer_cert );
4732
4733 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
4734 p, cert_len ) ) != 0 )
4735 {
4736 mbedtls_x509_crt_free( session->peer_cert );
4737 mbedtls_free( session->peer_cert );
4738 session->peer_cert = NULL;
4739 return( ret );
4740 }
4741
4742 p += cert_len;
4743 }
4744#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4745 /* Deserialize CRT digest from the end of the ticket. */
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004746 if( 2 > (size_t)( end - p ) )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4748
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004749 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
4750 session->peer_cert_digest_len = (size_t) *p++;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004751
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004752 if( session->peer_cert_digest_len != 0 )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004753 {
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004754 const mbedtls_md_info_t *md_info =
4755 mbedtls_md_info_from_type( session->peer_cert_digest_type );
4756 if( md_info == NULL )
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004758 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
4759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004760
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004761 if( session->peer_cert_digest_len > (size_t)( end - p ) )
4762 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4763
4764 session->peer_cert_digest =
4765 mbedtls_calloc( 1, session->peer_cert_digest_len );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004766 if( session->peer_cert_digest == NULL )
4767 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
4768
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004769 memcpy( session->peer_cert_digest, p,
4770 session->peer_cert_digest_len );
4771 p += session->peer_cert_digest_len;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004772 }
4773#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4774#endif /* MBEDTLS_X509_CRT_PARSE_C */
4775
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004776 /*
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004777 * Session ticket and associated data
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004778 */
4779#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
4780 if( 3 > (size_t)( end - p ) )
4781 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4782
4783 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
4784 p += 3;
4785
4786 if( session->ticket_len != 0 )
4787 {
4788 if( session->ticket_len > (size_t)( end - p ) )
4789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4790
4791 session->ticket = mbedtls_calloc( 1, session->ticket_len );
4792 if( session->ticket == NULL )
4793 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
4794
4795 memcpy( session->ticket, p, session->ticket_len );
4796 p += session->ticket_len;
4797 }
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004798
4799 if( 4 > (size_t)( end - p ) )
4800 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4801
4802 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
4803 ( (uint32_t) p[1] << 16 ) |
4804 ( (uint32_t) p[2] << 8 ) |
4805 ( (uint32_t) p[3] );
4806 p += 4;
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004807#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
4808
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004809 /*
4810 * Misc extension-related info
4811 */
4812#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4813 if( 1 > (size_t)( end - p ) )
4814 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4815
4816 session->mfl_code = *p++;
4817#endif
4818
Manuel Pégourié-Gonnardf743c032019-05-24 12:06:29 +02004819#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4820 if( 1 > (size_t)( end - p ) )
4821 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4822
4823 session->encrypt_then_mac = *p++;
4824#endif
4825
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004826 /* Done, should have consumed entire buffer */
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004827 if( p != end )
4828 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4829
4830 return( 0 );
4831}
Jerry Yuc5aef882021-12-23 20:15:02 +08004832#endif /*MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004833static int ssl_session_load( mbedtls_ssl_session *session,
4834 unsigned char omit_header,
4835 const unsigned char *buf,
4836 size_t len )
4837{
4838 const unsigned char *p = buf;
4839 const unsigned char * const end = buf + len;
4840
4841 if( !omit_header )
4842 {
4843 /*
4844 * Check Mbed TLS version identifier
4845 */
4846
4847 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
4848 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4849
4850 if( memcmp( p, ssl_serialized_session_header,
4851 sizeof( ssl_serialized_session_header ) ) != 0 )
4852 {
4853 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
4854 }
4855 p += sizeof( ssl_serialized_session_header );
4856 }
4857
4858 /*
4859 * TLS version identifier
4860 */
4861 if( 1 > (size_t)( end - p ) )
4862 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4863 session->minor_ver = *p++;
4864
4865 /* Dispatch according to TLS version. */
4866 switch( session->minor_ver )
4867 {
4868#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4869 case MBEDTLS_SSL_MINOR_VERSION_3: /* TLS 1.2 */
4870 {
4871 size_t remaining_len = ( end - p );
4872 return( ssl_session_load_tls12( session, p, remaining_len ) );
4873 }
4874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4875
4876 default:
4877 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4878 }
4879}
4880
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004881/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004882 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004883 */
4884int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
4885 const unsigned char *buf,
4886 size_t len )
4887{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004888 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004889
4890 if( ret != 0 )
4891 mbedtls_ssl_session_free( session );
4892
4893 return( ret );
4894}
4895
4896/*
Paul Bakker1961b702013-01-25 14:49:24 +01004897 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004898 */
Hanno Becker41934dd2021-08-07 19:13:43 +01004899static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
4900{
4901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4902
4903 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
4904 return( ret );
4905
4906#if defined(MBEDTLS_SSL_PROTO_DTLS)
4907 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4908 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
4909 {
4910 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
4911 return( ret );
4912 }
4913#endif /* MBEDTLS_SSL_PROTO_DTLS */
4914
4915 return( ret );
4916}
4917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004918int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004919{
Hanno Becker41934dd2021-08-07 19:13:43 +01004920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004921
Hanno Becker41934dd2021-08-07 19:13:43 +01004922 if( ssl == NULL ||
4923 ssl->conf == NULL ||
4924 ssl->handshake == NULL ||
4925 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4926 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004927 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01004928 }
4929
4930 ret = ssl_prepare_handshake_step( ssl );
4931 if( ret != 0 )
4932 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004933
Jerry Yue7047812021-09-13 19:26:39 +08004934 ret = mbedtls_ssl_handle_pending_alert( ssl );
4935 if( ret != 0 )
4936 goto cleanup;
4937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004938#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004939 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08004940 {
Ronald Cron6f135e12021-12-08 16:57:54 +01004941#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08004942 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yuf4436812021-08-26 22:59:56 +08004943 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01004944#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08004945
4946#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4947 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
4948 ret = mbedtls_ssl_handshake_client_step( ssl );
4949#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4950 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004951#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004952#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004953 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08004954 {
Ronald Cron6f135e12021-12-08 16:57:54 +01004955#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08004956 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08004957 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01004958#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08004959
4960#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4961 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
4962 ret = mbedtls_ssl_handshake_server_step( ssl );
4963#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4964 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004965#endif
4966
Jerry Yue7047812021-09-13 19:26:39 +08004967 if( ret != 0 )
4968 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004969 /* handshake_step return error. And it is same
4970 * with alert_reason.
4971 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08004972 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08004973 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08004974 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08004975 goto cleanup;
4976 }
4977 }
4978
4979cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01004980 return( ret );
4981}
4982
4983/*
4984 * Perform the SSL handshake
4985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01004987{
4988 int ret = 0;
4989
Hanno Beckera817ea42020-10-20 15:20:23 +01004990 /* Sanity checks */
4991
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004992 if( ssl == NULL || ssl->conf == NULL )
4993 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4994
Hanno Beckera817ea42020-10-20 15:20:23 +01004995#if defined(MBEDTLS_SSL_PROTO_DTLS)
4996 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4997 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
4998 {
4999 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
5000 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
5001 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5002 }
5003#endif /* MBEDTLS_SSL_PROTO_DTLS */
5004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01005006
Hanno Beckera817ea42020-10-20 15:20:23 +01005007 /* Main handshake loop */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005008 while( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker1961b702013-01-25 14:49:24 +01005009 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01005011
5012 if( ret != 0 )
5013 break;
5014 }
5015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005017
5018 return( ret );
5019}
5020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021#if defined(MBEDTLS_SSL_RENEGOTIATION)
5022#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00005023/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005024 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00005025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005026static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005027{
Janos Follath865b3eb2019-12-16 11:46:15 +00005028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005031
5032 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005033 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5034 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005035
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005036 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005037 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005038 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005039 return( ret );
5040 }
5041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005043
5044 return( 0 );
5045}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005047
5048/*
5049 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005050 * - any side: calling mbedtls_ssl_renegotiate(),
5051 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
5052 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02005053 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005054 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005055 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005056 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00005057int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00005058{
Janos Follath865b3eb2019-12-16 11:46:15 +00005059 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00005060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005062
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005063 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
5064 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005065
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02005066 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
5067 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005069 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005070 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02005071 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005072 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02005073 ssl->handshake->out_msg_seq = 1;
5074 else
5075 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02005076 }
5077#endif
5078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005079 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
5080 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00005081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005082 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005083 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005084 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005085 return( ret );
5086 }
5087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005089
5090 return( 0 );
5091}
5092
5093/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005094 * Renegotiate current connection on client,
5095 * or request renegotiation on server
5096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005097int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005098{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005100
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005101 if( ssl == NULL || ssl->conf == NULL )
5102 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005104#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005105 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005106 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005107 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005108 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
5109 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005111 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02005112
5113 /* Did we already try/start sending HelloRequest? */
5114 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005115 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02005116
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005117 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005118 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005121#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005122 /*
5123 * On client, either start the renegotiation process or,
5124 * if already in progress, continue the handshake
5125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005126 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005127 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005128 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
5129 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005130
Hanno Becker40cdaa12020-02-05 10:48:27 +00005131 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005132 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005133 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005134 return( ret );
5135 }
5136 }
5137 else
5138 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005139 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005140 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005141 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005142 return( ret );
5143 }
5144 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005145#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005146
Paul Bakker37ce0ff2013-10-31 14:32:04 +01005147 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005148}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005149#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005151#if defined(MBEDTLS_X509_CRT_PARSE_C)
5152static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02005153{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154 mbedtls_ssl_key_cert *cur = key_cert, *next;
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02005155
5156 while( cur != NULL )
5157 {
5158 next = cur->next;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005159 mbedtls_free( cur );
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02005160 cur = next;
5161 }
5162}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005163#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02005164
Gilles Peskine9b562d52018-04-25 20:32:43 +02005165void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00005166{
Gilles Peskine9b562d52018-04-25 20:32:43 +02005167 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
5168
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005169 if( handshake == NULL )
5170 return;
5171
Brett Warrene0edc842021-08-17 09:53:13 +01005172#if defined(MBEDTLS_ECP_C)
5173#if !defined(MBEDTLS_DEPRECATED_REMOVED)
5174 if ( ssl->handshake->group_list_heap_allocated )
5175 mbedtls_free( (void*) handshake->group_list );
5176 handshake->group_list = NULL;
5177#endif /* MBEDTLS_DEPRECATED_REMOVED */
5178#endif /* MBEDTLS_ECP_C */
5179
Jerry Yuf017ee42022-01-12 15:49:48 +08005180#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5181#if !defined(MBEDTLS_DEPRECATED_REMOVED)
5182 if ( ssl->handshake->sig_algs_heap_allocated )
5183 mbedtls_free( (void*) handshake->sig_algs );
5184 handshake->sig_algs = NULL;
5185#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00005186#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5187 if( ssl->handshake->certificate_request_context )
5188 {
5189 mbedtls_free( (void*) handshake->certificate_request_context );
5190 }
5191#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08005192#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5193
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02005194#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
5195 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
5196 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02005197 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02005198 handshake->async_in_progress = 0;
5199 }
5200#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
5201
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02005202#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05005203#if defined(MBEDTLS_USE_PSA_CRYPTO)
5204 psa_hash_abort( &handshake->fin_sha256_psa );
5205#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02005206 mbedtls_sha256_free( &handshake->fin_sha256 );
5207#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05005208#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02005209#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05005210#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05005211 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05005212#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02005213 mbedtls_sha512_free( &handshake->fin_sha512 );
5214#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05005215#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02005216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005217#if defined(MBEDTLS_DHM_C)
5218 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00005219#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005220#if defined(MBEDTLS_ECDH_C)
5221 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02005222#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02005223#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02005224 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02005225#if defined(MBEDTLS_SSL_CLI_C)
5226 mbedtls_free( handshake->ecjpake_cache );
5227 handshake->ecjpake_cache = NULL;
5228 handshake->ecjpake_cache_len = 0;
5229#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02005230#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005231
Janos Follath4ae5c292016-02-10 11:27:43 +00005232#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
5233 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02005234 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005235 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02005236#endif
5237
Gilles Peskineeccd8882020-03-10 12:19:08 +01005238#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01005239 if( handshake->psk != NULL )
5240 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005241 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01005242 mbedtls_free( handshake->psk );
5243 }
5244#endif
5245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005246#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
5247 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02005248 /*
5249 * Free only the linked list wrapper, not the keys themselves
5250 * since the belong to the SNI callback
5251 */
5252 if( handshake->sni_key_cert != NULL )
5253 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005254 mbedtls_ssl_key_cert *cur = handshake->sni_key_cert, *next;
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02005255
5256 while( cur != NULL )
5257 {
5258 next = cur->next;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005259 mbedtls_free( cur );
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02005260 cur = next;
5261 }
5262 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02005264
Gilles Peskineeccd8882020-03-10 12:19:08 +01005265#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02005266 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00005267 if( handshake->ecrs_peer_cert != NULL )
5268 {
5269 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
5270 mbedtls_free( handshake->ecrs_peer_cert );
5271 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02005272#endif
5273
Hanno Becker75173122019-02-06 16:18:31 +00005274#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
5275 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5276 mbedtls_pk_free( &handshake->peer_pubkey );
5277#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5278
XiaokangQian34909742022-01-27 02:25:04 +00005279#if defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005280 mbedtls_free( handshake->verify_cookie );
XiaokangQian8499b6c2022-01-27 09:00:11 +00005281#endif /* MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 */
5282
5283#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00005284 mbedtls_ssl_flight_free( handshake->flight );
5285 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00005286#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02005287
Hanno Becker4a63ed42019-01-08 11:39:35 +00005288#if defined(MBEDTLS_ECDH_C) && \
5289 defined(MBEDTLS_USE_PSA_CRYPTO)
5290 psa_destroy_key( handshake->ecdh_psa_privkey );
5291#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
5292
Ronald Cron6f135e12021-12-08 16:57:54 +01005293#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08005294 mbedtls_ssl_transform_free( handshake->transform_handshake );
5295 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08005296 mbedtls_free( handshake->transform_earlydata );
5297 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01005298#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08005299
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005300
5301#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5302 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
5303 * processes datagrams and the fact that a datagram is allowed to have
5304 * several records in it, it is possible that the I/O buffers are not
5305 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02005306 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
5307 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005308#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01005309
Jerry Yuba9c7272021-10-30 11:54:10 +08005310 /* mbedtls_platform_zeroize MUST be last one in this function */
5311 mbedtls_platform_zeroize( handshake,
5312 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005313}
5314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005315void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00005316{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005317 if( session == NULL )
5318 return;
5319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005320#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00005321 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02005322#endif
Paul Bakker0a597072012-09-25 21:55:46 +00005323
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02005324#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005325 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02005326#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02005327
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005328 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005329}
5330
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005331#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005332
5333#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5334#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
5335#else
5336#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
5337#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5338
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005339#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005340
5341#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5342#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
5343#else
5344#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
5345#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5346
5347#if defined(MBEDTLS_SSL_ALPN)
5348#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
5349#else
5350#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
5351#endif /* MBEDTLS_SSL_ALPN */
5352
5353#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
5354#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
5355#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
5356#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
5357
5358#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
5359 ( (uint32_t) ( \
5360 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
5361 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
5362 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
5363 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
5364 0u ) )
5365
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005366static unsigned char ssl_serialized_context_header[] = {
5367 MBEDTLS_VERSION_MAJOR,
5368 MBEDTLS_VERSION_MINOR,
5369 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01005370 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
5371 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
5372 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
5373 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
5374 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005375};
5376
Paul Bakker5121ce52009-01-03 21:22:43 +00005377/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005378 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005379 *
5380 * The format of the serialized data is:
5381 * (in the presentation language of TLS, RFC 8446 section 3)
5382 *
5383 * // header
5384 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005385 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005386 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005387 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005388 * Note: When updating the format, remember to keep these
5389 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005390 *
5391 * // session sub-structure
5392 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5393 * // transform sub-structure
5394 * uint8 random[64]; // ServerHello.random+ClientHello.random
5395 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5396 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5397 * // fields from ssl_context
5398 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5399 * uint64 in_window_top; // DTLS: last validated record seq_num
5400 * uint64 in_window; // DTLS: bitmask for replay protection
5401 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5402 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5403 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5404 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5405 *
5406 * Note that many fields of the ssl_context or sub-structures are not
5407 * serialized, as they fall in one of the following categories:
5408 *
5409 * 1. forced value (eg in_left must be 0)
5410 * 2. pointer to dynamically-allocated memory (eg session, transform)
5411 * 3. value can be re-derived from other data (eg session keys from MS)
5412 * 4. value was temporary (eg content of input buffer)
5413 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005414 */
5415int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
5416 unsigned char *buf,
5417 size_t buf_len,
5418 size_t *olen )
5419{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005420 unsigned char *p = buf;
5421 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005422 size_t session_len;
5423 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005424
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005425 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005426 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5427 * this function's documentation.
5428 *
5429 * These are due to assumptions/limitations in the implementation. Some of
5430 * them are likely to stay (no handshake in progress) some might go away
5431 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005432 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005433 /* The initial handshake must be over */
5434 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005435 {
5436 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005437 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005438 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005439 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005440 {
5441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005442 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005443 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005444 /* Double-check that sub-structures are indeed ready */
5445 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005446 {
5447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005448 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005449 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005450 /* There must be no pending incoming or outgoing data */
5451 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005452 {
5453 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005454 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005455 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005456 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005457 {
5458 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005459 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005460 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005461 /* Protocol must be DLTS, not TLS */
5462 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005463 {
5464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005465 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005466 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005467 /* Version must be 1.2 */
5468 if( ssl->major_ver != MBEDTLS_SSL_MAJOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005469 {
5470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005471 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005472 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005473 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005474 {
5475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005476 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005477 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005478 /* We must be using an AEAD ciphersuite */
5479 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005480 {
5481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005482 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005483 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005484 /* Renegotiation must not be enabled */
5485#if defined(MBEDTLS_SSL_RENEGOTIATION)
5486 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005487 {
5488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005489 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005490 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005491#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005492
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005493 /*
5494 * Version and format identifier
5495 */
5496 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005497
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005498 if( used <= buf_len )
5499 {
5500 memcpy( p, ssl_serialized_context_header,
5501 sizeof( ssl_serialized_context_header ) );
5502 p += sizeof( ssl_serialized_context_header );
5503 }
5504
5505 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005506 * Session (length + data)
5507 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005508 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005509 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
5510 return( ret );
5511
5512 used += 4 + session_len;
5513 if( used <= buf_len )
5514 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005515 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
5516 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005517
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005518 ret = ssl_session_save( ssl->session, 1,
5519 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005520 if( ret != 0 )
5521 return( ret );
5522
5523 p += session_len;
5524 }
5525
5526 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005527 * Transform
5528 */
5529 used += sizeof( ssl->transform->randbytes );
5530 if( used <= buf_len )
5531 {
5532 memcpy( p, ssl->transform->randbytes,
5533 sizeof( ssl->transform->randbytes ) );
5534 p += sizeof( ssl->transform->randbytes );
5535 }
5536
5537#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5538 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
5539 if( used <= buf_len )
5540 {
5541 *p++ = ssl->transform->in_cid_len;
5542 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
5543 p += ssl->transform->in_cid_len;
5544
5545 *p++ = ssl->transform->out_cid_len;
5546 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
5547 p += ssl->transform->out_cid_len;
5548 }
5549#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5550
5551 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005552 * Saved fields from top-level ssl_context structure
5553 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005554 used += 4;
5555 if( used <= buf_len )
5556 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005557 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
5558 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005559 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005560
5561#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5562 used += 16;
5563 if( used <= buf_len )
5564 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005565 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
5566 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005567
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005568 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
5569 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005570 }
5571#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5572
5573#if defined(MBEDTLS_SSL_PROTO_DTLS)
5574 used += 1;
5575 if( used <= buf_len )
5576 {
5577 *p++ = ssl->disable_datagram_packing;
5578 }
5579#endif /* MBEDTLS_SSL_PROTO_DTLS */
5580
Jerry Yuae0b2e22021-10-08 15:21:19 +08005581 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005582 if( used <= buf_len )
5583 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005584 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
5585 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005586 }
5587
5588#if defined(MBEDTLS_SSL_PROTO_DTLS)
5589 used += 2;
5590 if( used <= buf_len )
5591 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005592 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
5593 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005594 }
5595#endif /* MBEDTLS_SSL_PROTO_DTLS */
5596
5597#if defined(MBEDTLS_SSL_ALPN)
5598 {
5599 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02005600 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005601 : 0;
5602
5603 used += 1 + alpn_len;
5604 if( used <= buf_len )
5605 {
5606 *p++ = alpn_len;
5607
5608 if( ssl->alpn_chosen != NULL )
5609 {
5610 memcpy( p, ssl->alpn_chosen, alpn_len );
5611 p += alpn_len;
5612 }
5613 }
5614 }
5615#endif /* MBEDTLS_SSL_ALPN */
5616
5617 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005618 * Done
5619 */
5620 *olen = used;
5621
5622 if( used > buf_len )
5623 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005624
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005625 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
5626
Hanno Becker43aefe22020-02-05 10:44:56 +00005627 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005628}
5629
5630/*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005631 * Helper to get TLS 1.2 PRF from ciphersuite
5632 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
5633 */
5634typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
5635 const char *label,
5636 const unsigned char *random, size_t rlen,
5637 unsigned char *dstbuf, size_t dlen );
5638static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
5639{
Jerry Yuc3091b12021-12-23 14:57:39 +08005640#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02005641#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005642 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5643 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
5644
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005645 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
5646 return( tls_prf_sha384 );
Jarno Lamsab7b486c2019-08-21 15:30:44 +03005647#else
5648 (void) ciphersuite_id;
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005649#endif
5650 return( tls_prf_sha256 );
Jerry Yu53d23e22022-02-09 16:25:09 +08005651#else /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuc5aef882021-12-23 20:15:02 +08005652 (void) ciphersuite_id;
5653 return( NULL );
Jerry Yu53d23e22022-02-09 16:25:09 +08005654#endif /* !MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuc3091b12021-12-23 14:57:39 +08005655
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005656}
5657
5658/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005659 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005660 *
5661 * This internal version is wrapped by a public function that cleans up in
5662 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005663 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005664static int ssl_context_load( mbedtls_ssl_context *ssl,
5665 const unsigned char *buf,
5666 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005667{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005668 const unsigned char *p = buf;
5669 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005670 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005672
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005673 /*
5674 * The context should have been freshly setup or reset.
5675 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005676 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005677 * renegotiating, or if the user mistakenly loaded a session first.)
5678 */
5679 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5680 ssl->session != NULL )
5681 {
5682 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5683 }
5684
5685 /*
5686 * We can't check that the config matches the initial one, but we can at
5687 * least check it matches the requirements for serializing.
5688 */
5689 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5690 ssl->conf->max_major_ver < MBEDTLS_SSL_MAJOR_VERSION_3 ||
5691 ssl->conf->min_major_ver > MBEDTLS_SSL_MAJOR_VERSION_3 ||
5692 ssl->conf->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 ||
5693 ssl->conf->min_minor_ver > MBEDTLS_SSL_MINOR_VERSION_3 ||
5694#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005695 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005696#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005697 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005698 {
5699 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5700 }
5701
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005702 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
5703
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005704 /*
5705 * Check version identifier
5706 */
5707 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
5708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5709
5710 if( memcmp( p, ssl_serialized_context_header,
5711 sizeof( ssl_serialized_context_header ) ) != 0 )
5712 {
5713 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
5714 }
5715 p += sizeof( ssl_serialized_context_header );
5716
5717 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005718 * Session
5719 */
5720 if( (size_t)( end - p ) < 4 )
5721 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5722
5723 session_len = ( (size_t) p[0] << 24 ) |
5724 ( (size_t) p[1] << 16 ) |
5725 ( (size_t) p[2] << 8 ) |
5726 ( (size_t) p[3] );
5727 p += 4;
5728
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005729 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005730 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005731 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005732 ssl->session_in = ssl->session;
5733 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005734 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005735
5736 if( (size_t)( end - p ) < session_len )
5737 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5738
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005739 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005740 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005741 {
5742 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005743 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005744 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005745
5746 p += session_len;
5747
5748 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005749 * Transform
5750 */
5751
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005752 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005753 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005754 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005755 ssl->transform_in = ssl->transform;
5756 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005757 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005758
5759 /* Read random bytes and populate structure */
5760 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
5761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5762
Hanno Beckerbd257552021-03-22 06:59:27 +00005763 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005764 ssl->session->ciphersuite,
5765 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00005766#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5767 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005768 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00005769#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5770 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005771 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
5772 p, /* currently pointing to randbytes */
5773 MBEDTLS_SSL_MINOR_VERSION_3, /* (D)TLS 1.2 is forced */
5774 ssl->conf->endpoint,
5775 ssl );
5776 if( ret != 0 )
5777 return( ret );
5778
5779 p += sizeof( ssl->transform->randbytes );
5780
5781#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5782 /* Read connection IDs and store them */
5783 if( (size_t)( end - p ) < 1 )
5784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5785
5786 ssl->transform->in_cid_len = *p++;
5787
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02005788 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5790
5791 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
5792 p += ssl->transform->in_cid_len;
5793
5794 ssl->transform->out_cid_len = *p++;
5795
5796 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
5797 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5798
5799 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
5800 p += ssl->transform->out_cid_len;
5801#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5802
5803 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005804 * Saved fields from top-level ssl_context structure
5805 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005806 if( (size_t)( end - p ) < 4 )
5807 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5808
5809 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
5810 ( (uint32_t) p[1] << 16 ) |
5811 ( (uint32_t) p[2] << 8 ) |
5812 ( (uint32_t) p[3] );
5813 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005814
5815#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5816 if( (size_t)( end - p ) < 16 )
5817 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5818
5819 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
5820 ( (uint64_t) p[1] << 48 ) |
5821 ( (uint64_t) p[2] << 40 ) |
5822 ( (uint64_t) p[3] << 32 ) |
5823 ( (uint64_t) p[4] << 24 ) |
5824 ( (uint64_t) p[5] << 16 ) |
5825 ( (uint64_t) p[6] << 8 ) |
5826 ( (uint64_t) p[7] );
5827 p += 8;
5828
5829 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
5830 ( (uint64_t) p[1] << 48 ) |
5831 ( (uint64_t) p[2] << 40 ) |
5832 ( (uint64_t) p[3] << 32 ) |
5833 ( (uint64_t) p[4] << 24 ) |
5834 ( (uint64_t) p[5] << 16 ) |
5835 ( (uint64_t) p[6] << 8 ) |
5836 ( (uint64_t) p[7] );
5837 p += 8;
5838#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5839
5840#if defined(MBEDTLS_SSL_PROTO_DTLS)
5841 if( (size_t)( end - p ) < 1 )
5842 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5843
5844 ssl->disable_datagram_packing = *p++;
5845#endif /* MBEDTLS_SSL_PROTO_DTLS */
5846
Jerry Yud9a94fe2021-09-28 18:58:59 +08005847 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005848 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005849 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
5850 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005851
5852#if defined(MBEDTLS_SSL_PROTO_DTLS)
5853 if( (size_t)( end - p ) < 2 )
5854 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5855
5856 ssl->mtu = ( p[0] << 8 ) | p[1];
5857 p += 2;
5858#endif /* MBEDTLS_SSL_PROTO_DTLS */
5859
5860#if defined(MBEDTLS_SSL_ALPN)
5861 {
5862 uint8_t alpn_len;
5863 const char **cur;
5864
5865 if( (size_t)( end - p ) < 1 )
5866 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5867
5868 alpn_len = *p++;
5869
5870 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
5871 {
5872 /* alpn_chosen should point to an item in the configured list */
5873 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
5874 {
5875 if( strlen( *cur ) == alpn_len &&
5876 memcmp( p, cur, alpn_len ) == 0 )
5877 {
5878 ssl->alpn_chosen = *cur;
5879 break;
5880 }
5881 }
5882 }
5883
5884 /* can only happen on conf mismatch */
5885 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
5886 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5887
5888 p += alpn_len;
5889 }
5890#endif /* MBEDTLS_SSL_ALPN */
5891
5892 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005893 * Forced fields from top-level ssl_context structure
5894 *
5895 * Most of them already set to the correct value by mbedtls_ssl_init() and
5896 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5897 */
5898 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
5899
5900 ssl->major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
5901 ssl->minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
5902
Hanno Becker361b10d2019-08-30 10:42:49 +01005903 /* Adjust pointers for header fields of outgoing records to
5904 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005905 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01005906
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005907#if defined(MBEDTLS_SSL_PROTO_DTLS)
5908 ssl->in_epoch = 1;
5909#endif
5910
5911 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5912 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005913 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5914 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005915 if( ssl->handshake != NULL )
5916 {
5917 mbedtls_ssl_handshake_free( ssl );
5918 mbedtls_free( ssl->handshake );
5919 ssl->handshake = NULL;
5920 }
5921
5922 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005923 * Done - should have consumed entire buffer
5924 */
5925 if( p != end )
5926 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005927
5928 return( 0 );
5929}
5930
5931/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005932 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005933 */
5934int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
5935 const unsigned char *buf,
5936 size_t len )
5937{
5938 int ret = ssl_context_load( context, buf, len );
5939
5940 if( ret != 0 )
5941 mbedtls_ssl_free( context );
5942
5943 return( ret );
5944}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005945#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005946
5947/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005948 * Free an SSL context
5949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005950void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005951{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005952 if( ssl == NULL )
5953 return;
5954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005956
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01005957 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005958 {
sander-visserb8aa2072020-05-06 22:05:13 +02005959#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5960 size_t out_buf_len = ssl->out_buf_len;
5961#else
5962 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5963#endif
5964
Darryl Greenb33cc762019-11-28 14:29:44 +00005965 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005966 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005967 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005968 }
5969
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01005970 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005971 {
sander-visserb8aa2072020-05-06 22:05:13 +02005972#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5973 size_t in_buf_len = ssl->in_buf_len;
5974#else
5975 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5976#endif
5977
Darryl Greenb33cc762019-11-28 14:29:44 +00005978 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005979 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005980 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005981 }
5982
Paul Bakker48916f92012-09-16 19:57:18 +00005983 if( ssl->transform )
5984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005985 mbedtls_ssl_transform_free( ssl->transform );
5986 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00005987 }
5988
5989 if( ssl->handshake )
5990 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02005991 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005992 mbedtls_ssl_transform_free( ssl->transform_negotiate );
5993 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00005994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005995 mbedtls_free( ssl->handshake );
5996 mbedtls_free( ssl->transform_negotiate );
5997 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00005998 }
5999
Ronald Cron6f135e12021-12-08 16:57:54 +01006000#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01006001 mbedtls_ssl_transform_free( ssl->transform_application );
6002 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01006003#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01006004
Paul Bakkerc0463502013-02-14 11:19:38 +01006005 if( ssl->session )
6006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006007 mbedtls_ssl_session_free( ssl->session );
6008 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01006009 }
6010
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02006011#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02006012 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00006013 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05006014 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006015 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00006016 }
Paul Bakker0be444a2013-08-27 21:55:01 +02006017#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00006018
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02006019#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006020 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02006021#endif
6022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00006024
Paul Bakker86f04f42013-02-14 11:20:09 +01006025 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05006026 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00006027}
6028
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006029/*
6030 * Initialze mbedtls_ssl_config
6031 */
6032void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
6033{
6034 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
6035}
6036
Gilles Peskineeccd8882020-03-10 12:19:08 +01006037#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08006038#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02006039/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02006040 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
6041 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02006042 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
6043 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01006044static int ssl_preset_default_hashes[] = {
6045#if defined(MBEDTLS_SHA512_C)
6046 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006047#endif
6048#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01006049 MBEDTLS_MD_SHA384,
6050#endif
6051#if defined(MBEDTLS_SHA256_C)
6052 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006053#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01006054 MBEDTLS_MD_NONE
6055};
Jerry Yuf017ee42022-01-12 15:49:48 +08006056#endif /* !MBEDTLS_DEPRECATED_REMOVED */
6057#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01006058
Gilles Peskineae270bf2021-06-02 00:05:29 +02006059/* The selection should be the same as mbedtls_x509_crt_profile_default in
6060 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02006061 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02006062 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02006063 * about this list.
6064 */
Brett Warrene0edc842021-08-17 09:53:13 +01006065static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02006066#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006067 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02006068#endif
6069#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006070 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02006071#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02006072#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006073 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02006074#endif
6075#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006076 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02006077#endif
6078#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006079 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02006080#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02006081#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006082 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02006083#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02006084#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006085 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02006086#endif
6087#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006088 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02006089#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006090 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02006091};
Gilles Peskineae270bf2021-06-02 00:05:29 +02006092
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006093static int ssl_preset_suiteb_ciphersuites[] = {
6094 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
6095 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
6096 0
6097};
6098
Gilles Peskineeccd8882020-03-10 12:19:08 +01006099#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08006100#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006101static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08006102#if defined(MBEDTLS_SHA256_C)
6103 MBEDTLS_MD_SHA256,
6104#endif
Jerry Yu713013f2022-01-17 18:16:35 +08006105#if defined(MBEDTLS_SHA384_C)
6106 MBEDTLS_MD_SHA384,
6107#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006108 MBEDTLS_MD_NONE
6109};
Jerry Yuf017ee42022-01-12 15:49:48 +08006110#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01006111
Jerry Yu909df7b2022-01-22 11:56:27 +08006112/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08006113 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08006114 * rules SHOULD be upheld.
6115 * - No duplicate entries.
6116 * - But if there is a good reason, do not change the order of the algorithms.
6117 * - ssl_tls12_present* is for TLS 1.2 use only.
6118 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08006119 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01006120static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08006121
Jerry Yued5e9f42022-01-26 11:21:34 +08006122#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
6123 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
6124 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
6125#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
6126 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08006127
Jerry Yu909df7b2022-01-22 11:56:27 +08006128#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
6129 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
6130 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
6131#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
6132 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
6133
Jerry Yued5e9f42022-01-26 11:21:34 +08006134#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
6135 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
6136 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
6137#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
6138 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08006139
Jerry Yu909df7b2022-01-22 11:56:27 +08006140#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
6141 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
6142#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
6143
Jerry Yu53037892022-01-25 11:02:06 +08006144#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
6145 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
6146#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
6147
Jerry Yu909df7b2022-01-22 11:56:27 +08006148 MBEDTLS_TLS1_3_SIG_NONE
6149};
6150
6151/* NOTICE: see above */
6152#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6153static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08006154#if defined(MBEDTLS_SHA512_C)
6155 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
6156#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08006157#if defined(MBEDTLS_SHA384_C)
6158 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
6159#endif
6160#if defined(MBEDTLS_SHA256_C)
6161 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
6162#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08006163 MBEDTLS_TLS1_3_SIG_NONE
6164};
6165#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
6166/* NOTICE: see above */
6167static uint16_t ssl_preset_suiteb_sig_algs[] = {
6168
Jerry Yu909df7b2022-01-22 11:56:27 +08006169#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
6170 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
6171 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
6172#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
6173 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
6174
Jerry Yu53037892022-01-25 11:02:06 +08006175#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
6176 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
6177 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
6178#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
6179 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08006180
6181#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
6182 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
6183#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08006184
Jerry Yu53037892022-01-25 11:02:06 +08006185#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
6186 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
6187#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
6188
Jerry Yu713013f2022-01-17 18:16:35 +08006189 MBEDTLS_TLS1_3_SIG_NONE
6190};
Jerry Yu6106fdc2022-01-12 16:36:14 +08006191
Jerry Yu909df7b2022-01-22 11:56:27 +08006192/* NOTICE: see above */
6193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6194static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08006195#if defined(MBEDTLS_SHA256_C)
6196 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
6197#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08006198#if defined(MBEDTLS_SHA384_C)
6199 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
6200#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00006201 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01006202};
Jerry Yu909df7b2022-01-22 11:56:27 +08006203#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
6204
Jerry Yu1a8b4812022-01-20 17:56:50 +08006205#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006206
Brett Warrene0edc842021-08-17 09:53:13 +01006207static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01006208#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006209 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01006210#endif
6211#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01006212 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01006213#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006214 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006215};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006216
Jerry Yu1a8b4812022-01-20 17:56:50 +08006217#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006218/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08006219 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08006220static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08006221{
6222 size_t i, j;
6223 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08006224
Jerry Yuf377d642022-01-25 10:43:59 +08006225 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08006226 {
Jerry Yuf377d642022-01-25 10:43:59 +08006227 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08006228 {
Jerry Yuf377d642022-01-25 10:43:59 +08006229 if( sig_algs[i] != sig_algs[j] )
6230 continue;
6231 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
6232 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
6233 sig_algs[i], j, i );
6234 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08006235 }
6236 }
6237 return( ret );
6238}
6239
6240#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6241
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006242/*
Tillmann Karras588ad502015-09-25 04:27:22 +02006243 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006244 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02006245int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006246 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006247{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02006248#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00006249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02006250#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006251
Jerry Yu1a8b4812022-01-20 17:56:50 +08006252#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08006253 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08006254 {
6255 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
6256 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
6257 }
6258
Jerry Yuf377d642022-01-25 10:43:59 +08006259 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08006260 {
6261 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
6262 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
6263 }
Jerry Yu909df7b2022-01-22 11:56:27 +08006264
6265#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08006266 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08006267 {
Jerry Yu909df7b2022-01-22 11:56:27 +08006268 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08006269 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
6270 }
6271
Jerry Yuf377d642022-01-25 10:43:59 +08006272 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08006273 {
Jerry Yu909df7b2022-01-22 11:56:27 +08006274 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08006275 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
6276 }
6277#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08006278#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6279
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02006280 /* Use the functions here so that they are covered in tests,
6281 * but otherwise access member directly for efficiency */
6282 mbedtls_ssl_conf_endpoint( conf, endpoint );
6283 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006284
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006285 /*
6286 * Things that are common to all presets
6287 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02006288#if defined(MBEDTLS_SSL_CLI_C)
6289 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
6290 {
6291 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
6292#if defined(MBEDTLS_SSL_SESSION_TICKETS)
6293 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
6294#endif
6295 }
6296#endif
6297
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006298#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6299 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
6300#endif
6301
6302#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6303 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
6304#endif
6305
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02006306#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006307 conf->f_cookie_write = ssl_cookie_write_dummy;
6308 conf->f_cookie_check = ssl_cookie_check_dummy;
6309#endif
6310
6311#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
6312 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
6313#endif
6314
Janos Follath088ce432017-04-10 12:42:31 +01006315#if defined(MBEDTLS_SSL_SRV_C)
6316 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02006317 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01006318#endif
6319
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006320#if defined(MBEDTLS_SSL_PROTO_DTLS)
6321 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
6322 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
6323#endif
6324
6325#if defined(MBEDTLS_SSL_RENEGOTIATION)
6326 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00006327 memset( conf->renego_period, 0x00, 2 );
6328 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006329#endif
6330
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006331#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01006332 if( endpoint == MBEDTLS_SSL_IS_SERVER )
6333 {
6334 const unsigned char dhm_p[] =
6335 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
6336 const unsigned char dhm_g[] =
6337 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01006338
Hanno Beckere2defad2021-07-24 05:59:17 +01006339 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
6340 dhm_p, sizeof( dhm_p ),
6341 dhm_g, sizeof( dhm_g ) ) ) != 0 )
6342 {
6343 return( ret );
6344 }
6345 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02006346#endif
6347
Ronald Cron6f135e12021-12-08 16:57:54 +01006348#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01006349 /*
6350 * Allow all TLS 1.3 key exchange modes by default.
6351 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00006352 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01006353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01006354
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006355 /*
6356 * Preset-specific defaults
6357 */
6358 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006359 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006360 /*
6361 * NSA Suite B
6362 */
6363 case MBEDTLS_SSL_PRESET_SUITEB:
6364 conf->min_major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
6365 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3; /* TLS 1.2 */
6366 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08006367#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
6368 /* Hybrid TLS 1.2/1.3 is not supported yet */
6369 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
6370#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006371 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08006372#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006373
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006374 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006375
6376#if defined(MBEDTLS_X509_CRT_PARSE_C)
6377 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006378#endif
6379
Gilles Peskineeccd8882020-03-10 12:19:08 +01006380#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08006381#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006382 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08006383#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08006384#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6385 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
6386 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
6387 else
6388#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
6389 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006390#endif
6391
Brett Warrene0edc842021-08-17 09:53:13 +01006392#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
6393 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006394#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006395 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006396 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006397
6398 /*
6399 * Default
6400 */
6401 default:
Ron Eldor5e9f14d2017-05-28 10:46:38 +03006402 conf->min_major_ver = ( MBEDTLS_SSL_MIN_MAJOR_VERSION >
6403 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION ) ?
6404 MBEDTLS_SSL_MIN_MAJOR_VERSION :
6405 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION;
6406 conf->min_minor_ver = ( MBEDTLS_SSL_MIN_MINOR_VERSION >
6407 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION ) ?
6408 MBEDTLS_SSL_MIN_MINOR_VERSION :
6409 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006410 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08006411#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
6412 /* Hybrid TLS 1.2/1.3 is not supported yet */
6413 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
6414#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006415 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08006416#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006417
6418#if defined(MBEDTLS_SSL_PROTO_DTLS)
6419 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
TRodziewiczef73f012021-05-13 14:53:36 +02006420 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006421#endif
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006422 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006423
6424#if defined(MBEDTLS_X509_CRT_PARSE_C)
6425 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6426#endif
6427
Gilles Peskineeccd8882020-03-10 12:19:08 +01006428#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08006429#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01006430 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08006431#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08006432#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6433 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
6434 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
6435 else
6436#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
6437 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01006438#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006439
Brett Warrene0edc842021-08-17 09:53:13 +01006440#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
6441 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006442#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006443 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006444
6445#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6446 conf->dhm_min_bitlen = 1024;
6447#endif
6448 }
6449
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006450 return( 0 );
6451}
6452
6453/*
6454 * Free mbedtls_ssl_config
6455 */
6456void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
6457{
6458#if defined(MBEDTLS_DHM_C)
6459 mbedtls_mpi_free( &conf->dhm_P );
6460 mbedtls_mpi_free( &conf->dhm_G );
6461#endif
6462
Gilles Peskineeccd8882020-03-10 12:19:08 +01006463#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006464 if( conf->psk != NULL )
6465 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05006466 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006467 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00006468 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006469 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006470 }
6471
6472 if( conf->psk_identity != NULL )
6473 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05006474 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09006475 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00006476 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006477 conf->psk_identity_len = 0;
6478 }
6479#endif
6480
6481#if defined(MBEDTLS_X509_CRT_PARSE_C)
6482 ssl_key_cert_free( conf->key_cert );
6483#endif
6484
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05006485 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006486}
6487
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006488#if defined(MBEDTLS_PK_C) && \
6489 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006490/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006491 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006493unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006494{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006495#if defined(MBEDTLS_RSA_C)
6496 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
6497 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006498#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006499#if defined(MBEDTLS_ECDSA_C)
6500 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
6501 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006502#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006503 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006504}
6505
Hanno Becker7e5437a2017-04-28 17:15:26 +01006506unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
6507{
6508 switch( type ) {
6509 case MBEDTLS_PK_RSA:
6510 return( MBEDTLS_SSL_SIG_RSA );
6511 case MBEDTLS_PK_ECDSA:
6512 case MBEDTLS_PK_ECKEY:
6513 return( MBEDTLS_SSL_SIG_ECDSA );
6514 default:
6515 return( MBEDTLS_SSL_SIG_ANON );
6516 }
6517}
6518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006519mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006520{
6521 switch( sig )
6522 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006523#if defined(MBEDTLS_RSA_C)
6524 case MBEDTLS_SSL_SIG_RSA:
6525 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006526#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006527#if defined(MBEDTLS_ECDSA_C)
6528 case MBEDTLS_SSL_SIG_ECDSA:
6529 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006530#endif
6531 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006532 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006533 }
6534}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006535#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006536
Hanno Becker7e5437a2017-04-28 17:15:26 +01006537#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01006538 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006539
6540/* Find an entry in a signature-hash set matching a given hash algorithm. */
6541mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
6542 mbedtls_pk_type_t sig_alg )
6543{
6544 switch( sig_alg )
6545 {
6546 case MBEDTLS_PK_RSA:
6547 return( set->rsa );
6548 case MBEDTLS_PK_ECDSA:
6549 return( set->ecdsa );
6550 default:
6551 return( MBEDTLS_MD_NONE );
6552 }
6553}
6554
6555/* Add a signature-hash-pair to a signature-hash set */
6556void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
6557 mbedtls_pk_type_t sig_alg,
6558 mbedtls_md_type_t md_alg )
6559{
6560 switch( sig_alg )
6561 {
6562 case MBEDTLS_PK_RSA:
6563 if( set->rsa == MBEDTLS_MD_NONE )
6564 set->rsa = md_alg;
6565 break;
6566
6567 case MBEDTLS_PK_ECDSA:
6568 if( set->ecdsa == MBEDTLS_MD_NONE )
6569 set->ecdsa = md_alg;
6570 break;
6571
6572 default:
6573 break;
6574 }
6575}
6576
6577/* Allow exactly one hash algorithm for each signature. */
6578void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
6579 mbedtls_md_type_t md_alg )
6580{
6581 set->rsa = md_alg;
6582 set->ecdsa = md_alg;
6583}
6584
6585#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01006586 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Hanno Becker7e5437a2017-04-28 17:15:26 +01006587
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006588/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006589 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006591mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006592{
6593 switch( hash )
6594 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006595#if defined(MBEDTLS_MD5_C)
6596 case MBEDTLS_SSL_HASH_MD5:
6597 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006598#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006599#if defined(MBEDTLS_SHA1_C)
6600 case MBEDTLS_SSL_HASH_SHA1:
6601 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006602#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006603#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006604 case MBEDTLS_SSL_HASH_SHA224:
6605 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006606#endif
6607#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006608 case MBEDTLS_SSL_HASH_SHA256:
6609 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006610#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006611#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006612 case MBEDTLS_SSL_HASH_SHA384:
6613 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006614#endif
6615#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006616 case MBEDTLS_SSL_HASH_SHA512:
6617 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006618#endif
6619 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006620 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006621 }
6622}
6623
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006624/*
6625 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6626 */
6627unsigned char mbedtls_ssl_hash_from_md_alg( int md )
6628{
6629 switch( md )
6630 {
6631#if defined(MBEDTLS_MD5_C)
6632 case MBEDTLS_MD_MD5:
6633 return( MBEDTLS_SSL_HASH_MD5 );
6634#endif
6635#if defined(MBEDTLS_SHA1_C)
6636 case MBEDTLS_MD_SHA1:
6637 return( MBEDTLS_SSL_HASH_SHA1 );
6638#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006639#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006640 case MBEDTLS_MD_SHA224:
6641 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006642#endif
6643#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006644 case MBEDTLS_MD_SHA256:
6645 return( MBEDTLS_SSL_HASH_SHA256 );
6646#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006647#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006648 case MBEDTLS_MD_SHA384:
6649 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006650#endif
6651#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006652 case MBEDTLS_MD_SHA512:
6653 return( MBEDTLS_SSL_HASH_SHA512 );
6654#endif
6655 default:
6656 return( MBEDTLS_SSL_HASH_NONE );
6657 }
6658}
6659
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006660/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006661 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006662 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006663 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006664int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006665{
Brett Warrene0edc842021-08-17 09:53:13 +01006666 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006667
Brett Warrene0edc842021-08-17 09:53:13 +01006668 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006669 return( -1 );
6670
Brett Warrene0edc842021-08-17 09:53:13 +01006671 for( ; *group_list != 0; group_list++ )
6672 {
6673 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006674 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01006675 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006676
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006677 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006678}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006679
6680#if defined(MBEDTLS_ECP_C)
6681/*
6682 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6683 */
6684int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
6685{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01006686 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006687 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
6688}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02006689#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006691#if defined(MBEDTLS_X509_CRT_PARSE_C)
6692int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
6693 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006694 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02006695 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006696{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006697 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006698 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006699 const char *ext_oid;
6700 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006702 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006703 {
6704 /* Server part of the key exchange */
6705 switch( ciphersuite->key_exchange )
6706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006707 case MBEDTLS_KEY_EXCHANGE_RSA:
6708 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006709 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006710 break;
6711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006712 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6713 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6714 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6715 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006716 break;
6717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006718 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6719 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006720 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006721 break;
6722
6723 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006724 case MBEDTLS_KEY_EXCHANGE_NONE:
6725 case MBEDTLS_KEY_EXCHANGE_PSK:
6726 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6727 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006728 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006729 usage = 0;
6730 }
6731 }
6732 else
6733 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006734 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6735 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006736 }
6737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006738 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006739 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006740 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006741 ret = -1;
6742 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006743
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006744 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006746 ext_oid = MBEDTLS_OID_SERVER_AUTH;
6747 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006748 }
6749 else
6750 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006751 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
6752 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006753 }
6754
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006755 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006756 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006757 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006758 ret = -1;
6759 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006760
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006761 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006762}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006763#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006764
Simon Butcher99000142016-10-13 17:21:01 +01006765int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
6766{
6767#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6768 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Becker541af852021-05-14 16:49:01 +01006769 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01006770
6771 switch( md )
6772 {
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02006773#if defined(MBEDTLS_SHA384_C)
Simon Butcher99000142016-10-13 17:21:01 +01006774 case MBEDTLS_SSL_HASH_SHA384:
6775 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6776 break;
6777#endif
6778#if defined(MBEDTLS_SHA256_C)
6779 case MBEDTLS_SSL_HASH_SHA256:
6780 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6781 break;
6782#endif
6783 default:
Hanno Becker541af852021-05-14 16:49:01 +01006784 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01006785 }
6786
6787 return 0;
6788#else /* !MBEDTLS_SSL_PROTO_TLS1_2 */
6789 (void) ssl;
6790 (void) md;
6791
Hanno Becker541af852021-05-14 16:49:01 +01006792 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01006793#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
6794}
6795
TRodziewicz0f82ec62021-05-12 17:49:18 +02006796#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006797
6798#if defined(MBEDTLS_USE_PSA_CRYPTO)
6799int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
6800 unsigned char *hash, size_t *hashlen,
6801 unsigned char *data, size_t data_len,
6802 mbedtls_md_type_t md_alg )
6803{
Andrzej Kurek814feff2019-01-14 04:35:19 -05006804 psa_status_t status;
Jaeden Amero34973232019-02-20 10:32:28 +00006805 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006806 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
6807
Hanno Becker4c8c7aa2019-04-10 09:25:41 +01006808 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
Andrzej Kurek814feff2019-01-14 04:35:19 -05006809
6810 if( ( status = psa_hash_setup( &hash_operation,
6811 hash_alg ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006812 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05006813 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006814 goto exit;
6815 }
6816
Andrzej Kurek814feff2019-01-14 04:35:19 -05006817 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
6818 64 ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006819 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05006820 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006821 goto exit;
6822 }
6823
Andrzej Kurek814feff2019-01-14 04:35:19 -05006824 if( ( status = psa_hash_update( &hash_operation,
6825 data, data_len ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006826 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05006827 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006828 goto exit;
6829 }
6830
Ronald Cron69a63422021-10-18 09:47:58 +02006831 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
Andrzej Kurek814feff2019-01-14 04:35:19 -05006832 hashlen ) ) != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006833 {
Andrzej Kurek814feff2019-01-14 04:35:19 -05006834 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006835 goto exit;
6836 }
6837
6838exit:
Andrzej Kurek814feff2019-01-14 04:35:19 -05006839 if( status != PSA_SUCCESS )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006840 {
6841 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6842 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Andrzej Kurek814feff2019-01-14 04:35:19 -05006843 switch( status )
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006844 {
6845 case PSA_ERROR_NOT_SUPPORTED:
6846 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
Andrzej Kurek814feff2019-01-14 04:35:19 -05006847 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006848 case PSA_ERROR_BUFFER_TOO_SMALL:
6849 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
6850 case PSA_ERROR_INSUFFICIENT_MEMORY:
6851 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
6852 default:
TRodziewiczb579ccd2021-04-13 14:28:28 +02006853 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006854 }
6855 }
6856 return( 0 );
6857}
6858
6859#else
6860
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01006861int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02006862 unsigned char *hash, size_t *hashlen,
6863 unsigned char *data, size_t data_len,
6864 mbedtls_md_type_t md_alg )
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01006865{
6866 int ret = 0;
6867 mbedtls_md_context_t ctx;
6868 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
Gilles Peskineca1d7422018-04-24 11:53:22 +02006869 *hashlen = mbedtls_md_get_size( md_info );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01006870
Hanno Becker4c8c7aa2019-04-10 09:25:41 +01006871 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
Andrzej Kurek814feff2019-01-14 04:35:19 -05006872
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01006873 mbedtls_md_init( &ctx );
6874
6875 /*
6876 * digitally-signed struct {
6877 * opaque client_random[32];
6878 * opaque server_random[32];
6879 * ServerDHParams params;
6880 * };
6881 */
6882 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
6883 {
6884 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
6885 goto exit;
6886 }
6887 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
6888 {
6889 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
6890 goto exit;
6891 }
6892 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
6893 {
6894 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
6895 goto exit;
6896 }
6897 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
6898 {
6899 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
6900 goto exit;
6901 }
Gilles Peskineca1d7422018-04-24 11:53:22 +02006902 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01006903 {
6904 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
6905 goto exit;
6906 }
6907
6908exit:
6909 mbedtls_md_free( &ctx );
6910
6911 if( ret != 0 )
6912 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6913 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6914
6915 return( ret );
6916}
Andrzej Kurekd6db9be2019-01-10 05:27:10 -05006917#endif /* MBEDTLS_USE_PSA_CRYPTO */
6918
TRodziewicz0f82ec62021-05-12 17:49:18 +02006919#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01006920
Jerry Yu148165c2021-09-24 23:20:59 +08006921#if defined(MBEDTLS_USE_PSA_CRYPTO)
6922int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
6923 const mbedtls_md_type_t md,
6924 unsigned char *dst,
6925 size_t dst_len,
6926 size_t *olen )
6927{
Ronald Cronf6893e12022-01-07 22:09:01 +01006928 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6929 psa_hash_operation_t *hash_operation_to_clone;
6930 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6931
Jerry Yu148165c2021-09-24 23:20:59 +08006932 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006933
6934 switch( md )
6935 {
6936#if defined(MBEDTLS_SHA384_C)
6937 case MBEDTLS_MD_SHA384:
6938 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6939 break;
6940#endif
6941
6942#if defined(MBEDTLS_SHA256_C)
6943 case MBEDTLS_MD_SHA256:
6944 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6945 break;
6946#endif
6947
6948 default:
6949 goto exit;
6950 }
6951
6952 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
6953 if( status != PSA_SUCCESS )
6954 goto exit;
6955
6956 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
6957 if( status != PSA_SUCCESS )
6958 goto exit;
6959
6960exit:
Ronald Cronb788c042022-02-15 09:14:15 +01006961 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08006962}
6963#else /* MBEDTLS_USE_PSA_CRYPTO */
6964
Jerry Yu24c0ec32021-09-09 14:21:07 +08006965#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08006966static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
6967 unsigned char *dst,
6968 size_t dst_len,
6969 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08006970{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006971 int ret;
6972 mbedtls_sha512_context sha512;
6973
6974 if( dst_len < 48 )
6975 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6976
6977 mbedtls_sha512_init( &sha512 );
6978 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6979
6980 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
6981 {
6982 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
6983 goto exit;
6984 }
6985
6986 *olen = 48;
6987
6988exit:
6989
6990 mbedtls_sha512_free( &sha512 );
6991 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08006992}
6993#endif /* MBEDTLS_SHA384_C */
6994
6995#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08006996static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
6997 unsigned char *dst,
6998 size_t dst_len,
6999 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08007000{
Jerry Yu24c0ec32021-09-09 14:21:07 +08007001 int ret;
7002 mbedtls_sha256_context sha256;
7003
7004 if( dst_len < 32 )
7005 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7006
7007 mbedtls_sha256_init( &sha256 );
7008 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08007009
Jerry Yu24c0ec32021-09-09 14:21:07 +08007010 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
7011 {
7012 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
7013 goto exit;
7014 }
7015
7016 *olen = 32;
7017
7018exit:
7019
7020 mbedtls_sha256_free( &sha256 );
7021 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08007022}
7023#endif /* MBEDTLS_SHA256_C */
7024
Jerry Yu000f9762021-09-14 11:12:51 +08007025int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
7026 const mbedtls_md_type_t md,
7027 unsigned char *dst,
7028 size_t dst_len,
7029 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08007030{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08007031 switch( md )
7032 {
7033
Jerry Yu24c0ec32021-09-09 14:21:07 +08007034#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08007035 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08007036 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08007037#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08007038
Jerry Yu24c0ec32021-09-09 14:21:07 +08007039#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08007040 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08007041 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08007042#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08007043
7044 default:
7045 break;
7046 }
Jerry Yuc5aef882021-12-23 20:15:02 +08007047 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08007048}
XiaokangQian647719a2021-12-07 09:16:29 +00007049
Jerry Yu148165c2021-09-24 23:20:59 +08007050#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08007051
Jerry Yu1ea9d102021-12-21 13:41:49 +08007052#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
7053 defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
7054 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jerry Yuba073422021-12-20 22:22:15 +08007055/*
Jerry Yub925f212022-01-12 11:17:02 +08007056 * Function for writing a supported groups (TLS 1.3) or supported elliptic
7057 * curves (TLS 1.2) extension.
Jerry Yuba073422021-12-20 22:22:15 +08007058 *
Jerry Yub925f212022-01-12 11:17:02 +08007059 * The "extension_data" field of a supported groups extension contains a
7060 * "NamedGroupList" value (TLS 1.3 RFC8446):
Jerry Yuba073422021-12-20 22:22:15 +08007061 * enum {
7062 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
7063 * x25519(0x001D), x448(0x001E),
7064 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
7065 * ffdhe6144(0x0103), ffdhe8192(0x0104),
7066 * ffdhe_private_use(0x01FC..0x01FF),
7067 * ecdhe_private_use(0xFE00..0xFEFF),
7068 * (0xFFFF)
7069 * } NamedGroup;
7070 * struct {
7071 * NamedGroup named_group_list<2..2^16-1>;
7072 * } NamedGroupList;
Jerry Yub925f212022-01-12 11:17:02 +08007073 *
7074 * The "extension_data" field of a supported elliptic curves extension contains
7075 * a "NamedCurveList" value (TLS 1.2 RFC 8422):
Jerry Yu63282b42022-01-11 15:43:53 +08007076 * enum {
7077 * deprecated(1..22),
7078 * secp256r1 (23), secp384r1 (24), secp521r1 (25),
7079 * x25519(29), x448(30),
7080 * reserved (0xFE00..0xFEFF),
7081 * deprecated(0xFF01..0xFF02),
7082 * (0xFFFF)
7083 * } NamedCurve;
7084 * struct {
7085 * NamedCurve named_curve_list<2..2^16-1>
7086 * } NamedCurveList;
7087 *
Jerry Yub925f212022-01-12 11:17:02 +08007088 * The TLS 1.3 supported groups extension was defined to be a compatible
7089 * generalization of the TLS 1.2 supported elliptic curves extension. They both
7090 * share the same extension identifier.
Jerry Yu63282b42022-01-11 15:43:53 +08007091 *
Jerry Yub925f212022-01-12 11:17:02 +08007092 * DHE groups are not supported yet.
Jerry Yuba073422021-12-20 22:22:15 +08007093 */
Jerry Yuba073422021-12-20 22:22:15 +08007094int mbedtls_ssl_write_supported_groups_ext( mbedtls_ssl_context *ssl,
7095 unsigned char *buf,
Jerry Yu17532612021-12-20 22:32:09 +08007096 const unsigned char *end,
Jerry Yuba073422021-12-20 22:22:15 +08007097 size_t *out_len )
7098{
7099 unsigned char *p = buf ;
7100 unsigned char *named_group_list; /* Start of named_group_list */
7101 size_t named_group_list_len; /* Length of named_group_list */
7102 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
7103
7104 *out_len = 0;
Jerry Yuf46b0162022-01-11 16:28:00 +08007105
Jerry Yuba073422021-12-20 22:22:15 +08007106 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported_groups extension" ) );
7107
7108 /* Check if we have space for header and length fields:
7109 * - extension_type (2 bytes)
7110 * - extension_data_length (2 bytes)
7111 * - named_group_list_length (2 bytes)
7112 */
7113 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
7114 p += 6;
7115
7116 named_group_list = p;
7117
7118 if( group_list == NULL )
7119 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
7120
Jerry Yu1510cea2022-01-12 10:56:49 +08007121 for( ; *group_list != 0; group_list++ )
Jerry Yuba073422021-12-20 22:22:15 +08007122 {
Jerry Yu1510cea2022-01-12 10:56:49 +08007123 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got supported group(%04x)", *group_list ) );
Jerry Yu63282b42022-01-11 15:43:53 +08007124
Jerry Yu1ea9d102021-12-21 13:41:49 +08007125#if defined(MBEDTLS_ECP_C)
Jerry Yu1510cea2022-01-12 10:56:49 +08007126 if( ( mbedtls_ssl_conf_is_tls13_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08007127 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) ) ||
Jerry Yu1510cea2022-01-12 10:56:49 +08007128 ( mbedtls_ssl_conf_is_tls12_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08007129 mbedtls_ssl_tls12_named_group_is_ecdhe( *group_list ) ) )
Jerry Yuba073422021-12-20 22:22:15 +08007130 {
Jerry Yu3ad14ac2022-01-11 17:13:16 +08007131 const mbedtls_ecp_curve_info *curve_info;
7132 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
Jerry Yub925f212022-01-12 11:17:02 +08007133 if( curve_info == NULL )
Jerry Yu3ad14ac2022-01-11 17:13:16 +08007134 continue;
Jerry Yub925f212022-01-12 11:17:02 +08007135 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
7136 MBEDTLS_PUT_UINT16_BE( *group_list, p, 0 );
7137 p += 2;
7138 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NamedGroup: %s ( %x )",
7139 curve_info->name, *group_list ) );
Jerry Yuba073422021-12-20 22:22:15 +08007140 }
Jerry Yu63282b42022-01-11 15:43:53 +08007141#endif /* MBEDTLS_ECP_C */
7142 /* Add DHE groups here */
Jerry Yuba073422021-12-20 22:22:15 +08007143
7144 }
7145
Jerry Yu1510cea2022-01-12 10:56:49 +08007146 /* Length of named_group_list */
Jerry Yuba073422021-12-20 22:22:15 +08007147 named_group_list_len = p - named_group_list;
7148 if( named_group_list_len == 0 )
7149 {
7150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No group available." ) );
7151 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7152 }
7153
7154 /* Write extension_type */
7155 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_GROUPS, buf, 0 );
7156 /* Write extension_data_length */
7157 MBEDTLS_PUT_UINT16_BE( named_group_list_len + 2, buf, 2 );
7158 /* Write length of named_group_list */
7159 MBEDTLS_PUT_UINT16_BE( named_group_list_len, buf, 4 );
7160
Jerry Yu7f029d82022-01-11 11:08:53 +08007161 MBEDTLS_SSL_DEBUG_BUF( 3, "Supported groups extension",
7162 buf + 4, named_group_list_len + 2 );
Jerry Yuba073422021-12-20 22:22:15 +08007163
7164 *out_len = p - buf;
7165
7166#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
7167 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
7168#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7169
7170 return( 0 );
7171}
7172
Jerry Yu1ea9d102021-12-21 13:41:49 +08007173#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED ||
7174 MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C ||
7175 MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jerry Yuba073422021-12-20 22:22:15 +08007176
Jerry Yuf017ee42022-01-12 15:49:48 +08007177#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7178/*
Jerry Yu7ddc38c2022-01-19 11:08:05 +08007179 * Function for writing a signature algorithm extension.
Jerry Yuf017ee42022-01-12 15:49:48 +08007180 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08007181 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
Jerry Yu7ddc38c2022-01-19 11:08:05 +08007182 * value (TLS 1.3 RFC8446):
7183 * enum {
7184 * ....
7185 * ecdsa_secp256r1_sha256( 0x0403 ),
7186 * ecdsa_secp384r1_sha384( 0x0503 ),
7187 * ecdsa_secp521r1_sha512( 0x0603 ),
7188 * ....
7189 * } SignatureScheme;
Jerry Yuf017ee42022-01-12 15:49:48 +08007190 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08007191 * struct {
7192 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
7193 * } SignatureSchemeList;
Jerry Yuf017ee42022-01-12 15:49:48 +08007194 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08007195 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
7196 * value (TLS 1.2 RFC5246):
Jerry Yu7ddc38c2022-01-19 11:08:05 +08007197 * enum {
7198 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
7199 * sha512(6), (255)
7200 * } HashAlgorithm;
7201 *
7202 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
7203 * SignatureAlgorithm;
7204 *
7205 * struct {
7206 * HashAlgorithm hash;
7207 * SignatureAlgorithm signature;
7208 * } SignatureAndHashAlgorithm;
7209 *
7210 * SignatureAndHashAlgorithm
7211 * supported_signature_algorithms<2..2^16-2>;
7212 *
7213 * The TLS 1.3 signature algorithm extension was defined to be a compatible
7214 * generalization of the TLS 1.2 signature algorithm extension.
7215 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
7216 * `SignatureScheme` field of TLS 1.3
7217 *
Jerry Yuf017ee42022-01-12 15:49:48 +08007218 */
7219int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
7220 const unsigned char *end, size_t *out_len )
7221{
7222 unsigned char *p = buf;
7223 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
7224 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
7225
7226 *out_len = 0;
7227
7228 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
7229
7230 /* Check if we have space for header and length field:
7231 * - extension_type (2 bytes)
7232 * - extension_data_length (2 bytes)
7233 * - supported_signature_algorithms_length (2 bytes)
7234 */
7235 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
7236 p += 6;
7237
7238 /*
7239 * Write supported_signature_algorithms
7240 */
7241 supported_sig_alg = p;
Jerry Yu6106fdc2022-01-12 16:36:14 +08007242 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
7243 if( sig_alg == NULL )
7244 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
7245
7246 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
Jerry Yuf017ee42022-01-12 15:49:48 +08007247 {
Jerry Yu1bab3012022-01-19 17:43:22 +08007248 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
7249 continue;
Jerry Yuf017ee42022-01-12 15:49:48 +08007250 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
7251 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
7252 p += 2;
7253 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x]", *sig_alg ) );
7254 }
7255
7256 /* Length of supported_signature_algorithms */
7257 supported_sig_alg_len = p - supported_sig_alg;
7258 if( supported_sig_alg_len == 0 )
7259 {
7260 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
7261 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7262 }
7263
7264 /* Write extension_type */
7265 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
7266 /* Write extension_data_length */
7267 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
7268 /* Write length of supported_signature_algorithms */
7269 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
7270
7271 /* Output the total length of signature algorithms extension. */
7272 *out_len = p - buf;
7273
7274#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
7275 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
7276#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7277 return( 0 );
7278}
7279#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yuc73c6182022-02-08 20:29:25 +08007280
Jerry Yuc5aef882021-12-23 20:15:02 +08007281#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7282int mbedtls_ssl_write_hostname_ext( mbedtls_ssl_context *ssl,
7283 unsigned char *buf,
7284 const unsigned char *end,
7285 size_t *olen )
7286{
7287 unsigned char *p = buf;
7288 size_t hostname_len;
7289
7290 *olen = 0;
7291
7292 if( ssl->hostname == NULL )
7293 return( 0 );
7294
7295 MBEDTLS_SSL_DEBUG_MSG( 3,
7296 ( "client hello, adding server name extension: %s",
7297 ssl->hostname ) );
7298
7299 hostname_len = strlen( ssl->hostname );
7300
7301 MBEDTLS_SSL_CHK_BUF_PTR( p, end, hostname_len + 9 );
7302
7303 /*
7304 * Sect. 3, RFC 6066 (TLS Extensions Definitions)
7305 *
7306 * In order to provide any of the server names, clients MAY include an
7307 * extension of type "server_name" in the (extended) client hello. The
7308 * "extension_data" field of this extension SHALL contain
7309 * "ServerNameList" where:
7310 *
7311 * struct {
7312 * NameType name_type;
7313 * select (name_type) {
7314 * case host_name: HostName;
7315 * } name;
7316 * } ServerName;
7317 *
7318 * enum {
7319 * host_name(0), (255)
7320 * } NameType;
7321 *
7322 * opaque HostName<1..2^16-1>;
7323 *
7324 * struct {
7325 * ServerName server_name_list<1..2^16-1>
7326 * } ServerNameList;
7327 *
7328 */
7329 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SERVERNAME, p, 0 );
7330 p += 2;
7331
7332 MBEDTLS_PUT_UINT16_BE( hostname_len + 5, p, 0 );
7333 p += 2;
7334
7335 MBEDTLS_PUT_UINT16_BE( hostname_len + 3, p, 0 );
7336 p += 2;
7337
7338 *p++ = MBEDTLS_BYTE_0( MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME );
7339
7340 MBEDTLS_PUT_UINT16_BE( hostname_len, p, 0 );
7341 p += 2;
7342
7343 memcpy( p, ssl->hostname, hostname_len );
7344
7345 *olen = hostname_len + 9;
7346
7347 return( 0 );
7348}
7349#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Jerry Yuf017ee42022-01-12 15:49:48 +08007350
Jerry Yudc7bd172022-02-17 13:44:15 +08007351
7352#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
7353
7354#if defined(MBEDTLS_USE_PSA_CRYPTO)
7355
7356static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
7357 mbedtls_svc_key_id_t key,
7358 psa_algorithm_t alg,
7359 const unsigned char* seed, size_t seed_length,
7360 const unsigned char* label, size_t label_length,
7361 size_t capacity )
7362{
7363 psa_status_t status;
7364
7365 status = psa_key_derivation_setup( derivation, alg );
7366 if( status != PSA_SUCCESS )
7367 return( status );
7368
7369 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
7370 {
7371 status = psa_key_derivation_input_bytes( derivation,
7372 PSA_KEY_DERIVATION_INPUT_SEED,
7373 seed, seed_length );
7374 if( status != PSA_SUCCESS )
7375 return( status );
7376
7377 if( mbedtls_svc_key_id_is_null( key ) )
7378 {
7379 status = psa_key_derivation_input_bytes(
7380 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
7381 NULL, 0 );
7382 }
7383 else
7384 {
7385 status = psa_key_derivation_input_key(
7386 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
7387 }
7388 if( status != PSA_SUCCESS )
7389 return( status );
7390
7391 status = psa_key_derivation_input_bytes( derivation,
7392 PSA_KEY_DERIVATION_INPUT_LABEL,
7393 label, label_length );
7394 if( status != PSA_SUCCESS )
7395 return( status );
7396 }
7397 else
7398 {
7399 return( PSA_ERROR_NOT_SUPPORTED );
7400 }
7401
7402 status = psa_key_derivation_set_capacity( derivation, capacity );
7403 if( status != PSA_SUCCESS )
7404 return( status );
7405
7406 return( PSA_SUCCESS );
7407}
7408
7409static int tls_prf_generic( mbedtls_md_type_t md_type,
7410 const unsigned char *secret, size_t slen,
7411 const char *label,
7412 const unsigned char *random, size_t rlen,
7413 unsigned char *dstbuf, size_t dlen )
7414{
7415 psa_status_t status;
7416 psa_algorithm_t alg;
7417 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
7418 psa_key_derivation_operation_t derivation =
7419 PSA_KEY_DERIVATION_OPERATION_INIT;
7420
7421 if( md_type == MBEDTLS_MD_SHA384 )
7422 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
7423 else
7424 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
7425
7426 /* Normally a "secret" should be long enough to be impossible to
7427 * find by brute force, and in particular should not be empty. But
7428 * this PRF is also used to derive an IV, in particular in EAP-TLS,
7429 * and for this use case it makes sense to have a 0-length "secret".
7430 * Since the key API doesn't allow importing a key of length 0,
7431 * keep master_key=0, which setup_psa_key_derivation() understands
7432 * to mean a 0-length "secret" input. */
7433 if( slen != 0 )
7434 {
7435 psa_key_attributes_t key_attributes = psa_key_attributes_init();
7436 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
7437 psa_set_key_algorithm( &key_attributes, alg );
7438 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
7439
7440 status = psa_import_key( &key_attributes, secret, slen, &master_key );
7441 if( status != PSA_SUCCESS )
7442 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7443 }
7444
7445 status = setup_psa_key_derivation( &derivation,
7446 master_key, alg,
7447 random, rlen,
7448 (unsigned char const *) label,
7449 (size_t) strlen( label ),
7450 dlen );
7451 if( status != PSA_SUCCESS )
7452 {
7453 psa_key_derivation_abort( &derivation );
7454 psa_destroy_key( master_key );
7455 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7456 }
7457
7458 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
7459 if( status != PSA_SUCCESS )
7460 {
7461 psa_key_derivation_abort( &derivation );
7462 psa_destroy_key( master_key );
7463 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7464 }
7465
7466 status = psa_key_derivation_abort( &derivation );
7467 if( status != PSA_SUCCESS )
7468 {
7469 psa_destroy_key( master_key );
7470 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7471 }
7472
7473 if( ! mbedtls_svc_key_id_is_null( master_key ) )
7474 status = psa_destroy_key( master_key );
7475 if( status != PSA_SUCCESS )
7476 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7477
7478 return( 0 );
7479}
7480
7481#else /* MBEDTLS_USE_PSA_CRYPTO */
7482
7483static int tls_prf_generic( mbedtls_md_type_t md_type,
7484 const unsigned char *secret, size_t slen,
7485 const char *label,
7486 const unsigned char *random, size_t rlen,
7487 unsigned char *dstbuf, size_t dlen )
7488{
7489 size_t nb;
7490 size_t i, j, k, md_len;
7491 unsigned char *tmp;
7492 size_t tmp_len = 0;
7493 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
7494 const mbedtls_md_info_t *md_info;
7495 mbedtls_md_context_t md_ctx;
7496 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7497
7498 mbedtls_md_init( &md_ctx );
7499
7500 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
7501 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7502
7503 md_len = mbedtls_md_get_size( md_info );
7504
7505 tmp_len = md_len + strlen( label ) + rlen;
7506 tmp = mbedtls_calloc( 1, tmp_len );
7507 if( tmp == NULL )
7508 {
7509 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7510 goto exit;
7511 }
7512
7513 nb = strlen( label );
7514 memcpy( tmp + md_len, label, nb );
7515 memcpy( tmp + md_len + nb, random, rlen );
7516 nb += rlen;
7517
7518 /*
7519 * Compute P_<hash>(secret, label + random)[0..dlen]
7520 */
7521 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
7522 goto exit;
7523
7524 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
7525 if( ret != 0 )
7526 goto exit;
7527 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
7528 if( ret != 0 )
7529 goto exit;
7530 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
7531 if( ret != 0 )
7532 goto exit;
7533
7534 for( i = 0; i < dlen; i += md_len )
7535 {
7536 ret = mbedtls_md_hmac_reset ( &md_ctx );
7537 if( ret != 0 )
7538 goto exit;
7539 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
7540 if( ret != 0 )
7541 goto exit;
7542 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
7543 if( ret != 0 )
7544 goto exit;
7545
7546 ret = mbedtls_md_hmac_reset ( &md_ctx );
7547 if( ret != 0 )
7548 goto exit;
7549 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
7550 if( ret != 0 )
7551 goto exit;
7552 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
7553 if( ret != 0 )
7554 goto exit;
7555
7556 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
7557
7558 for( j = 0; j < k; j++ )
7559 dstbuf[i + j] = h_i[j];
7560 }
7561
7562exit:
7563 mbedtls_md_free( &md_ctx );
7564
7565 mbedtls_platform_zeroize( tmp, tmp_len );
7566 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
7567
7568 mbedtls_free( tmp );
7569
7570 return( ret );
7571}
7572#endif /* MBEDTLS_USE_PSA_CRYPTO */
7573
7574#if defined(MBEDTLS_SHA256_C)
7575static int tls_prf_sha256( const unsigned char *secret, size_t slen,
7576 const char *label,
7577 const unsigned char *random, size_t rlen,
7578 unsigned char *dstbuf, size_t dlen )
7579{
7580 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
7581 label, random, rlen, dstbuf, dlen ) );
7582}
7583#endif /* MBEDTLS_SHA256_C */
7584
7585#if defined(MBEDTLS_SHA384_C)
7586static int tls_prf_sha384( const unsigned char *secret, size_t slen,
7587 const char *label,
7588 const unsigned char *random, size_t rlen,
7589 unsigned char *dstbuf, size_t dlen )
7590{
7591 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
7592 label, random, rlen, dstbuf, dlen ) );
7593}
7594#endif /* MBEDTLS_SHA384_C */
7595
Jerry Yuf009d862022-02-17 14:01:37 +08007596/*
7597 * Set appropriate PRF function and other SSL / TLS1.2 functions
7598 *
7599 * Inputs:
7600 * - SSL/TLS minor version
7601 * - hash associated with the ciphersuite (only used by TLS 1.2)
7602 *
7603 * Outputs:
7604 * - the tls_prf, calc_verify and calc_finished members of handshake structure
7605 */
7606static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
7607 int minor_ver,
7608 mbedtls_md_type_t hash )
7609{
7610
7611#if defined(MBEDTLS_SHA384_C)
7612 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
7613 hash == MBEDTLS_MD_SHA384 )
7614 {
7615 handshake->tls_prf = tls_prf_sha384;
7616 handshake->calc_verify = ssl_calc_verify_tls_sha384;
7617 handshake->calc_finished = ssl_calc_finished_tls_sha384;
7618 }
7619 else
7620#endif
7621#if defined(MBEDTLS_SHA256_C)
7622 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
7623 {
7624 handshake->tls_prf = tls_prf_sha256;
7625 handshake->calc_verify = ssl_calc_verify_tls_sha256;
7626 handshake->calc_finished = ssl_calc_finished_tls_sha256;
7627 }
7628 else
7629#endif
7630 {
7631 (void) hash;
7632 (void) minor_ver;
7633 (void) handshake;
7634 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7635 }
7636
7637 return( 0 );
7638}
Jerry Yud6ab2352022-02-17 14:03:43 +08007639
7640#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
7641 defined(MBEDTLS_USE_PSA_CRYPTO)
7642static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
7643{
7644 if( ssl->conf->f_psk != NULL )
7645 {
7646 /* If we've used a callback to select the PSK,
7647 * the static configuration is irrelevant. */
7648 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
7649 return( 1 );
7650
7651 return( 0 );
7652 }
7653
7654 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
7655 return( 1 );
7656
7657 return( 0 );
7658}
7659#endif /* MBEDTLS_USE_PSA_CRYPTO &&
7660 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7661
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007662/*
7663 * Compute master secret if needed
7664 *
7665 * Parameters:
7666 * [in/out] handshake
7667 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7668 * (PSA-PSK) ciphersuite_info, psk_opaque
7669 * [out] premaster (cleared)
7670 * [out] master
7671 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7672 * debug: conf->f_dbg, conf->p_dbg
7673 * EMS: passed to calc_verify (debug + session_negotiate)
7674 * PSA-PSA: minor_ver, conf
7675 */
7676static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
7677 unsigned char *master,
7678 const mbedtls_ssl_context *ssl )
7679{
7680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7681
7682 /* cf. RFC 5246, Section 8.1:
7683 * "The master secret is always exactly 48 bytes in length." */
7684 size_t const master_secret_len = 48;
7685
7686#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7687 unsigned char session_hash[48];
7688#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7689
7690 /* The label for the KDF used for key expansion.
7691 * This is either "master secret" or "extended master secret"
7692 * depending on whether the Extended Master Secret extension
7693 * is used. */
7694 char const *lbl = "master secret";
7695
7696 /* The salt for the KDF used for key expansion.
7697 * - If the Extended Master Secret extension is not used,
7698 * this is ClientHello.Random + ServerHello.Random
7699 * (see Sect. 8.1 in RFC 5246).
7700 * - If the Extended Master Secret extension is used,
7701 * this is the transcript of the handshake so far.
7702 * (see Sect. 4 in RFC 7627). */
7703 unsigned char const *salt = handshake->randbytes;
7704 size_t salt_len = 64;
7705
7706#if !defined(MBEDTLS_DEBUG_C) && \
7707 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7708 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
7709 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
7710 ssl = NULL; /* make sure we don't use it except for those cases */
7711 (void) ssl;
7712#endif
7713
7714 if( handshake->resume != 0 )
7715 {
7716 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
7717 return( 0 );
7718 }
7719
7720#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7721 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
7722 {
7723 lbl = "extended master secret";
7724 salt = session_hash;
7725 handshake->calc_verify( ssl, session_hash, &salt_len );
7726
7727 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
7728 session_hash, salt_len );
7729 }
7730#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
7731
7732#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
7733 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
7734 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
7735 ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
7736 ssl_use_opaque_psk( ssl ) == 1 )
7737 {
7738 /* Perform PSK-to-MS expansion in a single step. */
7739 psa_status_t status;
7740 psa_algorithm_t alg;
7741 mbedtls_svc_key_id_t psk;
7742 psa_key_derivation_operation_t derivation =
7743 PSA_KEY_DERIVATION_OPERATION_INIT;
7744 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
7745
7746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
7747
7748 psk = mbedtls_ssl_get_opaque_psk( ssl );
7749
7750 if( hash_alg == MBEDTLS_MD_SHA384 )
7751 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
7752 else
7753 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
7754
7755 status = setup_psa_key_derivation( &derivation, psk, alg,
7756 salt, salt_len,
7757 (unsigned char const *) lbl,
7758 (size_t) strlen( lbl ),
7759 master_secret_len );
7760 if( status != PSA_SUCCESS )
7761 {
7762 psa_key_derivation_abort( &derivation );
7763 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7764 }
7765
7766 status = psa_key_derivation_output_bytes( &derivation,
7767 master,
7768 master_secret_len );
7769 if( status != PSA_SUCCESS )
7770 {
7771 psa_key_derivation_abort( &derivation );
7772 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7773 }
7774
7775 status = psa_key_derivation_abort( &derivation );
7776 if( status != PSA_SUCCESS )
7777 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
7778 }
7779 else
7780#endif
7781 {
7782 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
7783 lbl, salt, salt_len,
7784 master,
7785 master_secret_len );
7786 if( ret != 0 )
7787 {
7788 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7789 return( ret );
7790 }
7791
7792 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
7793 handshake->premaster,
7794 handshake->pmslen );
7795
7796 mbedtls_platform_zeroize( handshake->premaster,
7797 sizeof(handshake->premaster) );
7798 }
7799
7800 return( 0 );
7801}
7802
Jerry Yud62f87e2022-02-17 14:09:02 +08007803int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
7804{
7805 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7806 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7807 ssl->handshake->ciphersuite_info;
7808
7809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
7810
7811 /* Set PRF, calc_verify and calc_finished function pointers */
7812 ret = ssl_set_handshake_prfs( ssl->handshake,
7813 ssl->minor_ver,
7814 ciphersuite_info->mac );
7815 if( ret != 0 )
7816 {
7817 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
7818 return( ret );
7819 }
7820
7821 /* Compute master secret if needed */
7822 ret = ssl_compute_master( ssl->handshake,
7823 ssl->session_negotiate->master,
7824 ssl );
7825 if( ret != 0 )
7826 {
7827 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
7828 return( ret );
7829 }
7830
7831 /* Swap the client and server random values:
7832 * - MS derivation wanted client+server (RFC 5246 8.1)
7833 * - key derivation wants server+client (RFC 5246 6.3) */
7834 {
7835 unsigned char tmp[64];
7836 memcpy( tmp, ssl->handshake->randbytes, 64 );
7837 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
7838 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
7839 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
7840 }
7841
7842 /* Populate transform structure */
7843 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
7844 ssl->session_negotiate->ciphersuite,
7845 ssl->session_negotiate->master,
7846#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
7847 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7848 ssl->session_negotiate->encrypt_then_mac,
7849#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
7850 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7851 ssl->handshake->tls_prf,
7852 ssl->handshake->randbytes,
7853 ssl->minor_ver,
7854 ssl->conf->endpoint,
7855 ssl );
7856 if( ret != 0 )
7857 {
7858 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
7859 return( ret );
7860 }
7861
7862 /* We no longer need Server/ClientHello.random values */
7863 mbedtls_platform_zeroize( ssl->handshake->randbytes,
7864 sizeof( ssl->handshake->randbytes ) );
7865
7866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
7867
7868 return( 0 );
7869}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007870
7871#if defined(MBEDTLS_SHA256_C)
7872void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
7873 unsigned char *hash,
7874 size_t *hlen )
7875{
7876#if defined(MBEDTLS_USE_PSA_CRYPTO)
7877 size_t hash_size;
7878 psa_status_t status;
7879 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
7880
7881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
7882 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
7883 if( status != PSA_SUCCESS )
7884 {
7885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7886 return;
7887 }
7888
7889 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
7890 if( status != PSA_SUCCESS )
7891 {
7892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7893 return;
7894 }
7895
7896 *hlen = 32;
7897 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
7898 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
7899#else
7900 mbedtls_sha256_context sha256;
7901
7902 mbedtls_sha256_init( &sha256 );
7903
7904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
7905
7906 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
7907 mbedtls_sha256_finish( &sha256, hash );
7908
7909 *hlen = 32;
7910
7911 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
7912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
7913
7914 mbedtls_sha256_free( &sha256 );
7915#endif /* MBEDTLS_USE_PSA_CRYPTO */
7916 return;
7917}
7918#endif /* MBEDTLS_SHA256_C */
7919
Jerry Yuc1cb3842022-02-17 14:13:48 +08007920#if defined(MBEDTLS_SHA384_C)
7921void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
7922 unsigned char *hash,
7923 size_t *hlen )
7924{
7925#if defined(MBEDTLS_USE_PSA_CRYPTO)
7926 size_t hash_size;
7927 psa_status_t status;
7928 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
7929
7930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
7931 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
7932 if( status != PSA_SUCCESS )
7933 {
7934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7935 return;
7936 }
7937
7938 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
7939 if( status != PSA_SUCCESS )
7940 {
7941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7942 return;
7943 }
7944
7945 *hlen = 48;
7946 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
7947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
7948#else
7949 mbedtls_sha512_context sha512;
7950
7951 mbedtls_sha512_init( &sha512 );
7952
7953 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
7954
7955 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
7956 mbedtls_sha512_finish( &sha512, hash );
7957
7958 *hlen = 48;
7959
7960 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
7961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
7962
7963 mbedtls_sha512_free( &sha512 );
7964#endif /* MBEDTLS_USE_PSA_CRYPTO */
7965 return;
7966}
7967#endif /* MBEDTLS_SHA384_C */
7968
Jerry Yudc7bd172022-02-17 13:44:15 +08007969#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007971#endif /* MBEDTLS_SSL_TLS_C */