blob: 6c7f84f67e105b928ecc7f08f955c4928039b3ff [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 Yuc73c6182022-02-08 20:29:25 +0800434#if defined(MBEDTLS_X509_CRT_PARSE_C)
435static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
436{
437#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
438 if( session->peer_cert != NULL )
439 {
440 mbedtls_x509_crt_free( session->peer_cert );
441 mbedtls_free( session->peer_cert );
442 session->peer_cert = NULL;
443 }
444#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
445 if( session->peer_cert_digest != NULL )
446 {
447 /* Zeroization is not necessary. */
448 mbedtls_free( session->peer_cert_digest );
449 session->peer_cert_digest = NULL;
450 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
451 session->peer_cert_digest_len = 0;
452 }
453#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
454}
455#endif /* MBEDTLS_X509_CRT_PARSE_C */
456
457void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
458 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
459{
460 ((void) ciphersuite_info);
461
462#if defined(MBEDTLS_SHA384_C)
463 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
464 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
465 else
466#endif
467#if defined(MBEDTLS_SHA256_C)
468 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
469 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
470 else
471#endif
472 {
473 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
474 return;
475 }
476}
477
478void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
479{
480 ((void) ssl);
481#if defined(MBEDTLS_SHA256_C)
482#if defined(MBEDTLS_USE_PSA_CRYPTO)
483 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
484 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
485#else
486 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
487#endif
488#endif
489#if defined(MBEDTLS_SHA384_C)
490#if defined(MBEDTLS_USE_PSA_CRYPTO)
491 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
492 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
493#else
494 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
495#endif
496#endif
497}
498
499static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
500 const unsigned char *buf, size_t len )
501{
502#if defined(MBEDTLS_SHA256_C)
503#if defined(MBEDTLS_USE_PSA_CRYPTO)
504 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
505#else
506 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
507#endif
508#endif
509#if defined(MBEDTLS_SHA384_C)
510#if defined(MBEDTLS_USE_PSA_CRYPTO)
511 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
512#else
513 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
514#endif
515#endif
516}
517
518#if defined(MBEDTLS_SHA256_C)
519static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
520 const unsigned char *buf, size_t len )
521{
522#if defined(MBEDTLS_USE_PSA_CRYPTO)
523 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
524#else
525 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
526#endif
527}
528#endif
529
530#if defined(MBEDTLS_SHA384_C)
531static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
532 const unsigned char *buf, size_t len )
533{
534#if defined(MBEDTLS_USE_PSA_CRYPTO)
535 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
536#else
537 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
538#endif
539}
540#endif
541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200543{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500547#if defined(MBEDTLS_USE_PSA_CRYPTO)
548 handshake->fin_sha256_psa = psa_hash_operation_init();
549 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
550#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200552 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200553#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500554#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200555#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500556#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500557 handshake->fin_sha384_psa = psa_hash_operation_init();
558 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500559#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200561 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200562#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500563#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200564
565 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100566
567#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100568 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100569 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
570#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572#if defined(MBEDTLS_DHM_C)
573 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200574#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575#if defined(MBEDTLS_ECDH_C)
576 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200577#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200578#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200579 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200580#if defined(MBEDTLS_SSL_CLI_C)
581 handshake->ecjpake_cache = NULL;
582 handshake->ecjpake_cache_len = 0;
583#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200584#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200585
Gilles Peskineeccd8882020-03-10 12:19:08 +0100586#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200587 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200588#endif
589
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200590#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
591 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
592#endif
Hanno Becker75173122019-02-06 16:18:31 +0000593
594#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
595 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
596 mbedtls_pk_init( &handshake->peer_pubkey );
597#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200598}
599
Hanno Beckera18d1322018-01-03 14:27:32 +0000600void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200601{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200603
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100604#if defined(MBEDTLS_USE_PSA_CRYPTO)
605 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
606 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100607#else
608 mbedtls_cipher_init( &transform->cipher_ctx_enc );
609 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100610#endif
611
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000612#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613 mbedtls_md_init( &transform->md_ctx_enc );
614 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000615#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616}
617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200619{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200621}
622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000624{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000626 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200628 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200630 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200631 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200632
633 /*
634 * Either the pointers are now NULL or cleared properly and can be freed.
635 * Now allocate missing structures.
636 */
637 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200638 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200639 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200640 }
Paul Bakker48916f92012-09-16 19:57:18 +0000641
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200642 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200643 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200644 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200645 }
Paul Bakker48916f92012-09-16 19:57:18 +0000646
Paul Bakker82788fb2014-10-20 13:59:19 +0200647 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200648 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200649 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200650 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500651#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
652 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400653
Andrzej Kurek4a063792020-10-21 15:08:44 +0200654 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
655 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500656#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000657
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200658 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000659 if( ssl->handshake == NULL ||
660 ssl->transform_negotiate == NULL ||
661 ssl->session_negotiate == NULL )
662 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 mbedtls_free( ssl->handshake );
666 mbedtls_free( ssl->transform_negotiate );
667 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200668
669 ssl->handshake = NULL;
670 ssl->transform_negotiate = NULL;
671 ssl->session_negotiate = NULL;
672
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200673 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000674 }
675
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200676 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000678 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200679 ssl_handshake_params_init( ssl->handshake );
680
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200682 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
683 {
684 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200685
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200686 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
687 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
688 else
689 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200690
Hanno Becker0f57a652020-02-05 10:37:26 +0000691 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200692 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200693#endif
694
Brett Warrene0edc842021-08-17 09:53:13 +0100695/*
696 * curve_list is translated to IANA TLS group identifiers here because
697 * mbedtls_ssl_conf_curves returns void and so can't return
698 * any error codes.
699 */
700#if defined(MBEDTLS_ECP_C)
701#if !defined(MBEDTLS_DEPRECATED_REMOVED)
702 /* Heap allocate and translate curve_list from internal to IANA group ids */
703 if ( ssl->conf->curve_list != NULL )
704 {
705 size_t length;
706 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
707
708 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
709 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
710
711 /* Leave room for zero termination */
712 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
713 if ( group_list == NULL )
714 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
715
716 for( size_t i = 0; i < length; i++ )
717 {
718 const mbedtls_ecp_curve_info *info =
719 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
720 if ( info == NULL )
721 {
722 mbedtls_free( group_list );
723 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
724 }
725 group_list[i] = info->tls_id;
726 }
727
728 group_list[length] = 0;
729
730 ssl->handshake->group_list = group_list;
731 ssl->handshake->group_list_heap_allocated = 1;
732 }
733 else
734 {
735 ssl->handshake->group_list = ssl->conf->group_list;
736 ssl->handshake->group_list_heap_allocated = 0;
737 }
738#endif /* MBEDTLS_DEPRECATED_REMOVED */
739#endif /* MBEDTLS_ECP_C */
740
Jerry Yuf017ee42022-01-12 15:49:48 +0800741#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
742#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800743#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800744 /* Heap allocate and translate sig_hashes from internal hash identifiers to
745 signature algorithms IANA identifiers. */
746 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800747 ssl->conf->sig_hashes != NULL )
748 {
749 const int *md;
750 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800751 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800752 uint16_t *p;
753
Jerry Yub476a442022-01-21 18:14:45 +0800754#if defined(static_assert)
755 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
756 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
757 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800758#endif
759
Jerry Yuf017ee42022-01-12 15:49:48 +0800760 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
761 {
762 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
763 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800764#if defined(MBEDTLS_ECDSA_C)
765 sig_algs_len += sizeof( uint16_t );
766#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800767
Jerry Yub476a442022-01-21 18:14:45 +0800768#if defined(MBEDTLS_RSA_C)
769 sig_algs_len += sizeof( uint16_t );
770#endif
771 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
772 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800773 }
774
Jerry Yub476a442022-01-21 18:14:45 +0800775 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800776 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
777
Jerry Yub476a442022-01-21 18:14:45 +0800778 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
779 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800780 if( ssl->handshake->sig_algs == NULL )
781 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
782
783 p = (uint16_t *)ssl->handshake->sig_algs;
784 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
785 {
786 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
787 if( hash == MBEDTLS_SSL_HASH_NONE )
788 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800789#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800790 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
791 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800792#endif
793#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800794 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
795 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800796#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800797 }
798 *p = MBEDTLS_TLS1_3_SIG_NONE;
799 ssl->handshake->sig_algs_heap_allocated = 1;
800 }
801 else
Jerry Yua69269a2022-01-17 21:06:01 +0800802#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800803 {
804 ssl->handshake->sig_algs = ssl->conf->sig_algs;
805 ssl->handshake->sig_algs_heap_allocated = 0;
806 }
807#endif /* MBEDTLS_DEPRECATED_REMOVED */
808#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000809 return( 0 );
810}
811
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200812#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200813/* Dummy cookie callbacks for defaults */
814static int ssl_cookie_write_dummy( void *ctx,
815 unsigned char **p, unsigned char *end,
816 const unsigned char *cli_id, size_t cli_id_len )
817{
818 ((void) ctx);
819 ((void) p);
820 ((void) end);
821 ((void) cli_id);
822 ((void) cli_id_len);
823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200825}
826
827static int ssl_cookie_check_dummy( void *ctx,
828 const unsigned char *cookie, size_t cookie_len,
829 const unsigned char *cli_id, size_t cli_id_len )
830{
831 ((void) ctx);
832 ((void) cookie);
833 ((void) cookie_len);
834 ((void) cli_id);
835 ((void) cli_id_len);
836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200838}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200839#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200840
Paul Bakker5121ce52009-01-03 21:22:43 +0000841/*
842 * Initialize an SSL context
843 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200844void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
845{
846 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
847}
848
Jerry Yu60835a82021-08-04 10:13:52 +0800849static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
850{
Ronald Cron6f135e12021-12-08 16:57:54 +0100851#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +0800852 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
853 {
854 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
855 {
856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported" ) );
857 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
858 }
859 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
860 return( 0 );
861 }
862#endif
863
864#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
865 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
866 {
867 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
868 return( 0 );
869 }
870#endif
871
Ronald Cron6f135e12021-12-08 16:57:54 +0100872#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +0800873 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( ssl->conf ) )
874 {
875 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Hybrid TLS 1.2 + TLS 1.3 configurations are not yet supported" ) );
876 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
877 }
878#endif
879
880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
881 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
882}
883
884static int ssl_conf_check(const mbedtls_ssl_context *ssl)
885{
886 int ret;
887 ret = ssl_conf_version_check( ssl );
888 if( ret != 0 )
889 return( ret );
890
891 /* Space for further checks */
892
893 return( 0 );
894}
895
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200896/*
897 * Setup an SSL context
898 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100899
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200900int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200901 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000902{
Janos Follath865b3eb2019-12-16 11:46:15 +0000903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000904 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
905 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000906
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200907 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000908
Jerry Yu60835a82021-08-04 10:13:52 +0800909 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
910 return( ret );
911
Paul Bakker62f2dee2012-09-28 07:31:51 +0000912 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100913 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000914 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200915
916 /* Set to NULL in case of an error condition */
917 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200918
Darryl Greenb33cc762019-11-28 14:29:44 +0000919#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
920 ssl->in_buf_len = in_buf_len;
921#endif
922 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000923 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000924 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200926 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +0200927 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +1000928 }
929
Darryl Greenb33cc762019-11-28 14:29:44 +0000930#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
931 ssl->out_buf_len = out_buf_len;
932#endif
933 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000934 if( ssl->out_buf == NULL )
935 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000936 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200937 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +0200938 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +0000939 }
940
Hanno Becker3e6f8ab2020-02-05 10:40:57 +0000941 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +0200942
Johan Pascalb62bb512015-12-03 21:56:45 +0100943#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +0200944 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +0100945#endif
946
Paul Bakker48916f92012-09-16 19:57:18 +0000947 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +0200948 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +0000949
950 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +0200951
952error:
953 mbedtls_free( ssl->in_buf );
954 mbedtls_free( ssl->out_buf );
955
956 ssl->conf = NULL;
957
Darryl Greenb33cc762019-11-28 14:29:44 +0000958#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
959 ssl->in_buf_len = 0;
960 ssl->out_buf_len = 0;
961#endif
k-stachowiaka47911c2018-07-04 17:41:58 +0200962 ssl->in_buf = NULL;
963 ssl->out_buf = NULL;
964
965 ssl->in_hdr = NULL;
966 ssl->in_ctr = NULL;
967 ssl->in_len = NULL;
968 ssl->in_iv = NULL;
969 ssl->in_msg = NULL;
970
971 ssl->out_hdr = NULL;
972 ssl->out_ctr = NULL;
973 ssl->out_len = NULL;
974 ssl->out_iv = NULL;
975 ssl->out_msg = NULL;
976
k-stachowiak9f7798e2018-07-31 16:52:32 +0200977 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +0000978}
979
980/*
Paul Bakker7eb013f2011-10-06 12:37:39 +0000981 * Reset an initialized and used SSL context for re-use while retaining
982 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +0200983 *
984 * If partial is non-zero, keep data in the input buffer and client ID.
985 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +0000986 */
XiaokangQian78b1fa72022-01-19 06:56:30 +0000987void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
988 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +0000989{
Darryl Greenb33cc762019-11-28 14:29:44 +0000990#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
991 size_t in_buf_len = ssl->in_buf_len;
992 size_t out_buf_len = ssl->out_buf_len;
993#else
994 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
995 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
996#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000997
Hanno Beckerb0302c42021-08-03 09:39:42 +0100998#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
999 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001000#endif
1001
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001002 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001003 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001004
Hanno Beckerb0302c42021-08-03 09:39:42 +01001005 mbedtls_ssl_reset_in_out_pointers( ssl );
1006
1007 /* Reset incoming message parsing */
1008 ssl->in_offt = NULL;
1009 ssl->nb_zero = 0;
1010 ssl->in_msgtype = 0;
1011 ssl->in_msglen = 0;
1012 ssl->in_hslen = 0;
1013 ssl->keep_current_message = 0;
1014 ssl->transform_in = NULL;
1015
1016#if defined(MBEDTLS_SSL_PROTO_DTLS)
1017 ssl->next_record_offset = 0;
1018 ssl->in_epoch = 0;
1019#endif
1020
1021 /* Keep current datagram if partial == 1 */
1022 if( partial == 0 )
1023 {
1024 ssl->in_left = 0;
1025 memset( ssl->in_buf, 0, in_buf_len );
1026 }
1027
1028 /* Reset outgoing message writing */
1029 ssl->out_msgtype = 0;
1030 ssl->out_msglen = 0;
1031 ssl->out_left = 0;
1032 memset( ssl->out_buf, 0, out_buf_len );
1033 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1034 ssl->transform_out = NULL;
1035
1036#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1037 mbedtls_ssl_dtls_replay_reset( ssl );
1038#endif
1039
XiaokangQian2b01dc32022-01-21 02:53:13 +00001040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001041 if( ssl->transform )
1042 {
1043 mbedtls_ssl_transform_free( ssl->transform );
1044 mbedtls_free( ssl->transform );
1045 ssl->transform = NULL;
1046 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001047#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1048
XiaokangQian2b01dc32022-01-21 02:53:13 +00001049#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1050 mbedtls_ssl_transform_free( ssl->transform_application );
1051 mbedtls_free( ssl->transform_application );
1052 ssl->transform_application = NULL;
1053
1054 if( ssl->handshake != NULL )
1055 {
1056 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1057 mbedtls_free( ssl->handshake->transform_earlydata );
1058 ssl->handshake->transform_earlydata = NULL;
1059
1060 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1061 mbedtls_free( ssl->handshake->transform_handshake );
1062 ssl->handshake->transform_handshake = NULL;
1063 }
1064
XiaokangQian2b01dc32022-01-21 02:53:13 +00001065#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001066}
1067
1068int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1069{
1070 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1071
1072 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1073
XiaokangQian78b1fa72022-01-19 06:56:30 +00001074 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001075
1076 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077#if defined(MBEDTLS_SSL_RENEGOTIATION)
1078 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001079 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001080
1081 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1083 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001084#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001086
Hanno Beckerb0302c42021-08-03 09:39:42 +01001087 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001088 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001089 if( ssl->session )
1090 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 mbedtls_ssl_session_free( ssl->session );
1092 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001093 ssl->session = NULL;
1094 }
1095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001097 ssl->alpn_chosen = NULL;
1098#endif
1099
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001100#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001101#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001102 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001103#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001104 {
1105 mbedtls_free( ssl->cli_id );
1106 ssl->cli_id = NULL;
1107 ssl->cli_id_len = 0;
1108 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001109#endif
1110
Paul Bakker48916f92012-09-16 19:57:18 +00001111 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1112 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001113
1114 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001115}
1116
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001117/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001118 * Reset an initialized and used SSL context for re-use while retaining
1119 * all application-set variables, function pointers and data.
1120 */
1121int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1122{
Hanno Becker43aefe22020-02-05 10:44:56 +00001123 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001124}
1125
1126/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001127 * SSL set accessors
1128 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001129void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001130{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001131 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001132}
1133
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001134void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001135{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001136 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001137}
1138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001140void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001141{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001142 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001143}
1144#endif
1145
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001146void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001147{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001148 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001149}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001152
Hanno Becker1841b0a2018-08-24 11:13:57 +01001153void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1154 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001155{
1156 ssl->disable_datagram_packing = !allow_packing;
1157}
1158
1159void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1160 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001161{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001162 conf->hs_timeout_min = min;
1163 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001164}
1165#endif
1166
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001167void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001168{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001169 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001170}
1171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001173void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001174 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001175 void *p_vrfy )
1176{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001177 conf->f_vrfy = f_vrfy;
1178 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001179}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001181
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001182void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001183 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001184 void *p_rng )
1185{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001186 conf->f_rng = f_rng;
1187 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001188}
1189
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001190void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001191 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001192 void *p_dbg )
1193{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001194 conf->f_dbg = f_dbg;
1195 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001196}
1197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001199 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001200 mbedtls_ssl_send_t *f_send,
1201 mbedtls_ssl_recv_t *f_recv,
1202 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001203{
1204 ssl->p_bio = p_bio;
1205 ssl->f_send = f_send;
1206 ssl->f_recv = f_recv;
1207 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001208}
1209
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001210#if defined(MBEDTLS_SSL_PROTO_DTLS)
1211void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1212{
1213 ssl->mtu = mtu;
1214}
1215#endif
1216
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001217void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001218{
1219 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001220}
1221
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001222void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1223 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001224 mbedtls_ssl_set_timer_t *f_set_timer,
1225 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001226{
1227 ssl->p_timer = p_timer;
1228 ssl->f_set_timer = f_set_timer;
1229 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001230
1231 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001232 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001233}
1234
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss2ed95272022-01-21 18:02:17 -05001236void mbedtls_ssl_conf_cert_cb( mbedtls_ssl_config *conf,
1237 int (*f_cert_cb)(mbedtls_ssl_context *) )
1238{
1239 conf->f_cert_cb = f_cert_cb;
1240}
1241#endif /* MBEDTLS_SSL_SRV_C */
1242
1243#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001244void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001245 void *p_cache,
1246 mbedtls_ssl_cache_get_t *f_get_cache,
1247 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001248{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001249 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001250 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001251 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001252}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#if defined(MBEDTLS_SSL_CLI_C)
1256int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001257{
Janos Follath865b3eb2019-12-16 11:46:15 +00001258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001259
1260 if( ssl == NULL ||
1261 session == NULL ||
1262 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001263 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001266 }
1267
Hanno Beckere810bbc2021-05-14 16:01:05 +01001268 if( ssl->handshake->resume == 1 )
1269 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1270
Hanno Becker52055ae2019-02-06 14:30:46 +00001271 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1272 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001273 return( ret );
1274
Paul Bakker0a597072012-09-25 21:55:46 +00001275 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001276
1277 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001278}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001280
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001281void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1282 const int *ciphersuites )
1283{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001284 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001285}
1286
Ronald Cron6f135e12021-12-08 16:57:54 +01001287#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001288void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001289 const int kex_modes )
1290{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001291 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001292}
Ronald Cron6f135e12021-12-08 16:57:54 +01001293#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001296void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001297 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001298{
1299 conf->cert_profile = profile;
1300}
1301
Glenn Strauss36872db2022-01-22 05:06:31 -05001302static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1303{
1304 mbedtls_ssl_key_cert *cur = key_cert, *next;
1305
1306 while( cur != NULL )
1307 {
1308 next = cur->next;
1309 mbedtls_free( cur );
1310 cur = next;
1311 }
1312}
1313
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001314/* Append a new keycert entry to a (possibly empty) list */
1315static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1316 mbedtls_x509_crt *cert,
1317 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001318{
niisato8ee24222018-06-25 19:05:48 +09001319 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001320
Glenn Strauss36872db2022-01-22 05:06:31 -05001321 if( cert == NULL )
1322 {
1323 /* Free list if cert is null */
1324 ssl_key_cert_free( *head );
1325 *head = NULL;
1326 return( 0 );
1327 }
1328
niisato8ee24222018-06-25 19:05:48 +09001329 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1330 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001331 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001332
niisato8ee24222018-06-25 19:05:48 +09001333 new_cert->cert = cert;
1334 new_cert->key = key;
1335 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001336
Glenn Strauss36872db2022-01-22 05:06:31 -05001337 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001338 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001339 {
niisato8ee24222018-06-25 19:05:48 +09001340 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001341 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001342 else
1343 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001344 mbedtls_ssl_key_cert *cur = *head;
1345 while( cur->next != NULL )
1346 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001347 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001348 }
1349
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001350 return( 0 );
1351}
1352
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001353int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001354 mbedtls_x509_crt *own_cert,
1355 mbedtls_pk_context *pk_key )
1356{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001357 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001358}
1359
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001360void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001361 mbedtls_x509_crt *ca_chain,
1362 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001363{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001364 conf->ca_chain = ca_chain;
1365 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001366
1367#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1368 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1369 * cannot be used together. */
1370 conf->f_ca_cb = NULL;
1371 conf->p_ca_cb = NULL;
1372#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001373}
Hanno Becker5adaad92019-03-27 16:54:37 +00001374
1375#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1376void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001377 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001378 void *p_ca_cb )
1379{
1380 conf->f_ca_cb = f_ca_cb;
1381 conf->p_ca_cb = p_ca_cb;
1382
1383 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1384 * cannot be used together. */
1385 conf->ca_chain = NULL;
1386 conf->ca_crl = NULL;
1387}
1388#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001390
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001391#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001392const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1393 size_t *name_len )
1394{
1395 *name_len = ssl->handshake->sni_name_len;
1396 return( ssl->handshake->sni_name );
1397}
1398
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001399int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1400 mbedtls_x509_crt *own_cert,
1401 mbedtls_pk_context *pk_key )
1402{
1403 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1404 own_cert, pk_key ) );
1405}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001406
1407void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1408 mbedtls_x509_crt *ca_chain,
1409 mbedtls_x509_crl *ca_crl )
1410{
1411 ssl->handshake->sni_ca_chain = ca_chain;
1412 ssl->handshake->sni_ca_crl = ca_crl;
1413}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001414
1415void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1416 int authmode )
1417{
1418 ssl->handshake->sni_authmode = authmode;
1419}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001420#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1421
Hanno Becker8927c832019-04-03 12:52:50 +01001422#if defined(MBEDTLS_X509_CRT_PARSE_C)
1423void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1424 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1425 void *p_vrfy )
1426{
1427 ssl->f_vrfy = f_vrfy;
1428 ssl->p_vrfy = p_vrfy;
1429}
1430#endif
1431
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001432#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001433/*
1434 * Set EC J-PAKE password for current handshake
1435 */
1436int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1437 const unsigned char *pw,
1438 size_t pw_len )
1439{
1440 mbedtls_ecjpake_role role;
1441
Janos Follath8eb64132016-06-03 15:40:57 +01001442 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001443 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1444
1445 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1446 role = MBEDTLS_ECJPAKE_SERVER;
1447 else
1448 role = MBEDTLS_ECJPAKE_CLIENT;
1449
1450 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1451 role,
1452 MBEDTLS_MD_SHA256,
1453 MBEDTLS_ECP_DP_SECP256R1,
1454 pw, pw_len ) );
1455}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001456#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001457
Gilles Peskineeccd8882020-03-10 12:19:08 +01001458#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001459
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001460static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1461{
1462#if defined(MBEDTLS_USE_PSA_CRYPTO)
1463 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1464 return( 1 );
1465#endif /* MBEDTLS_USE_PSA_CRYPTO */
1466
1467 if( conf->psk != NULL )
1468 return( 1 );
1469
1470 return( 0 );
1471}
1472
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001473static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1474{
1475 /* Remove reference to existing PSK, if any. */
1476#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001477 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001478 {
1479 /* The maintenance of the PSK key slot is the
1480 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001481 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001482 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001483 /* This and the following branch should never
1484 * be taken simultaenously as we maintain the
1485 * invariant that raw and opaque PSKs are never
1486 * configured simultaneously. As a safeguard,
1487 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001488#endif /* MBEDTLS_USE_PSA_CRYPTO */
1489 if( conf->psk != NULL )
1490 {
1491 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1492
1493 mbedtls_free( conf->psk );
1494 conf->psk = NULL;
1495 conf->psk_len = 0;
1496 }
1497
1498 /* Remove reference to PSK identity, if any. */
1499 if( conf->psk_identity != NULL )
1500 {
1501 mbedtls_free( conf->psk_identity );
1502 conf->psk_identity = NULL;
1503 conf->psk_identity_len = 0;
1504 }
1505}
1506
Hanno Becker7390c712018-11-15 13:33:04 +00001507/* This function assumes that PSK identity in the SSL config is unset.
1508 * It checks that the provided identity is well-formed and attempts
1509 * to make a copy of it in the SSL config.
1510 * On failure, the PSK identity in the config remains unset. */
1511static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1512 unsigned char const *psk_identity,
1513 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001514{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001515 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001516 if( psk_identity == NULL ||
1517 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001518 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001519 {
1520 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1521 }
1522
Hanno Becker7390c712018-11-15 13:33:04 +00001523 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1524 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001525 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001526
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001527 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001528 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001529
1530 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001531}
1532
Hanno Becker7390c712018-11-15 13:33:04 +00001533int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1534 const unsigned char *psk, size_t psk_len,
1535 const unsigned char *psk_identity, size_t psk_identity_len )
1536{
Janos Follath865b3eb2019-12-16 11:46:15 +00001537 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001538
1539 /* We currently only support one PSK, raw or opaque. */
1540 if( ssl_conf_psk_is_configured( conf ) )
1541 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001542
1543 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001544 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001545 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001546 if( psk_len == 0 )
1547 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1548 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1549 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1550
Hanno Becker7390c712018-11-15 13:33:04 +00001551 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1552 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1553 conf->psk_len = psk_len;
1554 memcpy( conf->psk, psk, conf->psk_len );
1555
1556 /* Check and set PSK Identity */
1557 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1558 if( ret != 0 )
1559 ssl_conf_remove_psk( conf );
1560
1561 return( ret );
1562}
1563
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001564static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1565{
1566#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001567 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001568 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001569 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001570 }
1571 else
1572#endif /* MBEDTLS_USE_PSA_CRYPTO */
1573 if( ssl->handshake->psk != NULL )
1574 {
1575 mbedtls_platform_zeroize( ssl->handshake->psk,
1576 ssl->handshake->psk_len );
1577 mbedtls_free( ssl->handshake->psk );
1578 ssl->handshake->psk_len = 0;
1579 }
1580}
1581
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001582int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1583 const unsigned char *psk, size_t psk_len )
1584{
1585 if( psk == NULL || ssl->handshake == NULL )
1586 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1587
1588 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1589 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1590
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001591 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001592
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001593 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001594 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001595
1596 ssl->handshake->psk_len = psk_len;
1597 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1598
1599 return( 0 );
1600}
1601
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001602#if defined(MBEDTLS_USE_PSA_CRYPTO)
1603int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001604 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001605 const unsigned char *psk_identity,
1606 size_t psk_identity_len )
1607{
Janos Follath865b3eb2019-12-16 11:46:15 +00001608 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001609
1610 /* We currently only support one PSK, raw or opaque. */
1611 if( ssl_conf_psk_is_configured( conf ) )
1612 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001613
Hanno Becker7390c712018-11-15 13:33:04 +00001614 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001615 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001616 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001617 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001618
1619 /* Check and set PSK Identity */
1620 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1621 psk_identity_len );
1622 if( ret != 0 )
1623 ssl_conf_remove_psk( conf );
1624
1625 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001626}
1627
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001628int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1629 mbedtls_svc_key_id_t psk )
1630{
1631 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1632 ( ssl->handshake == NULL ) )
1633 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1634
1635 ssl_remove_psk( ssl );
1636 ssl->handshake->psk_opaque = psk;
1637 return( 0 );
1638}
1639#endif /* MBEDTLS_USE_PSA_CRYPTO */
1640
1641void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1642 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1643 size_t),
1644 void *p_psk )
1645{
1646 conf->f_psk = f_psk;
1647 conf->p_psk = p_psk;
1648}
1649#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1650
1651#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001652psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001653 size_t taglen,
1654 psa_algorithm_t *alg,
1655 psa_key_type_t *key_type,
1656 size_t *key_size )
1657{
1658 switch ( mbedtls_cipher_type )
1659 {
1660 case MBEDTLS_CIPHER_AES_128_CBC:
1661 *alg = PSA_ALG_CBC_NO_PADDING;
1662 *key_type = PSA_KEY_TYPE_AES;
1663 *key_size = 128;
1664 break;
1665 case MBEDTLS_CIPHER_AES_128_CCM:
1666 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1667 *key_type = PSA_KEY_TYPE_AES;
1668 *key_size = 128;
1669 break;
1670 case MBEDTLS_CIPHER_AES_128_GCM:
1671 *alg = PSA_ALG_GCM;
1672 *key_type = PSA_KEY_TYPE_AES;
1673 *key_size = 128;
1674 break;
1675 case MBEDTLS_CIPHER_AES_192_CCM:
1676 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1677 *key_type = PSA_KEY_TYPE_AES;
1678 *key_size = 192;
1679 break;
1680 case MBEDTLS_CIPHER_AES_192_GCM:
1681 *alg = PSA_ALG_GCM;
1682 *key_type = PSA_KEY_TYPE_AES;
1683 *key_size = 192;
1684 break;
1685 case MBEDTLS_CIPHER_AES_256_CBC:
1686 *alg = PSA_ALG_CBC_NO_PADDING;
1687 *key_type = PSA_KEY_TYPE_AES;
1688 *key_size = 256;
1689 break;
1690 case MBEDTLS_CIPHER_AES_256_CCM:
1691 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1692 *key_type = PSA_KEY_TYPE_AES;
1693 *key_size = 256;
1694 break;
1695 case MBEDTLS_CIPHER_AES_256_GCM:
1696 *alg = PSA_ALG_GCM;
1697 *key_type = PSA_KEY_TYPE_AES;
1698 *key_size = 256;
1699 break;
1700 case MBEDTLS_CIPHER_ARIA_128_CBC:
1701 *alg = PSA_ALG_CBC_NO_PADDING;
1702 *key_type = PSA_KEY_TYPE_ARIA;
1703 *key_size = 128;
1704 break;
1705 case MBEDTLS_CIPHER_ARIA_128_CCM:
1706 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1707 *key_type = PSA_KEY_TYPE_ARIA;
1708 *key_size = 128;
1709 break;
1710 case MBEDTLS_CIPHER_ARIA_128_GCM:
1711 *alg = PSA_ALG_GCM;
1712 *key_type = PSA_KEY_TYPE_ARIA;
1713 *key_size = 128;
1714 break;
1715 case MBEDTLS_CIPHER_ARIA_192_CCM:
1716 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1717 *key_type = PSA_KEY_TYPE_ARIA;
1718 *key_size = 192;
1719 break;
1720 case MBEDTLS_CIPHER_ARIA_192_GCM:
1721 *alg = PSA_ALG_GCM;
1722 *key_type = PSA_KEY_TYPE_ARIA;
1723 *key_size = 192;
1724 break;
1725 case MBEDTLS_CIPHER_ARIA_256_CBC:
1726 *alg = PSA_ALG_CBC_NO_PADDING;
1727 *key_type = PSA_KEY_TYPE_ARIA;
1728 *key_size = 256;
1729 break;
1730 case MBEDTLS_CIPHER_ARIA_256_CCM:
1731 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1732 *key_type = PSA_KEY_TYPE_ARIA;
1733 *key_size = 256;
1734 break;
1735 case MBEDTLS_CIPHER_ARIA_256_GCM:
1736 *alg = PSA_ALG_GCM;
1737 *key_type = PSA_KEY_TYPE_ARIA;
1738 *key_size = 256;
1739 break;
1740 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1741 *alg = PSA_ALG_CBC_NO_PADDING;
1742 *key_type = PSA_KEY_TYPE_CAMELLIA;
1743 *key_size = 128;
1744 break;
1745 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1746 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1747 *key_type = PSA_KEY_TYPE_CAMELLIA;
1748 *key_size = 128;
1749 break;
1750 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1751 *alg = PSA_ALG_GCM;
1752 *key_type = PSA_KEY_TYPE_CAMELLIA;
1753 *key_size = 128;
1754 break;
1755 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1756 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1757 *key_type = PSA_KEY_TYPE_CAMELLIA;
1758 *key_size = 192;
1759 break;
1760 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1761 *alg = PSA_ALG_GCM;
1762 *key_type = PSA_KEY_TYPE_CAMELLIA;
1763 *key_size = 192;
1764 break;
1765 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1766 *alg = PSA_ALG_CBC_NO_PADDING;
1767 *key_type = PSA_KEY_TYPE_CAMELLIA;
1768 *key_size = 256;
1769 break;
1770 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1771 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1772 *key_type = PSA_KEY_TYPE_CAMELLIA;
1773 *key_size = 256;
1774 break;
1775 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1776 *alg = PSA_ALG_GCM;
1777 *key_type = PSA_KEY_TYPE_CAMELLIA;
1778 *key_size = 256;
1779 break;
1780 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1781 *alg = PSA_ALG_CHACHA20_POLY1305;
1782 *key_type = PSA_KEY_TYPE_CHACHA20;
1783 *key_size = 256;
1784 break;
1785 case MBEDTLS_CIPHER_NULL:
1786 *alg = MBEDTLS_SSL_NULL_CIPHER;
1787 *key_type = 0;
1788 *key_size = 0;
1789 break;
1790 default:
1791 return PSA_ERROR_NOT_SUPPORTED;
1792 }
1793
1794 return PSA_SUCCESS;
1795}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001796#endif /* MBEDTLS_USE_PSA_CRYPTO */
1797
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001798#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001799int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1800 const unsigned char *dhm_P, size_t P_len,
1801 const unsigned char *dhm_G, size_t G_len )
1802{
Janos Follath865b3eb2019-12-16 11:46:15 +00001803 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001804
Glenn Strausscee11292021-12-20 01:43:17 -05001805 mbedtls_mpi_free( &conf->dhm_P );
1806 mbedtls_mpi_free( &conf->dhm_G );
1807
Hanno Beckera90658f2017-10-04 15:29:08 +01001808 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1809 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1810 {
1811 mbedtls_mpi_free( &conf->dhm_P );
1812 mbedtls_mpi_free( &conf->dhm_G );
1813 return( ret );
1814 }
1815
1816 return( 0 );
1817}
Paul Bakker5121ce52009-01-03 21:22:43 +00001818
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001819int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001820{
Janos Follath865b3eb2019-12-16 11:46:15 +00001821 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001822
Glenn Strausscee11292021-12-20 01:43:17 -05001823 mbedtls_mpi_free( &conf->dhm_P );
1824 mbedtls_mpi_free( &conf->dhm_G );
1825
Gilles Peskinee5702482021-06-11 21:59:08 +02001826 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1827 &conf->dhm_P ) ) != 0 ||
1828 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1829 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001830 {
1831 mbedtls_mpi_free( &conf->dhm_P );
1832 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001833 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001834 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001835
1836 return( 0 );
1837}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001838#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001839
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001840#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1841/*
1842 * Set the minimum length for Diffie-Hellman parameters
1843 */
1844void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1845 unsigned int bitlen )
1846{
1847 conf->dhm_min_bitlen = bitlen;
1848}
1849#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1850
Gilles Peskineeccd8882020-03-10 12:19:08 +01001851#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001852#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001853/*
1854 * Set allowed/preferred hashes for handshake signatures
1855 */
1856void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1857 const int *hashes )
1858{
1859 conf->sig_hashes = hashes;
1860}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001861#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001862
Jerry Yuf017ee42022-01-12 15:49:48 +08001863/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001864void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1865 const uint16_t* sig_algs )
1866{
Jerry Yuf017ee42022-01-12 15:49:48 +08001867#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1868 conf->sig_hashes = NULL;
1869#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1870 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001871}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001872#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001873
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001874#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001875#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001876/*
1877 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001878 *
1879 * mbedtls_ssl_setup() takes the provided list
1880 * and translates it to a list of IANA TLS group identifiers,
1881 * stored in ssl->handshake->group_list.
1882 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001883 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001884void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001885 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001886{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001887 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01001888 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001889}
Brett Warrene0edc842021-08-17 09:53:13 +01001890#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01001891#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001892
Brett Warrene0edc842021-08-17 09:53:13 +01001893/*
1894 * Set the allowed groups
1895 */
1896void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
1897 const uint16_t *group_list )
1898{
1899#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1900 conf->curve_list = NULL;
1901#endif
1902 conf->group_list = group_list;
1903}
1904
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001905#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00001907{
Hanno Becker947194e2017-04-07 13:25:49 +01001908 /* Initialize to suppress unnecessary compiler warning */
1909 size_t hostname_len = 0;
1910
1911 /* Check if new hostname is valid before
1912 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01001913 if( hostname != NULL )
1914 {
1915 hostname_len = strlen( hostname );
1916
1917 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
1918 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1919 }
1920
1921 /* Now it's clear that we will overwrite the old hostname,
1922 * so we can free it safely */
1923
1924 if( ssl->hostname != NULL )
1925 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05001926 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01001927 mbedtls_free( ssl->hostname );
1928 }
1929
1930 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01001931
Paul Bakker5121ce52009-01-03 21:22:43 +00001932 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01001933 {
1934 ssl->hostname = NULL;
1935 }
1936 else
1937 {
1938 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01001939 if( ssl->hostname == NULL )
1940 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02001941
Hanno Becker947194e2017-04-07 13:25:49 +01001942 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02001943
Hanno Becker947194e2017-04-07 13:25:49 +01001944 ssl->hostname[hostname_len] = '\0';
1945 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001946
1947 return( 0 );
1948}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01001949#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001950
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001951#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001952void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001954 const unsigned char *, size_t),
1955 void *p_sni )
1956{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001957 conf->f_sni = f_sni;
1958 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00001959}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00001961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001963int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001964{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001965 size_t cur_len, tot_len;
1966 const char **p;
1967
1968 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08001969 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
1970 * MUST NOT be truncated."
1971 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001972 */
1973 tot_len = 0;
1974 for( p = protos; *p != NULL; p++ )
1975 {
1976 cur_len = strlen( *p );
1977 tot_len += cur_len;
1978
Ronald Cron8216dd32020-04-23 16:41:44 +02001979 if( ( cur_len == 0 ) ||
1980 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
1981 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001983 }
1984
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001985 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001986
1987 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001988}
1989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001991{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02001992 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001993}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001995
Johan Pascalb62bb512015-12-03 21:56:45 +01001996#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03001997void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
1998 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02001999{
2000 conf->dtls_srtp_mki_support = support_mki_value;
2001}
2002
Ron Eldoref72faf2018-07-12 11:54:20 +03002003int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2004 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002005 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002006{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002007 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002008 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002009 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002010 }
Ron Eldor591f1622018-01-22 12:30:04 +02002011
2012 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002013 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002014 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002015 }
Ron Eldor591f1622018-01-22 12:30:04 +02002016
2017 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2018 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002019 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002020}
2021
Ron Eldoref72faf2018-07-12 11:54:20 +03002022int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002023 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002024{
Johan Pascal253d0262020-09-22 13:04:45 +02002025 const mbedtls_ssl_srtp_profile *p;
2026 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002027
Johan Pascal253d0262020-09-22 13:04:45 +02002028 /* check the profiles list: all entry must be valid,
2029 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002030 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2031 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2032 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002033 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002034 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002035 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002036 list_size++;
2037 }
2038 else
2039 {
2040 /* unsupported value, stop parsing and set the size to an error value */
2041 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002042 }
2043 }
2044
Johan Pascal5ef72d22020-10-28 17:05:47 +01002045 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002046 {
Johan Pascal253d0262020-09-22 13:04:45 +02002047 conf->dtls_srtp_profile_list = NULL;
2048 conf->dtls_srtp_profile_list_len = 0;
2049 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2050 }
2051
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002052 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002053 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002054
2055 return( 0 );
2056}
2057
Johan Pascal5ef72d22020-10-28 17:05:47 +01002058void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2059 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002060{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002061 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2062 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002063 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002064 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002065 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002066 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002067 else
2068 {
2069 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002070 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2071 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002072 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002073}
Johan Pascalb62bb512015-12-03 21:56:45 +01002074#endif /* MBEDTLS_SSL_DTLS_SRTP */
2075
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002076void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002077{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002078 conf->max_major_ver = major;
2079 conf->max_minor_ver = minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002080}
2081
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002082void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002083{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002084 conf->min_major_ver = major;
2085 conf->min_minor_ver = minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002086}
2087
Janos Follath088ce432017-04-10 12:42:31 +01002088#if defined(MBEDTLS_SSL_SRV_C)
2089void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2090 char cert_req_ca_list )
2091{
2092 conf->cert_req_ca_list = cert_req_ca_list;
2093}
2094#endif
2095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002097void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002098{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002099 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002100}
2101#endif
2102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002104void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002105{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002106 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002107}
2108#endif
2109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002111int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002112{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002114 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002115 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002117 }
2118
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002119 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002120
2121 return( 0 );
2122}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002124
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002125void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002126{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002127 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002128}
2129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002131void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002132{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002133 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002134}
2135
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002136void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002137{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002138 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002139}
2140
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002141void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002142 const unsigned char period[8] )
2143{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002144 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002145}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002146#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002149#if defined(MBEDTLS_SSL_CLI_C)
2150void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002151{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002152 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002153}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002154#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002155
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002156#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002157void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2158 mbedtls_ssl_ticket_write_t *f_ticket_write,
2159 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2160 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002161{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002162 conf->f_ticket_write = f_ticket_write;
2163 conf->f_ticket_parse = f_ticket_parse;
2164 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002165}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002166#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002168
Hanno Becker7e6c1782021-06-08 09:24:55 +01002169void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2170 mbedtls_ssl_export_keys_t *f_export_keys,
2171 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002172{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002173 ssl->f_export_keys = f_export_keys;
2174 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002175}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002176
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002177#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002178void mbedtls_ssl_conf_async_private_cb(
2179 mbedtls_ssl_config *conf,
2180 mbedtls_ssl_async_sign_t *f_async_sign,
2181 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2182 mbedtls_ssl_async_resume_t *f_async_resume,
2183 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002184 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002185{
2186 conf->f_async_sign_start = f_async_sign;
2187 conf->f_async_decrypt_start = f_async_decrypt;
2188 conf->f_async_resume = f_async_resume;
2189 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002190 conf->p_async_config_data = async_config_data;
2191}
2192
Gilles Peskine8f97af72018-04-26 11:46:10 +02002193void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2194{
2195 return( conf->p_async_config_data );
2196}
2197
Gilles Peskine1febfef2018-04-30 11:54:39 +02002198void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002199{
2200 if( ssl->handshake == NULL )
2201 return( NULL );
2202 else
2203 return( ssl->handshake->user_async_ctx );
2204}
2205
Gilles Peskine1febfef2018-04-30 11:54:39 +02002206void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002207 void *ctx )
2208{
2209 if( ssl->handshake != NULL )
2210 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002211}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002212#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002213
Paul Bakker5121ce52009-01-03 21:22:43 +00002214/*
2215 * SSL get accessors
2216 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002217uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002218{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002219 if( ssl->session != NULL )
2220 return( ssl->session->verify_result );
2221
2222 if( ssl->session_negotiate != NULL )
2223 return( ssl->session_negotiate->verify_result );
2224
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002225 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002226}
2227
Glenn Strauss8f526902022-01-13 00:04:49 -05002228int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2229{
2230 if( ssl == NULL || ssl->session == NULL )
2231 return( 0 );
2232
2233 return( ssl->session->ciphersuite );
2234}
2235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002237{
Paul Bakker926c8e42013-03-06 10:23:34 +01002238 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002239 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002242}
2243
Gilles Peskinee1a0c252022-01-13 01:08:03 +01002244mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(
2245 const mbedtls_ssl_context *ssl )
2246{
2247 /* For major_ver, only 3 is supported, so skip checking it. */
2248 switch( ssl->minor_ver )
2249 {
2250 case MBEDTLS_SSL_MINOR_VERSION_3:
2251 return( MBEDTLS_SSL_VERSION_1_2 );
2252 case MBEDTLS_SSL_MINOR_VERSION_4:
2253 return( MBEDTLS_SSL_VERSION_1_3 );
2254 default:
2255 return( MBEDTLS_SSL_VERSION_UNKNOWN );
2256 }
2257}
2258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002260{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002262 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002263 {
2264 switch( ssl->minor_ver )
2265 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266 case MBEDTLS_SSL_MINOR_VERSION_3:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002267 return( "DTLSv1.2" );
2268
2269 default:
2270 return( "unknown (DTLS)" );
2271 }
2272 }
2273#endif
2274
Paul Bakker43ca69c2011-01-15 17:35:19 +00002275 switch( ssl->minor_ver )
2276 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277 case MBEDTLS_SSL_MINOR_VERSION_3:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002278 return( "TLSv1.2" );
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002279 case MBEDTLS_SSL_MINOR_VERSION_4:
2280 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002281 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002282 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002283 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002284}
2285
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002286#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002287size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2288{
David Horstmann95d516f2021-05-04 18:36:56 +01002289 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002290 size_t read_mfl;
2291
2292 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2293 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2294 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2295 {
2296 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2297 }
2298
2299 /* Check if a smaller max length was negotiated */
2300 if( ssl->session_out != NULL )
2301 {
2302 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2303 if( read_mfl < max_len )
2304 {
2305 max_len = read_mfl;
2306 }
2307 }
2308
2309 // During a handshake, use the value being negotiated
2310 if( ssl->session_negotiate != NULL )
2311 {
2312 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2313 if( read_mfl < max_len )
2314 {
2315 max_len = read_mfl;
2316 }
2317 }
2318
2319 return( max_len );
2320}
2321
2322size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002323{
2324 size_t max_len;
2325
2326 /*
2327 * Assume mfl_code is correct since it was checked when set
2328 */
Angus Grattond8213d02016-05-25 20:56:48 +10002329 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002330
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002331 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002332 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002333 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002334 {
Angus Grattond8213d02016-05-25 20:56:48 +10002335 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002336 }
2337
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002338 /* During a handshake, use the value being negotiated */
2339 if( ssl->session_negotiate != NULL &&
2340 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2341 {
2342 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2343 }
2344
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002345 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002346}
2347#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2348
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002349#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002350size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002351{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002352 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2353 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2354 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2355 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2356 return ( 0 );
2357
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002358 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2359 return( ssl->mtu );
2360
2361 if( ssl->mtu == 0 )
2362 return( ssl->handshake->mtu );
2363
2364 return( ssl->mtu < ssl->handshake->mtu ?
2365 ssl->mtu : ssl->handshake->mtu );
2366}
2367#endif /* MBEDTLS_SSL_PROTO_DTLS */
2368
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002369int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2370{
2371 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2372
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002373#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2374 !defined(MBEDTLS_SSL_PROTO_DTLS)
2375 (void) ssl;
2376#endif
2377
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002378#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002379 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002380
2381 if( max_len > mfl )
2382 max_len = mfl;
2383#endif
2384
2385#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002386 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002387 {
Hanno Becker89490712020-02-05 10:50:12 +00002388 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002389 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2390 const size_t overhead = (size_t) ret;
2391
2392 if( ret < 0 )
2393 return( ret );
2394
2395 if( mtu <= overhead )
2396 {
2397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2398 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2399 }
2400
2401 if( max_len > mtu - overhead )
2402 max_len = mtu - overhead;
2403 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002404#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002405
Hanno Becker0defedb2018-08-10 12:35:02 +01002406#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2407 !defined(MBEDTLS_SSL_PROTO_DTLS)
2408 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002409#endif
2410
2411 return( (int) max_len );
2412}
2413
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002414int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2415{
2416 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2417
2418#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2419 (void) ssl;
2420#endif
2421
2422#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2423 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2424
2425 if( max_len > mfl )
2426 max_len = mfl;
2427#endif
2428
2429 return( (int) max_len );
2430}
2431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432#if defined(MBEDTLS_X509_CRT_PARSE_C)
2433const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002434{
2435 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002436 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002437
Hanno Beckere6824572019-02-07 13:18:46 +00002438#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002439 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002440#else
2441 return( NULL );
2442#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002443}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002445
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002447int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2448 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002449{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002450 int ret;
2451
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002452 if( ssl == NULL ||
2453 dst == NULL ||
2454 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002455 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002458 }
2459
Hanno Beckere810bbc2021-05-14 16:01:05 +01002460 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2461 * idempotent: Each session can only be exported once.
2462 *
2463 * (This is in preparation for TLS 1.3 support where we will
2464 * need the ability to export multiple sessions (aka tickets),
2465 * which will be achieved by calling mbedtls_ssl_get_session()
2466 * multiple times until it fails.)
2467 *
2468 * Check whether we have already exported the current session,
2469 * and fail if so.
2470 */
2471 if( ssl->session->exported == 1 )
2472 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2473
2474 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2475 if( ret != 0 )
2476 return( ret );
2477
2478 /* Remember that we've exported the session. */
2479 ssl->session->exported = 1;
2480 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002481}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002483
Paul Bakker5121ce52009-01-03 21:22:43 +00002484/*
Hanno Beckera835da52019-05-16 12:39:07 +01002485 * Define ticket header determining Mbed TLS version
2486 * and structure of the ticket.
2487 */
2488
Hanno Becker94ef3b32019-05-16 12:50:45 +01002489/*
Hanno Becker50b59662019-05-28 14:30:45 +01002490 * Define bitflag determining compile-time settings influencing
2491 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002492 */
2493
Hanno Becker50b59662019-05-28 14:30:45 +01002494#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002495#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002496#else
Hanno Becker3e088662019-05-29 11:10:18 +01002497#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002498#endif /* MBEDTLS_HAVE_TIME */
2499
2500#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002501#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002502#else
Hanno Becker3e088662019-05-29 11:10:18 +01002503#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002504#endif /* MBEDTLS_X509_CRT_PARSE_C */
2505
2506#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002507#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002508#else
Hanno Becker3e088662019-05-29 11:10:18 +01002509#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002510#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2511
2512#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002513#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002514#else
Hanno Becker3e088662019-05-29 11:10:18 +01002515#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002516#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2517
Hanno Becker94ef3b32019-05-16 12:50:45 +01002518#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002519#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002520#else
Hanno Becker3e088662019-05-29 11:10:18 +01002521#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002522#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2523
Hanno Becker94ef3b32019-05-16 12:50:45 +01002524#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2525#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2526#else
2527#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2528#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2529
Hanno Becker3e088662019-05-29 11:10:18 +01002530#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2531#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2532#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2533#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002534#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2535#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002536
Hanno Becker50b59662019-05-28 14:30:45 +01002537#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002538 ( (uint16_t) ( \
2539 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2540 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2541 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2542 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002543 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002544 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002545
Hanno Beckerf8787072019-05-16 12:41:07 +01002546static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002547 MBEDTLS_VERSION_MAJOR,
2548 MBEDTLS_VERSION_MINOR,
2549 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002550 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2551 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002552};
Hanno Beckera835da52019-05-16 12:39:07 +01002553
2554/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002555 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002556 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002557 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002558 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002559 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002560 * opaque mbedtls_version[3]; // library version: major, minor, patch
2561 * opaque session_format[2]; // library-version specific 16-bit field
2562 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002563 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002564 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002565 * Note: When updating the format, remember to keep
2566 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002567 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002568 * // In this version, `session_format` determines
2569 * // the setting of those compile-time
2570 * // configuration options which influence
2571 * // the structure of mbedtls_ssl_session.
2572 *
Hanno Beckerfa0d61e2021-08-02 08:56:14 +01002573 * uint8_t minor_ver; // Protocol-version. Possible values:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002574 * // - TLS 1.2 (MBEDTLS_SSL_MINOR_VERSION_3)
2575 *
2576 * select (serialized_session.minor_ver) {
2577 *
2578 * case MBEDTLS_SSL_MINOR_VERSION_3: // TLS 1.2
2579 * serialized_session_tls12 data;
2580 *
2581 * };
2582 *
2583 * } serialized_session;
2584 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002585 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002586
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002587static int ssl_session_save( const mbedtls_ssl_session *session,
2588 unsigned char omit_header,
2589 unsigned char *buf,
2590 size_t buf_len,
2591 size_t *olen )
2592{
2593 unsigned char *p = buf;
2594 size_t used = 0;
2595
2596 if( !omit_header )
2597 {
2598 /*
2599 * Add Mbed TLS version identifier
2600 */
2601
2602 used += sizeof( ssl_serialized_session_header );
2603
2604 if( used <= buf_len )
2605 {
2606 memcpy( p, ssl_serialized_session_header,
2607 sizeof( ssl_serialized_session_header ) );
2608 p += sizeof( ssl_serialized_session_header );
2609 }
2610 }
2611
2612 /*
2613 * TLS version identifier
2614 */
2615 used += 1;
2616 if( used <= buf_len )
2617 {
2618 *p++ = session->minor_ver;
2619 }
2620
2621 /* Forward to version-specific serialization routine. */
2622 switch( session->minor_ver )
2623 {
2624#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2625 case MBEDTLS_SSL_MINOR_VERSION_3:
2626 {
2627 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2628 used += ssl_session_save_tls12( session, p, remaining_len );
2629 break;
2630 }
2631#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2632
2633 default:
2634 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2635 }
2636
2637 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002638 if( used > buf_len )
2639 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002640
2641 return( 0 );
2642}
2643
2644/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002645 * Public wrapper for ssl_session_save()
2646 */
2647int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2648 unsigned char *buf,
2649 size_t buf_len,
2650 size_t *olen )
2651{
2652 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2653}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002654
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002655/*
2656 * Deserialize session, see mbedtls_ssl_session_save() for format.
2657 *
2658 * This internal version is wrapped by a public function that cleans up in
2659 * case of error, and has an extra option omit_header.
2660 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002661static int ssl_session_load( mbedtls_ssl_session *session,
2662 unsigned char omit_header,
2663 const unsigned char *buf,
2664 size_t len )
2665{
2666 const unsigned char *p = buf;
2667 const unsigned char * const end = buf + len;
2668
2669 if( !omit_header )
2670 {
2671 /*
2672 * Check Mbed TLS version identifier
2673 */
2674
2675 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2676 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2677
2678 if( memcmp( p, ssl_serialized_session_header,
2679 sizeof( ssl_serialized_session_header ) ) != 0 )
2680 {
2681 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2682 }
2683 p += sizeof( ssl_serialized_session_header );
2684 }
2685
2686 /*
2687 * TLS version identifier
2688 */
2689 if( 1 > (size_t)( end - p ) )
2690 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2691 session->minor_ver = *p++;
2692
2693 /* Dispatch according to TLS version. */
2694 switch( session->minor_ver )
2695 {
2696#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2697 case MBEDTLS_SSL_MINOR_VERSION_3: /* TLS 1.2 */
2698 {
2699 size_t remaining_len = ( end - p );
2700 return( ssl_session_load_tls12( session, p, remaining_len ) );
2701 }
2702#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2703
2704 default:
2705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2706 }
2707}
2708
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002709/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002710 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002711 */
2712int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2713 const unsigned char *buf,
2714 size_t len )
2715{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002716 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002717
2718 if( ret != 0 )
2719 mbedtls_ssl_session_free( session );
2720
2721 return( ret );
2722}
2723
2724/*
Paul Bakker1961b702013-01-25 14:49:24 +01002725 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002726 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002727static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2728{
2729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2730
Ronald Cron66dbf912022-02-02 15:33:46 +01002731 /*
2732 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002733 * that were written into the output buffer by the previous handshake step,
2734 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002735 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2736 * We proceed to the next handshake step only when all data from the
2737 * previous one have been sent to the peer, thus we make sure that this is
2738 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2739 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2740 * we have to wait before to go ahead.
2741 * In the case of TLS 1.3, handshake step handlers do not send data to the
2742 * peer. Data are only sent here and through
2743 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2744 * alert occured.
2745 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002746 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2747 return( ret );
2748
2749#if defined(MBEDTLS_SSL_PROTO_DTLS)
2750 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2751 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2752 {
2753 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2754 return( ret );
2755 }
2756#endif /* MBEDTLS_SSL_PROTO_DTLS */
2757
2758 return( ret );
2759}
2760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002762{
Hanno Becker41934dd2021-08-07 19:13:43 +01002763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002764
Hanno Becker41934dd2021-08-07 19:13:43 +01002765 if( ssl == NULL ||
2766 ssl->conf == NULL ||
2767 ssl->handshake == NULL ||
2768 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2769 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002770 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002771 }
2772
2773 ret = ssl_prepare_handshake_step( ssl );
2774 if( ret != 0 )
2775 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002776
Jerry Yue7047812021-09-13 19:26:39 +08002777 ret = mbedtls_ssl_handle_pending_alert( ssl );
2778 if( ret != 0 )
2779 goto cleanup;
2780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002782 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002783 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002784#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002785 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yuf4436812021-08-26 22:59:56 +08002786 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002787#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002788
2789#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2790 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2791 ret = mbedtls_ssl_handshake_client_step( ssl );
2792#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2793 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002794#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002796 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002797 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002798#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002799 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002800 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002801#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002802
2803#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2804 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2805 ret = mbedtls_ssl_handshake_server_step( ssl );
2806#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2807 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002808#endif
2809
Jerry Yue7047812021-09-13 19:26:39 +08002810 if( ret != 0 )
2811 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002812 /* handshake_step return error. And it is same
2813 * with alert_reason.
2814 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002815 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002816 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002817 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002818 goto cleanup;
2819 }
2820 }
2821
2822cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002823 return( ret );
2824}
2825
2826/*
2827 * Perform the SSL handshake
2828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002830{
2831 int ret = 0;
2832
Hanno Beckera817ea42020-10-20 15:20:23 +01002833 /* Sanity checks */
2834
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002835 if( ssl == NULL || ssl->conf == NULL )
2836 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2837
Hanno Beckera817ea42020-10-20 15:20:23 +01002838#if defined(MBEDTLS_SSL_PROTO_DTLS)
2839 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2840 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2841 {
2842 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2843 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2844 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2845 }
2846#endif /* MBEDTLS_SSL_PROTO_DTLS */
2847
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002849
Hanno Beckera817ea42020-10-20 15:20:23 +01002850 /* Main handshake loop */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 while( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker1961b702013-01-25 14:49:24 +01002852 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002854
2855 if( ret != 0 )
2856 break;
2857 }
2858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002860
2861 return( ret );
2862}
2863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864#if defined(MBEDTLS_SSL_RENEGOTIATION)
2865#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002866/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002867 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002870{
Janos Follath865b3eb2019-12-16 11:46:15 +00002871 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002874
2875 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2877 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002878
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002879 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002880 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002882 return( ret );
2883 }
2884
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002886
2887 return( 0 );
2888}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002890
2891/*
2892 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * - any side: calling mbedtls_ssl_renegotiate(),
2894 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2895 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002896 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002897 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002899 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002900int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002901{
Janos Follath865b3eb2019-12-16 11:46:15 +00002902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002905
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002906 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2907 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002908
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002909 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
2910 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002912 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002914 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002915 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002916 ssl->handshake->out_msg_seq = 1;
2917 else
2918 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002919 }
2920#endif
2921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
2923 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00002924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00002926 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002928 return( ret );
2929 }
2930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002932
2933 return( 0 );
2934}
2935
2936/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002937 * Renegotiate current connection on client,
2938 * or request renegotiation on server
2939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002941{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002943
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002944 if( ssl == NULL || ssl->conf == NULL )
2945 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002948 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002949 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002950 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
2952 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02002955
2956 /* Did we already try/start sending HelloRequest? */
2957 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02002959
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002960 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002961 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002965 /*
2966 * On client, either start the renegotiation process or,
2967 * if already in progress, continue the handshake
2968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002970 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
2972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002973
Hanno Becker40cdaa12020-02-05 10:48:27 +00002974 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002975 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00002976 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002977 return( ret );
2978 }
2979 }
2980 else
2981 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002983 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002985 return( ret );
2986 }
2987 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002989
Paul Bakker37ce0ff2013-10-31 14:32:04 +01002990 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002991}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002993
Gilles Peskine9b562d52018-04-25 20:32:43 +02002994void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002995{
Gilles Peskine9b562d52018-04-25 20:32:43 +02002996 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
2997
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002998 if( handshake == NULL )
2999 return;
3000
Brett Warrene0edc842021-08-17 09:53:13 +01003001#if defined(MBEDTLS_ECP_C)
3002#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3003 if ( ssl->handshake->group_list_heap_allocated )
3004 mbedtls_free( (void*) handshake->group_list );
3005 handshake->group_list = NULL;
3006#endif /* MBEDTLS_DEPRECATED_REMOVED */
3007#endif /* MBEDTLS_ECP_C */
3008
Jerry Yuf017ee42022-01-12 15:49:48 +08003009#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3010#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3011 if ( ssl->handshake->sig_algs_heap_allocated )
3012 mbedtls_free( (void*) handshake->sig_algs );
3013 handshake->sig_algs = NULL;
3014#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003015#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3016 if( ssl->handshake->certificate_request_context )
3017 {
3018 mbedtls_free( (void*) handshake->certificate_request_context );
3019 }
3020#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003021#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3022
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003023#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3024 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3025 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003026 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003027 handshake->async_in_progress = 0;
3028 }
3029#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3030
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003031#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003032#if defined(MBEDTLS_USE_PSA_CRYPTO)
3033 psa_hash_abort( &handshake->fin_sha256_psa );
3034#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003035 mbedtls_sha256_free( &handshake->fin_sha256 );
3036#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003037#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003038#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003040 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003041#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003042 mbedtls_sha512_free( &handshake->fin_sha512 );
3043#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003044#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#if defined(MBEDTLS_DHM_C)
3047 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003048#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049#if defined(MBEDTLS_ECDH_C)
3050 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003051#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003052#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003053 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003054#if defined(MBEDTLS_SSL_CLI_C)
3055 mbedtls_free( handshake->ecjpake_cache );
3056 handshake->ecjpake_cache = NULL;
3057 handshake->ecjpake_cache_len = 0;
3058#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003059#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003060
Janos Follath4ae5c292016-02-10 11:27:43 +00003061#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3062 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003063 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003065#endif
3066
Gilles Peskineeccd8882020-03-10 12:19:08 +01003067#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003068 if( handshake->psk != NULL )
3069 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003070 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003071 mbedtls_free( handshake->psk );
3072 }
3073#endif
3074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3076 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003077 /*
3078 * Free only the linked list wrapper, not the keys themselves
3079 * since the belong to the SNI callback
3080 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003081 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003083
Gilles Peskineeccd8882020-03-10 12:19:08 +01003084#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003085 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003086 if( handshake->ecrs_peer_cert != NULL )
3087 {
3088 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3089 mbedtls_free( handshake->ecrs_peer_cert );
3090 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003091#endif
3092
Hanno Becker75173122019-02-06 16:18:31 +00003093#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3094 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3095 mbedtls_pk_free( &handshake->peer_pubkey );
3096#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3097
XiaokangQian34909742022-01-27 02:25:04 +00003098#if defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 mbedtls_free( handshake->verify_cookie );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003100#endif /* MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 */
3101
3102#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003103 mbedtls_ssl_flight_free( handshake->flight );
3104 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003105#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003106
Hanno Becker4a63ed42019-01-08 11:39:35 +00003107#if defined(MBEDTLS_ECDH_C) && \
3108 defined(MBEDTLS_USE_PSA_CRYPTO)
3109 psa_destroy_key( handshake->ecdh_psa_privkey );
3110#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3111
Ronald Cron6f135e12021-12-08 16:57:54 +01003112#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003113 mbedtls_ssl_transform_free( handshake->transform_handshake );
3114 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003115 mbedtls_free( handshake->transform_earlydata );
3116 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003117#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003118
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003119
3120#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3121 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3122 * processes datagrams and the fact that a datagram is allowed to have
3123 * several records in it, it is possible that the I/O buffers are not
3124 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003125 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3126 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003127#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003128
Jerry Yuba9c7272021-10-30 11:54:10 +08003129 /* mbedtls_platform_zeroize MUST be last one in this function */
3130 mbedtls_platform_zeroize( handshake,
3131 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003132}
3133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003135{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003136 if( session == NULL )
3137 return;
3138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003140 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003141#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003142
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003143#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003145#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003146
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003147 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003148}
3149
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003150#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003151
3152#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3153#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3154#else
3155#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3156#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3157
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003158#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003159
3160#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3161#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3162#else
3163#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3164#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3165
3166#if defined(MBEDTLS_SSL_ALPN)
3167#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3168#else
3169#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3170#endif /* MBEDTLS_SSL_ALPN */
3171
3172#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3173#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3174#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3175#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3176
3177#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3178 ( (uint32_t) ( \
3179 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3180 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3181 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3182 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3183 0u ) )
3184
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003185static unsigned char ssl_serialized_context_header[] = {
3186 MBEDTLS_VERSION_MAJOR,
3187 MBEDTLS_VERSION_MINOR,
3188 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003189 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3190 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3191 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3192 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3193 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003194};
3195
Paul Bakker5121ce52009-01-03 21:22:43 +00003196/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003197 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003198 *
3199 * The format of the serialized data is:
3200 * (in the presentation language of TLS, RFC 8446 section 3)
3201 *
3202 * // header
3203 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003204 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003205 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003206 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003207 * Note: When updating the format, remember to keep these
3208 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003209 *
3210 * // session sub-structure
3211 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3212 * // transform sub-structure
3213 * uint8 random[64]; // ServerHello.random+ClientHello.random
3214 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3215 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3216 * // fields from ssl_context
3217 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3218 * uint64 in_window_top; // DTLS: last validated record seq_num
3219 * uint64 in_window; // DTLS: bitmask for replay protection
3220 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3221 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3222 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3223 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3224 *
3225 * Note that many fields of the ssl_context or sub-structures are not
3226 * serialized, as they fall in one of the following categories:
3227 *
3228 * 1. forced value (eg in_left must be 0)
3229 * 2. pointer to dynamically-allocated memory (eg session, transform)
3230 * 3. value can be re-derived from other data (eg session keys from MS)
3231 * 4. value was temporary (eg content of input buffer)
3232 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003233 */
3234int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3235 unsigned char *buf,
3236 size_t buf_len,
3237 size_t *olen )
3238{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003239 unsigned char *p = buf;
3240 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003241 size_t session_len;
3242 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003243
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003244 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003245 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3246 * this function's documentation.
3247 *
3248 * These are due to assumptions/limitations in the implementation. Some of
3249 * them are likely to stay (no handshake in progress) some might go away
3250 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003251 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003252 /* The initial handshake must be over */
3253 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003254 {
3255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003256 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003257 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003258 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003259 {
3260 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003261 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003262 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003263 /* Double-check that sub-structures are indeed ready */
3264 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003265 {
3266 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003267 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003268 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003269 /* There must be no pending incoming or outgoing data */
3270 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003271 {
3272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003273 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003274 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003275 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003276 {
3277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003278 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003279 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003280 /* Protocol must be DLTS, not TLS */
3281 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003282 {
3283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003284 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003285 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003286 /* Version must be 1.2 */
3287 if( ssl->major_ver != MBEDTLS_SSL_MAJOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003288 {
3289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003290 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003291 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003292 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003293 {
3294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003295 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003296 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003297 /* We must be using an AEAD ciphersuite */
3298 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003299 {
3300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003301 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003302 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003303 /* Renegotiation must not be enabled */
3304#if defined(MBEDTLS_SSL_RENEGOTIATION)
3305 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003306 {
3307 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003308 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003309 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003310#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003311
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003312 /*
3313 * Version and format identifier
3314 */
3315 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003316
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003317 if( used <= buf_len )
3318 {
3319 memcpy( p, ssl_serialized_context_header,
3320 sizeof( ssl_serialized_context_header ) );
3321 p += sizeof( ssl_serialized_context_header );
3322 }
3323
3324 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003325 * Session (length + data)
3326 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003327 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003328 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3329 return( ret );
3330
3331 used += 4 + session_len;
3332 if( used <= buf_len )
3333 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003334 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3335 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003336
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003337 ret = ssl_session_save( ssl->session, 1,
3338 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003339 if( ret != 0 )
3340 return( ret );
3341
3342 p += session_len;
3343 }
3344
3345 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003346 * Transform
3347 */
3348 used += sizeof( ssl->transform->randbytes );
3349 if( used <= buf_len )
3350 {
3351 memcpy( p, ssl->transform->randbytes,
3352 sizeof( ssl->transform->randbytes ) );
3353 p += sizeof( ssl->transform->randbytes );
3354 }
3355
3356#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3357 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3358 if( used <= buf_len )
3359 {
3360 *p++ = ssl->transform->in_cid_len;
3361 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3362 p += ssl->transform->in_cid_len;
3363
3364 *p++ = ssl->transform->out_cid_len;
3365 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3366 p += ssl->transform->out_cid_len;
3367 }
3368#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3369
3370 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003371 * Saved fields from top-level ssl_context structure
3372 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003373 used += 4;
3374 if( used <= buf_len )
3375 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003376 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3377 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003378 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003379
3380#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3381 used += 16;
3382 if( used <= buf_len )
3383 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003384 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3385 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003386
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003387 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3388 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003389 }
3390#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3391
3392#if defined(MBEDTLS_SSL_PROTO_DTLS)
3393 used += 1;
3394 if( used <= buf_len )
3395 {
3396 *p++ = ssl->disable_datagram_packing;
3397 }
3398#endif /* MBEDTLS_SSL_PROTO_DTLS */
3399
Jerry Yuae0b2e22021-10-08 15:21:19 +08003400 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003401 if( used <= buf_len )
3402 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003403 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3404 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003405 }
3406
3407#if defined(MBEDTLS_SSL_PROTO_DTLS)
3408 used += 2;
3409 if( used <= buf_len )
3410 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003411 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3412 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003413 }
3414#endif /* MBEDTLS_SSL_PROTO_DTLS */
3415
3416#if defined(MBEDTLS_SSL_ALPN)
3417 {
3418 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003419 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003420 : 0;
3421
3422 used += 1 + alpn_len;
3423 if( used <= buf_len )
3424 {
3425 *p++ = alpn_len;
3426
3427 if( ssl->alpn_chosen != NULL )
3428 {
3429 memcpy( p, ssl->alpn_chosen, alpn_len );
3430 p += alpn_len;
3431 }
3432 }
3433 }
3434#endif /* MBEDTLS_SSL_ALPN */
3435
3436 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003437 * Done
3438 */
3439 *olen = used;
3440
3441 if( used > buf_len )
3442 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003443
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003444 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3445
Hanno Becker43aefe22020-02-05 10:44:56 +00003446 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003447}
3448
3449/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003450 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003451 *
3452 * This internal version is wrapped by a public function that cleans up in
3453 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003454 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003455static int ssl_context_load( mbedtls_ssl_context *ssl,
3456 const unsigned char *buf,
3457 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003458{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003459 const unsigned char *p = buf;
3460 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003461 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003463
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003464 /*
3465 * The context should have been freshly setup or reset.
3466 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003467 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003468 * renegotiating, or if the user mistakenly loaded a session first.)
3469 */
3470 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3471 ssl->session != NULL )
3472 {
3473 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3474 }
3475
3476 /*
3477 * We can't check that the config matches the initial one, but we can at
3478 * least check it matches the requirements for serializing.
3479 */
3480 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
3481 ssl->conf->max_major_ver < MBEDTLS_SSL_MAJOR_VERSION_3 ||
3482 ssl->conf->min_major_ver > MBEDTLS_SSL_MAJOR_VERSION_3 ||
3483 ssl->conf->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 ||
3484 ssl->conf->min_minor_ver > MBEDTLS_SSL_MINOR_VERSION_3 ||
3485#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003486 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003487#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003488 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003489 {
3490 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3491 }
3492
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003493 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3494
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003495 /*
3496 * Check version identifier
3497 */
3498 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3499 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3500
3501 if( memcmp( p, ssl_serialized_context_header,
3502 sizeof( ssl_serialized_context_header ) ) != 0 )
3503 {
3504 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3505 }
3506 p += sizeof( ssl_serialized_context_header );
3507
3508 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003509 * Session
3510 */
3511 if( (size_t)( end - p ) < 4 )
3512 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3513
3514 session_len = ( (size_t) p[0] << 24 ) |
3515 ( (size_t) p[1] << 16 ) |
3516 ( (size_t) p[2] << 8 ) |
3517 ( (size_t) p[3] );
3518 p += 4;
3519
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003520 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003521 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003522 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003523 ssl->session_in = ssl->session;
3524 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003525 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003526
3527 if( (size_t)( end - p ) < session_len )
3528 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3529
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003530 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003531 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003532 {
3533 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003534 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003535 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003536
3537 p += session_len;
3538
3539 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003540 * Transform
3541 */
3542
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003543 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003544 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003545 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003546 ssl->transform_in = ssl->transform;
3547 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003548 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003549
3550 /* Read random bytes and populate structure */
3551 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3552 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003553#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003554 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003555 ssl->session->ciphersuite,
3556 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003557#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3558 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003559 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003560#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3561 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003562 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3563 p, /* currently pointing to randbytes */
3564 MBEDTLS_SSL_MINOR_VERSION_3, /* (D)TLS 1.2 is forced */
3565 ssl->conf->endpoint,
3566 ssl );
3567 if( ret != 0 )
3568 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003569#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003570 p += sizeof( ssl->transform->randbytes );
3571
3572#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3573 /* Read connection IDs and store them */
3574 if( (size_t)( end - p ) < 1 )
3575 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3576
3577 ssl->transform->in_cid_len = *p++;
3578
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003579 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003580 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3581
3582 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3583 p += ssl->transform->in_cid_len;
3584
3585 ssl->transform->out_cid_len = *p++;
3586
3587 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3588 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3589
3590 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3591 p += ssl->transform->out_cid_len;
3592#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3593
3594 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003595 * Saved fields from top-level ssl_context structure
3596 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003597 if( (size_t)( end - p ) < 4 )
3598 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3599
3600 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3601 ( (uint32_t) p[1] << 16 ) |
3602 ( (uint32_t) p[2] << 8 ) |
3603 ( (uint32_t) p[3] );
3604 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003605
3606#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3607 if( (size_t)( end - p ) < 16 )
3608 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3609
3610 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3611 ( (uint64_t) p[1] << 48 ) |
3612 ( (uint64_t) p[2] << 40 ) |
3613 ( (uint64_t) p[3] << 32 ) |
3614 ( (uint64_t) p[4] << 24 ) |
3615 ( (uint64_t) p[5] << 16 ) |
3616 ( (uint64_t) p[6] << 8 ) |
3617 ( (uint64_t) p[7] );
3618 p += 8;
3619
3620 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3621 ( (uint64_t) p[1] << 48 ) |
3622 ( (uint64_t) p[2] << 40 ) |
3623 ( (uint64_t) p[3] << 32 ) |
3624 ( (uint64_t) p[4] << 24 ) |
3625 ( (uint64_t) p[5] << 16 ) |
3626 ( (uint64_t) p[6] << 8 ) |
3627 ( (uint64_t) p[7] );
3628 p += 8;
3629#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3630
3631#if defined(MBEDTLS_SSL_PROTO_DTLS)
3632 if( (size_t)( end - p ) < 1 )
3633 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3634
3635 ssl->disable_datagram_packing = *p++;
3636#endif /* MBEDTLS_SSL_PROTO_DTLS */
3637
Jerry Yud9a94fe2021-09-28 18:58:59 +08003638 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003639 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003640 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3641 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003642
3643#if defined(MBEDTLS_SSL_PROTO_DTLS)
3644 if( (size_t)( end - p ) < 2 )
3645 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3646
3647 ssl->mtu = ( p[0] << 8 ) | p[1];
3648 p += 2;
3649#endif /* MBEDTLS_SSL_PROTO_DTLS */
3650
3651#if defined(MBEDTLS_SSL_ALPN)
3652 {
3653 uint8_t alpn_len;
3654 const char **cur;
3655
3656 if( (size_t)( end - p ) < 1 )
3657 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3658
3659 alpn_len = *p++;
3660
3661 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3662 {
3663 /* alpn_chosen should point to an item in the configured list */
3664 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3665 {
3666 if( strlen( *cur ) == alpn_len &&
3667 memcmp( p, cur, alpn_len ) == 0 )
3668 {
3669 ssl->alpn_chosen = *cur;
3670 break;
3671 }
3672 }
3673 }
3674
3675 /* can only happen on conf mismatch */
3676 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3677 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3678
3679 p += alpn_len;
3680 }
3681#endif /* MBEDTLS_SSL_ALPN */
3682
3683 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003684 * Forced fields from top-level ssl_context structure
3685 *
3686 * Most of them already set to the correct value by mbedtls_ssl_init() and
3687 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3688 */
3689 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
3690
3691 ssl->major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
3692 ssl->minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
3693
Hanno Becker361b10d2019-08-30 10:42:49 +01003694 /* Adjust pointers for header fields of outgoing records to
3695 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003696 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003697
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003698#if defined(MBEDTLS_SSL_PROTO_DTLS)
3699 ssl->in_epoch = 1;
3700#endif
3701
3702 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3703 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003704 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3705 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003706 if( ssl->handshake != NULL )
3707 {
3708 mbedtls_ssl_handshake_free( ssl );
3709 mbedtls_free( ssl->handshake );
3710 ssl->handshake = NULL;
3711 }
3712
3713 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003714 * Done - should have consumed entire buffer
3715 */
3716 if( p != end )
3717 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003718
3719 return( 0 );
3720}
3721
3722/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003723 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003724 */
3725int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3726 const unsigned char *buf,
3727 size_t len )
3728{
3729 int ret = ssl_context_load( context, buf, len );
3730
3731 if( ret != 0 )
3732 mbedtls_ssl_free( context );
3733
3734 return( ret );
3735}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003736#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003737
3738/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003739 * Free an SSL context
3740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003741void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003742{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003743 if( ssl == NULL )
3744 return;
3745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003747
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003748 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003749 {
sander-visserb8aa2072020-05-06 22:05:13 +02003750#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3751 size_t out_buf_len = ssl->out_buf_len;
3752#else
3753 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3754#endif
3755
Darryl Greenb33cc762019-11-28 14:29:44 +00003756 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003757 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003758 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003759 }
3760
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003761 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003762 {
sander-visserb8aa2072020-05-06 22:05:13 +02003763#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3764 size_t in_buf_len = ssl->in_buf_len;
3765#else
3766 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3767#endif
3768
Darryl Greenb33cc762019-11-28 14:29:44 +00003769 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003771 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003772 }
3773
Paul Bakker48916f92012-09-16 19:57:18 +00003774 if( ssl->transform )
3775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776 mbedtls_ssl_transform_free( ssl->transform );
3777 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003778 }
3779
3780 if( ssl->handshake )
3781 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003782 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3784 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003786 mbedtls_free( ssl->handshake );
3787 mbedtls_free( ssl->transform_negotiate );
3788 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003789 }
3790
Ronald Cron6f135e12021-12-08 16:57:54 +01003791#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003792 mbedtls_ssl_transform_free( ssl->transform_application );
3793 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003794#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003795
Paul Bakkerc0463502013-02-14 11:19:38 +01003796 if( ssl->session )
3797 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798 mbedtls_ssl_session_free( ssl->session );
3799 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003800 }
3801
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003803 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003804 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003805 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003807 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003808#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003809
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003810#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003811 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003812#endif
3813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003814 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003815
Paul Bakker86f04f42013-02-14 11:20:09 +01003816 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003817 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003818}
3819
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003820/*
3821 * Initialze mbedtls_ssl_config
3822 */
3823void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3824{
3825 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3826}
3827
Gilles Peskineeccd8882020-03-10 12:19:08 +01003828#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003829#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003830/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003831 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3832 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003833 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3834 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003835static int ssl_preset_default_hashes[] = {
3836#if defined(MBEDTLS_SHA512_C)
3837 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003838#endif
3839#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003840 MBEDTLS_MD_SHA384,
3841#endif
3842#if defined(MBEDTLS_SHA256_C)
3843 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003844#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003845 MBEDTLS_MD_NONE
3846};
Jerry Yuf017ee42022-01-12 15:49:48 +08003847#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3848#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003849
Gilles Peskineae270bf2021-06-02 00:05:29 +02003850/* The selection should be the same as mbedtls_x509_crt_profile_default in
3851 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003852 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003853 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003854 * about this list.
3855 */
Brett Warrene0edc842021-08-17 09:53:13 +01003856static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003857#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003858 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003859#endif
3860#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003861 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003862#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003863#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003864 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003865#endif
3866#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003867 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003868#endif
3869#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003870 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003871#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003872#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003873 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003874#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003875#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003876 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003877#endif
3878#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003879 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003880#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003881 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003882};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003883
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003884static int ssl_preset_suiteb_ciphersuites[] = {
3885 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3886 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3887 0
3888};
3889
Gilles Peskineeccd8882020-03-10 12:19:08 +01003890#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003891#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003892static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003893#if defined(MBEDTLS_SHA256_C)
3894 MBEDTLS_MD_SHA256,
3895#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003896#if defined(MBEDTLS_SHA384_C)
3897 MBEDTLS_MD_SHA384,
3898#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003899 MBEDTLS_MD_NONE
3900};
Jerry Yuf017ee42022-01-12 15:49:48 +08003901#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003902
Jerry Yu909df7b2022-01-22 11:56:27 +08003903/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003904 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08003905 * rules SHOULD be upheld.
3906 * - No duplicate entries.
3907 * - But if there is a good reason, do not change the order of the algorithms.
3908 * - ssl_tls12_present* is for TLS 1.2 use only.
3909 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08003910 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003911static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08003912
Jerry Yued5e9f42022-01-26 11:21:34 +08003913#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3914 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3915 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3916#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3917 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003918
Jerry Yu909df7b2022-01-22 11:56:27 +08003919#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3920 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3921 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3922#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3923 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
3924
Jerry Yued5e9f42022-01-26 11:21:34 +08003925#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
3926 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
3927 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
3928#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3929 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003930
Jerry Yu909df7b2022-01-22 11:56:27 +08003931#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3932 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3933#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
3934
Jerry Yu53037892022-01-25 11:02:06 +08003935#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
3936 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
3937#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
3938
Jerry Yu909df7b2022-01-22 11:56:27 +08003939 MBEDTLS_TLS1_3_SIG_NONE
3940};
3941
3942/* NOTICE: see above */
3943#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3944static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08003945#if defined(MBEDTLS_SHA512_C)
3946 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
3947#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08003948#if defined(MBEDTLS_SHA384_C)
3949 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
3950#endif
3951#if defined(MBEDTLS_SHA256_C)
3952 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
3953#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08003954 MBEDTLS_TLS1_3_SIG_NONE
3955};
3956#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3957/* NOTICE: see above */
3958static uint16_t ssl_preset_suiteb_sig_algs[] = {
3959
Jerry Yu909df7b2022-01-22 11:56:27 +08003960#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3961 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3962 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3963#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3964 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
3965
Jerry Yu53037892022-01-25 11:02:06 +08003966#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3967 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3968 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3969#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3970 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003971
3972#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3973 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3974#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08003975
Jerry Yu53037892022-01-25 11:02:06 +08003976#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
3977 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
3978#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
3979
Jerry Yu713013f2022-01-17 18:16:35 +08003980 MBEDTLS_TLS1_3_SIG_NONE
3981};
Jerry Yu6106fdc2022-01-12 16:36:14 +08003982
Jerry Yu909df7b2022-01-22 11:56:27 +08003983/* NOTICE: see above */
3984#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3985static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08003986#if defined(MBEDTLS_SHA256_C)
3987 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
3988#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08003989#if defined(MBEDTLS_SHA384_C)
3990 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
3991#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00003992 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003993};
Jerry Yu909df7b2022-01-22 11:56:27 +08003994#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3995
Jerry Yu1a8b4812022-01-20 17:56:50 +08003996#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003997
Brett Warrene0edc842021-08-17 09:53:13 +01003998static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01003999#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004000 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004001#endif
4002#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004003 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004004#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004005 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004006};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004007
Jerry Yu1a8b4812022-01-20 17:56:50 +08004008#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004009/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004010 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004011static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004012{
4013 size_t i, j;
4014 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004015
Jerry Yuf377d642022-01-25 10:43:59 +08004016 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004017 {
Jerry Yuf377d642022-01-25 10:43:59 +08004018 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004019 {
Jerry Yuf377d642022-01-25 10:43:59 +08004020 if( sig_algs[i] != sig_algs[j] )
4021 continue;
4022 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4023 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4024 sig_algs[i], j, i );
4025 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004026 }
4027 }
4028 return( ret );
4029}
4030
4031#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4032
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004033/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004034 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004035 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004036int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004037 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004038{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004039#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004041#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004042
Jerry Yu1a8b4812022-01-20 17:56:50 +08004043#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004044 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004045 {
4046 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4047 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4048 }
4049
Jerry Yuf377d642022-01-25 10:43:59 +08004050 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004051 {
4052 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4053 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4054 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004055
4056#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004057 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004058 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004059 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004060 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4061 }
4062
Jerry Yuf377d642022-01-25 10:43:59 +08004063 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004064 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004065 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004066 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4067 }
4068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004069#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4070
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004071 /* Use the functions here so that they are covered in tests,
4072 * but otherwise access member directly for efficiency */
4073 mbedtls_ssl_conf_endpoint( conf, endpoint );
4074 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004075
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004076 /*
4077 * Things that are common to all presets
4078 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004079#if defined(MBEDTLS_SSL_CLI_C)
4080 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4081 {
4082 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4083#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4084 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4085#endif
4086 }
4087#endif
4088
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004089#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4090 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4091#endif
4092
4093#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4094 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4095#endif
4096
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004097#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004098 conf->f_cookie_write = ssl_cookie_write_dummy;
4099 conf->f_cookie_check = ssl_cookie_check_dummy;
4100#endif
4101
4102#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4103 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4104#endif
4105
Janos Follath088ce432017-04-10 12:42:31 +01004106#if defined(MBEDTLS_SSL_SRV_C)
4107 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004108 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004109#endif
4110
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004111#if defined(MBEDTLS_SSL_PROTO_DTLS)
4112 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4113 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4114#endif
4115
4116#if defined(MBEDTLS_SSL_RENEGOTIATION)
4117 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004118 memset( conf->renego_period, 0x00, 2 );
4119 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004120#endif
4121
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004122#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004123 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4124 {
4125 const unsigned char dhm_p[] =
4126 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4127 const unsigned char dhm_g[] =
4128 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004129
Hanno Beckere2defad2021-07-24 05:59:17 +01004130 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4131 dhm_p, sizeof( dhm_p ),
4132 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4133 {
4134 return( ret );
4135 }
4136 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004137#endif
4138
Ronald Cron6f135e12021-12-08 16:57:54 +01004139#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004140 /*
4141 * Allow all TLS 1.3 key exchange modes by default.
4142 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004143 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004144#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004145
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004146 /*
4147 * Preset-specific defaults
4148 */
4149 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004150 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004151 /*
4152 * NSA Suite B
4153 */
4154 case MBEDTLS_SSL_PRESET_SUITEB:
4155 conf->min_major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
4156 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3; /* TLS 1.2 */
4157 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004158#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4159 /* Hybrid TLS 1.2/1.3 is not supported yet */
4160 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
4161#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004162 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004163#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004164
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004165 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004166
4167#if defined(MBEDTLS_X509_CRT_PARSE_C)
4168 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004169#endif
4170
Gilles Peskineeccd8882020-03-10 12:19:08 +01004171#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004172#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004173 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004174#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004175#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4176 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4177 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4178 else
4179#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4180 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004181#endif
4182
Brett Warrene0edc842021-08-17 09:53:13 +01004183#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4184 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004185#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004186 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004187 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004188
4189 /*
4190 * Default
4191 */
4192 default:
Ron Eldor5e9f14d2017-05-28 10:46:38 +03004193 conf->min_major_ver = ( MBEDTLS_SSL_MIN_MAJOR_VERSION >
4194 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION ) ?
4195 MBEDTLS_SSL_MIN_MAJOR_VERSION :
4196 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION;
4197 conf->min_minor_ver = ( MBEDTLS_SSL_MIN_MINOR_VERSION >
4198 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION ) ?
4199 MBEDTLS_SSL_MIN_MINOR_VERSION :
4200 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004201 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004202#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4203 /* Hybrid TLS 1.2/1.3 is not supported yet */
4204 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
4205#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004206 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004207#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004208
4209#if defined(MBEDTLS_SSL_PROTO_DTLS)
4210 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
TRodziewiczef73f012021-05-13 14:53:36 +02004211 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004212#endif
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004213 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004214
4215#if defined(MBEDTLS_X509_CRT_PARSE_C)
4216 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4217#endif
4218
Gilles Peskineeccd8882020-03-10 12:19:08 +01004219#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004220#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004221 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004222#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004223#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4224 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4225 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4226 else
4227#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4228 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004229#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004230
Brett Warrene0edc842021-08-17 09:53:13 +01004231#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4232 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004233#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004234 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004235
4236#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4237 conf->dhm_min_bitlen = 1024;
4238#endif
4239 }
4240
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004241 return( 0 );
4242}
4243
4244/*
4245 * Free mbedtls_ssl_config
4246 */
4247void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4248{
4249#if defined(MBEDTLS_DHM_C)
4250 mbedtls_mpi_free( &conf->dhm_P );
4251 mbedtls_mpi_free( &conf->dhm_G );
4252#endif
4253
Gilles Peskineeccd8882020-03-10 12:19:08 +01004254#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004255 if( conf->psk != NULL )
4256 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004257 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004258 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004259 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004260 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004261 }
4262
4263 if( conf->psk_identity != NULL )
4264 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004265 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004266 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004267 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004268 conf->psk_identity_len = 0;
4269 }
4270#endif
4271
4272#if defined(MBEDTLS_X509_CRT_PARSE_C)
4273 ssl_key_cert_free( conf->key_cert );
4274#endif
4275
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004276 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004277}
4278
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004279#if defined(MBEDTLS_PK_C) && \
4280 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004281/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004282 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004284unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004285{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004286#if defined(MBEDTLS_RSA_C)
4287 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4288 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004289#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004290#if defined(MBEDTLS_ECDSA_C)
4291 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4292 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004293#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004294 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004295}
4296
Hanno Becker7e5437a2017-04-28 17:15:26 +01004297unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4298{
4299 switch( type ) {
4300 case MBEDTLS_PK_RSA:
4301 return( MBEDTLS_SSL_SIG_RSA );
4302 case MBEDTLS_PK_ECDSA:
4303 case MBEDTLS_PK_ECKEY:
4304 return( MBEDTLS_SSL_SIG_ECDSA );
4305 default:
4306 return( MBEDTLS_SSL_SIG_ANON );
4307 }
4308}
4309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004310mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004311{
4312 switch( sig )
4313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004314#if defined(MBEDTLS_RSA_C)
4315 case MBEDTLS_SSL_SIG_RSA:
4316 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004317#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318#if defined(MBEDTLS_ECDSA_C)
4319 case MBEDTLS_SSL_SIG_ECDSA:
4320 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004321#endif
4322 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004323 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004324 }
4325}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004326#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004327
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004328/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004329 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004331mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004332{
4333 switch( hash )
4334 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004335#if defined(MBEDTLS_MD5_C)
4336 case MBEDTLS_SSL_HASH_MD5:
4337 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004338#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004339#if defined(MBEDTLS_SHA1_C)
4340 case MBEDTLS_SSL_HASH_SHA1:
4341 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004342#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004343#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004344 case MBEDTLS_SSL_HASH_SHA224:
4345 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004346#endif
4347#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004348 case MBEDTLS_SSL_HASH_SHA256:
4349 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004350#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004351#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352 case MBEDTLS_SSL_HASH_SHA384:
4353 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004354#endif
4355#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356 case MBEDTLS_SSL_HASH_SHA512:
4357 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004358#endif
4359 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004360 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004361 }
4362}
4363
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004364/*
4365 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4366 */
4367unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4368{
4369 switch( md )
4370 {
4371#if defined(MBEDTLS_MD5_C)
4372 case MBEDTLS_MD_MD5:
4373 return( MBEDTLS_SSL_HASH_MD5 );
4374#endif
4375#if defined(MBEDTLS_SHA1_C)
4376 case MBEDTLS_MD_SHA1:
4377 return( MBEDTLS_SSL_HASH_SHA1 );
4378#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004379#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004380 case MBEDTLS_MD_SHA224:
4381 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004382#endif
4383#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004384 case MBEDTLS_MD_SHA256:
4385 return( MBEDTLS_SSL_HASH_SHA256 );
4386#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004387#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004388 case MBEDTLS_MD_SHA384:
4389 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004390#endif
4391#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004392 case MBEDTLS_MD_SHA512:
4393 return( MBEDTLS_SSL_HASH_SHA512 );
4394#endif
4395 default:
4396 return( MBEDTLS_SSL_HASH_NONE );
4397 }
4398}
4399
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004400/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004401 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004402 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004403 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004404int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004405{
Brett Warrene0edc842021-08-17 09:53:13 +01004406 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004407
Brett Warrene0edc842021-08-17 09:53:13 +01004408 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004409 return( -1 );
4410
Brett Warrene0edc842021-08-17 09:53:13 +01004411 for( ; *group_list != 0; group_list++ )
4412 {
4413 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004414 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004415 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004416
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004417 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004418}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004419
4420#if defined(MBEDTLS_ECP_C)
4421/*
4422 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4423 */
4424int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4425{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004426 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004427 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4428}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004429#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004431#if defined(MBEDTLS_X509_CRT_PARSE_C)
4432int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4433 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004434 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004435 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004436{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004437 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004438 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004439 const char *ext_oid;
4440 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004442 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004443 {
4444 /* Server part of the key exchange */
4445 switch( ciphersuite->key_exchange )
4446 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004447 case MBEDTLS_KEY_EXCHANGE_RSA:
4448 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004449 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004450 break;
4451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4453 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4454 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4455 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004456 break;
4457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4459 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004460 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004461 break;
4462
4463 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004464 case MBEDTLS_KEY_EXCHANGE_NONE:
4465 case MBEDTLS_KEY_EXCHANGE_PSK:
4466 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4467 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004468 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004469 usage = 0;
4470 }
4471 }
4472 else
4473 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004474 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4475 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004476 }
4477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004478 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004479 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004480 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004481 ret = -1;
4482 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004484 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004485 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004486 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4487 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004488 }
4489 else
4490 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004491 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4492 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004493 }
4494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004495 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004496 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004497 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004498 ret = -1;
4499 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004500
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004501 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004502}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004503#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004504
Simon Butcher99000142016-10-13 17:21:01 +01004505int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
4506{
4507#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4508 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Becker541af852021-05-14 16:49:01 +01004509 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01004510
4511 switch( md )
4512 {
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02004513#if defined(MBEDTLS_SHA384_C)
Simon Butcher99000142016-10-13 17:21:01 +01004514 case MBEDTLS_SSL_HASH_SHA384:
4515 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
4516 break;
4517#endif
4518#if defined(MBEDTLS_SHA256_C)
4519 case MBEDTLS_SSL_HASH_SHA256:
4520 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
4521 break;
4522#endif
4523 default:
Hanno Becker541af852021-05-14 16:49:01 +01004524 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01004525 }
4526
4527 return 0;
4528#else /* !MBEDTLS_SSL_PROTO_TLS1_2 */
4529 (void) ssl;
4530 (void) md;
4531
Hanno Becker541af852021-05-14 16:49:01 +01004532 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01004533#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4534}
4535
Jerry Yu148165c2021-09-24 23:20:59 +08004536#if defined(MBEDTLS_USE_PSA_CRYPTO)
4537int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4538 const mbedtls_md_type_t md,
4539 unsigned char *dst,
4540 size_t dst_len,
4541 size_t *olen )
4542{
Ronald Cronf6893e12022-01-07 22:09:01 +01004543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4544 psa_hash_operation_t *hash_operation_to_clone;
4545 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4546
Jerry Yu148165c2021-09-24 23:20:59 +08004547 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004548
4549 switch( md )
4550 {
4551#if defined(MBEDTLS_SHA384_C)
4552 case MBEDTLS_MD_SHA384:
4553 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4554 break;
4555#endif
4556
4557#if defined(MBEDTLS_SHA256_C)
4558 case MBEDTLS_MD_SHA256:
4559 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4560 break;
4561#endif
4562
4563 default:
4564 goto exit;
4565 }
4566
4567 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4568 if( status != PSA_SUCCESS )
4569 goto exit;
4570
4571 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4572 if( status != PSA_SUCCESS )
4573 goto exit;
4574
4575exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004576 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004577}
4578#else /* MBEDTLS_USE_PSA_CRYPTO */
4579
Jerry Yu24c0ec32021-09-09 14:21:07 +08004580#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004581static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4582 unsigned char *dst,
4583 size_t dst_len,
4584 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004585{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004586 int ret;
4587 mbedtls_sha512_context sha512;
4588
4589 if( dst_len < 48 )
4590 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4591
4592 mbedtls_sha512_init( &sha512 );
4593 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4594
4595 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4596 {
4597 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4598 goto exit;
4599 }
4600
4601 *olen = 48;
4602
4603exit:
4604
4605 mbedtls_sha512_free( &sha512 );
4606 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004607}
4608#endif /* MBEDTLS_SHA384_C */
4609
4610#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004611static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4612 unsigned char *dst,
4613 size_t dst_len,
4614 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004615{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004616 int ret;
4617 mbedtls_sha256_context sha256;
4618
4619 if( dst_len < 32 )
4620 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4621
4622 mbedtls_sha256_init( &sha256 );
4623 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004624
Jerry Yu24c0ec32021-09-09 14:21:07 +08004625 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4626 {
4627 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4628 goto exit;
4629 }
4630
4631 *olen = 32;
4632
4633exit:
4634
4635 mbedtls_sha256_free( &sha256 );
4636 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004637}
4638#endif /* MBEDTLS_SHA256_C */
4639
Jerry Yu000f9762021-09-14 11:12:51 +08004640int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4641 const mbedtls_md_type_t md,
4642 unsigned char *dst,
4643 size_t dst_len,
4644 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004645{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004646 switch( md )
4647 {
4648
Jerry Yu24c0ec32021-09-09 14:21:07 +08004649#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004650 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004651 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004652#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004653
Jerry Yu24c0ec32021-09-09 14:21:07 +08004654#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004655 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004656 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004657#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004658
4659 default:
4660 break;
4661 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004662 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004663}
XiaokangQian647719a2021-12-07 09:16:29 +00004664
Jerry Yu148165c2021-09-24 23:20:59 +08004665#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004666
Jerry Yu1ea9d102021-12-21 13:41:49 +08004667#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
4668 defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4669 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jerry Yuba073422021-12-20 22:22:15 +08004670/*
Jerry Yub925f212022-01-12 11:17:02 +08004671 * Function for writing a supported groups (TLS 1.3) or supported elliptic
4672 * curves (TLS 1.2) extension.
Jerry Yuba073422021-12-20 22:22:15 +08004673 *
Jerry Yub925f212022-01-12 11:17:02 +08004674 * The "extension_data" field of a supported groups extension contains a
4675 * "NamedGroupList" value (TLS 1.3 RFC8446):
Jerry Yuba073422021-12-20 22:22:15 +08004676 * enum {
4677 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
4678 * x25519(0x001D), x448(0x001E),
4679 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
4680 * ffdhe6144(0x0103), ffdhe8192(0x0104),
4681 * ffdhe_private_use(0x01FC..0x01FF),
4682 * ecdhe_private_use(0xFE00..0xFEFF),
4683 * (0xFFFF)
4684 * } NamedGroup;
4685 * struct {
4686 * NamedGroup named_group_list<2..2^16-1>;
4687 * } NamedGroupList;
Jerry Yub925f212022-01-12 11:17:02 +08004688 *
4689 * The "extension_data" field of a supported elliptic curves extension contains
4690 * a "NamedCurveList" value (TLS 1.2 RFC 8422):
Jerry Yu63282b42022-01-11 15:43:53 +08004691 * enum {
4692 * deprecated(1..22),
4693 * secp256r1 (23), secp384r1 (24), secp521r1 (25),
4694 * x25519(29), x448(30),
4695 * reserved (0xFE00..0xFEFF),
4696 * deprecated(0xFF01..0xFF02),
4697 * (0xFFFF)
4698 * } NamedCurve;
4699 * struct {
4700 * NamedCurve named_curve_list<2..2^16-1>
4701 * } NamedCurveList;
4702 *
Jerry Yub925f212022-01-12 11:17:02 +08004703 * The TLS 1.3 supported groups extension was defined to be a compatible
4704 * generalization of the TLS 1.2 supported elliptic curves extension. They both
4705 * share the same extension identifier.
Jerry Yu63282b42022-01-11 15:43:53 +08004706 *
Jerry Yub925f212022-01-12 11:17:02 +08004707 * DHE groups are not supported yet.
Jerry Yuba073422021-12-20 22:22:15 +08004708 */
Jerry Yuba073422021-12-20 22:22:15 +08004709int mbedtls_ssl_write_supported_groups_ext( mbedtls_ssl_context *ssl,
4710 unsigned char *buf,
Jerry Yu17532612021-12-20 22:32:09 +08004711 const unsigned char *end,
Jerry Yuba073422021-12-20 22:22:15 +08004712 size_t *out_len )
4713{
4714 unsigned char *p = buf ;
4715 unsigned char *named_group_list; /* Start of named_group_list */
4716 size_t named_group_list_len; /* Length of named_group_list */
4717 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
4718
4719 *out_len = 0;
Jerry Yuf46b0162022-01-11 16:28:00 +08004720
Jerry Yuba073422021-12-20 22:22:15 +08004721 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported_groups extension" ) );
4722
4723 /* Check if we have space for header and length fields:
4724 * - extension_type (2 bytes)
4725 * - extension_data_length (2 bytes)
4726 * - named_group_list_length (2 bytes)
4727 */
4728 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
4729 p += 6;
4730
4731 named_group_list = p;
4732
4733 if( group_list == NULL )
4734 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
4735
Jerry Yu1510cea2022-01-12 10:56:49 +08004736 for( ; *group_list != 0; group_list++ )
Jerry Yuba073422021-12-20 22:22:15 +08004737 {
Jerry Yu1510cea2022-01-12 10:56:49 +08004738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got supported group(%04x)", *group_list ) );
Jerry Yu63282b42022-01-11 15:43:53 +08004739
Jerry Yu1ea9d102021-12-21 13:41:49 +08004740#if defined(MBEDTLS_ECP_C)
Jerry Yu1510cea2022-01-12 10:56:49 +08004741 if( ( mbedtls_ssl_conf_is_tls13_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004742 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) ) ||
Jerry Yu1510cea2022-01-12 10:56:49 +08004743 ( mbedtls_ssl_conf_is_tls12_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004744 mbedtls_ssl_tls12_named_group_is_ecdhe( *group_list ) ) )
Jerry Yuba073422021-12-20 22:22:15 +08004745 {
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004746 const mbedtls_ecp_curve_info *curve_info;
4747 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
Jerry Yub925f212022-01-12 11:17:02 +08004748 if( curve_info == NULL )
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004749 continue;
Jerry Yub925f212022-01-12 11:17:02 +08004750 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
4751 MBEDTLS_PUT_UINT16_BE( *group_list, p, 0 );
4752 p += 2;
4753 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NamedGroup: %s ( %x )",
4754 curve_info->name, *group_list ) );
Jerry Yuba073422021-12-20 22:22:15 +08004755 }
Jerry Yu63282b42022-01-11 15:43:53 +08004756#endif /* MBEDTLS_ECP_C */
4757 /* Add DHE groups here */
Jerry Yuba073422021-12-20 22:22:15 +08004758
4759 }
4760
Jerry Yu1510cea2022-01-12 10:56:49 +08004761 /* Length of named_group_list */
Jerry Yuba073422021-12-20 22:22:15 +08004762 named_group_list_len = p - named_group_list;
4763 if( named_group_list_len == 0 )
4764 {
4765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No group available." ) );
4766 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4767 }
4768
4769 /* Write extension_type */
4770 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_GROUPS, buf, 0 );
4771 /* Write extension_data_length */
4772 MBEDTLS_PUT_UINT16_BE( named_group_list_len + 2, buf, 2 );
4773 /* Write length of named_group_list */
4774 MBEDTLS_PUT_UINT16_BE( named_group_list_len, buf, 4 );
4775
Jerry Yu7f029d82022-01-11 11:08:53 +08004776 MBEDTLS_SSL_DEBUG_BUF( 3, "Supported groups extension",
4777 buf + 4, named_group_list_len + 2 );
Jerry Yuba073422021-12-20 22:22:15 +08004778
4779 *out_len = p - buf;
4780
4781#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4782 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
4783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4784
4785 return( 0 );
4786}
4787
Jerry Yu1ea9d102021-12-21 13:41:49 +08004788#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED ||
4789 MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C ||
4790 MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jerry Yuba073422021-12-20 22:22:15 +08004791
Jerry Yuf017ee42022-01-12 15:49:48 +08004792#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4793/*
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004794 * Function for writing a signature algorithm extension.
Jerry Yuf017ee42022-01-12 15:49:48 +08004795 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08004796 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004797 * value (TLS 1.3 RFC8446):
4798 * enum {
4799 * ....
4800 * ecdsa_secp256r1_sha256( 0x0403 ),
4801 * ecdsa_secp384r1_sha384( 0x0503 ),
4802 * ecdsa_secp521r1_sha512( 0x0603 ),
4803 * ....
4804 * } SignatureScheme;
Jerry Yuf017ee42022-01-12 15:49:48 +08004805 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004806 * struct {
4807 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4808 * } SignatureSchemeList;
Jerry Yuf017ee42022-01-12 15:49:48 +08004809 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08004810 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4811 * value (TLS 1.2 RFC5246):
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004812 * enum {
4813 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4814 * sha512(6), (255)
4815 * } HashAlgorithm;
4816 *
4817 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4818 * SignatureAlgorithm;
4819 *
4820 * struct {
4821 * HashAlgorithm hash;
4822 * SignatureAlgorithm signature;
4823 * } SignatureAndHashAlgorithm;
4824 *
4825 * SignatureAndHashAlgorithm
4826 * supported_signature_algorithms<2..2^16-2>;
4827 *
4828 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4829 * generalization of the TLS 1.2 signature algorithm extension.
4830 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4831 * `SignatureScheme` field of TLS 1.3
4832 *
Jerry Yuf017ee42022-01-12 15:49:48 +08004833 */
4834int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
4835 const unsigned char *end, size_t *out_len )
4836{
4837 unsigned char *p = buf;
4838 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
4839 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
4840
4841 *out_len = 0;
4842
4843 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
4844
4845 /* Check if we have space for header and length field:
4846 * - extension_type (2 bytes)
4847 * - extension_data_length (2 bytes)
4848 * - supported_signature_algorithms_length (2 bytes)
4849 */
4850 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
4851 p += 6;
4852
4853 /*
4854 * Write supported_signature_algorithms
4855 */
4856 supported_sig_alg = p;
Jerry Yu6106fdc2022-01-12 16:36:14 +08004857 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
4858 if( sig_alg == NULL )
4859 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
4860
4861 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
Jerry Yuf017ee42022-01-12 15:49:48 +08004862 {
Jerry Yu1bab3012022-01-19 17:43:22 +08004863 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
4864 continue;
Jerry Yuf017ee42022-01-12 15:49:48 +08004865 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
4866 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
4867 p += 2;
4868 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x]", *sig_alg ) );
4869 }
4870
4871 /* Length of supported_signature_algorithms */
4872 supported_sig_alg_len = p - supported_sig_alg;
4873 if( supported_sig_alg_len == 0 )
4874 {
4875 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
4876 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4877 }
4878
4879 /* Write extension_type */
4880 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
4881 /* Write extension_data_length */
4882 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
4883 /* Write length of supported_signature_algorithms */
4884 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
4885
4886 /* Output the total length of signature algorithms extension. */
4887 *out_len = p - buf;
4888
4889#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4890 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
4891#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4892 return( 0 );
4893}
4894#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yuc73c6182022-02-08 20:29:25 +08004895
Jerry Yuc5aef882021-12-23 20:15:02 +08004896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4897int mbedtls_ssl_write_hostname_ext( mbedtls_ssl_context *ssl,
4898 unsigned char *buf,
4899 const unsigned char *end,
4900 size_t *olen )
4901{
4902 unsigned char *p = buf;
4903 size_t hostname_len;
4904
4905 *olen = 0;
4906
4907 if( ssl->hostname == NULL )
4908 return( 0 );
4909
4910 MBEDTLS_SSL_DEBUG_MSG( 3,
4911 ( "client hello, adding server name extension: %s",
4912 ssl->hostname ) );
4913
4914 hostname_len = strlen( ssl->hostname );
4915
4916 MBEDTLS_SSL_CHK_BUF_PTR( p, end, hostname_len + 9 );
4917
4918 /*
4919 * Sect. 3, RFC 6066 (TLS Extensions Definitions)
4920 *
4921 * In order to provide any of the server names, clients MAY include an
4922 * extension of type "server_name" in the (extended) client hello. The
4923 * "extension_data" field of this extension SHALL contain
4924 * "ServerNameList" where:
4925 *
4926 * struct {
4927 * NameType name_type;
4928 * select (name_type) {
4929 * case host_name: HostName;
4930 * } name;
4931 * } ServerName;
4932 *
4933 * enum {
4934 * host_name(0), (255)
4935 * } NameType;
4936 *
4937 * opaque HostName<1..2^16-1>;
4938 *
4939 * struct {
4940 * ServerName server_name_list<1..2^16-1>
4941 * } ServerNameList;
4942 *
4943 */
4944 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SERVERNAME, p, 0 );
4945 p += 2;
4946
4947 MBEDTLS_PUT_UINT16_BE( hostname_len + 5, p, 0 );
4948 p += 2;
4949
4950 MBEDTLS_PUT_UINT16_BE( hostname_len + 3, p, 0 );
4951 p += 2;
4952
4953 *p++ = MBEDTLS_BYTE_0( MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME );
4954
4955 MBEDTLS_PUT_UINT16_BE( hostname_len, p, 0 );
4956 p += 2;
4957
4958 memcpy( p, ssl->hostname, hostname_len );
4959
4960 *olen = hostname_len + 9;
4961
4962 return( 0 );
4963}
4964#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Jerry Yuf017ee42022-01-12 15:49:48 +08004965
Jerry Yudc7bd172022-02-17 13:44:15 +08004966#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4967
4968#if defined(MBEDTLS_USE_PSA_CRYPTO)
4969
4970static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4971 mbedtls_svc_key_id_t key,
4972 psa_algorithm_t alg,
4973 const unsigned char* seed, size_t seed_length,
4974 const unsigned char* label, size_t label_length,
4975 size_t capacity )
4976{
4977 psa_status_t status;
4978
4979 status = psa_key_derivation_setup( derivation, alg );
4980 if( status != PSA_SUCCESS )
4981 return( status );
4982
4983 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4984 {
4985 status = psa_key_derivation_input_bytes( derivation,
4986 PSA_KEY_DERIVATION_INPUT_SEED,
4987 seed, seed_length );
4988 if( status != PSA_SUCCESS )
4989 return( status );
4990
4991 if( mbedtls_svc_key_id_is_null( key ) )
4992 {
4993 status = psa_key_derivation_input_bytes(
4994 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4995 NULL, 0 );
4996 }
4997 else
4998 {
4999 status = psa_key_derivation_input_key(
5000 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5001 }
5002 if( status != PSA_SUCCESS )
5003 return( status );
5004
5005 status = psa_key_derivation_input_bytes( derivation,
5006 PSA_KEY_DERIVATION_INPUT_LABEL,
5007 label, label_length );
5008 if( status != PSA_SUCCESS )
5009 return( status );
5010 }
5011 else
5012 {
5013 return( PSA_ERROR_NOT_SUPPORTED );
5014 }
5015
5016 status = psa_key_derivation_set_capacity( derivation, capacity );
5017 if( status != PSA_SUCCESS )
5018 return( status );
5019
5020 return( PSA_SUCCESS );
5021}
5022
5023static int tls_prf_generic( mbedtls_md_type_t md_type,
5024 const unsigned char *secret, size_t slen,
5025 const char *label,
5026 const unsigned char *random, size_t rlen,
5027 unsigned char *dstbuf, size_t dlen )
5028{
5029 psa_status_t status;
5030 psa_algorithm_t alg;
5031 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5032 psa_key_derivation_operation_t derivation =
5033 PSA_KEY_DERIVATION_OPERATION_INIT;
5034
5035 if( md_type == MBEDTLS_MD_SHA384 )
5036 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5037 else
5038 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5039
5040 /* Normally a "secret" should be long enough to be impossible to
5041 * find by brute force, and in particular should not be empty. But
5042 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5043 * and for this use case it makes sense to have a 0-length "secret".
5044 * Since the key API doesn't allow importing a key of length 0,
5045 * keep master_key=0, which setup_psa_key_derivation() understands
5046 * to mean a 0-length "secret" input. */
5047 if( slen != 0 )
5048 {
5049 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5050 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5051 psa_set_key_algorithm( &key_attributes, alg );
5052 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5053
5054 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5055 if( status != PSA_SUCCESS )
5056 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5057 }
5058
5059 status = setup_psa_key_derivation( &derivation,
5060 master_key, alg,
5061 random, rlen,
5062 (unsigned char const *) label,
5063 (size_t) strlen( label ),
5064 dlen );
5065 if( status != PSA_SUCCESS )
5066 {
5067 psa_key_derivation_abort( &derivation );
5068 psa_destroy_key( master_key );
5069 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5070 }
5071
5072 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5073 if( status != PSA_SUCCESS )
5074 {
5075 psa_key_derivation_abort( &derivation );
5076 psa_destroy_key( master_key );
5077 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5078 }
5079
5080 status = psa_key_derivation_abort( &derivation );
5081 if( status != PSA_SUCCESS )
5082 {
5083 psa_destroy_key( master_key );
5084 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5085 }
5086
5087 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5088 status = psa_destroy_key( master_key );
5089 if( status != PSA_SUCCESS )
5090 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5091
5092 return( 0 );
5093}
5094
5095#else /* MBEDTLS_USE_PSA_CRYPTO */
5096
5097static int tls_prf_generic( mbedtls_md_type_t md_type,
5098 const unsigned char *secret, size_t slen,
5099 const char *label,
5100 const unsigned char *random, size_t rlen,
5101 unsigned char *dstbuf, size_t dlen )
5102{
5103 size_t nb;
5104 size_t i, j, k, md_len;
5105 unsigned char *tmp;
5106 size_t tmp_len = 0;
5107 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5108 const mbedtls_md_info_t *md_info;
5109 mbedtls_md_context_t md_ctx;
5110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5111
5112 mbedtls_md_init( &md_ctx );
5113
5114 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5115 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5116
5117 md_len = mbedtls_md_get_size( md_info );
5118
5119 tmp_len = md_len + strlen( label ) + rlen;
5120 tmp = mbedtls_calloc( 1, tmp_len );
5121 if( tmp == NULL )
5122 {
5123 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5124 goto exit;
5125 }
5126
5127 nb = strlen( label );
5128 memcpy( tmp + md_len, label, nb );
5129 memcpy( tmp + md_len + nb, random, rlen );
5130 nb += rlen;
5131
5132 /*
5133 * Compute P_<hash>(secret, label + random)[0..dlen]
5134 */
5135 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5136 goto exit;
5137
5138 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5139 if( ret != 0 )
5140 goto exit;
5141 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5142 if( ret != 0 )
5143 goto exit;
5144 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5145 if( ret != 0 )
5146 goto exit;
5147
5148 for( i = 0; i < dlen; i += md_len )
5149 {
5150 ret = mbedtls_md_hmac_reset ( &md_ctx );
5151 if( ret != 0 )
5152 goto exit;
5153 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5154 if( ret != 0 )
5155 goto exit;
5156 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5157 if( ret != 0 )
5158 goto exit;
5159
5160 ret = mbedtls_md_hmac_reset ( &md_ctx );
5161 if( ret != 0 )
5162 goto exit;
5163 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5164 if( ret != 0 )
5165 goto exit;
5166 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5167 if( ret != 0 )
5168 goto exit;
5169
5170 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5171
5172 for( j = 0; j < k; j++ )
5173 dstbuf[i + j] = h_i[j];
5174 }
5175
5176exit:
5177 mbedtls_md_free( &md_ctx );
5178
5179 mbedtls_platform_zeroize( tmp, tmp_len );
5180 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5181
5182 mbedtls_free( tmp );
5183
5184 return( ret );
5185}
5186#endif /* MBEDTLS_USE_PSA_CRYPTO */
5187
5188#if defined(MBEDTLS_SHA256_C)
5189static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5190 const char *label,
5191 const unsigned char *random, size_t rlen,
5192 unsigned char *dstbuf, size_t dlen )
5193{
5194 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5195 label, random, rlen, dstbuf, dlen ) );
5196}
5197#endif /* MBEDTLS_SHA256_C */
5198
5199#if defined(MBEDTLS_SHA384_C)
5200static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5201 const char *label,
5202 const unsigned char *random, size_t rlen,
5203 unsigned char *dstbuf, size_t dlen )
5204{
5205 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5206 label, random, rlen, dstbuf, dlen ) );
5207}
5208#endif /* MBEDTLS_SHA384_C */
5209
Jerry Yuf009d862022-02-17 14:01:37 +08005210/*
5211 * Set appropriate PRF function and other SSL / TLS1.2 functions
5212 *
5213 * Inputs:
5214 * - SSL/TLS minor version
5215 * - hash associated with the ciphersuite (only used by TLS 1.2)
5216 *
5217 * Outputs:
5218 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5219 */
5220static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
5221 int minor_ver,
5222 mbedtls_md_type_t hash )
5223{
5224
5225#if defined(MBEDTLS_SHA384_C)
5226 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
5227 hash == MBEDTLS_MD_SHA384 )
5228 {
5229 handshake->tls_prf = tls_prf_sha384;
5230 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5231 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5232 }
5233 else
5234#endif
5235#if defined(MBEDTLS_SHA256_C)
5236 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
5237 {
5238 handshake->tls_prf = tls_prf_sha256;
5239 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5240 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5241 }
5242 else
5243#endif
5244 {
5245 (void) hash;
5246 (void) minor_ver;
5247 (void) handshake;
5248 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5249 }
5250
5251 return( 0 );
5252}
Jerry Yud6ab2352022-02-17 14:03:43 +08005253
5254#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
5255 defined(MBEDTLS_USE_PSA_CRYPTO)
5256static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
5257{
5258 if( ssl->conf->f_psk != NULL )
5259 {
5260 /* If we've used a callback to select the PSK,
5261 * the static configuration is irrelevant. */
5262 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
5263 return( 1 );
5264
5265 return( 0 );
5266 }
5267
5268 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5269 return( 1 );
5270
5271 return( 0 );
5272}
5273#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5274 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5275
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005276/*
5277 * Compute master secret if needed
5278 *
5279 * Parameters:
5280 * [in/out] handshake
5281 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5282 * (PSA-PSK) ciphersuite_info, psk_opaque
5283 * [out] premaster (cleared)
5284 * [out] master
5285 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5286 * debug: conf->f_dbg, conf->p_dbg
5287 * EMS: passed to calc_verify (debug + session_negotiate)
5288 * PSA-PSA: minor_ver, conf
5289 */
5290static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5291 unsigned char *master,
5292 const mbedtls_ssl_context *ssl )
5293{
5294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5295
5296 /* cf. RFC 5246, Section 8.1:
5297 * "The master secret is always exactly 48 bytes in length." */
5298 size_t const master_secret_len = 48;
5299
5300#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5301 unsigned char session_hash[48];
5302#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5303
5304 /* The label for the KDF used for key expansion.
5305 * This is either "master secret" or "extended master secret"
5306 * depending on whether the Extended Master Secret extension
5307 * is used. */
5308 char const *lbl = "master secret";
5309
5310 /* The salt for the KDF used for key expansion.
5311 * - If the Extended Master Secret extension is not used,
5312 * this is ClientHello.Random + ServerHello.Random
5313 * (see Sect. 8.1 in RFC 5246).
5314 * - If the Extended Master Secret extension is used,
5315 * this is the transcript of the handshake so far.
5316 * (see Sect. 4 in RFC 7627). */
5317 unsigned char const *salt = handshake->randbytes;
5318 size_t salt_len = 64;
5319
5320#if !defined(MBEDTLS_DEBUG_C) && \
5321 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5322 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5323 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5324 ssl = NULL; /* make sure we don't use it except for those cases */
5325 (void) ssl;
5326#endif
5327
5328 if( handshake->resume != 0 )
5329 {
5330 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5331 return( 0 );
5332 }
5333
5334#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5335 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5336 {
5337 lbl = "extended master secret";
5338 salt = session_hash;
5339 handshake->calc_verify( ssl, session_hash, &salt_len );
5340
5341 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5342 session_hash, salt_len );
5343 }
5344#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5345
5346#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5347 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5348 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
5349 ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
5350 ssl_use_opaque_psk( ssl ) == 1 )
5351 {
5352 /* Perform PSK-to-MS expansion in a single step. */
5353 psa_status_t status;
5354 psa_algorithm_t alg;
5355 mbedtls_svc_key_id_t psk;
5356 psa_key_derivation_operation_t derivation =
5357 PSA_KEY_DERIVATION_OPERATION_INIT;
5358 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5359
5360 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5361
5362 psk = mbedtls_ssl_get_opaque_psk( ssl );
5363
5364 if( hash_alg == MBEDTLS_MD_SHA384 )
5365 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5366 else
5367 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5368
5369 status = setup_psa_key_derivation( &derivation, psk, alg,
5370 salt, salt_len,
5371 (unsigned char const *) lbl,
5372 (size_t) strlen( lbl ),
5373 master_secret_len );
5374 if( status != PSA_SUCCESS )
5375 {
5376 psa_key_derivation_abort( &derivation );
5377 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5378 }
5379
5380 status = psa_key_derivation_output_bytes( &derivation,
5381 master,
5382 master_secret_len );
5383 if( status != PSA_SUCCESS )
5384 {
5385 psa_key_derivation_abort( &derivation );
5386 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5387 }
5388
5389 status = psa_key_derivation_abort( &derivation );
5390 if( status != PSA_SUCCESS )
5391 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5392 }
5393 else
5394#endif
5395 {
5396 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5397 lbl, salt, salt_len,
5398 master,
5399 master_secret_len );
5400 if( ret != 0 )
5401 {
5402 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5403 return( ret );
5404 }
5405
5406 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5407 handshake->premaster,
5408 handshake->pmslen );
5409
5410 mbedtls_platform_zeroize( handshake->premaster,
5411 sizeof(handshake->premaster) );
5412 }
5413
5414 return( 0 );
5415}
5416
Jerry Yud62f87e2022-02-17 14:09:02 +08005417int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5418{
5419 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5420 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5421 ssl->handshake->ciphersuite_info;
5422
5423 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5424
5425 /* Set PRF, calc_verify and calc_finished function pointers */
5426 ret = ssl_set_handshake_prfs( ssl->handshake,
5427 ssl->minor_ver,
5428 ciphersuite_info->mac );
5429 if( ret != 0 )
5430 {
5431 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5432 return( ret );
5433 }
5434
5435 /* Compute master secret if needed */
5436 ret = ssl_compute_master( ssl->handshake,
5437 ssl->session_negotiate->master,
5438 ssl );
5439 if( ret != 0 )
5440 {
5441 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5442 return( ret );
5443 }
5444
5445 /* Swap the client and server random values:
5446 * - MS derivation wanted client+server (RFC 5246 8.1)
5447 * - key derivation wants server+client (RFC 5246 6.3) */
5448 {
5449 unsigned char tmp[64];
5450 memcpy( tmp, ssl->handshake->randbytes, 64 );
5451 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5452 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5453 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5454 }
5455
5456 /* Populate transform structure */
5457 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5458 ssl->session_negotiate->ciphersuite,
5459 ssl->session_negotiate->master,
5460#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5461 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5462 ssl->session_negotiate->encrypt_then_mac,
5463#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5464 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5465 ssl->handshake->tls_prf,
5466 ssl->handshake->randbytes,
5467 ssl->minor_ver,
5468 ssl->conf->endpoint,
5469 ssl );
5470 if( ret != 0 )
5471 {
5472 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5473 return( ret );
5474 }
5475
5476 /* We no longer need Server/ClientHello.random values */
5477 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5478 sizeof( ssl->handshake->randbytes ) );
5479
5480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5481
5482 return( 0 );
5483}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005484
5485#if defined(MBEDTLS_SHA256_C)
5486void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5487 unsigned char *hash,
5488 size_t *hlen )
5489{
5490#if defined(MBEDTLS_USE_PSA_CRYPTO)
5491 size_t hash_size;
5492 psa_status_t status;
5493 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5494
5495 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5496 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5497 if( status != PSA_SUCCESS )
5498 {
5499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5500 return;
5501 }
5502
5503 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5504 if( status != PSA_SUCCESS )
5505 {
5506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5507 return;
5508 }
5509
5510 *hlen = 32;
5511 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5513#else
5514 mbedtls_sha256_context sha256;
5515
5516 mbedtls_sha256_init( &sha256 );
5517
5518 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5519
5520 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5521 mbedtls_sha256_finish( &sha256, hash );
5522
5523 *hlen = 32;
5524
5525 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5527
5528 mbedtls_sha256_free( &sha256 );
5529#endif /* MBEDTLS_USE_PSA_CRYPTO */
5530 return;
5531}
5532#endif /* MBEDTLS_SHA256_C */
5533
Jerry Yuc1cb3842022-02-17 14:13:48 +08005534#if defined(MBEDTLS_SHA384_C)
5535void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5536 unsigned char *hash,
5537 size_t *hlen )
5538{
5539#if defined(MBEDTLS_USE_PSA_CRYPTO)
5540 size_t hash_size;
5541 psa_status_t status;
5542 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5543
5544 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5545 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5546 if( status != PSA_SUCCESS )
5547 {
5548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5549 return;
5550 }
5551
5552 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5553 if( status != PSA_SUCCESS )
5554 {
5555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5556 return;
5557 }
5558
5559 *hlen = 48;
5560 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5562#else
5563 mbedtls_sha512_context sha512;
5564
5565 mbedtls_sha512_init( &sha512 );
5566
5567 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5568
5569 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5570 mbedtls_sha512_finish( &sha512, hash );
5571
5572 *hlen = 48;
5573
5574 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5576
5577 mbedtls_sha512_free( &sha512 );
5578#endif /* MBEDTLS_USE_PSA_CRYPTO */
5579 return;
5580}
5581#endif /* MBEDTLS_SHA384_C */
5582
Jerry Yuce3dca42022-02-17 14:16:37 +08005583#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5584int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5585{
5586 unsigned char *p = ssl->handshake->premaster;
5587 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5588 const unsigned char *psk = NULL;
5589 size_t psk_len = 0;
5590
5591 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5592 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5593 {
5594 /*
5595 * This should never happen because the existence of a PSK is always
5596 * checked before calling this function
5597 */
5598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5599 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5600 }
5601
5602 /*
5603 * PMS = struct {
5604 * opaque other_secret<0..2^16-1>;
5605 * opaque psk<0..2^16-1>;
5606 * };
5607 * with "other_secret" depending on the particular key exchange
5608 */
5609#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5610 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5611 {
5612 if( end - p < 2 )
5613 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5614
5615 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5616 p += 2;
5617
5618 if( end < p || (size_t)( end - p ) < psk_len )
5619 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5620
5621 memset( p, 0, psk_len );
5622 p += psk_len;
5623 }
5624 else
5625#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5626#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5627 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5628 {
5629 /*
5630 * other_secret already set by the ClientKeyExchange message,
5631 * and is 48 bytes long
5632 */
5633 if( end - p < 2 )
5634 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5635
5636 *p++ = 0;
5637 *p++ = 48;
5638 p += 48;
5639 }
5640 else
5641#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5642#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5643 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5644 {
5645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5646 size_t len;
5647
5648 /* Write length only when we know the actual value */
5649 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5650 p + 2, end - ( p + 2 ), &len,
5651 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5652 {
5653 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5654 return( ret );
5655 }
5656 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5657 p += 2 + len;
5658
5659 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5660 }
5661 else
5662#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5663#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5664 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5665 {
5666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5667 size_t zlen;
5668
5669 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5670 p + 2, end - ( p + 2 ),
5671 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5672 {
5673 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5674 return( ret );
5675 }
5676
5677 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5678 p += 2 + zlen;
5679
5680 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5681 MBEDTLS_DEBUG_ECDH_Z );
5682 }
5683 else
5684#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5685 {
5686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5688 }
5689
5690 /* opaque psk<0..2^16-1>; */
5691 if( end - p < 2 )
5692 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5693
5694 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5695 p += 2;
5696
5697 if( end < p || (size_t)( end - p ) < psk_len )
5698 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5699
5700 memcpy( p, psk, psk_len );
5701 p += psk_len;
5702
5703 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5704
5705 return( 0 );
5706}
5707#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005708
5709#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5710static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5711
5712#if defined(MBEDTLS_SSL_PROTO_DTLS)
5713int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5714{
5715 /* If renegotiation is not enforced, retransmit until we would reach max
5716 * timeout if we were using the usual handshake doubling scheme */
5717 if( ssl->conf->renego_max_records < 0 )
5718 {
5719 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5720 unsigned char doublings = 1;
5721
5722 while( ratio != 0 )
5723 {
5724 ++doublings;
5725 ratio >>= 1;
5726 }
5727
5728 if( ++ssl->renego_records_seen > doublings )
5729 {
5730 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5731 return( 0 );
5732 }
5733 }
5734
5735 return( ssl_write_hello_request( ssl ) );
5736}
5737#endif
5738#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005739
Jerry Yud9526692022-02-17 14:23:47 +08005740/*
5741 * Handshake functions
5742 */
5743#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5744/* No certificate support -> dummy functions */
5745int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5746{
5747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5748 ssl->handshake->ciphersuite_info;
5749
5750 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5751
5752 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5753 {
5754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5755 ssl->state++;
5756 return( 0 );
5757 }
5758
5759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5760 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5761}
5762
5763int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5764{
5765 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5766 ssl->handshake->ciphersuite_info;
5767
5768 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5769
5770 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5771 {
5772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5773 ssl->state++;
5774 return( 0 );
5775 }
5776
5777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5778 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5779}
5780
5781#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5782/* Some certificate support -> implement write and parse */
5783
5784int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5785{
5786 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5787 size_t i, n;
5788 const mbedtls_x509_crt *crt;
5789 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5790 ssl->handshake->ciphersuite_info;
5791
5792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5793
5794 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5795 {
5796 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5797 ssl->state++;
5798 return( 0 );
5799 }
5800
5801#if defined(MBEDTLS_SSL_CLI_C)
5802 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5803 {
5804 if( ssl->handshake->client_auth == 0 )
5805 {
5806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5807 ssl->state++;
5808 return( 0 );
5809 }
5810 }
5811#endif /* MBEDTLS_SSL_CLI_C */
5812#if defined(MBEDTLS_SSL_SRV_C)
5813 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5814 {
5815 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5816 {
5817 /* Should never happen because we shouldn't have picked the
5818 * ciphersuite if we don't have a certificate. */
5819 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5820 }
5821 }
5822#endif
5823
5824 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5825
5826 /*
5827 * 0 . 0 handshake type
5828 * 1 . 3 handshake length
5829 * 4 . 6 length of all certs
5830 * 7 . 9 length of cert. 1
5831 * 10 . n-1 peer certificate
5832 * n . n+2 length of cert. 2
5833 * n+3 . ... upper level cert, etc.
5834 */
5835 i = 7;
5836 crt = mbedtls_ssl_own_cert( ssl );
5837
5838 while( crt != NULL )
5839 {
5840 n = crt->raw.len;
5841 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5842 {
5843 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5844 " > %" MBEDTLS_PRINTF_SIZET,
5845 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5846 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5847 }
5848
5849 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5850 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5851 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5852
5853 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5854 i += n; crt = crt->next;
5855 }
5856
5857 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5858 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5859 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5860
5861 ssl->out_msglen = i;
5862 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5863 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5864
5865 ssl->state++;
5866
5867 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5868 {
5869 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5870 return( ret );
5871 }
5872
5873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5874
5875 return( ret );
5876}
5877
5878#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5879
5880#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5881static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5882 unsigned char *crt_buf,
5883 size_t crt_buf_len )
5884{
5885 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5886
5887 if( peer_crt == NULL )
5888 return( -1 );
5889
5890 if( peer_crt->raw.len != crt_buf_len )
5891 return( -1 );
5892
5893 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5894}
5895#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5896static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5897 unsigned char *crt_buf,
5898 size_t crt_buf_len )
5899{
5900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5901 unsigned char const * const peer_cert_digest =
5902 ssl->session->peer_cert_digest;
5903 mbedtls_md_type_t const peer_cert_digest_type =
5904 ssl->session->peer_cert_digest_type;
5905 mbedtls_md_info_t const * const digest_info =
5906 mbedtls_md_info_from_type( peer_cert_digest_type );
5907 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5908 size_t digest_len;
5909
5910 if( peer_cert_digest == NULL || digest_info == NULL )
5911 return( -1 );
5912
5913 digest_len = mbedtls_md_get_size( digest_info );
5914 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5915 return( -1 );
5916
5917 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5918 if( ret != 0 )
5919 return( -1 );
5920
5921 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5922}
5923#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5924#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5925
5926/*
5927 * Once the certificate message is read, parse it into a cert chain and
5928 * perform basic checks, but leave actual verification to the caller
5929 */
5930static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5931 mbedtls_x509_crt *chain )
5932{
5933 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5934#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5935 int crt_cnt=0;
5936#endif
5937 size_t i, n;
5938 uint8_t alert;
5939
5940 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5941 {
5942 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5943 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5944 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5945 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5946 }
5947
5948 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5949 {
5950 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5951 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5952 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5953 }
5954
5955 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5956 {
5957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5958 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5959 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5960 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5961 }
5962
5963 i = mbedtls_ssl_hs_hdr_len( ssl );
5964
5965 /*
5966 * Same message structure as in mbedtls_ssl_write_certificate()
5967 */
5968 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5969
5970 if( ssl->in_msg[i] != 0 ||
5971 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5972 {
5973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5974 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5975 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5976 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5977 }
5978
5979 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5980 i += 3;
5981
5982 /* Iterate through and parse the CRTs in the provided chain. */
5983 while( i < ssl->in_hslen )
5984 {
5985 /* Check that there's room for the next CRT's length fields. */
5986 if ( i + 3 > ssl->in_hslen ) {
5987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5988 mbedtls_ssl_send_alert_message( ssl,
5989 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5990 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5991 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5992 }
5993 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5994 * anything beyond 2**16 ~ 64K. */
5995 if( ssl->in_msg[i] != 0 )
5996 {
5997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5998 mbedtls_ssl_send_alert_message( ssl,
5999 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6000 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6001 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6002 }
6003
6004 /* Read length of the next CRT in the chain. */
6005 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6006 | (unsigned int) ssl->in_msg[i + 2];
6007 i += 3;
6008
6009 if( n < 128 || i + n > ssl->in_hslen )
6010 {
6011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6012 mbedtls_ssl_send_alert_message( ssl,
6013 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6014 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6015 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6016 }
6017
6018 /* Check if we're handling the first CRT in the chain. */
6019#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6020 if( crt_cnt++ == 0 &&
6021 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6022 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6023 {
6024 /* During client-side renegotiation, check that the server's
6025 * end-CRTs hasn't changed compared to the initial handshake,
6026 * mitigating the triple handshake attack. On success, reuse
6027 * the original end-CRT instead of parsing it again. */
6028 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6029 if( ssl_check_peer_crt_unchanged( ssl,
6030 &ssl->in_msg[i],
6031 n ) != 0 )
6032 {
6033 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6034 mbedtls_ssl_send_alert_message( ssl,
6035 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6036 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6037 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6038 }
6039
6040 /* Now we can safely free the original chain. */
6041 ssl_clear_peer_cert( ssl->session );
6042 }
6043#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6044
6045 /* Parse the next certificate in the chain. */
6046#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6047 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6048#else
6049 /* If we don't need to store the CRT chain permanently, parse
6050 * it in-place from the input buffer instead of making a copy. */
6051 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6052#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6053 switch( ret )
6054 {
6055 case 0: /*ok*/
6056 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6057 /* Ignore certificate with an unknown algorithm: maybe a
6058 prior certificate was already trusted. */
6059 break;
6060
6061 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6062 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6063 goto crt_parse_der_failed;
6064
6065 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6066 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6067 goto crt_parse_der_failed;
6068
6069 default:
6070 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6071 crt_parse_der_failed:
6072 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6073 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6074 return( ret );
6075 }
6076
6077 i += n;
6078 }
6079
6080 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6081 return( 0 );
6082}
6083
6084#if defined(MBEDTLS_SSL_SRV_C)
6085static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6086{
6087 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6088 return( -1 );
6089
6090 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6091 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6092 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6093 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6094 {
6095 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
6096 return( 0 );
6097 }
6098 return( -1 );
6099}
6100#endif /* MBEDTLS_SSL_SRV_C */
6101
6102/* Check if a certificate message is expected.
6103 * Return either
6104 * - SSL_CERTIFICATE_EXPECTED, or
6105 * - SSL_CERTIFICATE_SKIP
6106 * indicating whether a Certificate message is expected or not.
6107 */
6108#define SSL_CERTIFICATE_EXPECTED 0
6109#define SSL_CERTIFICATE_SKIP 1
6110static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6111 int authmode )
6112{
6113 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6114 ssl->handshake->ciphersuite_info;
6115
6116 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6117 return( SSL_CERTIFICATE_SKIP );
6118
6119#if defined(MBEDTLS_SSL_SRV_C)
6120 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6121 {
6122 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6123 return( SSL_CERTIFICATE_SKIP );
6124
6125 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6126 {
6127 ssl->session_negotiate->verify_result =
6128 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6129 return( SSL_CERTIFICATE_SKIP );
6130 }
6131 }
6132#else
6133 ((void) authmode);
6134#endif /* MBEDTLS_SSL_SRV_C */
6135
6136 return( SSL_CERTIFICATE_EXPECTED );
6137}
6138
6139static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6140 int authmode,
6141 mbedtls_x509_crt *chain,
6142 void *rs_ctx )
6143{
6144 int ret = 0;
6145 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6146 ssl->handshake->ciphersuite_info;
6147 int have_ca_chain = 0;
6148
6149 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6150 void *p_vrfy;
6151
6152 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6153 return( 0 );
6154
6155 if( ssl->f_vrfy != NULL )
6156 {
6157 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6158 f_vrfy = ssl->f_vrfy;
6159 p_vrfy = ssl->p_vrfy;
6160 }
6161 else
6162 {
6163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6164 f_vrfy = ssl->conf->f_vrfy;
6165 p_vrfy = ssl->conf->p_vrfy;
6166 }
6167
6168 /*
6169 * Main check: verify certificate
6170 */
6171#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6172 if( ssl->conf->f_ca_cb != NULL )
6173 {
6174 ((void) rs_ctx);
6175 have_ca_chain = 1;
6176
6177 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6178 ret = mbedtls_x509_crt_verify_with_ca_cb(
6179 chain,
6180 ssl->conf->f_ca_cb,
6181 ssl->conf->p_ca_cb,
6182 ssl->conf->cert_profile,
6183 ssl->hostname,
6184 &ssl->session_negotiate->verify_result,
6185 f_vrfy, p_vrfy );
6186 }
6187 else
6188#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6189 {
6190 mbedtls_x509_crt *ca_chain;
6191 mbedtls_x509_crl *ca_crl;
6192
6193#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6194 if( ssl->handshake->sni_ca_chain != NULL )
6195 {
6196 ca_chain = ssl->handshake->sni_ca_chain;
6197 ca_crl = ssl->handshake->sni_ca_crl;
6198 }
6199 else
6200#endif
6201 {
6202 ca_chain = ssl->conf->ca_chain;
6203 ca_crl = ssl->conf->ca_crl;
6204 }
6205
6206 if( ca_chain != NULL )
6207 have_ca_chain = 1;
6208
6209 ret = mbedtls_x509_crt_verify_restartable(
6210 chain,
6211 ca_chain, ca_crl,
6212 ssl->conf->cert_profile,
6213 ssl->hostname,
6214 &ssl->session_negotiate->verify_result,
6215 f_vrfy, p_vrfy, rs_ctx );
6216 }
6217
6218 if( ret != 0 )
6219 {
6220 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6221 }
6222
6223#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6224 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6225 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6226#endif
6227
6228 /*
6229 * Secondary checks: always done, but change 'ret' only if it was 0
6230 */
6231
6232#if defined(MBEDTLS_ECP_C)
6233 {
6234 const mbedtls_pk_context *pk = &chain->pk;
6235
6236 /* If certificate uses an EC key, make sure the curve is OK */
6237 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6238 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6239 {
6240 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6241
6242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6243 if( ret == 0 )
6244 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6245 }
6246 }
6247#endif /* MBEDTLS_ECP_C */
6248
6249 if( mbedtls_ssl_check_cert_usage( chain,
6250 ciphersuite_info,
6251 ! ssl->conf->endpoint,
6252 &ssl->session_negotiate->verify_result ) != 0 )
6253 {
6254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6255 if( ret == 0 )
6256 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6257 }
6258
6259 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6260 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6261 * with details encoded in the verification flags. All other kinds
6262 * of error codes, including those from the user provided f_vrfy
6263 * functions, are treated as fatal and lead to a failure of
6264 * ssl_parse_certificate even if verification was optional. */
6265 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6266 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6267 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6268 {
6269 ret = 0;
6270 }
6271
6272 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6273 {
6274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6275 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6276 }
6277
6278 if( ret != 0 )
6279 {
6280 uint8_t alert;
6281
6282 /* The certificate may have been rejected for several reasons.
6283 Pick one and send the corresponding alert. Which alert to send
6284 may be a subject of debate in some cases. */
6285 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6286 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6287 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6288 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6289 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6290 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6291 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6292 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6293 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6294 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6295 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6296 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6297 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6298 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6299 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6300 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6301 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6302 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6303 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6304 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6305 else
6306 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6307 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6308 alert );
6309 }
6310
6311#if defined(MBEDTLS_DEBUG_C)
6312 if( ssl->session_negotiate->verify_result != 0 )
6313 {
6314 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6315 (unsigned int) ssl->session_negotiate->verify_result ) );
6316 }
6317 else
6318 {
6319 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6320 }
6321#endif /* MBEDTLS_DEBUG_C */
6322
6323 return( ret );
6324}
6325
6326#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6327static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6328 unsigned char *start, size_t len )
6329{
6330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6331 /* Remember digest of the peer's end-CRT. */
6332 ssl->session_negotiate->peer_cert_digest =
6333 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6334 if( ssl->session_negotiate->peer_cert_digest == NULL )
6335 {
6336 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6337 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6338 mbedtls_ssl_send_alert_message( ssl,
6339 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6340 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6341
6342 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6343 }
6344
6345 ret = mbedtls_md( mbedtls_md_info_from_type(
6346 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6347 start, len,
6348 ssl->session_negotiate->peer_cert_digest );
6349
6350 ssl->session_negotiate->peer_cert_digest_type =
6351 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6352 ssl->session_negotiate->peer_cert_digest_len =
6353 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6354
6355 return( ret );
6356}
6357
6358static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6359 unsigned char *start, size_t len )
6360{
6361 unsigned char *end = start + len;
6362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6363
6364 /* Make a copy of the peer's raw public key. */
6365 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6366 ret = mbedtls_pk_parse_subpubkey( &start, end,
6367 &ssl->handshake->peer_pubkey );
6368 if( ret != 0 )
6369 {
6370 /* We should have parsed the public key before. */
6371 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6372 }
6373
6374 return( 0 );
6375}
6376#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6377
6378int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6379{
6380 int ret = 0;
6381 int crt_expected;
6382#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6383 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6384 ? ssl->handshake->sni_authmode
6385 : ssl->conf->authmode;
6386#else
6387 const int authmode = ssl->conf->authmode;
6388#endif
6389 void *rs_ctx = NULL;
6390 mbedtls_x509_crt *chain = NULL;
6391
6392 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6393
6394 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6395 if( crt_expected == SSL_CERTIFICATE_SKIP )
6396 {
6397 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6398 goto exit;
6399 }
6400
6401#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6402 if( ssl->handshake->ecrs_enabled &&
6403 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6404 {
6405 chain = ssl->handshake->ecrs_peer_cert;
6406 ssl->handshake->ecrs_peer_cert = NULL;
6407 goto crt_verify;
6408 }
6409#endif
6410
6411 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6412 {
6413 /* mbedtls_ssl_read_record may have sent an alert already. We
6414 let it decide whether to alert. */
6415 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6416 goto exit;
6417 }
6418
6419#if defined(MBEDTLS_SSL_SRV_C)
6420 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6421 {
6422 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6423
6424 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6425 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6426
6427 goto exit;
6428 }
6429#endif /* MBEDTLS_SSL_SRV_C */
6430
6431 /* Clear existing peer CRT structure in case we tried to
6432 * reuse a session but it failed, and allocate a new one. */
6433 ssl_clear_peer_cert( ssl->session_negotiate );
6434
6435 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6436 if( chain == NULL )
6437 {
6438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6439 sizeof( mbedtls_x509_crt ) ) );
6440 mbedtls_ssl_send_alert_message( ssl,
6441 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6442 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6443
6444 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6445 goto exit;
6446 }
6447 mbedtls_x509_crt_init( chain );
6448
6449 ret = ssl_parse_certificate_chain( ssl, chain );
6450 if( ret != 0 )
6451 goto exit;
6452
6453#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6454 if( ssl->handshake->ecrs_enabled)
6455 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6456
6457crt_verify:
6458 if( ssl->handshake->ecrs_enabled)
6459 rs_ctx = &ssl->handshake->ecrs_ctx;
6460#endif
6461
6462 ret = ssl_parse_certificate_verify( ssl, authmode,
6463 chain, rs_ctx );
6464 if( ret != 0 )
6465 goto exit;
6466
6467#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6468 {
6469 unsigned char *crt_start, *pk_start;
6470 size_t crt_len, pk_len;
6471
6472 /* We parse the CRT chain without copying, so
6473 * these pointers point into the input buffer,
6474 * and are hence still valid after freeing the
6475 * CRT chain. */
6476
6477 crt_start = chain->raw.p;
6478 crt_len = chain->raw.len;
6479
6480 pk_start = chain->pk_raw.p;
6481 pk_len = chain->pk_raw.len;
6482
6483 /* Free the CRT structures before computing
6484 * digest and copying the peer's public key. */
6485 mbedtls_x509_crt_free( chain );
6486 mbedtls_free( chain );
6487 chain = NULL;
6488
6489 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6490 if( ret != 0 )
6491 goto exit;
6492
6493 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6494 if( ret != 0 )
6495 goto exit;
6496 }
6497#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6498 /* Pass ownership to session structure. */
6499 ssl->session_negotiate->peer_cert = chain;
6500 chain = NULL;
6501#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6502
6503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6504
6505exit:
6506
6507 if( ret == 0 )
6508 ssl->state++;
6509
6510#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6511 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6512 {
6513 ssl->handshake->ecrs_peer_cert = chain;
6514 chain = NULL;
6515 }
6516#endif
6517
6518 if( chain != NULL )
6519 {
6520 mbedtls_x509_crt_free( chain );
6521 mbedtls_free( chain );
6522 }
6523
6524 return( ret );
6525}
6526#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6527
Jerry Yu615bd6f2022-02-17 14:25:15 +08006528#if defined(MBEDTLS_SHA256_C)
6529static void ssl_calc_finished_tls_sha256(
6530 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6531{
6532 int len = 12;
6533 const char *sender;
6534 unsigned char padbuf[32];
6535#if defined(MBEDTLS_USE_PSA_CRYPTO)
6536 size_t hash_size;
6537 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6538 psa_status_t status;
6539#else
6540 mbedtls_sha256_context sha256;
6541#endif
6542
6543 mbedtls_ssl_session *session = ssl->session_negotiate;
6544 if( !session )
6545 session = ssl->session;
6546
6547 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6548 ? "client finished"
6549 : "server finished";
6550
6551#if defined(MBEDTLS_USE_PSA_CRYPTO)
6552 sha256_psa = psa_hash_operation_init();
6553
6554 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6555
6556 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6557 if( status != PSA_SUCCESS )
6558 {
6559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6560 return;
6561 }
6562
6563 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6564 if( status != PSA_SUCCESS )
6565 {
6566 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6567 return;
6568 }
6569 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6570#else
6571
6572 mbedtls_sha256_init( &sha256 );
6573
6574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6575
6576 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6577
6578 /*
6579 * TLSv1.2:
6580 * hash = PRF( master, finished_label,
6581 * Hash( handshake ) )[0.11]
6582 */
6583
6584#if !defined(MBEDTLS_SHA256_ALT)
6585 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6586 sha256.state, sizeof( sha256.state ) );
6587#endif
6588
6589 mbedtls_sha256_finish( &sha256, padbuf );
6590 mbedtls_sha256_free( &sha256 );
6591#endif /* MBEDTLS_USE_PSA_CRYPTO */
6592
6593 ssl->handshake->tls_prf( session->master, 48, sender,
6594 padbuf, 32, buf, len );
6595
6596 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6597
6598 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6599
6600 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6601}
6602#endif /* MBEDTLS_SHA256_C */
6603
Jerry Yub7ba49e2022-02-17 14:25:53 +08006604
6605#if defined(MBEDTLS_SHA384_C)
6606
6607static void ssl_calc_finished_tls_sha384(
6608 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6609{
6610 int len = 12;
6611 const char *sender;
6612 unsigned char padbuf[48];
6613#if defined(MBEDTLS_USE_PSA_CRYPTO)
6614 size_t hash_size;
6615 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6616 psa_status_t status;
6617#else
6618 mbedtls_sha512_context sha512;
6619#endif
6620
6621 mbedtls_ssl_session *session = ssl->session_negotiate;
6622 if( !session )
6623 session = ssl->session;
6624
6625 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6626 ? "client finished"
6627 : "server finished";
6628
6629#if defined(MBEDTLS_USE_PSA_CRYPTO)
6630 sha384_psa = psa_hash_operation_init();
6631
6632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6633
6634 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6635 if( status != PSA_SUCCESS )
6636 {
6637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6638 return;
6639 }
6640
6641 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6642 if( status != PSA_SUCCESS )
6643 {
6644 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6645 return;
6646 }
6647 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6648#else
6649 mbedtls_sha512_init( &sha512 );
6650
6651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6652
6653 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6654
6655 /*
6656 * TLSv1.2:
6657 * hash = PRF( master, finished_label,
6658 * Hash( handshake ) )[0.11]
6659 */
6660
6661#if !defined(MBEDTLS_SHA512_ALT)
6662 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6663 sha512.state, sizeof( sha512.state ) );
6664#endif
6665 mbedtls_sha512_finish( &sha512, padbuf );
6666
6667 mbedtls_sha512_free( &sha512 );
6668#endif
6669
6670 ssl->handshake->tls_prf( session->master, 48, sender,
6671 padbuf, 48, buf, len );
6672
6673 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6674
6675 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6676
6677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6678}
6679#endif /* MBEDTLS_SHA384_C */
6680
Jerry Yuaef00152022-02-17 14:27:31 +08006681void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6682{
6683 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6684
6685 /*
6686 * Free our handshake params
6687 */
6688 mbedtls_ssl_handshake_free( ssl );
6689 mbedtls_free( ssl->handshake );
6690 ssl->handshake = NULL;
6691
6692 /*
6693 * Free the previous transform and swith in the current one
6694 */
6695 if( ssl->transform )
6696 {
6697 mbedtls_ssl_transform_free( ssl->transform );
6698 mbedtls_free( ssl->transform );
6699 }
6700 ssl->transform = ssl->transform_negotiate;
6701 ssl->transform_negotiate = NULL;
6702
6703 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6704}
6705
Jerry Yu2a9fff52022-02-17 14:28:51 +08006706void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6707{
6708 int resume = ssl->handshake->resume;
6709
6710 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6711
6712#if defined(MBEDTLS_SSL_RENEGOTIATION)
6713 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6714 {
6715 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6716 ssl->renego_records_seen = 0;
6717 }
6718#endif
6719
6720 /*
6721 * Free the previous session and switch in the current one
6722 */
6723 if( ssl->session )
6724 {
6725#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6726 /* RFC 7366 3.1: keep the EtM state */
6727 ssl->session_negotiate->encrypt_then_mac =
6728 ssl->session->encrypt_then_mac;
6729#endif
6730
6731 mbedtls_ssl_session_free( ssl->session );
6732 mbedtls_free( ssl->session );
6733 }
6734 ssl->session = ssl->session_negotiate;
6735 ssl->session_negotiate = NULL;
6736
6737 /*
6738 * Add cache entry
6739 */
6740 if( ssl->conf->f_set_cache != NULL &&
6741 ssl->session->id_len != 0 &&
6742 resume == 0 )
6743 {
6744 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6745 ssl->session->id,
6746 ssl->session->id_len,
6747 ssl->session ) != 0 )
6748 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6749 }
6750
6751#if defined(MBEDTLS_SSL_PROTO_DTLS)
6752 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6753 ssl->handshake->flight != NULL )
6754 {
6755 /* Cancel handshake timer */
6756 mbedtls_ssl_set_timer( ssl, 0 );
6757
6758 /* Keep last flight around in case we need to resend it:
6759 * we need the handshake and transform structures for that */
6760 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6761 }
6762 else
6763#endif
6764 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6765
6766 ssl->state++;
6767
6768 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6769}
6770
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006771int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6772{
6773 int ret, hash_len;
6774
6775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6776
6777 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6778
6779 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6780
6781 /*
6782 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6783 * may define some other value. Currently (early 2016), no defined
6784 * ciphersuite does this (and this is unlikely to change as activity has
6785 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6786 */
6787 hash_len = 12;
6788
6789#if defined(MBEDTLS_SSL_RENEGOTIATION)
6790 ssl->verify_data_len = hash_len;
6791 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6792#endif
6793
6794 ssl->out_msglen = 4 + hash_len;
6795 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6796 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6797
6798 /*
6799 * In case of session resuming, invert the client and server
6800 * ChangeCipherSpec messages order.
6801 */
6802 if( ssl->handshake->resume != 0 )
6803 {
6804#if defined(MBEDTLS_SSL_CLI_C)
6805 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6806 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6807#endif
6808#if defined(MBEDTLS_SSL_SRV_C)
6809 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6810 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6811#endif
6812 }
6813 else
6814 ssl->state++;
6815
6816 /*
6817 * Switch to our negotiated transform and session parameters for outbound
6818 * data.
6819 */
6820 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6821
6822#if defined(MBEDTLS_SSL_PROTO_DTLS)
6823 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6824 {
6825 unsigned char i;
6826
6827 /* Remember current epoch settings for resending */
6828 ssl->handshake->alt_transform_out = ssl->transform_out;
6829 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6830 sizeof( ssl->handshake->alt_out_ctr ) );
6831
6832 /* Set sequence_number to zero */
6833 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6834
6835
6836 /* Increment epoch */
6837 for( i = 2; i > 0; i-- )
6838 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6839 break;
6840
6841 /* The loop goes to its end iff the counter is wrapping */
6842 if( i == 0 )
6843 {
6844 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6845 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6846 }
6847 }
6848 else
6849#endif /* MBEDTLS_SSL_PROTO_DTLS */
6850 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6851
6852 ssl->transform_out = ssl->transform_negotiate;
6853 ssl->session_out = ssl->session_negotiate;
6854
6855#if defined(MBEDTLS_SSL_PROTO_DTLS)
6856 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6857 mbedtls_ssl_send_flight_completed( ssl );
6858#endif
6859
6860 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6861 {
6862 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6863 return( ret );
6864 }
6865
6866#if defined(MBEDTLS_SSL_PROTO_DTLS)
6867 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6868 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6869 {
6870 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6871 return( ret );
6872 }
6873#endif
6874
6875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6876
6877 return( 0 );
6878}
6879
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006880#define SSL_MAX_HASH_LEN 12
6881
6882int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6883{
6884 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6885 unsigned int hash_len = 12;
6886 unsigned char buf[SSL_MAX_HASH_LEN];
6887
6888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6889
6890 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6891
6892 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6893 {
6894 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6895 goto exit;
6896 }
6897
6898 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6899 {
6900 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6901 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6902 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6903 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6904 goto exit;
6905 }
6906
6907 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6908 {
6909 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6910 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6911 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6912 goto exit;
6913 }
6914
6915 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6916 {
6917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6918 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6919 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6920 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6921 goto exit;
6922 }
6923
6924 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6925 buf, hash_len ) != 0 )
6926 {
6927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6928 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6929 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6930 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6931 goto exit;
6932 }
6933
6934#if defined(MBEDTLS_SSL_RENEGOTIATION)
6935 ssl->verify_data_len = hash_len;
6936 memcpy( ssl->peer_verify_data, buf, hash_len );
6937#endif
6938
6939 if( ssl->handshake->resume != 0 )
6940 {
6941#if defined(MBEDTLS_SSL_CLI_C)
6942 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6943 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6944#endif
6945#if defined(MBEDTLS_SSL_SRV_C)
6946 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6947 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6948#endif
6949 }
6950 else
6951 ssl->state++;
6952
6953#if defined(MBEDTLS_SSL_PROTO_DTLS)
6954 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6955 mbedtls_ssl_recv_flight_completed( ssl );
6956#endif
6957
6958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6959
6960exit:
6961 mbedtls_platform_zeroize( buf, hash_len );
6962 return( ret );
6963}
6964
Jerry Yu392112c2022-02-17 14:34:10 +08006965#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6966/*
6967 * Helper to get TLS 1.2 PRF from ciphersuite
6968 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6969 */
6970static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6971{
6972#if defined(MBEDTLS_SHA384_C)
6973 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6974 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6975
6976 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6977 return( tls_prf_sha384 );
6978#else
6979 (void) ciphersuite_id;
6980#endif
6981 return( tls_prf_sha256 );
6982}
6983#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006984
6985static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6986{
6987 ((void) tls_prf);
6988#if defined(MBEDTLS_SHA384_C)
6989 if( tls_prf == tls_prf_sha384 )
6990 {
6991 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6992 }
6993 else
6994#endif
6995#if defined(MBEDTLS_SHA256_C)
6996 if( tls_prf == tls_prf_sha256 )
6997 {
6998 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6999 }
7000 else
7001#endif
7002 return( MBEDTLS_SSL_TLS_PRF_NONE );
7003}
7004
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007005/*
7006 * Populate a transform structure with session keys and all the other
7007 * necessary information.
7008 *
7009 * Parameters:
7010 * - [in/out]: transform: structure to populate
7011 * [in] must be just initialised with mbedtls_ssl_transform_init()
7012 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7013 * - [in] ciphersuite
7014 * - [in] master
7015 * - [in] encrypt_then_mac
7016 * - [in] compression
7017 * - [in] tls_prf: pointer to PRF to use for key derivation
7018 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
7019 * - [in] minor_ver: SSL/TLS minor version
7020 * - [in] endpoint: client or server
7021 * - [in] ssl: used for:
7022 * - ssl->conf->{f,p}_export_keys
7023 * [in] optionally used for:
7024 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7025 */
7026static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7027 int ciphersuite,
7028 const unsigned char master[48],
7029#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
7030 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7031 int encrypt_then_mac,
7032#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
7033 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7034 ssl_tls_prf_t tls_prf,
7035 const unsigned char randbytes[64],
7036 int minor_ver,
7037 unsigned endpoint,
7038 const mbedtls_ssl_context *ssl )
7039{
7040 int ret = 0;
7041 unsigned char keyblk[256];
7042 unsigned char *key1;
7043 unsigned char *key2;
7044 unsigned char *mac_enc;
7045 unsigned char *mac_dec;
7046 size_t mac_key_len = 0;
7047 size_t iv_copy_len;
7048 size_t keylen;
7049 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
7050 const mbedtls_cipher_info_t *cipher_info;
7051 const mbedtls_md_info_t *md_info;
7052
7053#if defined(MBEDTLS_USE_PSA_CRYPTO)
7054 psa_key_type_t key_type;
7055 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7056 psa_algorithm_t alg;
7057 size_t key_bits;
7058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7059#endif
7060
7061#if !defined(MBEDTLS_DEBUG_C) && \
7062 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7063 if( ssl->f_export_keys == NULL )
7064 {
7065 ssl = NULL; /* make sure we don't use it except for these cases */
7066 (void) ssl;
7067 }
7068#endif
7069
7070 /*
7071 * Some data just needs copying into the structure
7072 */
7073#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
7074 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7075 transform->encrypt_then_mac = encrypt_then_mac;
7076#endif
7077 transform->minor_ver = minor_ver;
7078
7079#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7080 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7081#endif
7082
7083#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
7084 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
7085 {
7086 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7087 * generation separate. This should never happen. */
7088 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7089 }
7090#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7091
7092 /*
7093 * Get various info structures
7094 */
7095 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7096 if( ciphersuite_info == NULL )
7097 {
7098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7099 ciphersuite ) );
7100 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7101 }
7102
7103 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7104 if( cipher_info == NULL )
7105 {
7106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7107 ciphersuite_info->cipher ) );
7108 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7109 }
7110
7111 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7112 if( md_info == NULL )
7113 {
7114 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7115 (unsigned) ciphersuite_info->mac ) );
7116 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7117 }
7118
7119#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7120 /* Copy own and peer's CID if the use of the CID
7121 * extension has been negotiated. */
7122 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7123 {
7124 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7125
7126 transform->in_cid_len = ssl->own_cid_len;
7127 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7128 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7129 transform->in_cid_len );
7130
7131 transform->out_cid_len = ssl->handshake->peer_cid_len;
7132 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7133 ssl->handshake->peer_cid_len );
7134 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7135 transform->out_cid_len );
7136 }
7137#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7138
7139 /*
7140 * Compute key block using the PRF
7141 */
7142 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7143 if( ret != 0 )
7144 {
7145 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7146 return( ret );
7147 }
7148
7149 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7150 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7151 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7152 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7153 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7154
7155 /*
7156 * Determine the appropriate key, IV and MAC length.
7157 */
7158
7159 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
7160
7161#if defined(MBEDTLS_GCM_C) || \
7162 defined(MBEDTLS_CCM_C) || \
7163 defined(MBEDTLS_CHACHAPOLY_C)
7164 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
7165 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
7166 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
7167 {
7168 size_t explicit_ivlen;
7169
7170 transform->maclen = 0;
7171 mac_key_len = 0;
7172 transform->taglen =
7173 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7174
7175 /* All modes haves 96-bit IVs, but the length of the static parts vary
7176 * with mode and version:
7177 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7178 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7179 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7180 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7181 * sequence number).
7182 */
7183 transform->ivlen = 12;
7184 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
7185 transform->fixed_ivlen = 12;
7186 else
7187 transform->fixed_ivlen = 4;
7188
7189 /* Minimum length of encrypted record */
7190 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7191 transform->minlen = explicit_ivlen + transform->taglen;
7192 }
7193 else
7194#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7195#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7196 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
7197 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7198 {
7199 /* Initialize HMAC contexts */
7200 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7201 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7202 {
7203 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7204 goto end;
7205 }
7206
7207 /* Get MAC length */
7208 mac_key_len = mbedtls_md_get_size( md_info );
7209 transform->maclen = mac_key_len;
7210
7211 /* IV length */
7212 transform->ivlen = cipher_info->iv_size;
7213
7214 /* Minimum length */
7215 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
7216 transform->minlen = transform->maclen;
7217 else
7218 {
7219 /*
7220 * GenericBlockCipher:
7221 * 1. if EtM is in use: one block plus MAC
7222 * otherwise: * first multiple of blocklen greater than maclen
7223 * 2. IV
7224 */
7225#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7226 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
7227 {
7228 transform->minlen = transform->maclen
7229 + cipher_info->block_size;
7230 }
7231 else
7232#endif
7233 {
7234 transform->minlen = transform->maclen
7235 + cipher_info->block_size
7236 - transform->maclen % cipher_info->block_size;
7237 }
7238
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007239 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
7240 {
7241 transform->minlen += transform->ivlen;
7242 }
7243 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007244 {
7245 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7246 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7247 goto end;
7248 }
7249 }
7250 }
7251 else
7252#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7253 {
7254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7255 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7256 }
7257
7258 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7259 (unsigned) keylen,
7260 (unsigned) transform->minlen,
7261 (unsigned) transform->ivlen,
7262 (unsigned) transform->maclen ) );
7263
7264 /*
7265 * Finally setup the cipher contexts, IVs and MAC secrets.
7266 */
7267#if defined(MBEDTLS_SSL_CLI_C)
7268 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7269 {
7270 key1 = keyblk + mac_key_len * 2;
7271 key2 = keyblk + mac_key_len * 2 + keylen;
7272
7273 mac_enc = keyblk;
7274 mac_dec = keyblk + mac_key_len;
7275
7276 /*
7277 * This is not used in TLS v1.1.
7278 */
7279 iv_copy_len = ( transform->fixed_ivlen ) ?
7280 transform->fixed_ivlen : transform->ivlen;
7281 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7282 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7283 iv_copy_len );
7284 }
7285 else
7286#endif /* MBEDTLS_SSL_CLI_C */
7287#if defined(MBEDTLS_SSL_SRV_C)
7288 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7289 {
7290 key1 = keyblk + mac_key_len * 2 + keylen;
7291 key2 = keyblk + mac_key_len * 2;
7292
7293 mac_enc = keyblk + mac_key_len;
7294 mac_dec = keyblk;
7295
7296 /*
7297 * This is not used in TLS v1.1.
7298 */
7299 iv_copy_len = ( transform->fixed_ivlen ) ?
7300 transform->fixed_ivlen : transform->ivlen;
7301 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7302 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7303 iv_copy_len );
7304 }
7305 else
7306#endif /* MBEDTLS_SSL_SRV_C */
7307 {
7308 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7309 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7310 goto end;
7311 }
7312
7313#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007314 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7315 For AEAD-based ciphersuites, there is nothing to do here. */
7316 if( mac_key_len != 0 )
7317 {
7318 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7319 if( ret != 0 )
7320 goto end;
7321 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7322 if( ret != 0 )
7323 goto end;
7324 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007325#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7326
7327 ((void) mac_dec);
7328 ((void) mac_enc);
7329
7330 if( ssl != NULL && ssl->f_export_keys != NULL )
7331 {
7332 ssl->f_export_keys( ssl->p_export_keys,
7333 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7334 master, 48,
7335 randbytes + 32,
7336 randbytes,
7337 tls_prf_get_type( tls_prf ) );
7338 }
7339
7340#if defined(MBEDTLS_USE_PSA_CRYPTO)
7341 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7342 transform->taglen,
7343 &alg,
7344 &key_type,
7345 &key_bits ) ) != PSA_SUCCESS )
7346 {
7347 ret = psa_ssl_status_to_mbedtls( status );
7348 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7349 goto end;
7350 }
7351
7352 transform->psa_alg = alg;
7353
7354 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7355 {
7356 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7357 psa_set_key_algorithm( &attributes, alg );
7358 psa_set_key_type( &attributes, key_type );
7359
7360 if( ( status = psa_import_key( &attributes,
7361 key1,
7362 PSA_BITS_TO_BYTES( key_bits ),
7363 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7364 {
7365 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7366 ret = psa_ssl_status_to_mbedtls( status );
7367 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7368 goto end;
7369 }
7370
7371 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7372
7373 if( ( status = psa_import_key( &attributes,
7374 key2,
7375 PSA_BITS_TO_BYTES( key_bits ),
7376 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7377 {
7378 ret = psa_ssl_status_to_mbedtls( status );
7379 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7380 goto end;
7381 }
7382 }
7383#else
7384 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7385 cipher_info ) ) != 0 )
7386 {
7387 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7388 goto end;
7389 }
7390
7391 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7392 cipher_info ) ) != 0 )
7393 {
7394 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7395 goto end;
7396 }
7397
7398 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7399 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7400 MBEDTLS_ENCRYPT ) ) != 0 )
7401 {
7402 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7403 goto end;
7404 }
7405
7406 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7407 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7408 MBEDTLS_DECRYPT ) ) != 0 )
7409 {
7410 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7411 goto end;
7412 }
7413
7414#if defined(MBEDTLS_CIPHER_MODE_CBC)
7415 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7416 {
7417 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7418 MBEDTLS_PADDING_NONE ) ) != 0 )
7419 {
7420 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7421 goto end;
7422 }
7423
7424 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7425 MBEDTLS_PADDING_NONE ) ) != 0 )
7426 {
7427 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7428 goto end;
7429 }
7430 }
7431#endif /* MBEDTLS_CIPHER_MODE_CBC */
7432#endif /* MBEDTLS_USE_PSA_CRYPTO */
7433
7434end:
7435 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7436 return( ret );
7437}
7438
Jerry Yuee40f9d2022-02-17 14:55:16 +08007439#if defined(MBEDTLS_USE_PSA_CRYPTO)
7440int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7441 unsigned char *hash, size_t *hashlen,
7442 unsigned char *data, size_t data_len,
7443 mbedtls_md_type_t md_alg )
7444{
7445 psa_status_t status;
7446 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7447 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7448
7449 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7450
7451 if( ( status = psa_hash_setup( &hash_operation,
7452 hash_alg ) ) != PSA_SUCCESS )
7453 {
7454 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7455 goto exit;
7456 }
7457
7458 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7459 64 ) ) != PSA_SUCCESS )
7460 {
7461 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7462 goto exit;
7463 }
7464
7465 if( ( status = psa_hash_update( &hash_operation,
7466 data, data_len ) ) != PSA_SUCCESS )
7467 {
7468 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7469 goto exit;
7470 }
7471
7472 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7473 hashlen ) ) != PSA_SUCCESS )
7474 {
7475 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7476 goto exit;
7477 }
7478
7479exit:
7480 if( status != PSA_SUCCESS )
7481 {
7482 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7483 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7484 switch( status )
7485 {
7486 case PSA_ERROR_NOT_SUPPORTED:
7487 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7488 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7489 case PSA_ERROR_BUFFER_TOO_SMALL:
7490 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7491 case PSA_ERROR_INSUFFICIENT_MEMORY:
7492 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7493 default:
7494 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7495 }
7496 }
7497 return( 0 );
7498}
7499
7500#else
7501
7502int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7503 unsigned char *hash, size_t *hashlen,
7504 unsigned char *data, size_t data_len,
7505 mbedtls_md_type_t md_alg )
7506{
7507 int ret = 0;
7508 mbedtls_md_context_t ctx;
7509 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7510 *hashlen = mbedtls_md_get_size( md_info );
7511
7512 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7513
7514 mbedtls_md_init( &ctx );
7515
7516 /*
7517 * digitally-signed struct {
7518 * opaque client_random[32];
7519 * opaque server_random[32];
7520 * ServerDHParams params;
7521 * };
7522 */
7523 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7524 {
7525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7526 goto exit;
7527 }
7528 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7529 {
7530 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7531 goto exit;
7532 }
7533 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7534 {
7535 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7536 goto exit;
7537 }
7538 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7539 {
7540 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7541 goto exit;
7542 }
7543 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7544 {
7545 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7546 goto exit;
7547 }
7548
7549exit:
7550 mbedtls_md_free( &ctx );
7551
7552 if( ret != 0 )
7553 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7554 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7555
7556 return( ret );
7557}
7558#endif /* MBEDTLS_USE_PSA_CRYPTO */
7559
Jerry Yud9d91da2022-02-17 14:57:06 +08007560#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7561
7562/* Find an entry in a signature-hash set matching a given hash algorithm. */
7563mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7564 mbedtls_pk_type_t sig_alg )
7565{
7566 switch( sig_alg )
7567 {
7568 case MBEDTLS_PK_RSA:
7569 return( set->rsa );
7570 case MBEDTLS_PK_ECDSA:
7571 return( set->ecdsa );
7572 default:
7573 return( MBEDTLS_MD_NONE );
7574 }
7575}
7576
7577/* Add a signature-hash-pair to a signature-hash set */
7578void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7579 mbedtls_pk_type_t sig_alg,
7580 mbedtls_md_type_t md_alg )
7581{
7582 switch( sig_alg )
7583 {
7584 case MBEDTLS_PK_RSA:
7585 if( set->rsa == MBEDTLS_MD_NONE )
7586 set->rsa = md_alg;
7587 break;
7588
7589 case MBEDTLS_PK_ECDSA:
7590 if( set->ecdsa == MBEDTLS_MD_NONE )
7591 set->ecdsa = md_alg;
7592 break;
7593
7594 default:
7595 break;
7596 }
7597}
7598
7599/* Allow exactly one hash algorithm for each signature. */
7600void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7601 mbedtls_md_type_t md_alg )
7602{
7603 set->rsa = md_alg;
7604 set->ecdsa = md_alg;
7605}
7606
7607#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7608
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007609/* Serialization of TLS 1.2 sessions:
7610 *
7611 * struct {
7612 * uint64 start_time;
7613 * uint8 ciphersuite[2]; // defined by the standard
7614 * uint8 compression; // 0 or 1
7615 * uint8 session_id_len; // at most 32
7616 * opaque session_id[32];
7617 * opaque master[48]; // fixed length in the standard
7618 * uint32 verify_result;
7619 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7620 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7621 * uint32 ticket_lifetime;
7622 * uint8 mfl_code; // up to 255 according to standard
7623 * uint8 encrypt_then_mac; // 0 or 1
7624 * } serialized_session_tls12;
7625 *
7626 */
7627static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7628 unsigned char *buf,
7629 size_t buf_len )
7630{
7631 unsigned char *p = buf;
7632 size_t used = 0;
7633
7634#if defined(MBEDTLS_HAVE_TIME)
7635 uint64_t start;
7636#endif
7637#if defined(MBEDTLS_X509_CRT_PARSE_C)
7638#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7639 size_t cert_len;
7640#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7641#endif /* MBEDTLS_X509_CRT_PARSE_C */
7642
7643 /*
7644 * Time
7645 */
7646#if defined(MBEDTLS_HAVE_TIME)
7647 used += 8;
7648
7649 if( used <= buf_len )
7650 {
7651 start = (uint64_t) session->start;
7652
7653 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7654 p += 8;
7655 }
7656#endif /* MBEDTLS_HAVE_TIME */
7657
7658 /*
7659 * Basic mandatory fields
7660 */
7661 used += 2 /* ciphersuite */
7662 + 1 /* compression */
7663 + 1 /* id_len */
7664 + sizeof( session->id )
7665 + sizeof( session->master )
7666 + 4; /* verify_result */
7667
7668 if( used <= buf_len )
7669 {
7670 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7671 p += 2;
7672
7673 *p++ = MBEDTLS_BYTE_0( session->compression );
7674
7675 *p++ = MBEDTLS_BYTE_0( session->id_len );
7676 memcpy( p, session->id, 32 );
7677 p += 32;
7678
7679 memcpy( p, session->master, 48 );
7680 p += 48;
7681
7682 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7683 p += 4;
7684 }
7685
7686 /*
7687 * Peer's end-entity certificate
7688 */
7689#if defined(MBEDTLS_X509_CRT_PARSE_C)
7690#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7691 if( session->peer_cert == NULL )
7692 cert_len = 0;
7693 else
7694 cert_len = session->peer_cert->raw.len;
7695
7696 used += 3 + cert_len;
7697
7698 if( used <= buf_len )
7699 {
7700 *p++ = MBEDTLS_BYTE_2( cert_len );
7701 *p++ = MBEDTLS_BYTE_1( cert_len );
7702 *p++ = MBEDTLS_BYTE_0( cert_len );
7703
7704 if( session->peer_cert != NULL )
7705 {
7706 memcpy( p, session->peer_cert->raw.p, cert_len );
7707 p += cert_len;
7708 }
7709 }
7710#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7711 if( session->peer_cert_digest != NULL )
7712 {
7713 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7714 if( used <= buf_len )
7715 {
7716 *p++ = (unsigned char) session->peer_cert_digest_type;
7717 *p++ = (unsigned char) session->peer_cert_digest_len;
7718 memcpy( p, session->peer_cert_digest,
7719 session->peer_cert_digest_len );
7720 p += session->peer_cert_digest_len;
7721 }
7722 }
7723 else
7724 {
7725 used += 2;
7726 if( used <= buf_len )
7727 {
7728 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7729 *p++ = 0;
7730 }
7731 }
7732#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7733#endif /* MBEDTLS_X509_CRT_PARSE_C */
7734
7735 /*
7736 * Session ticket if any, plus associated data
7737 */
7738#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7739 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7740
7741 if( used <= buf_len )
7742 {
7743 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7744 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7745 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7746
7747 if( session->ticket != NULL )
7748 {
7749 memcpy( p, session->ticket, session->ticket_len );
7750 p += session->ticket_len;
7751 }
7752
7753 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7754 p += 4;
7755 }
7756#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7757
7758 /*
7759 * Misc extension-related info
7760 */
7761#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7762 used += 1;
7763
7764 if( used <= buf_len )
7765 *p++ = session->mfl_code;
7766#endif
7767
7768#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7769 used += 1;
7770
7771 if( used <= buf_len )
7772 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7773#endif
7774
7775 return( used );
7776}
7777
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007778static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7779 const unsigned char *buf,
7780 size_t len )
7781{
7782#if defined(MBEDTLS_HAVE_TIME)
7783 uint64_t start;
7784#endif
7785#if defined(MBEDTLS_X509_CRT_PARSE_C)
7786#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7787 size_t cert_len;
7788#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7789#endif /* MBEDTLS_X509_CRT_PARSE_C */
7790
7791 const unsigned char *p = buf;
7792 const unsigned char * const end = buf + len;
7793
7794 /*
7795 * Time
7796 */
7797#if defined(MBEDTLS_HAVE_TIME)
7798 if( 8 > (size_t)( end - p ) )
7799 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7800
7801 start = ( (uint64_t) p[0] << 56 ) |
7802 ( (uint64_t) p[1] << 48 ) |
7803 ( (uint64_t) p[2] << 40 ) |
7804 ( (uint64_t) p[3] << 32 ) |
7805 ( (uint64_t) p[4] << 24 ) |
7806 ( (uint64_t) p[5] << 16 ) |
7807 ( (uint64_t) p[6] << 8 ) |
7808 ( (uint64_t) p[7] );
7809 p += 8;
7810
7811 session->start = (time_t) start;
7812#endif /* MBEDTLS_HAVE_TIME */
7813
7814 /*
7815 * Basic mandatory fields
7816 */
7817 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7818 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7819
7820 session->ciphersuite = ( p[0] << 8 ) | p[1];
7821 p += 2;
7822
7823 session->compression = *p++;
7824
7825 session->id_len = *p++;
7826 memcpy( session->id, p, 32 );
7827 p += 32;
7828
7829 memcpy( session->master, p, 48 );
7830 p += 48;
7831
7832 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7833 ( (uint32_t) p[1] << 16 ) |
7834 ( (uint32_t) p[2] << 8 ) |
7835 ( (uint32_t) p[3] );
7836 p += 4;
7837
7838 /* Immediately clear invalid pointer values that have been read, in case
7839 * we exit early before we replaced them with valid ones. */
7840#if defined(MBEDTLS_X509_CRT_PARSE_C)
7841#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7842 session->peer_cert = NULL;
7843#else
7844 session->peer_cert_digest = NULL;
7845#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7846#endif /* MBEDTLS_X509_CRT_PARSE_C */
7847#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7848 session->ticket = NULL;
7849#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7850
7851 /*
7852 * Peer certificate
7853 */
7854#if defined(MBEDTLS_X509_CRT_PARSE_C)
7855#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7856 /* Deserialize CRT from the end of the ticket. */
7857 if( 3 > (size_t)( end - p ) )
7858 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7859
7860 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7861 p += 3;
7862
7863 if( cert_len != 0 )
7864 {
7865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7866
7867 if( cert_len > (size_t)( end - p ) )
7868 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7869
7870 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7871
7872 if( session->peer_cert == NULL )
7873 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7874
7875 mbedtls_x509_crt_init( session->peer_cert );
7876
7877 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7878 p, cert_len ) ) != 0 )
7879 {
7880 mbedtls_x509_crt_free( session->peer_cert );
7881 mbedtls_free( session->peer_cert );
7882 session->peer_cert = NULL;
7883 return( ret );
7884 }
7885
7886 p += cert_len;
7887 }
7888#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7889 /* Deserialize CRT digest from the end of the ticket. */
7890 if( 2 > (size_t)( end - p ) )
7891 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7892
7893 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7894 session->peer_cert_digest_len = (size_t) *p++;
7895
7896 if( session->peer_cert_digest_len != 0 )
7897 {
7898 const mbedtls_md_info_t *md_info =
7899 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7900 if( md_info == NULL )
7901 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7902 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7903 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7904
7905 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7906 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7907
7908 session->peer_cert_digest =
7909 mbedtls_calloc( 1, session->peer_cert_digest_len );
7910 if( session->peer_cert_digest == NULL )
7911 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7912
7913 memcpy( session->peer_cert_digest, p,
7914 session->peer_cert_digest_len );
7915 p += session->peer_cert_digest_len;
7916 }
7917#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7918#endif /* MBEDTLS_X509_CRT_PARSE_C */
7919
7920 /*
7921 * Session ticket and associated data
7922 */
7923#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7924 if( 3 > (size_t)( end - p ) )
7925 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7926
7927 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7928 p += 3;
7929
7930 if( session->ticket_len != 0 )
7931 {
7932 if( session->ticket_len > (size_t)( end - p ) )
7933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7934
7935 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7936 if( session->ticket == NULL )
7937 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7938
7939 memcpy( session->ticket, p, session->ticket_len );
7940 p += session->ticket_len;
7941 }
7942
7943 if( 4 > (size_t)( end - p ) )
7944 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7945
7946 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7947 ( (uint32_t) p[1] << 16 ) |
7948 ( (uint32_t) p[2] << 8 ) |
7949 ( (uint32_t) p[3] );
7950 p += 4;
7951#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7952
7953 /*
7954 * Misc extension-related info
7955 */
7956#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7957 if( 1 > (size_t)( end - p ) )
7958 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7959
7960 session->mfl_code = *p++;
7961#endif
7962
7963#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7964 if( 1 > (size_t)( end - p ) )
7965 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7966
7967 session->encrypt_then_mac = *p++;
7968#endif
7969
7970 /* Done, should have consumed entire buffer */
7971 if( p != end )
7972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7973
7974 return( 0 );
7975}
Jerry Yudc7bd172022-02-17 13:44:15 +08007976#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007978#endif /* MBEDTLS_SSL_TLS_C */