blob: 2220721f1e2ea5e29566e2d02ace2ab2e7d7017d [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
2731 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2732 return( ret );
2733
2734#if defined(MBEDTLS_SSL_PROTO_DTLS)
2735 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2736 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2737 {
2738 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2739 return( ret );
2740 }
2741#endif /* MBEDTLS_SSL_PROTO_DTLS */
2742
2743 return( ret );
2744}
2745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002747{
Hanno Becker41934dd2021-08-07 19:13:43 +01002748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002749
Hanno Becker41934dd2021-08-07 19:13:43 +01002750 if( ssl == NULL ||
2751 ssl->conf == NULL ||
2752 ssl->handshake == NULL ||
2753 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2754 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002756 }
2757
2758 ret = ssl_prepare_handshake_step( ssl );
2759 if( ret != 0 )
2760 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002761
Jerry Yue7047812021-09-13 19:26:39 +08002762 ret = mbedtls_ssl_handle_pending_alert( ssl );
2763 if( ret != 0 )
2764 goto cleanup;
2765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002767 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002768 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002769#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002770 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yuf4436812021-08-26 22:59:56 +08002771 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002772#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002773
2774#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2775 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2776 ret = mbedtls_ssl_handshake_client_step( ssl );
2777#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2778 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002779#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002781 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002782 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002783#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002784 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002785 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002786#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002787
2788#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2789 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2790 ret = mbedtls_ssl_handshake_server_step( ssl );
2791#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2792 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002793#endif
2794
Jerry Yue7047812021-09-13 19:26:39 +08002795 if( ret != 0 )
2796 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002797 /* handshake_step return error. And it is same
2798 * with alert_reason.
2799 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002800 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002801 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002802 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002803 goto cleanup;
2804 }
2805 }
2806
2807cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002808 return( ret );
2809}
2810
2811/*
2812 * Perform the SSL handshake
2813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002815{
2816 int ret = 0;
2817
Hanno Beckera817ea42020-10-20 15:20:23 +01002818 /* Sanity checks */
2819
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002820 if( ssl == NULL || ssl->conf == NULL )
2821 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2822
Hanno Beckera817ea42020-10-20 15:20:23 +01002823#if defined(MBEDTLS_SSL_PROTO_DTLS)
2824 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2825 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2826 {
2827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2828 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2829 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2830 }
2831#endif /* MBEDTLS_SSL_PROTO_DTLS */
2832
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002834
Hanno Beckera817ea42020-10-20 15:20:23 +01002835 /* Main handshake loop */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 while( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker1961b702013-01-25 14:49:24 +01002837 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002839
2840 if( ret != 0 )
2841 break;
2842 }
2843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002845
2846 return( ret );
2847}
2848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#if defined(MBEDTLS_SSL_RENEGOTIATION)
2850#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002851/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002852 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002855{
Janos Follath865b3eb2019-12-16 11:46:15 +00002856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002859
2860 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2862 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002863
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002864 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002865 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002867 return( ret );
2868 }
2869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002871
2872 return( 0 );
2873}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002875
2876/*
2877 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 * - any side: calling mbedtls_ssl_renegotiate(),
2879 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2880 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002881 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002882 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002884 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002885int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002886{
Janos Follath865b3eb2019-12-16 11:46:15 +00002887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002888
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002890
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002891 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2892 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002893
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002894 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
2895 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002897 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002899 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002900 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002901 ssl->handshake->out_msg_seq = 1;
2902 else
2903 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002904 }
2905#endif
2906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
2908 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00002909
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00002911 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002913 return( ret );
2914 }
2915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002917
2918 return( 0 );
2919}
2920
2921/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002922 * Renegotiate current connection on client,
2923 * or request renegotiation on server
2924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002926{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002928
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002929 if( ssl == NULL || ssl->conf == NULL )
2930 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002933 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002934 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002935 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
2937 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02002940
2941 /* Did we already try/start sending HelloRequest? */
2942 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02002944
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002945 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002946 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002950 /*
2951 * On client, either start the renegotiation process or,
2952 * if already in progress, continue the handshake
2953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002955 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
2957 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002958
Hanno Becker40cdaa12020-02-05 10:48:27 +00002959 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002960 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00002961 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002962 return( ret );
2963 }
2964 }
2965 else
2966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002968 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002970 return( ret );
2971 }
2972 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002974
Paul Bakker37ce0ff2013-10-31 14:32:04 +01002975 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002976}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002978
Gilles Peskine9b562d52018-04-25 20:32:43 +02002979void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002980{
Gilles Peskine9b562d52018-04-25 20:32:43 +02002981 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
2982
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002983 if( handshake == NULL )
2984 return;
2985
Brett Warrene0edc842021-08-17 09:53:13 +01002986#if defined(MBEDTLS_ECP_C)
2987#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2988 if ( ssl->handshake->group_list_heap_allocated )
2989 mbedtls_free( (void*) handshake->group_list );
2990 handshake->group_list = NULL;
2991#endif /* MBEDTLS_DEPRECATED_REMOVED */
2992#endif /* MBEDTLS_ECP_C */
2993
Jerry Yuf017ee42022-01-12 15:49:48 +08002994#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2995#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2996 if ( ssl->handshake->sig_algs_heap_allocated )
2997 mbedtls_free( (void*) handshake->sig_algs );
2998 handshake->sig_algs = NULL;
2999#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003000#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3001 if( ssl->handshake->certificate_request_context )
3002 {
3003 mbedtls_free( (void*) handshake->certificate_request_context );
3004 }
3005#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003006#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3007
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003008#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3009 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3010 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003011 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003012 handshake->async_in_progress = 0;
3013 }
3014#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3015
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003016#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003017#if defined(MBEDTLS_USE_PSA_CRYPTO)
3018 psa_hash_abort( &handshake->fin_sha256_psa );
3019#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003020 mbedtls_sha256_free( &handshake->fin_sha256 );
3021#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003022#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003023#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003024#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003025 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003026#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003027 mbedtls_sha512_free( &handshake->fin_sha512 );
3028#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003029#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031#if defined(MBEDTLS_DHM_C)
3032 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003033#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034#if defined(MBEDTLS_ECDH_C)
3035 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003036#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003037#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003038 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003039#if defined(MBEDTLS_SSL_CLI_C)
3040 mbedtls_free( handshake->ecjpake_cache );
3041 handshake->ecjpake_cache = NULL;
3042 handshake->ecjpake_cache_len = 0;
3043#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003044#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003045
Janos Follath4ae5c292016-02-10 11:27:43 +00003046#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3047 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003048 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003050#endif
3051
Gilles Peskineeccd8882020-03-10 12:19:08 +01003052#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003053 if( handshake->psk != NULL )
3054 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003055 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003056 mbedtls_free( handshake->psk );
3057 }
3058#endif
3059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3061 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003062 /*
3063 * Free only the linked list wrapper, not the keys themselves
3064 * since the belong to the SNI callback
3065 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003066 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003068
Gilles Peskineeccd8882020-03-10 12:19:08 +01003069#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003070 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003071 if( handshake->ecrs_peer_cert != NULL )
3072 {
3073 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3074 mbedtls_free( handshake->ecrs_peer_cert );
3075 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003076#endif
3077
Hanno Becker75173122019-02-06 16:18:31 +00003078#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3079 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3080 mbedtls_pk_free( &handshake->peer_pubkey );
3081#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3082
XiaokangQian34909742022-01-27 02:25:04 +00003083#if defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 mbedtls_free( handshake->verify_cookie );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003085#endif /* MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 */
3086
3087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003088 mbedtls_ssl_flight_free( handshake->flight );
3089 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003090#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003091
Hanno Becker4a63ed42019-01-08 11:39:35 +00003092#if defined(MBEDTLS_ECDH_C) && \
3093 defined(MBEDTLS_USE_PSA_CRYPTO)
3094 psa_destroy_key( handshake->ecdh_psa_privkey );
3095#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3096
Ronald Cron6f135e12021-12-08 16:57:54 +01003097#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003098 mbedtls_ssl_transform_free( handshake->transform_handshake );
3099 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003100 mbedtls_free( handshake->transform_earlydata );
3101 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003102#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003103
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003104
3105#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3106 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3107 * processes datagrams and the fact that a datagram is allowed to have
3108 * several records in it, it is possible that the I/O buffers are not
3109 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003110 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3111 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003112#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003113
Jerry Yuba9c7272021-10-30 11:54:10 +08003114 /* mbedtls_platform_zeroize MUST be last one in this function */
3115 mbedtls_platform_zeroize( handshake,
3116 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003117}
3118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003120{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003121 if( session == NULL )
3122 return;
3123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003125 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003126#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003127
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003128#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003130#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003131
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003132 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003133}
3134
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003135#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003136
3137#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3138#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3139#else
3140#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3141#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3142
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003143#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003144
3145#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3146#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3147#else
3148#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3149#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3150
3151#if defined(MBEDTLS_SSL_ALPN)
3152#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3153#else
3154#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3155#endif /* MBEDTLS_SSL_ALPN */
3156
3157#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3158#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3159#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3160#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3161
3162#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3163 ( (uint32_t) ( \
3164 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3165 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3166 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3167 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3168 0u ) )
3169
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003170static unsigned char ssl_serialized_context_header[] = {
3171 MBEDTLS_VERSION_MAJOR,
3172 MBEDTLS_VERSION_MINOR,
3173 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003174 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3175 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3176 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3177 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3178 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003179};
3180
Paul Bakker5121ce52009-01-03 21:22:43 +00003181/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003182 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003183 *
3184 * The format of the serialized data is:
3185 * (in the presentation language of TLS, RFC 8446 section 3)
3186 *
3187 * // header
3188 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003189 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003190 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003191 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003192 * Note: When updating the format, remember to keep these
3193 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003194 *
3195 * // session sub-structure
3196 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3197 * // transform sub-structure
3198 * uint8 random[64]; // ServerHello.random+ClientHello.random
3199 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3200 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3201 * // fields from ssl_context
3202 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3203 * uint64 in_window_top; // DTLS: last validated record seq_num
3204 * uint64 in_window; // DTLS: bitmask for replay protection
3205 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3206 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3207 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3208 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3209 *
3210 * Note that many fields of the ssl_context or sub-structures are not
3211 * serialized, as they fall in one of the following categories:
3212 *
3213 * 1. forced value (eg in_left must be 0)
3214 * 2. pointer to dynamically-allocated memory (eg session, transform)
3215 * 3. value can be re-derived from other data (eg session keys from MS)
3216 * 4. value was temporary (eg content of input buffer)
3217 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003218 */
3219int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3220 unsigned char *buf,
3221 size_t buf_len,
3222 size_t *olen )
3223{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003224 unsigned char *p = buf;
3225 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003226 size_t session_len;
3227 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003228
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003229 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003230 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3231 * this function's documentation.
3232 *
3233 * These are due to assumptions/limitations in the implementation. Some of
3234 * them are likely to stay (no handshake in progress) some might go away
3235 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003236 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003237 /* The initial handshake must be over */
3238 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003239 {
3240 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003241 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003242 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003243 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003244 {
3245 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003246 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003247 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003248 /* Double-check that sub-structures are indeed ready */
3249 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003250 {
3251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003252 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003253 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003254 /* There must be no pending incoming or outgoing data */
3255 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003256 {
3257 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003258 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003259 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003260 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003261 {
3262 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003263 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003264 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003265 /* Protocol must be DLTS, not TLS */
3266 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003267 {
3268 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003269 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003270 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003271 /* Version must be 1.2 */
3272 if( ssl->major_ver != MBEDTLS_SSL_MAJOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003273 {
3274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003275 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003276 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003277 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003278 {
3279 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003280 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003281 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003282 /* We must be using an AEAD ciphersuite */
3283 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003284 {
3285 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003286 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003287 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003288 /* Renegotiation must not be enabled */
3289#if defined(MBEDTLS_SSL_RENEGOTIATION)
3290 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003291 {
3292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003293 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003294 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003295#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003296
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003297 /*
3298 * Version and format identifier
3299 */
3300 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003301
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003302 if( used <= buf_len )
3303 {
3304 memcpy( p, ssl_serialized_context_header,
3305 sizeof( ssl_serialized_context_header ) );
3306 p += sizeof( ssl_serialized_context_header );
3307 }
3308
3309 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003310 * Session (length + data)
3311 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003312 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003313 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3314 return( ret );
3315
3316 used += 4 + session_len;
3317 if( used <= buf_len )
3318 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003319 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3320 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003321
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003322 ret = ssl_session_save( ssl->session, 1,
3323 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003324 if( ret != 0 )
3325 return( ret );
3326
3327 p += session_len;
3328 }
3329
3330 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003331 * Transform
3332 */
3333 used += sizeof( ssl->transform->randbytes );
3334 if( used <= buf_len )
3335 {
3336 memcpy( p, ssl->transform->randbytes,
3337 sizeof( ssl->transform->randbytes ) );
3338 p += sizeof( ssl->transform->randbytes );
3339 }
3340
3341#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3342 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3343 if( used <= buf_len )
3344 {
3345 *p++ = ssl->transform->in_cid_len;
3346 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3347 p += ssl->transform->in_cid_len;
3348
3349 *p++ = ssl->transform->out_cid_len;
3350 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3351 p += ssl->transform->out_cid_len;
3352 }
3353#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3354
3355 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003356 * Saved fields from top-level ssl_context structure
3357 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003358 used += 4;
3359 if( used <= buf_len )
3360 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003361 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3362 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003363 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003364
3365#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3366 used += 16;
3367 if( used <= buf_len )
3368 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003369 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3370 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003371
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003372 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3373 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003374 }
3375#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3376
3377#if defined(MBEDTLS_SSL_PROTO_DTLS)
3378 used += 1;
3379 if( used <= buf_len )
3380 {
3381 *p++ = ssl->disable_datagram_packing;
3382 }
3383#endif /* MBEDTLS_SSL_PROTO_DTLS */
3384
Jerry Yuae0b2e22021-10-08 15:21:19 +08003385 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003386 if( used <= buf_len )
3387 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003388 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3389 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003390 }
3391
3392#if defined(MBEDTLS_SSL_PROTO_DTLS)
3393 used += 2;
3394 if( used <= buf_len )
3395 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003396 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3397 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003398 }
3399#endif /* MBEDTLS_SSL_PROTO_DTLS */
3400
3401#if defined(MBEDTLS_SSL_ALPN)
3402 {
3403 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003404 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003405 : 0;
3406
3407 used += 1 + alpn_len;
3408 if( used <= buf_len )
3409 {
3410 *p++ = alpn_len;
3411
3412 if( ssl->alpn_chosen != NULL )
3413 {
3414 memcpy( p, ssl->alpn_chosen, alpn_len );
3415 p += alpn_len;
3416 }
3417 }
3418 }
3419#endif /* MBEDTLS_SSL_ALPN */
3420
3421 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003422 * Done
3423 */
3424 *olen = used;
3425
3426 if( used > buf_len )
3427 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003428
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003429 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3430
Hanno Becker43aefe22020-02-05 10:44:56 +00003431 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003432}
3433
3434/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003435 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003436 *
3437 * This internal version is wrapped by a public function that cleans up in
3438 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003439 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003440static int ssl_context_load( mbedtls_ssl_context *ssl,
3441 const unsigned char *buf,
3442 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003443{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003444 const unsigned char *p = buf;
3445 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003446 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003447 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003448
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003449 /*
3450 * The context should have been freshly setup or reset.
3451 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003452 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003453 * renegotiating, or if the user mistakenly loaded a session first.)
3454 */
3455 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3456 ssl->session != NULL )
3457 {
3458 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3459 }
3460
3461 /*
3462 * We can't check that the config matches the initial one, but we can at
3463 * least check it matches the requirements for serializing.
3464 */
3465 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
3466 ssl->conf->max_major_ver < MBEDTLS_SSL_MAJOR_VERSION_3 ||
3467 ssl->conf->min_major_ver > MBEDTLS_SSL_MAJOR_VERSION_3 ||
3468 ssl->conf->max_minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 ||
3469 ssl->conf->min_minor_ver > MBEDTLS_SSL_MINOR_VERSION_3 ||
3470#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003471 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003472#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003473 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003474 {
3475 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3476 }
3477
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003478 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3479
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003480 /*
3481 * Check version identifier
3482 */
3483 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3484 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3485
3486 if( memcmp( p, ssl_serialized_context_header,
3487 sizeof( ssl_serialized_context_header ) ) != 0 )
3488 {
3489 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3490 }
3491 p += sizeof( ssl_serialized_context_header );
3492
3493 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003494 * Session
3495 */
3496 if( (size_t)( end - p ) < 4 )
3497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3498
3499 session_len = ( (size_t) p[0] << 24 ) |
3500 ( (size_t) p[1] << 16 ) |
3501 ( (size_t) p[2] << 8 ) |
3502 ( (size_t) p[3] );
3503 p += 4;
3504
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003505 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003506 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003507 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003508 ssl->session_in = ssl->session;
3509 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003510 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003511
3512 if( (size_t)( end - p ) < session_len )
3513 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3514
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003515 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003516 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003517 {
3518 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003519 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003520 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003521
3522 p += session_len;
3523
3524 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003525 * Transform
3526 */
3527
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003528 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003529 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003530 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003531 ssl->transform_in = ssl->transform;
3532 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003533 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003534
3535 /* Read random bytes and populate structure */
3536 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3537 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003538#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003539 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003540 ssl->session->ciphersuite,
3541 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003542#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3543 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003544 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003545#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3546 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003547 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3548 p, /* currently pointing to randbytes */
3549 MBEDTLS_SSL_MINOR_VERSION_3, /* (D)TLS 1.2 is forced */
3550 ssl->conf->endpoint,
3551 ssl );
3552 if( ret != 0 )
3553 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003554#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003555 p += sizeof( ssl->transform->randbytes );
3556
3557#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3558 /* Read connection IDs and store them */
3559 if( (size_t)( end - p ) < 1 )
3560 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3561
3562 ssl->transform->in_cid_len = *p++;
3563
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003564 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003565 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3566
3567 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3568 p += ssl->transform->in_cid_len;
3569
3570 ssl->transform->out_cid_len = *p++;
3571
3572 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3573 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3574
3575 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3576 p += ssl->transform->out_cid_len;
3577#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3578
3579 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003580 * Saved fields from top-level ssl_context structure
3581 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003582 if( (size_t)( end - p ) < 4 )
3583 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3584
3585 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3586 ( (uint32_t) p[1] << 16 ) |
3587 ( (uint32_t) p[2] << 8 ) |
3588 ( (uint32_t) p[3] );
3589 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003590
3591#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3592 if( (size_t)( end - p ) < 16 )
3593 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3594
3595 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3596 ( (uint64_t) p[1] << 48 ) |
3597 ( (uint64_t) p[2] << 40 ) |
3598 ( (uint64_t) p[3] << 32 ) |
3599 ( (uint64_t) p[4] << 24 ) |
3600 ( (uint64_t) p[5] << 16 ) |
3601 ( (uint64_t) p[6] << 8 ) |
3602 ( (uint64_t) p[7] );
3603 p += 8;
3604
3605 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3606 ( (uint64_t) p[1] << 48 ) |
3607 ( (uint64_t) p[2] << 40 ) |
3608 ( (uint64_t) p[3] << 32 ) |
3609 ( (uint64_t) p[4] << 24 ) |
3610 ( (uint64_t) p[5] << 16 ) |
3611 ( (uint64_t) p[6] << 8 ) |
3612 ( (uint64_t) p[7] );
3613 p += 8;
3614#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3615
3616#if defined(MBEDTLS_SSL_PROTO_DTLS)
3617 if( (size_t)( end - p ) < 1 )
3618 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3619
3620 ssl->disable_datagram_packing = *p++;
3621#endif /* MBEDTLS_SSL_PROTO_DTLS */
3622
Jerry Yud9a94fe2021-09-28 18:58:59 +08003623 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003624 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003625 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3626 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003627
3628#if defined(MBEDTLS_SSL_PROTO_DTLS)
3629 if( (size_t)( end - p ) < 2 )
3630 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3631
3632 ssl->mtu = ( p[0] << 8 ) | p[1];
3633 p += 2;
3634#endif /* MBEDTLS_SSL_PROTO_DTLS */
3635
3636#if defined(MBEDTLS_SSL_ALPN)
3637 {
3638 uint8_t alpn_len;
3639 const char **cur;
3640
3641 if( (size_t)( end - p ) < 1 )
3642 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3643
3644 alpn_len = *p++;
3645
3646 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3647 {
3648 /* alpn_chosen should point to an item in the configured list */
3649 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3650 {
3651 if( strlen( *cur ) == alpn_len &&
3652 memcmp( p, cur, alpn_len ) == 0 )
3653 {
3654 ssl->alpn_chosen = *cur;
3655 break;
3656 }
3657 }
3658 }
3659
3660 /* can only happen on conf mismatch */
3661 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3662 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3663
3664 p += alpn_len;
3665 }
3666#endif /* MBEDTLS_SSL_ALPN */
3667
3668 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003669 * Forced fields from top-level ssl_context structure
3670 *
3671 * Most of them already set to the correct value by mbedtls_ssl_init() and
3672 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3673 */
3674 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
3675
3676 ssl->major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
3677 ssl->minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
3678
Hanno Becker361b10d2019-08-30 10:42:49 +01003679 /* Adjust pointers for header fields of outgoing records to
3680 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003681 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003682
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003683#if defined(MBEDTLS_SSL_PROTO_DTLS)
3684 ssl->in_epoch = 1;
3685#endif
3686
3687 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3688 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003689 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3690 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003691 if( ssl->handshake != NULL )
3692 {
3693 mbedtls_ssl_handshake_free( ssl );
3694 mbedtls_free( ssl->handshake );
3695 ssl->handshake = NULL;
3696 }
3697
3698 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003699 * Done - should have consumed entire buffer
3700 */
3701 if( p != end )
3702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003703
3704 return( 0 );
3705}
3706
3707/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003708 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003709 */
3710int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3711 const unsigned char *buf,
3712 size_t len )
3713{
3714 int ret = ssl_context_load( context, buf, len );
3715
3716 if( ret != 0 )
3717 mbedtls_ssl_free( context );
3718
3719 return( ret );
3720}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003721#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003722
3723/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003724 * Free an SSL context
3725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003727{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003728 if( ssl == NULL )
3729 return;
3730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003731 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003732
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003733 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003734 {
sander-visserb8aa2072020-05-06 22:05:13 +02003735#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3736 size_t out_buf_len = ssl->out_buf_len;
3737#else
3738 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3739#endif
3740
Darryl Greenb33cc762019-11-28 14:29:44 +00003741 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003743 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003744 }
3745
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003746 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003747 {
sander-visserb8aa2072020-05-06 22:05:13 +02003748#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3749 size_t in_buf_len = ssl->in_buf_len;
3750#else
3751 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3752#endif
3753
Darryl Greenb33cc762019-11-28 14:29:44 +00003754 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003755 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003756 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003757 }
3758
Paul Bakker48916f92012-09-16 19:57:18 +00003759 if( ssl->transform )
3760 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003761 mbedtls_ssl_transform_free( ssl->transform );
3762 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003763 }
3764
3765 if( ssl->handshake )
3766 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003767 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003768 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3769 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003771 mbedtls_free( ssl->handshake );
3772 mbedtls_free( ssl->transform_negotiate );
3773 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003774 }
3775
Ronald Cron6f135e12021-12-08 16:57:54 +01003776#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003777 mbedtls_ssl_transform_free( ssl->transform_application );
3778 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003779#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003780
Paul Bakkerc0463502013-02-14 11:19:38 +01003781 if( ssl->session )
3782 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783 mbedtls_ssl_session_free( ssl->session );
3784 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003785 }
3786
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003787#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003788 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003789 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003790 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003791 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003792 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003793#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003794
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003795#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003796 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003797#endif
3798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003800
Paul Bakker86f04f42013-02-14 11:20:09 +01003801 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003802 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003803}
3804
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003805/*
3806 * Initialze mbedtls_ssl_config
3807 */
3808void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3809{
3810 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3811}
3812
Gilles Peskineeccd8882020-03-10 12:19:08 +01003813#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003814#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003815/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003816 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3817 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003818 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3819 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003820static int ssl_preset_default_hashes[] = {
3821#if defined(MBEDTLS_SHA512_C)
3822 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003823#endif
3824#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003825 MBEDTLS_MD_SHA384,
3826#endif
3827#if defined(MBEDTLS_SHA256_C)
3828 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003829#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003830 MBEDTLS_MD_NONE
3831};
Jerry Yuf017ee42022-01-12 15:49:48 +08003832#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3833#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003834
Gilles Peskineae270bf2021-06-02 00:05:29 +02003835/* The selection should be the same as mbedtls_x509_crt_profile_default in
3836 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003837 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003838 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003839 * about this list.
3840 */
Brett Warrene0edc842021-08-17 09:53:13 +01003841static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003842#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003843 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003844#endif
3845#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003846 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003847#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003848#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003849 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003850#endif
3851#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003852 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003853#endif
3854#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003855 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003856#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003857#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003858 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003859#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003860#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003861 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003862#endif
3863#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003864 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003865#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003866 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003867};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003868
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003869static int ssl_preset_suiteb_ciphersuites[] = {
3870 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3871 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3872 0
3873};
3874
Gilles Peskineeccd8882020-03-10 12:19:08 +01003875#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003876#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003877static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003878#if defined(MBEDTLS_SHA256_C)
3879 MBEDTLS_MD_SHA256,
3880#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003881#if defined(MBEDTLS_SHA384_C)
3882 MBEDTLS_MD_SHA384,
3883#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003884 MBEDTLS_MD_NONE
3885};
Jerry Yuf017ee42022-01-12 15:49:48 +08003886#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003887
Jerry Yu909df7b2022-01-22 11:56:27 +08003888/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003889 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08003890 * rules SHOULD be upheld.
3891 * - No duplicate entries.
3892 * - But if there is a good reason, do not change the order of the algorithms.
3893 * - ssl_tls12_present* is for TLS 1.2 use only.
3894 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08003895 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003896static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08003897
Jerry Yued5e9f42022-01-26 11:21:34 +08003898#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3899 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3900 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3901#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3902 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003903
Jerry Yu909df7b2022-01-22 11:56:27 +08003904#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3905 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3906 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3907#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3908 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
3909
Jerry Yued5e9f42022-01-26 11:21:34 +08003910#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
3911 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
3912 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
3913#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3914 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003915
Jerry Yu909df7b2022-01-22 11:56:27 +08003916#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3917 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3918#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
3919
Jerry Yu53037892022-01-25 11:02:06 +08003920#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
3921 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
3922#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
3923
Jerry Yu909df7b2022-01-22 11:56:27 +08003924 MBEDTLS_TLS1_3_SIG_NONE
3925};
3926
3927/* NOTICE: see above */
3928#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3929static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08003930#if defined(MBEDTLS_SHA512_C)
3931 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
3932#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08003933#if defined(MBEDTLS_SHA384_C)
3934 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
3935#endif
3936#if defined(MBEDTLS_SHA256_C)
3937 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
3938#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08003939 MBEDTLS_TLS1_3_SIG_NONE
3940};
3941#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3942/* NOTICE: see above */
3943static uint16_t ssl_preset_suiteb_sig_algs[] = {
3944
Jerry Yu909df7b2022-01-22 11:56:27 +08003945#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3946 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3947 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3948#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3949 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
3950
Jerry Yu53037892022-01-25 11:02:06 +08003951#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3952 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3953 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3954#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3955 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003956
3957#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3958 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3959#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08003960
Jerry Yu53037892022-01-25 11:02:06 +08003961#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
3962 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
3963#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
3964
Jerry Yu713013f2022-01-17 18:16:35 +08003965 MBEDTLS_TLS1_3_SIG_NONE
3966};
Jerry Yu6106fdc2022-01-12 16:36:14 +08003967
Jerry Yu909df7b2022-01-22 11:56:27 +08003968/* NOTICE: see above */
3969#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3970static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08003971#if defined(MBEDTLS_SHA256_C)
3972 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
3973#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08003974#if defined(MBEDTLS_SHA384_C)
3975 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
3976#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00003977 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003978};
Jerry Yu909df7b2022-01-22 11:56:27 +08003979#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3980
Jerry Yu1a8b4812022-01-20 17:56:50 +08003981#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003982
Brett Warrene0edc842021-08-17 09:53:13 +01003983static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01003984#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003985 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01003986#endif
3987#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003988 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01003989#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003990 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003991};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003992
Jerry Yu1a8b4812022-01-20 17:56:50 +08003993#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08003994/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08003995 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08003996static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08003997{
3998 size_t i, j;
3999 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004000
Jerry Yuf377d642022-01-25 10:43:59 +08004001 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004002 {
Jerry Yuf377d642022-01-25 10:43:59 +08004003 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004004 {
Jerry Yuf377d642022-01-25 10:43:59 +08004005 if( sig_algs[i] != sig_algs[j] )
4006 continue;
4007 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4008 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4009 sig_algs[i], j, i );
4010 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004011 }
4012 }
4013 return( ret );
4014}
4015
4016#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4017
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004018/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004019 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004020 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004021int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004022 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004023{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004024#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004025 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004026#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004027
Jerry Yu1a8b4812022-01-20 17:56:50 +08004028#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004029 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004030 {
4031 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4032 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4033 }
4034
Jerry Yuf377d642022-01-25 10:43:59 +08004035 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004036 {
4037 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4038 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4039 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004040
4041#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004042 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004043 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004044 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004045 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4046 }
4047
Jerry Yuf377d642022-01-25 10:43:59 +08004048 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004049 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004050 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004051 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4052 }
4053#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004054#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4055
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004056 /* Use the functions here so that they are covered in tests,
4057 * but otherwise access member directly for efficiency */
4058 mbedtls_ssl_conf_endpoint( conf, endpoint );
4059 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004060
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004061 /*
4062 * Things that are common to all presets
4063 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004064#if defined(MBEDTLS_SSL_CLI_C)
4065 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4066 {
4067 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4068#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4069 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4070#endif
4071 }
4072#endif
4073
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004074#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4075 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4076#endif
4077
4078#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4079 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4080#endif
4081
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004082#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004083 conf->f_cookie_write = ssl_cookie_write_dummy;
4084 conf->f_cookie_check = ssl_cookie_check_dummy;
4085#endif
4086
4087#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4088 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4089#endif
4090
Janos Follath088ce432017-04-10 12:42:31 +01004091#if defined(MBEDTLS_SSL_SRV_C)
4092 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004093 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004094#endif
4095
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004096#if defined(MBEDTLS_SSL_PROTO_DTLS)
4097 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4098 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4099#endif
4100
4101#if defined(MBEDTLS_SSL_RENEGOTIATION)
4102 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004103 memset( conf->renego_period, 0x00, 2 );
4104 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004105#endif
4106
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004107#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004108 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4109 {
4110 const unsigned char dhm_p[] =
4111 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4112 const unsigned char dhm_g[] =
4113 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004114
Hanno Beckere2defad2021-07-24 05:59:17 +01004115 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4116 dhm_p, sizeof( dhm_p ),
4117 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4118 {
4119 return( ret );
4120 }
4121 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004122#endif
4123
Ronald Cron6f135e12021-12-08 16:57:54 +01004124#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004125 /*
4126 * Allow all TLS 1.3 key exchange modes by default.
4127 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004128 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004129#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004130
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004131 /*
4132 * Preset-specific defaults
4133 */
4134 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004135 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004136 /*
4137 * NSA Suite B
4138 */
4139 case MBEDTLS_SSL_PRESET_SUITEB:
4140 conf->min_major_ver = MBEDTLS_SSL_MAJOR_VERSION_3;
4141 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3; /* TLS 1.2 */
4142 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004143#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4144 /* Hybrid TLS 1.2/1.3 is not supported yet */
4145 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
4146#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004147 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004148#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004149
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004150 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004151
4152#if defined(MBEDTLS_X509_CRT_PARSE_C)
4153 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004154#endif
4155
Gilles Peskineeccd8882020-03-10 12:19:08 +01004156#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004157#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004158 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004159#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004160#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4161 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4162 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4163 else
4164#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4165 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004166#endif
4167
Brett Warrene0edc842021-08-17 09:53:13 +01004168#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4169 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004170#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004171 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004172 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004173
4174 /*
4175 * Default
4176 */
4177 default:
Ron Eldor5e9f14d2017-05-28 10:46:38 +03004178 conf->min_major_ver = ( MBEDTLS_SSL_MIN_MAJOR_VERSION >
4179 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION ) ?
4180 MBEDTLS_SSL_MIN_MAJOR_VERSION :
4181 MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION;
4182 conf->min_minor_ver = ( MBEDTLS_SSL_MIN_MINOR_VERSION >
4183 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION ) ?
4184 MBEDTLS_SSL_MIN_MINOR_VERSION :
4185 MBEDTLS_SSL_MIN_VALID_MINOR_VERSION;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004186 conf->max_major_ver = MBEDTLS_SSL_MAX_MAJOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004187#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4188 /* Hybrid TLS 1.2/1.3 is not supported yet */
4189 conf->max_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
4190#else
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004191 conf->max_minor_ver = MBEDTLS_SSL_MAX_MINOR_VERSION;
Jerry Yu7d239632022-01-27 14:16:44 +08004192#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004193
4194#if defined(MBEDTLS_SSL_PROTO_DTLS)
4195 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
TRodziewiczef73f012021-05-13 14:53:36 +02004196 conf->min_minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004197#endif
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004198 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004199
4200#if defined(MBEDTLS_X509_CRT_PARSE_C)
4201 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4202#endif
4203
Gilles Peskineeccd8882020-03-10 12:19:08 +01004204#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004205#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004206 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004207#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004208#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4209 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4210 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4211 else
4212#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4213 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004214#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004215
Brett Warrene0edc842021-08-17 09:53:13 +01004216#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4217 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004218#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004219 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004220
4221#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4222 conf->dhm_min_bitlen = 1024;
4223#endif
4224 }
4225
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004226 return( 0 );
4227}
4228
4229/*
4230 * Free mbedtls_ssl_config
4231 */
4232void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4233{
4234#if defined(MBEDTLS_DHM_C)
4235 mbedtls_mpi_free( &conf->dhm_P );
4236 mbedtls_mpi_free( &conf->dhm_G );
4237#endif
4238
Gilles Peskineeccd8882020-03-10 12:19:08 +01004239#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004240 if( conf->psk != NULL )
4241 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004242 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004243 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004244 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004245 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004246 }
4247
4248 if( conf->psk_identity != NULL )
4249 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004250 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004251 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004252 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004253 conf->psk_identity_len = 0;
4254 }
4255#endif
4256
4257#if defined(MBEDTLS_X509_CRT_PARSE_C)
4258 ssl_key_cert_free( conf->key_cert );
4259#endif
4260
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004261 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004262}
4263
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004264#if defined(MBEDTLS_PK_C) && \
4265 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004266/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004267 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004269unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004270{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004271#if defined(MBEDTLS_RSA_C)
4272 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4273 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004274#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004275#if defined(MBEDTLS_ECDSA_C)
4276 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4277 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004278#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004279 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004280}
4281
Hanno Becker7e5437a2017-04-28 17:15:26 +01004282unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4283{
4284 switch( type ) {
4285 case MBEDTLS_PK_RSA:
4286 return( MBEDTLS_SSL_SIG_RSA );
4287 case MBEDTLS_PK_ECDSA:
4288 case MBEDTLS_PK_ECKEY:
4289 return( MBEDTLS_SSL_SIG_ECDSA );
4290 default:
4291 return( MBEDTLS_SSL_SIG_ANON );
4292 }
4293}
4294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004295mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004296{
4297 switch( sig )
4298 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004299#if defined(MBEDTLS_RSA_C)
4300 case MBEDTLS_SSL_SIG_RSA:
4301 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004302#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004303#if defined(MBEDTLS_ECDSA_C)
4304 case MBEDTLS_SSL_SIG_ECDSA:
4305 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004306#endif
4307 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004308 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004309 }
4310}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004311#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004312
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004313/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004314 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004316mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004317{
4318 switch( hash )
4319 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004320#if defined(MBEDTLS_MD5_C)
4321 case MBEDTLS_SSL_HASH_MD5:
4322 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004323#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004324#if defined(MBEDTLS_SHA1_C)
4325 case MBEDTLS_SSL_HASH_SHA1:
4326 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004327#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004328#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004329 case MBEDTLS_SSL_HASH_SHA224:
4330 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004331#endif
4332#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004333 case MBEDTLS_SSL_HASH_SHA256:
4334 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004335#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004336#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004337 case MBEDTLS_SSL_HASH_SHA384:
4338 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004339#endif
4340#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004341 case MBEDTLS_SSL_HASH_SHA512:
4342 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004343#endif
4344 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004345 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004346 }
4347}
4348
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004349/*
4350 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4351 */
4352unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4353{
4354 switch( md )
4355 {
4356#if defined(MBEDTLS_MD5_C)
4357 case MBEDTLS_MD_MD5:
4358 return( MBEDTLS_SSL_HASH_MD5 );
4359#endif
4360#if defined(MBEDTLS_SHA1_C)
4361 case MBEDTLS_MD_SHA1:
4362 return( MBEDTLS_SSL_HASH_SHA1 );
4363#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004364#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004365 case MBEDTLS_MD_SHA224:
4366 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004367#endif
4368#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004369 case MBEDTLS_MD_SHA256:
4370 return( MBEDTLS_SSL_HASH_SHA256 );
4371#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004372#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004373 case MBEDTLS_MD_SHA384:
4374 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004375#endif
4376#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004377 case MBEDTLS_MD_SHA512:
4378 return( MBEDTLS_SSL_HASH_SHA512 );
4379#endif
4380 default:
4381 return( MBEDTLS_SSL_HASH_NONE );
4382 }
4383}
4384
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004385/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004386 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004387 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004388 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004389int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004390{
Brett Warrene0edc842021-08-17 09:53:13 +01004391 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004392
Brett Warrene0edc842021-08-17 09:53:13 +01004393 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004394 return( -1 );
4395
Brett Warrene0edc842021-08-17 09:53:13 +01004396 for( ; *group_list != 0; group_list++ )
4397 {
4398 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004399 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004400 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004401
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004402 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004403}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004404
4405#if defined(MBEDTLS_ECP_C)
4406/*
4407 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4408 */
4409int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4410{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004411 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004412 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4413}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004414#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004415
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004416#if defined(MBEDTLS_X509_CRT_PARSE_C)
4417int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4418 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004419 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004420 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004421{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004422 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004423 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004424 const char *ext_oid;
4425 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004426
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004427 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004428 {
4429 /* Server part of the key exchange */
4430 switch( ciphersuite->key_exchange )
4431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004432 case MBEDTLS_KEY_EXCHANGE_RSA:
4433 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004434 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004435 break;
4436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004437 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4438 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4439 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4440 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004441 break;
4442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004443 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4444 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004445 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004446 break;
4447
4448 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004449 case MBEDTLS_KEY_EXCHANGE_NONE:
4450 case MBEDTLS_KEY_EXCHANGE_PSK:
4451 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4452 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004453 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004454 usage = 0;
4455 }
4456 }
4457 else
4458 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004459 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4460 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004461 }
4462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004463 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004464 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004465 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004466 ret = -1;
4467 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004469 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004470 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004471 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4472 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004473 }
4474 else
4475 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004476 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4477 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004478 }
4479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004480 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004481 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004482 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004483 ret = -1;
4484 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004485
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004486 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004487}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004488#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004489
Simon Butcher99000142016-10-13 17:21:01 +01004490int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
4491{
4492#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4493 if( ssl->minor_ver != MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Becker541af852021-05-14 16:49:01 +01004494 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01004495
4496 switch( md )
4497 {
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02004498#if defined(MBEDTLS_SHA384_C)
Simon Butcher99000142016-10-13 17:21:01 +01004499 case MBEDTLS_SSL_HASH_SHA384:
4500 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
4501 break;
4502#endif
4503#if defined(MBEDTLS_SHA256_C)
4504 case MBEDTLS_SSL_HASH_SHA256:
4505 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
4506 break;
4507#endif
4508 default:
Hanno Becker541af852021-05-14 16:49:01 +01004509 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01004510 }
4511
4512 return 0;
4513#else /* !MBEDTLS_SSL_PROTO_TLS1_2 */
4514 (void) ssl;
4515 (void) md;
4516
Hanno Becker541af852021-05-14 16:49:01 +01004517 return( -1 );
Simon Butcher99000142016-10-13 17:21:01 +01004518#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4519}
4520
Jerry Yu148165c2021-09-24 23:20:59 +08004521#if defined(MBEDTLS_USE_PSA_CRYPTO)
4522int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4523 const mbedtls_md_type_t md,
4524 unsigned char *dst,
4525 size_t dst_len,
4526 size_t *olen )
4527{
Ronald Cronf6893e12022-01-07 22:09:01 +01004528 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4529 psa_hash_operation_t *hash_operation_to_clone;
4530 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4531
Jerry Yu148165c2021-09-24 23:20:59 +08004532 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004533
4534 switch( md )
4535 {
4536#if defined(MBEDTLS_SHA384_C)
4537 case MBEDTLS_MD_SHA384:
4538 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4539 break;
4540#endif
4541
4542#if defined(MBEDTLS_SHA256_C)
4543 case MBEDTLS_MD_SHA256:
4544 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4545 break;
4546#endif
4547
4548 default:
4549 goto exit;
4550 }
4551
4552 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4553 if( status != PSA_SUCCESS )
4554 goto exit;
4555
4556 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4557 if( status != PSA_SUCCESS )
4558 goto exit;
4559
4560exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004561 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004562}
4563#else /* MBEDTLS_USE_PSA_CRYPTO */
4564
Jerry Yu24c0ec32021-09-09 14:21:07 +08004565#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004566static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4567 unsigned char *dst,
4568 size_t dst_len,
4569 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004570{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004571 int ret;
4572 mbedtls_sha512_context sha512;
4573
4574 if( dst_len < 48 )
4575 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4576
4577 mbedtls_sha512_init( &sha512 );
4578 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4579
4580 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4581 {
4582 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4583 goto exit;
4584 }
4585
4586 *olen = 48;
4587
4588exit:
4589
4590 mbedtls_sha512_free( &sha512 );
4591 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004592}
4593#endif /* MBEDTLS_SHA384_C */
4594
4595#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004596static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4597 unsigned char *dst,
4598 size_t dst_len,
4599 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004600{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004601 int ret;
4602 mbedtls_sha256_context sha256;
4603
4604 if( dst_len < 32 )
4605 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4606
4607 mbedtls_sha256_init( &sha256 );
4608 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004609
Jerry Yu24c0ec32021-09-09 14:21:07 +08004610 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4611 {
4612 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4613 goto exit;
4614 }
4615
4616 *olen = 32;
4617
4618exit:
4619
4620 mbedtls_sha256_free( &sha256 );
4621 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004622}
4623#endif /* MBEDTLS_SHA256_C */
4624
Jerry Yu000f9762021-09-14 11:12:51 +08004625int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4626 const mbedtls_md_type_t md,
4627 unsigned char *dst,
4628 size_t dst_len,
4629 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004630{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004631 switch( md )
4632 {
4633
Jerry Yu24c0ec32021-09-09 14:21:07 +08004634#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004635 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004636 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004637#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004638
Jerry Yu24c0ec32021-09-09 14:21:07 +08004639#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004640 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004641 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004642#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004643
4644 default:
4645 break;
4646 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004647 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004648}
XiaokangQian647719a2021-12-07 09:16:29 +00004649
Jerry Yu148165c2021-09-24 23:20:59 +08004650#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004651
Jerry Yu1ea9d102021-12-21 13:41:49 +08004652#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) || \
4653 defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4654 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jerry Yuba073422021-12-20 22:22:15 +08004655/*
Jerry Yub925f212022-01-12 11:17:02 +08004656 * Function for writing a supported groups (TLS 1.3) or supported elliptic
4657 * curves (TLS 1.2) extension.
Jerry Yuba073422021-12-20 22:22:15 +08004658 *
Jerry Yub925f212022-01-12 11:17:02 +08004659 * The "extension_data" field of a supported groups extension contains a
4660 * "NamedGroupList" value (TLS 1.3 RFC8446):
Jerry Yuba073422021-12-20 22:22:15 +08004661 * enum {
4662 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
4663 * x25519(0x001D), x448(0x001E),
4664 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
4665 * ffdhe6144(0x0103), ffdhe8192(0x0104),
4666 * ffdhe_private_use(0x01FC..0x01FF),
4667 * ecdhe_private_use(0xFE00..0xFEFF),
4668 * (0xFFFF)
4669 * } NamedGroup;
4670 * struct {
4671 * NamedGroup named_group_list<2..2^16-1>;
4672 * } NamedGroupList;
Jerry Yub925f212022-01-12 11:17:02 +08004673 *
4674 * The "extension_data" field of a supported elliptic curves extension contains
4675 * a "NamedCurveList" value (TLS 1.2 RFC 8422):
Jerry Yu63282b42022-01-11 15:43:53 +08004676 * enum {
4677 * deprecated(1..22),
4678 * secp256r1 (23), secp384r1 (24), secp521r1 (25),
4679 * x25519(29), x448(30),
4680 * reserved (0xFE00..0xFEFF),
4681 * deprecated(0xFF01..0xFF02),
4682 * (0xFFFF)
4683 * } NamedCurve;
4684 * struct {
4685 * NamedCurve named_curve_list<2..2^16-1>
4686 * } NamedCurveList;
4687 *
Jerry Yub925f212022-01-12 11:17:02 +08004688 * The TLS 1.3 supported groups extension was defined to be a compatible
4689 * generalization of the TLS 1.2 supported elliptic curves extension. They both
4690 * share the same extension identifier.
Jerry Yu63282b42022-01-11 15:43:53 +08004691 *
Jerry Yub925f212022-01-12 11:17:02 +08004692 * DHE groups are not supported yet.
Jerry Yuba073422021-12-20 22:22:15 +08004693 */
Jerry Yuba073422021-12-20 22:22:15 +08004694int mbedtls_ssl_write_supported_groups_ext( mbedtls_ssl_context *ssl,
4695 unsigned char *buf,
Jerry Yu17532612021-12-20 22:32:09 +08004696 const unsigned char *end,
Jerry Yuba073422021-12-20 22:22:15 +08004697 size_t *out_len )
4698{
4699 unsigned char *p = buf ;
4700 unsigned char *named_group_list; /* Start of named_group_list */
4701 size_t named_group_list_len; /* Length of named_group_list */
4702 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
4703
4704 *out_len = 0;
Jerry Yuf46b0162022-01-11 16:28:00 +08004705
Jerry Yuba073422021-12-20 22:22:15 +08004706 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported_groups extension" ) );
4707
4708 /* Check if we have space for header and length fields:
4709 * - extension_type (2 bytes)
4710 * - extension_data_length (2 bytes)
4711 * - named_group_list_length (2 bytes)
4712 */
4713 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
4714 p += 6;
4715
4716 named_group_list = p;
4717
4718 if( group_list == NULL )
4719 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
4720
Jerry Yu1510cea2022-01-12 10:56:49 +08004721 for( ; *group_list != 0; group_list++ )
Jerry Yuba073422021-12-20 22:22:15 +08004722 {
Jerry Yu1510cea2022-01-12 10:56:49 +08004723 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got supported group(%04x)", *group_list ) );
Jerry Yu63282b42022-01-11 15:43:53 +08004724
Jerry Yu1ea9d102021-12-21 13:41:49 +08004725#if defined(MBEDTLS_ECP_C)
Jerry Yu1510cea2022-01-12 10:56:49 +08004726 if( ( mbedtls_ssl_conf_is_tls13_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004727 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) ) ||
Jerry Yu1510cea2022-01-12 10:56:49 +08004728 ( mbedtls_ssl_conf_is_tls12_enabled( ssl->conf ) &&
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004729 mbedtls_ssl_tls12_named_group_is_ecdhe( *group_list ) ) )
Jerry Yuba073422021-12-20 22:22:15 +08004730 {
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004731 const mbedtls_ecp_curve_info *curve_info;
4732 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
Jerry Yub925f212022-01-12 11:17:02 +08004733 if( curve_info == NULL )
Jerry Yu3ad14ac2022-01-11 17:13:16 +08004734 continue;
Jerry Yub925f212022-01-12 11:17:02 +08004735 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
4736 MBEDTLS_PUT_UINT16_BE( *group_list, p, 0 );
4737 p += 2;
4738 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NamedGroup: %s ( %x )",
4739 curve_info->name, *group_list ) );
Jerry Yuba073422021-12-20 22:22:15 +08004740 }
Jerry Yu63282b42022-01-11 15:43:53 +08004741#endif /* MBEDTLS_ECP_C */
4742 /* Add DHE groups here */
Jerry Yuba073422021-12-20 22:22:15 +08004743
4744 }
4745
Jerry Yu1510cea2022-01-12 10:56:49 +08004746 /* Length of named_group_list */
Jerry Yuba073422021-12-20 22:22:15 +08004747 named_group_list_len = p - named_group_list;
4748 if( named_group_list_len == 0 )
4749 {
4750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No group available." ) );
4751 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4752 }
4753
4754 /* Write extension_type */
4755 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_GROUPS, buf, 0 );
4756 /* Write extension_data_length */
4757 MBEDTLS_PUT_UINT16_BE( named_group_list_len + 2, buf, 2 );
4758 /* Write length of named_group_list */
4759 MBEDTLS_PUT_UINT16_BE( named_group_list_len, buf, 4 );
4760
Jerry Yu7f029d82022-01-11 11:08:53 +08004761 MBEDTLS_SSL_DEBUG_BUF( 3, "Supported groups extension",
4762 buf + 4, named_group_list_len + 2 );
Jerry Yuba073422021-12-20 22:22:15 +08004763
4764 *out_len = p - buf;
4765
4766#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4767 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
4768#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4769
4770 return( 0 );
4771}
4772
Jerry Yu1ea9d102021-12-21 13:41:49 +08004773#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED ||
4774 MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C ||
4775 MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jerry Yuba073422021-12-20 22:22:15 +08004776
Jerry Yuf017ee42022-01-12 15:49:48 +08004777#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4778/*
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004779 * Function for writing a signature algorithm extension.
Jerry Yuf017ee42022-01-12 15:49:48 +08004780 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08004781 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004782 * value (TLS 1.3 RFC8446):
4783 * enum {
4784 * ....
4785 * ecdsa_secp256r1_sha256( 0x0403 ),
4786 * ecdsa_secp384r1_sha384( 0x0503 ),
4787 * ecdsa_secp521r1_sha512( 0x0603 ),
4788 * ....
4789 * } SignatureScheme;
Jerry Yuf017ee42022-01-12 15:49:48 +08004790 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004791 * struct {
4792 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4793 * } SignatureSchemeList;
Jerry Yuf017ee42022-01-12 15:49:48 +08004794 *
Jerry Yu8afd6e42022-01-20 15:54:26 +08004795 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4796 * value (TLS 1.2 RFC5246):
Jerry Yu7ddc38c2022-01-19 11:08:05 +08004797 * enum {
4798 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4799 * sha512(6), (255)
4800 * } HashAlgorithm;
4801 *
4802 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4803 * SignatureAlgorithm;
4804 *
4805 * struct {
4806 * HashAlgorithm hash;
4807 * SignatureAlgorithm signature;
4808 * } SignatureAndHashAlgorithm;
4809 *
4810 * SignatureAndHashAlgorithm
4811 * supported_signature_algorithms<2..2^16-2>;
4812 *
4813 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4814 * generalization of the TLS 1.2 signature algorithm extension.
4815 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4816 * `SignatureScheme` field of TLS 1.3
4817 *
Jerry Yuf017ee42022-01-12 15:49:48 +08004818 */
4819int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
4820 const unsigned char *end, size_t *out_len )
4821{
4822 unsigned char *p = buf;
4823 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
4824 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
4825
4826 *out_len = 0;
4827
4828 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
4829
4830 /* Check if we have space for header and length field:
4831 * - extension_type (2 bytes)
4832 * - extension_data_length (2 bytes)
4833 * - supported_signature_algorithms_length (2 bytes)
4834 */
4835 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
4836 p += 6;
4837
4838 /*
4839 * Write supported_signature_algorithms
4840 */
4841 supported_sig_alg = p;
Jerry Yu6106fdc2022-01-12 16:36:14 +08004842 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
4843 if( sig_alg == NULL )
4844 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
4845
4846 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
Jerry Yuf017ee42022-01-12 15:49:48 +08004847 {
Jerry Yu1bab3012022-01-19 17:43:22 +08004848 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
4849 continue;
Jerry Yuf017ee42022-01-12 15:49:48 +08004850 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
4851 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
4852 p += 2;
4853 MBEDTLS_SSL_DEBUG_MSG( 3, ( "signature scheme [%x]", *sig_alg ) );
4854 }
4855
4856 /* Length of supported_signature_algorithms */
4857 supported_sig_alg_len = p - supported_sig_alg;
4858 if( supported_sig_alg_len == 0 )
4859 {
4860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
4861 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4862 }
4863
4864 /* Write extension_type */
4865 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
4866 /* Write extension_data_length */
4867 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
4868 /* Write length of supported_signature_algorithms */
4869 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
4870
4871 /* Output the total length of signature algorithms extension. */
4872 *out_len = p - buf;
4873
4874#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4875 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
4876#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4877 return( 0 );
4878}
4879#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yuc73c6182022-02-08 20:29:25 +08004880
Jerry Yuc5aef882021-12-23 20:15:02 +08004881#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4882int mbedtls_ssl_write_hostname_ext( mbedtls_ssl_context *ssl,
4883 unsigned char *buf,
4884 const unsigned char *end,
4885 size_t *olen )
4886{
4887 unsigned char *p = buf;
4888 size_t hostname_len;
4889
4890 *olen = 0;
4891
4892 if( ssl->hostname == NULL )
4893 return( 0 );
4894
4895 MBEDTLS_SSL_DEBUG_MSG( 3,
4896 ( "client hello, adding server name extension: %s",
4897 ssl->hostname ) );
4898
4899 hostname_len = strlen( ssl->hostname );
4900
4901 MBEDTLS_SSL_CHK_BUF_PTR( p, end, hostname_len + 9 );
4902
4903 /*
4904 * Sect. 3, RFC 6066 (TLS Extensions Definitions)
4905 *
4906 * In order to provide any of the server names, clients MAY include an
4907 * extension of type "server_name" in the (extended) client hello. The
4908 * "extension_data" field of this extension SHALL contain
4909 * "ServerNameList" where:
4910 *
4911 * struct {
4912 * NameType name_type;
4913 * select (name_type) {
4914 * case host_name: HostName;
4915 * } name;
4916 * } ServerName;
4917 *
4918 * enum {
4919 * host_name(0), (255)
4920 * } NameType;
4921 *
4922 * opaque HostName<1..2^16-1>;
4923 *
4924 * struct {
4925 * ServerName server_name_list<1..2^16-1>
4926 * } ServerNameList;
4927 *
4928 */
4929 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SERVERNAME, p, 0 );
4930 p += 2;
4931
4932 MBEDTLS_PUT_UINT16_BE( hostname_len + 5, p, 0 );
4933 p += 2;
4934
4935 MBEDTLS_PUT_UINT16_BE( hostname_len + 3, p, 0 );
4936 p += 2;
4937
4938 *p++ = MBEDTLS_BYTE_0( MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME );
4939
4940 MBEDTLS_PUT_UINT16_BE( hostname_len, p, 0 );
4941 p += 2;
4942
4943 memcpy( p, ssl->hostname, hostname_len );
4944
4945 *olen = hostname_len + 9;
4946
4947 return( 0 );
4948}
4949#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Jerry Yuf017ee42022-01-12 15:49:48 +08004950
Jerry Yudc7bd172022-02-17 13:44:15 +08004951#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4952
4953#if defined(MBEDTLS_USE_PSA_CRYPTO)
4954
4955static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4956 mbedtls_svc_key_id_t key,
4957 psa_algorithm_t alg,
4958 const unsigned char* seed, size_t seed_length,
4959 const unsigned char* label, size_t label_length,
4960 size_t capacity )
4961{
4962 psa_status_t status;
4963
4964 status = psa_key_derivation_setup( derivation, alg );
4965 if( status != PSA_SUCCESS )
4966 return( status );
4967
4968 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4969 {
4970 status = psa_key_derivation_input_bytes( derivation,
4971 PSA_KEY_DERIVATION_INPUT_SEED,
4972 seed, seed_length );
4973 if( status != PSA_SUCCESS )
4974 return( status );
4975
4976 if( mbedtls_svc_key_id_is_null( key ) )
4977 {
4978 status = psa_key_derivation_input_bytes(
4979 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4980 NULL, 0 );
4981 }
4982 else
4983 {
4984 status = psa_key_derivation_input_key(
4985 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4986 }
4987 if( status != PSA_SUCCESS )
4988 return( status );
4989
4990 status = psa_key_derivation_input_bytes( derivation,
4991 PSA_KEY_DERIVATION_INPUT_LABEL,
4992 label, label_length );
4993 if( status != PSA_SUCCESS )
4994 return( status );
4995 }
4996 else
4997 {
4998 return( PSA_ERROR_NOT_SUPPORTED );
4999 }
5000
5001 status = psa_key_derivation_set_capacity( derivation, capacity );
5002 if( status != PSA_SUCCESS )
5003 return( status );
5004
5005 return( PSA_SUCCESS );
5006}
5007
5008static int tls_prf_generic( mbedtls_md_type_t md_type,
5009 const unsigned char *secret, size_t slen,
5010 const char *label,
5011 const unsigned char *random, size_t rlen,
5012 unsigned char *dstbuf, size_t dlen )
5013{
5014 psa_status_t status;
5015 psa_algorithm_t alg;
5016 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5017 psa_key_derivation_operation_t derivation =
5018 PSA_KEY_DERIVATION_OPERATION_INIT;
5019
5020 if( md_type == MBEDTLS_MD_SHA384 )
5021 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5022 else
5023 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5024
5025 /* Normally a "secret" should be long enough to be impossible to
5026 * find by brute force, and in particular should not be empty. But
5027 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5028 * and for this use case it makes sense to have a 0-length "secret".
5029 * Since the key API doesn't allow importing a key of length 0,
5030 * keep master_key=0, which setup_psa_key_derivation() understands
5031 * to mean a 0-length "secret" input. */
5032 if( slen != 0 )
5033 {
5034 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5035 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5036 psa_set_key_algorithm( &key_attributes, alg );
5037 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5038
5039 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5040 if( status != PSA_SUCCESS )
5041 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5042 }
5043
5044 status = setup_psa_key_derivation( &derivation,
5045 master_key, alg,
5046 random, rlen,
5047 (unsigned char const *) label,
5048 (size_t) strlen( label ),
5049 dlen );
5050 if( status != PSA_SUCCESS )
5051 {
5052 psa_key_derivation_abort( &derivation );
5053 psa_destroy_key( master_key );
5054 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5055 }
5056
5057 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5058 if( status != PSA_SUCCESS )
5059 {
5060 psa_key_derivation_abort( &derivation );
5061 psa_destroy_key( master_key );
5062 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5063 }
5064
5065 status = psa_key_derivation_abort( &derivation );
5066 if( status != PSA_SUCCESS )
5067 {
5068 psa_destroy_key( master_key );
5069 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5070 }
5071
5072 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5073 status = psa_destroy_key( master_key );
5074 if( status != PSA_SUCCESS )
5075 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5076
5077 return( 0 );
5078}
5079
5080#else /* MBEDTLS_USE_PSA_CRYPTO */
5081
5082static int tls_prf_generic( mbedtls_md_type_t md_type,
5083 const unsigned char *secret, size_t slen,
5084 const char *label,
5085 const unsigned char *random, size_t rlen,
5086 unsigned char *dstbuf, size_t dlen )
5087{
5088 size_t nb;
5089 size_t i, j, k, md_len;
5090 unsigned char *tmp;
5091 size_t tmp_len = 0;
5092 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5093 const mbedtls_md_info_t *md_info;
5094 mbedtls_md_context_t md_ctx;
5095 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5096
5097 mbedtls_md_init( &md_ctx );
5098
5099 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5100 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5101
5102 md_len = mbedtls_md_get_size( md_info );
5103
5104 tmp_len = md_len + strlen( label ) + rlen;
5105 tmp = mbedtls_calloc( 1, tmp_len );
5106 if( tmp == NULL )
5107 {
5108 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5109 goto exit;
5110 }
5111
5112 nb = strlen( label );
5113 memcpy( tmp + md_len, label, nb );
5114 memcpy( tmp + md_len + nb, random, rlen );
5115 nb += rlen;
5116
5117 /*
5118 * Compute P_<hash>(secret, label + random)[0..dlen]
5119 */
5120 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5121 goto exit;
5122
5123 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5124 if( ret != 0 )
5125 goto exit;
5126 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5127 if( ret != 0 )
5128 goto exit;
5129 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5130 if( ret != 0 )
5131 goto exit;
5132
5133 for( i = 0; i < dlen; i += md_len )
5134 {
5135 ret = mbedtls_md_hmac_reset ( &md_ctx );
5136 if( ret != 0 )
5137 goto exit;
5138 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5139 if( ret != 0 )
5140 goto exit;
5141 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5142 if( ret != 0 )
5143 goto exit;
5144
5145 ret = mbedtls_md_hmac_reset ( &md_ctx );
5146 if( ret != 0 )
5147 goto exit;
5148 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5149 if( ret != 0 )
5150 goto exit;
5151 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5152 if( ret != 0 )
5153 goto exit;
5154
5155 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5156
5157 for( j = 0; j < k; j++ )
5158 dstbuf[i + j] = h_i[j];
5159 }
5160
5161exit:
5162 mbedtls_md_free( &md_ctx );
5163
5164 mbedtls_platform_zeroize( tmp, tmp_len );
5165 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5166
5167 mbedtls_free( tmp );
5168
5169 return( ret );
5170}
5171#endif /* MBEDTLS_USE_PSA_CRYPTO */
5172
5173#if defined(MBEDTLS_SHA256_C)
5174static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5175 const char *label,
5176 const unsigned char *random, size_t rlen,
5177 unsigned char *dstbuf, size_t dlen )
5178{
5179 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5180 label, random, rlen, dstbuf, dlen ) );
5181}
5182#endif /* MBEDTLS_SHA256_C */
5183
5184#if defined(MBEDTLS_SHA384_C)
5185static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5186 const char *label,
5187 const unsigned char *random, size_t rlen,
5188 unsigned char *dstbuf, size_t dlen )
5189{
5190 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5191 label, random, rlen, dstbuf, dlen ) );
5192}
5193#endif /* MBEDTLS_SHA384_C */
5194
Jerry Yuf009d862022-02-17 14:01:37 +08005195/*
5196 * Set appropriate PRF function and other SSL / TLS1.2 functions
5197 *
5198 * Inputs:
5199 * - SSL/TLS minor version
5200 * - hash associated with the ciphersuite (only used by TLS 1.2)
5201 *
5202 * Outputs:
5203 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5204 */
5205static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
5206 int minor_ver,
5207 mbedtls_md_type_t hash )
5208{
5209
5210#if defined(MBEDTLS_SHA384_C)
5211 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
5212 hash == MBEDTLS_MD_SHA384 )
5213 {
5214 handshake->tls_prf = tls_prf_sha384;
5215 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5216 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5217 }
5218 else
5219#endif
5220#if defined(MBEDTLS_SHA256_C)
5221 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
5222 {
5223 handshake->tls_prf = tls_prf_sha256;
5224 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5225 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5226 }
5227 else
5228#endif
5229 {
5230 (void) hash;
5231 (void) minor_ver;
5232 (void) handshake;
5233 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5234 }
5235
5236 return( 0 );
5237}
Jerry Yud6ab2352022-02-17 14:03:43 +08005238
5239#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
5240 defined(MBEDTLS_USE_PSA_CRYPTO)
5241static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
5242{
5243 if( ssl->conf->f_psk != NULL )
5244 {
5245 /* If we've used a callback to select the PSK,
5246 * the static configuration is irrelevant. */
5247 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
5248 return( 1 );
5249
5250 return( 0 );
5251 }
5252
5253 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5254 return( 1 );
5255
5256 return( 0 );
5257}
5258#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5259 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5260
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005261/*
5262 * Compute master secret if needed
5263 *
5264 * Parameters:
5265 * [in/out] handshake
5266 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5267 * (PSA-PSK) ciphersuite_info, psk_opaque
5268 * [out] premaster (cleared)
5269 * [out] master
5270 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5271 * debug: conf->f_dbg, conf->p_dbg
5272 * EMS: passed to calc_verify (debug + session_negotiate)
5273 * PSA-PSA: minor_ver, conf
5274 */
5275static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5276 unsigned char *master,
5277 const mbedtls_ssl_context *ssl )
5278{
5279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5280
5281 /* cf. RFC 5246, Section 8.1:
5282 * "The master secret is always exactly 48 bytes in length." */
5283 size_t const master_secret_len = 48;
5284
5285#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5286 unsigned char session_hash[48];
5287#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5288
5289 /* The label for the KDF used for key expansion.
5290 * This is either "master secret" or "extended master secret"
5291 * depending on whether the Extended Master Secret extension
5292 * is used. */
5293 char const *lbl = "master secret";
5294
5295 /* The salt for the KDF used for key expansion.
5296 * - If the Extended Master Secret extension is not used,
5297 * this is ClientHello.Random + ServerHello.Random
5298 * (see Sect. 8.1 in RFC 5246).
5299 * - If the Extended Master Secret extension is used,
5300 * this is the transcript of the handshake so far.
5301 * (see Sect. 4 in RFC 7627). */
5302 unsigned char const *salt = handshake->randbytes;
5303 size_t salt_len = 64;
5304
5305#if !defined(MBEDTLS_DEBUG_C) && \
5306 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5307 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5308 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5309 ssl = NULL; /* make sure we don't use it except for those cases */
5310 (void) ssl;
5311#endif
5312
5313 if( handshake->resume != 0 )
5314 {
5315 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5316 return( 0 );
5317 }
5318
5319#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5320 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5321 {
5322 lbl = "extended master secret";
5323 salt = session_hash;
5324 handshake->calc_verify( ssl, session_hash, &salt_len );
5325
5326 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5327 session_hash, salt_len );
5328 }
5329#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5330
5331#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5332 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5333 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
5334 ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
5335 ssl_use_opaque_psk( ssl ) == 1 )
5336 {
5337 /* Perform PSK-to-MS expansion in a single step. */
5338 psa_status_t status;
5339 psa_algorithm_t alg;
5340 mbedtls_svc_key_id_t psk;
5341 psa_key_derivation_operation_t derivation =
5342 PSA_KEY_DERIVATION_OPERATION_INIT;
5343 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5344
5345 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5346
5347 psk = mbedtls_ssl_get_opaque_psk( ssl );
5348
5349 if( hash_alg == MBEDTLS_MD_SHA384 )
5350 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5351 else
5352 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5353
5354 status = setup_psa_key_derivation( &derivation, psk, alg,
5355 salt, salt_len,
5356 (unsigned char const *) lbl,
5357 (size_t) strlen( lbl ),
5358 master_secret_len );
5359 if( status != PSA_SUCCESS )
5360 {
5361 psa_key_derivation_abort( &derivation );
5362 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5363 }
5364
5365 status = psa_key_derivation_output_bytes( &derivation,
5366 master,
5367 master_secret_len );
5368 if( status != PSA_SUCCESS )
5369 {
5370 psa_key_derivation_abort( &derivation );
5371 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5372 }
5373
5374 status = psa_key_derivation_abort( &derivation );
5375 if( status != PSA_SUCCESS )
5376 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5377 }
5378 else
5379#endif
5380 {
5381 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5382 lbl, salt, salt_len,
5383 master,
5384 master_secret_len );
5385 if( ret != 0 )
5386 {
5387 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5388 return( ret );
5389 }
5390
5391 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5392 handshake->premaster,
5393 handshake->pmslen );
5394
5395 mbedtls_platform_zeroize( handshake->premaster,
5396 sizeof(handshake->premaster) );
5397 }
5398
5399 return( 0 );
5400}
5401
Jerry Yud62f87e2022-02-17 14:09:02 +08005402int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5403{
5404 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5405 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5406 ssl->handshake->ciphersuite_info;
5407
5408 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5409
5410 /* Set PRF, calc_verify and calc_finished function pointers */
5411 ret = ssl_set_handshake_prfs( ssl->handshake,
5412 ssl->minor_ver,
5413 ciphersuite_info->mac );
5414 if( ret != 0 )
5415 {
5416 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5417 return( ret );
5418 }
5419
5420 /* Compute master secret if needed */
5421 ret = ssl_compute_master( ssl->handshake,
5422 ssl->session_negotiate->master,
5423 ssl );
5424 if( ret != 0 )
5425 {
5426 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5427 return( ret );
5428 }
5429
5430 /* Swap the client and server random values:
5431 * - MS derivation wanted client+server (RFC 5246 8.1)
5432 * - key derivation wants server+client (RFC 5246 6.3) */
5433 {
5434 unsigned char tmp[64];
5435 memcpy( tmp, ssl->handshake->randbytes, 64 );
5436 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5437 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5438 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5439 }
5440
5441 /* Populate transform structure */
5442 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5443 ssl->session_negotiate->ciphersuite,
5444 ssl->session_negotiate->master,
5445#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5446 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5447 ssl->session_negotiate->encrypt_then_mac,
5448#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5449 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5450 ssl->handshake->tls_prf,
5451 ssl->handshake->randbytes,
5452 ssl->minor_ver,
5453 ssl->conf->endpoint,
5454 ssl );
5455 if( ret != 0 )
5456 {
5457 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5458 return( ret );
5459 }
5460
5461 /* We no longer need Server/ClientHello.random values */
5462 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5463 sizeof( ssl->handshake->randbytes ) );
5464
5465 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5466
5467 return( 0 );
5468}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005469
5470#if defined(MBEDTLS_SHA256_C)
5471void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5472 unsigned char *hash,
5473 size_t *hlen )
5474{
5475#if defined(MBEDTLS_USE_PSA_CRYPTO)
5476 size_t hash_size;
5477 psa_status_t status;
5478 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5479
5480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5481 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5482 if( status != PSA_SUCCESS )
5483 {
5484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5485 return;
5486 }
5487
5488 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5489 if( status != PSA_SUCCESS )
5490 {
5491 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5492 return;
5493 }
5494
5495 *hlen = 32;
5496 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5497 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5498#else
5499 mbedtls_sha256_context sha256;
5500
5501 mbedtls_sha256_init( &sha256 );
5502
5503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5504
5505 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5506 mbedtls_sha256_finish( &sha256, hash );
5507
5508 *hlen = 32;
5509
5510 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5511 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5512
5513 mbedtls_sha256_free( &sha256 );
5514#endif /* MBEDTLS_USE_PSA_CRYPTO */
5515 return;
5516}
5517#endif /* MBEDTLS_SHA256_C */
5518
Jerry Yuc1cb3842022-02-17 14:13:48 +08005519#if defined(MBEDTLS_SHA384_C)
5520void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5521 unsigned char *hash,
5522 size_t *hlen )
5523{
5524#if defined(MBEDTLS_USE_PSA_CRYPTO)
5525 size_t hash_size;
5526 psa_status_t status;
5527 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5528
5529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5530 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5531 if( status != PSA_SUCCESS )
5532 {
5533 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5534 return;
5535 }
5536
5537 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5538 if( status != PSA_SUCCESS )
5539 {
5540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5541 return;
5542 }
5543
5544 *hlen = 48;
5545 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5546 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5547#else
5548 mbedtls_sha512_context sha512;
5549
5550 mbedtls_sha512_init( &sha512 );
5551
5552 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5553
5554 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5555 mbedtls_sha512_finish( &sha512, hash );
5556
5557 *hlen = 48;
5558
5559 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5560 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5561
5562 mbedtls_sha512_free( &sha512 );
5563#endif /* MBEDTLS_USE_PSA_CRYPTO */
5564 return;
5565}
5566#endif /* MBEDTLS_SHA384_C */
5567
Jerry Yuce3dca42022-02-17 14:16:37 +08005568#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5569int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5570{
5571 unsigned char *p = ssl->handshake->premaster;
5572 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5573 const unsigned char *psk = NULL;
5574 size_t psk_len = 0;
5575
5576 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5577 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5578 {
5579 /*
5580 * This should never happen because the existence of a PSK is always
5581 * checked before calling this function
5582 */
5583 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5584 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5585 }
5586
5587 /*
5588 * PMS = struct {
5589 * opaque other_secret<0..2^16-1>;
5590 * opaque psk<0..2^16-1>;
5591 * };
5592 * with "other_secret" depending on the particular key exchange
5593 */
5594#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5595 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5596 {
5597 if( end - p < 2 )
5598 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5599
5600 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5601 p += 2;
5602
5603 if( end < p || (size_t)( end - p ) < psk_len )
5604 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5605
5606 memset( p, 0, psk_len );
5607 p += psk_len;
5608 }
5609 else
5610#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5611#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5612 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5613 {
5614 /*
5615 * other_secret already set by the ClientKeyExchange message,
5616 * and is 48 bytes long
5617 */
5618 if( end - p < 2 )
5619 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5620
5621 *p++ = 0;
5622 *p++ = 48;
5623 p += 48;
5624 }
5625 else
5626#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5627#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5628 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5629 {
5630 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5631 size_t len;
5632
5633 /* Write length only when we know the actual value */
5634 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5635 p + 2, end - ( p + 2 ), &len,
5636 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5637 {
5638 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5639 return( ret );
5640 }
5641 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5642 p += 2 + len;
5643
5644 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5645 }
5646 else
5647#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5648#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5649 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5650 {
5651 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5652 size_t zlen;
5653
5654 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5655 p + 2, end - ( p + 2 ),
5656 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5657 {
5658 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5659 return( ret );
5660 }
5661
5662 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5663 p += 2 + zlen;
5664
5665 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5666 MBEDTLS_DEBUG_ECDH_Z );
5667 }
5668 else
5669#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5670 {
5671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5672 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5673 }
5674
5675 /* opaque psk<0..2^16-1>; */
5676 if( end - p < 2 )
5677 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5678
5679 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5680 p += 2;
5681
5682 if( end < p || (size_t)( end - p ) < psk_len )
5683 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5684
5685 memcpy( p, psk, psk_len );
5686 p += psk_len;
5687
5688 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5689
5690 return( 0 );
5691}
5692#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005693
5694#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5695static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5696
5697#if defined(MBEDTLS_SSL_PROTO_DTLS)
5698int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5699{
5700 /* If renegotiation is not enforced, retransmit until we would reach max
5701 * timeout if we were using the usual handshake doubling scheme */
5702 if( ssl->conf->renego_max_records < 0 )
5703 {
5704 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5705 unsigned char doublings = 1;
5706
5707 while( ratio != 0 )
5708 {
5709 ++doublings;
5710 ratio >>= 1;
5711 }
5712
5713 if( ++ssl->renego_records_seen > doublings )
5714 {
5715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5716 return( 0 );
5717 }
5718 }
5719
5720 return( ssl_write_hello_request( ssl ) );
5721}
5722#endif
5723#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005724
Jerry Yud9526692022-02-17 14:23:47 +08005725/*
5726 * Handshake functions
5727 */
5728#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5729/* No certificate support -> dummy functions */
5730int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5731{
5732 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5733 ssl->handshake->ciphersuite_info;
5734
5735 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5736
5737 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5738 {
5739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5740 ssl->state++;
5741 return( 0 );
5742 }
5743
5744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5745 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5746}
5747
5748int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5749{
5750 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5751 ssl->handshake->ciphersuite_info;
5752
5753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5754
5755 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5756 {
5757 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5758 ssl->state++;
5759 return( 0 );
5760 }
5761
5762 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5763 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5764}
5765
5766#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5767/* Some certificate support -> implement write and parse */
5768
5769int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5770{
5771 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5772 size_t i, n;
5773 const mbedtls_x509_crt *crt;
5774 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5775 ssl->handshake->ciphersuite_info;
5776
5777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5778
5779 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5780 {
5781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5782 ssl->state++;
5783 return( 0 );
5784 }
5785
5786#if defined(MBEDTLS_SSL_CLI_C)
5787 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5788 {
5789 if( ssl->handshake->client_auth == 0 )
5790 {
5791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5792 ssl->state++;
5793 return( 0 );
5794 }
5795 }
5796#endif /* MBEDTLS_SSL_CLI_C */
5797#if defined(MBEDTLS_SSL_SRV_C)
5798 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5799 {
5800 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5801 {
5802 /* Should never happen because we shouldn't have picked the
5803 * ciphersuite if we don't have a certificate. */
5804 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5805 }
5806 }
5807#endif
5808
5809 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5810
5811 /*
5812 * 0 . 0 handshake type
5813 * 1 . 3 handshake length
5814 * 4 . 6 length of all certs
5815 * 7 . 9 length of cert. 1
5816 * 10 . n-1 peer certificate
5817 * n . n+2 length of cert. 2
5818 * n+3 . ... upper level cert, etc.
5819 */
5820 i = 7;
5821 crt = mbedtls_ssl_own_cert( ssl );
5822
5823 while( crt != NULL )
5824 {
5825 n = crt->raw.len;
5826 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5827 {
5828 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5829 " > %" MBEDTLS_PRINTF_SIZET,
5830 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5831 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5832 }
5833
5834 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5835 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5836 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5837
5838 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5839 i += n; crt = crt->next;
5840 }
5841
5842 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5843 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5844 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5845
5846 ssl->out_msglen = i;
5847 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5848 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5849
5850 ssl->state++;
5851
5852 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5853 {
5854 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5855 return( ret );
5856 }
5857
5858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5859
5860 return( ret );
5861}
5862
5863#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5864
5865#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5866static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5867 unsigned char *crt_buf,
5868 size_t crt_buf_len )
5869{
5870 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5871
5872 if( peer_crt == NULL )
5873 return( -1 );
5874
5875 if( peer_crt->raw.len != crt_buf_len )
5876 return( -1 );
5877
5878 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5879}
5880#else /* 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 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5886 unsigned char const * const peer_cert_digest =
5887 ssl->session->peer_cert_digest;
5888 mbedtls_md_type_t const peer_cert_digest_type =
5889 ssl->session->peer_cert_digest_type;
5890 mbedtls_md_info_t const * const digest_info =
5891 mbedtls_md_info_from_type( peer_cert_digest_type );
5892 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5893 size_t digest_len;
5894
5895 if( peer_cert_digest == NULL || digest_info == NULL )
5896 return( -1 );
5897
5898 digest_len = mbedtls_md_get_size( digest_info );
5899 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5900 return( -1 );
5901
5902 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5903 if( ret != 0 )
5904 return( -1 );
5905
5906 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5907}
5908#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5909#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5910
5911/*
5912 * Once the certificate message is read, parse it into a cert chain and
5913 * perform basic checks, but leave actual verification to the caller
5914 */
5915static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5916 mbedtls_x509_crt *chain )
5917{
5918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5919#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5920 int crt_cnt=0;
5921#endif
5922 size_t i, n;
5923 uint8_t alert;
5924
5925 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5926 {
5927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5928 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5929 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5930 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5931 }
5932
5933 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5934 {
5935 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5936 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5937 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5938 }
5939
5940 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
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_DECODE_ERROR );
5945 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5946 }
5947
5948 i = mbedtls_ssl_hs_hdr_len( ssl );
5949
5950 /*
5951 * Same message structure as in mbedtls_ssl_write_certificate()
5952 */
5953 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5954
5955 if( ssl->in_msg[i] != 0 ||
5956 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5957 {
5958 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5959 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5960 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5961 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5962 }
5963
5964 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5965 i += 3;
5966
5967 /* Iterate through and parse the CRTs in the provided chain. */
5968 while( i < ssl->in_hslen )
5969 {
5970 /* Check that there's room for the next CRT's length fields. */
5971 if ( i + 3 > ssl->in_hslen ) {
5972 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5973 mbedtls_ssl_send_alert_message( ssl,
5974 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5975 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5976 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5977 }
5978 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5979 * anything beyond 2**16 ~ 64K. */
5980 if( ssl->in_msg[i] != 0 )
5981 {
5982 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5983 mbedtls_ssl_send_alert_message( ssl,
5984 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5985 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5986 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5987 }
5988
5989 /* Read length of the next CRT in the chain. */
5990 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5991 | (unsigned int) ssl->in_msg[i + 2];
5992 i += 3;
5993
5994 if( n < 128 || i + n > ssl->in_hslen )
5995 {
5996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5997 mbedtls_ssl_send_alert_message( ssl,
5998 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5999 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6000 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6001 }
6002
6003 /* Check if we're handling the first CRT in the chain. */
6004#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6005 if( crt_cnt++ == 0 &&
6006 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6007 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6008 {
6009 /* During client-side renegotiation, check that the server's
6010 * end-CRTs hasn't changed compared to the initial handshake,
6011 * mitigating the triple handshake attack. On success, reuse
6012 * the original end-CRT instead of parsing it again. */
6013 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6014 if( ssl_check_peer_crt_unchanged( ssl,
6015 &ssl->in_msg[i],
6016 n ) != 0 )
6017 {
6018 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6019 mbedtls_ssl_send_alert_message( ssl,
6020 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6021 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6022 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6023 }
6024
6025 /* Now we can safely free the original chain. */
6026 ssl_clear_peer_cert( ssl->session );
6027 }
6028#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6029
6030 /* Parse the next certificate in the chain. */
6031#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6032 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6033#else
6034 /* If we don't need to store the CRT chain permanently, parse
6035 * it in-place from the input buffer instead of making a copy. */
6036 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6037#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6038 switch( ret )
6039 {
6040 case 0: /*ok*/
6041 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6042 /* Ignore certificate with an unknown algorithm: maybe a
6043 prior certificate was already trusted. */
6044 break;
6045
6046 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6047 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6048 goto crt_parse_der_failed;
6049
6050 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6051 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6052 goto crt_parse_der_failed;
6053
6054 default:
6055 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6056 crt_parse_der_failed:
6057 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6058 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6059 return( ret );
6060 }
6061
6062 i += n;
6063 }
6064
6065 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6066 return( 0 );
6067}
6068
6069#if defined(MBEDTLS_SSL_SRV_C)
6070static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6071{
6072 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6073 return( -1 );
6074
6075 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6076 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6077 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6078 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6079 {
6080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
6081 return( 0 );
6082 }
6083 return( -1 );
6084}
6085#endif /* MBEDTLS_SSL_SRV_C */
6086
6087/* Check if a certificate message is expected.
6088 * Return either
6089 * - SSL_CERTIFICATE_EXPECTED, or
6090 * - SSL_CERTIFICATE_SKIP
6091 * indicating whether a Certificate message is expected or not.
6092 */
6093#define SSL_CERTIFICATE_EXPECTED 0
6094#define SSL_CERTIFICATE_SKIP 1
6095static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6096 int authmode )
6097{
6098 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6099 ssl->handshake->ciphersuite_info;
6100
6101 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6102 return( SSL_CERTIFICATE_SKIP );
6103
6104#if defined(MBEDTLS_SSL_SRV_C)
6105 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6106 {
6107 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6108 return( SSL_CERTIFICATE_SKIP );
6109
6110 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6111 {
6112 ssl->session_negotiate->verify_result =
6113 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6114 return( SSL_CERTIFICATE_SKIP );
6115 }
6116 }
6117#else
6118 ((void) authmode);
6119#endif /* MBEDTLS_SSL_SRV_C */
6120
6121 return( SSL_CERTIFICATE_EXPECTED );
6122}
6123
6124static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6125 int authmode,
6126 mbedtls_x509_crt *chain,
6127 void *rs_ctx )
6128{
6129 int ret = 0;
6130 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6131 ssl->handshake->ciphersuite_info;
6132 int have_ca_chain = 0;
6133
6134 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6135 void *p_vrfy;
6136
6137 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6138 return( 0 );
6139
6140 if( ssl->f_vrfy != NULL )
6141 {
6142 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6143 f_vrfy = ssl->f_vrfy;
6144 p_vrfy = ssl->p_vrfy;
6145 }
6146 else
6147 {
6148 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6149 f_vrfy = ssl->conf->f_vrfy;
6150 p_vrfy = ssl->conf->p_vrfy;
6151 }
6152
6153 /*
6154 * Main check: verify certificate
6155 */
6156#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6157 if( ssl->conf->f_ca_cb != NULL )
6158 {
6159 ((void) rs_ctx);
6160 have_ca_chain = 1;
6161
6162 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6163 ret = mbedtls_x509_crt_verify_with_ca_cb(
6164 chain,
6165 ssl->conf->f_ca_cb,
6166 ssl->conf->p_ca_cb,
6167 ssl->conf->cert_profile,
6168 ssl->hostname,
6169 &ssl->session_negotiate->verify_result,
6170 f_vrfy, p_vrfy );
6171 }
6172 else
6173#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6174 {
6175 mbedtls_x509_crt *ca_chain;
6176 mbedtls_x509_crl *ca_crl;
6177
6178#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6179 if( ssl->handshake->sni_ca_chain != NULL )
6180 {
6181 ca_chain = ssl->handshake->sni_ca_chain;
6182 ca_crl = ssl->handshake->sni_ca_crl;
6183 }
6184 else
6185#endif
6186 {
6187 ca_chain = ssl->conf->ca_chain;
6188 ca_crl = ssl->conf->ca_crl;
6189 }
6190
6191 if( ca_chain != NULL )
6192 have_ca_chain = 1;
6193
6194 ret = mbedtls_x509_crt_verify_restartable(
6195 chain,
6196 ca_chain, ca_crl,
6197 ssl->conf->cert_profile,
6198 ssl->hostname,
6199 &ssl->session_negotiate->verify_result,
6200 f_vrfy, p_vrfy, rs_ctx );
6201 }
6202
6203 if( ret != 0 )
6204 {
6205 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6206 }
6207
6208#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6209 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6210 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6211#endif
6212
6213 /*
6214 * Secondary checks: always done, but change 'ret' only if it was 0
6215 */
6216
6217#if defined(MBEDTLS_ECP_C)
6218 {
6219 const mbedtls_pk_context *pk = &chain->pk;
6220
6221 /* If certificate uses an EC key, make sure the curve is OK */
6222 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6223 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6224 {
6225 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6226
6227 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6228 if( ret == 0 )
6229 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6230 }
6231 }
6232#endif /* MBEDTLS_ECP_C */
6233
6234 if( mbedtls_ssl_check_cert_usage( chain,
6235 ciphersuite_info,
6236 ! ssl->conf->endpoint,
6237 &ssl->session_negotiate->verify_result ) != 0 )
6238 {
6239 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6240 if( ret == 0 )
6241 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6242 }
6243
6244 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6245 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6246 * with details encoded in the verification flags. All other kinds
6247 * of error codes, including those from the user provided f_vrfy
6248 * functions, are treated as fatal and lead to a failure of
6249 * ssl_parse_certificate even if verification was optional. */
6250 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6251 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6252 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6253 {
6254 ret = 0;
6255 }
6256
6257 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6258 {
6259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6260 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6261 }
6262
6263 if( ret != 0 )
6264 {
6265 uint8_t alert;
6266
6267 /* The certificate may have been rejected for several reasons.
6268 Pick one and send the corresponding alert. Which alert to send
6269 may be a subject of debate in some cases. */
6270 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6271 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6272 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6273 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6274 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6275 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6276 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6277 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6278 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6279 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6280 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6281 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6282 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6283 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6284 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6285 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6286 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6287 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6288 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6289 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6290 else
6291 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6292 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6293 alert );
6294 }
6295
6296#if defined(MBEDTLS_DEBUG_C)
6297 if( ssl->session_negotiate->verify_result != 0 )
6298 {
6299 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6300 (unsigned int) ssl->session_negotiate->verify_result ) );
6301 }
6302 else
6303 {
6304 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6305 }
6306#endif /* MBEDTLS_DEBUG_C */
6307
6308 return( ret );
6309}
6310
6311#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6312static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6313 unsigned char *start, size_t len )
6314{
6315 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6316 /* Remember digest of the peer's end-CRT. */
6317 ssl->session_negotiate->peer_cert_digest =
6318 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6319 if( ssl->session_negotiate->peer_cert_digest == NULL )
6320 {
6321 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6322 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6323 mbedtls_ssl_send_alert_message( ssl,
6324 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6325 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6326
6327 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6328 }
6329
6330 ret = mbedtls_md( mbedtls_md_info_from_type(
6331 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6332 start, len,
6333 ssl->session_negotiate->peer_cert_digest );
6334
6335 ssl->session_negotiate->peer_cert_digest_type =
6336 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6337 ssl->session_negotiate->peer_cert_digest_len =
6338 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6339
6340 return( ret );
6341}
6342
6343static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6344 unsigned char *start, size_t len )
6345{
6346 unsigned char *end = start + len;
6347 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6348
6349 /* Make a copy of the peer's raw public key. */
6350 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6351 ret = mbedtls_pk_parse_subpubkey( &start, end,
6352 &ssl->handshake->peer_pubkey );
6353 if( ret != 0 )
6354 {
6355 /* We should have parsed the public key before. */
6356 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6357 }
6358
6359 return( 0 );
6360}
6361#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6362
6363int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6364{
6365 int ret = 0;
6366 int crt_expected;
6367#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6368 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6369 ? ssl->handshake->sni_authmode
6370 : ssl->conf->authmode;
6371#else
6372 const int authmode = ssl->conf->authmode;
6373#endif
6374 void *rs_ctx = NULL;
6375 mbedtls_x509_crt *chain = NULL;
6376
6377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6378
6379 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6380 if( crt_expected == SSL_CERTIFICATE_SKIP )
6381 {
6382 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6383 goto exit;
6384 }
6385
6386#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6387 if( ssl->handshake->ecrs_enabled &&
6388 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6389 {
6390 chain = ssl->handshake->ecrs_peer_cert;
6391 ssl->handshake->ecrs_peer_cert = NULL;
6392 goto crt_verify;
6393 }
6394#endif
6395
6396 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6397 {
6398 /* mbedtls_ssl_read_record may have sent an alert already. We
6399 let it decide whether to alert. */
6400 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6401 goto exit;
6402 }
6403
6404#if defined(MBEDTLS_SSL_SRV_C)
6405 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6406 {
6407 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6408
6409 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6410 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6411
6412 goto exit;
6413 }
6414#endif /* MBEDTLS_SSL_SRV_C */
6415
6416 /* Clear existing peer CRT structure in case we tried to
6417 * reuse a session but it failed, and allocate a new one. */
6418 ssl_clear_peer_cert( ssl->session_negotiate );
6419
6420 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6421 if( chain == NULL )
6422 {
6423 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6424 sizeof( mbedtls_x509_crt ) ) );
6425 mbedtls_ssl_send_alert_message( ssl,
6426 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6427 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6428
6429 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6430 goto exit;
6431 }
6432 mbedtls_x509_crt_init( chain );
6433
6434 ret = ssl_parse_certificate_chain( ssl, chain );
6435 if( ret != 0 )
6436 goto exit;
6437
6438#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6439 if( ssl->handshake->ecrs_enabled)
6440 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6441
6442crt_verify:
6443 if( ssl->handshake->ecrs_enabled)
6444 rs_ctx = &ssl->handshake->ecrs_ctx;
6445#endif
6446
6447 ret = ssl_parse_certificate_verify( ssl, authmode,
6448 chain, rs_ctx );
6449 if( ret != 0 )
6450 goto exit;
6451
6452#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6453 {
6454 unsigned char *crt_start, *pk_start;
6455 size_t crt_len, pk_len;
6456
6457 /* We parse the CRT chain without copying, so
6458 * these pointers point into the input buffer,
6459 * and are hence still valid after freeing the
6460 * CRT chain. */
6461
6462 crt_start = chain->raw.p;
6463 crt_len = chain->raw.len;
6464
6465 pk_start = chain->pk_raw.p;
6466 pk_len = chain->pk_raw.len;
6467
6468 /* Free the CRT structures before computing
6469 * digest and copying the peer's public key. */
6470 mbedtls_x509_crt_free( chain );
6471 mbedtls_free( chain );
6472 chain = NULL;
6473
6474 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6475 if( ret != 0 )
6476 goto exit;
6477
6478 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6479 if( ret != 0 )
6480 goto exit;
6481 }
6482#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6483 /* Pass ownership to session structure. */
6484 ssl->session_negotiate->peer_cert = chain;
6485 chain = NULL;
6486#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6487
6488 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6489
6490exit:
6491
6492 if( ret == 0 )
6493 ssl->state++;
6494
6495#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6496 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6497 {
6498 ssl->handshake->ecrs_peer_cert = chain;
6499 chain = NULL;
6500 }
6501#endif
6502
6503 if( chain != NULL )
6504 {
6505 mbedtls_x509_crt_free( chain );
6506 mbedtls_free( chain );
6507 }
6508
6509 return( ret );
6510}
6511#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6512
Jerry Yu615bd6f2022-02-17 14:25:15 +08006513#if defined(MBEDTLS_SHA256_C)
6514static void ssl_calc_finished_tls_sha256(
6515 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6516{
6517 int len = 12;
6518 const char *sender;
6519 unsigned char padbuf[32];
6520#if defined(MBEDTLS_USE_PSA_CRYPTO)
6521 size_t hash_size;
6522 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6523 psa_status_t status;
6524#else
6525 mbedtls_sha256_context sha256;
6526#endif
6527
6528 mbedtls_ssl_session *session = ssl->session_negotiate;
6529 if( !session )
6530 session = ssl->session;
6531
6532 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6533 ? "client finished"
6534 : "server finished";
6535
6536#if defined(MBEDTLS_USE_PSA_CRYPTO)
6537 sha256_psa = psa_hash_operation_init();
6538
6539 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6540
6541 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6542 if( status != PSA_SUCCESS )
6543 {
6544 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6545 return;
6546 }
6547
6548 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6549 if( status != PSA_SUCCESS )
6550 {
6551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6552 return;
6553 }
6554 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6555#else
6556
6557 mbedtls_sha256_init( &sha256 );
6558
6559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6560
6561 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6562
6563 /*
6564 * TLSv1.2:
6565 * hash = PRF( master, finished_label,
6566 * Hash( handshake ) )[0.11]
6567 */
6568
6569#if !defined(MBEDTLS_SHA256_ALT)
6570 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6571 sha256.state, sizeof( sha256.state ) );
6572#endif
6573
6574 mbedtls_sha256_finish( &sha256, padbuf );
6575 mbedtls_sha256_free( &sha256 );
6576#endif /* MBEDTLS_USE_PSA_CRYPTO */
6577
6578 ssl->handshake->tls_prf( session->master, 48, sender,
6579 padbuf, 32, buf, len );
6580
6581 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6582
6583 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6584
6585 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6586}
6587#endif /* MBEDTLS_SHA256_C */
6588
Jerry Yub7ba49e2022-02-17 14:25:53 +08006589
6590#if defined(MBEDTLS_SHA384_C)
6591
6592static void ssl_calc_finished_tls_sha384(
6593 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6594{
6595 int len = 12;
6596 const char *sender;
6597 unsigned char padbuf[48];
6598#if defined(MBEDTLS_USE_PSA_CRYPTO)
6599 size_t hash_size;
6600 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6601 psa_status_t status;
6602#else
6603 mbedtls_sha512_context sha512;
6604#endif
6605
6606 mbedtls_ssl_session *session = ssl->session_negotiate;
6607 if( !session )
6608 session = ssl->session;
6609
6610 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6611 ? "client finished"
6612 : "server finished";
6613
6614#if defined(MBEDTLS_USE_PSA_CRYPTO)
6615 sha384_psa = psa_hash_operation_init();
6616
6617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6618
6619 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6620 if( status != PSA_SUCCESS )
6621 {
6622 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6623 return;
6624 }
6625
6626 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6627 if( status != PSA_SUCCESS )
6628 {
6629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6630 return;
6631 }
6632 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6633#else
6634 mbedtls_sha512_init( &sha512 );
6635
6636 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6637
6638 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6639
6640 /*
6641 * TLSv1.2:
6642 * hash = PRF( master, finished_label,
6643 * Hash( handshake ) )[0.11]
6644 */
6645
6646#if !defined(MBEDTLS_SHA512_ALT)
6647 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6648 sha512.state, sizeof( sha512.state ) );
6649#endif
6650 mbedtls_sha512_finish( &sha512, padbuf );
6651
6652 mbedtls_sha512_free( &sha512 );
6653#endif
6654
6655 ssl->handshake->tls_prf( session->master, 48, sender,
6656 padbuf, 48, buf, len );
6657
6658 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6659
6660 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6661
6662 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6663}
6664#endif /* MBEDTLS_SHA384_C */
6665
Jerry Yuaef00152022-02-17 14:27:31 +08006666void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6667{
6668 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6669
6670 /*
6671 * Free our handshake params
6672 */
6673 mbedtls_ssl_handshake_free( ssl );
6674 mbedtls_free( ssl->handshake );
6675 ssl->handshake = NULL;
6676
6677 /*
6678 * Free the previous transform and swith in the current one
6679 */
6680 if( ssl->transform )
6681 {
6682 mbedtls_ssl_transform_free( ssl->transform );
6683 mbedtls_free( ssl->transform );
6684 }
6685 ssl->transform = ssl->transform_negotiate;
6686 ssl->transform_negotiate = NULL;
6687
6688 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6689}
6690
Jerry Yu2a9fff52022-02-17 14:28:51 +08006691void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6692{
6693 int resume = ssl->handshake->resume;
6694
6695 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6696
6697#if defined(MBEDTLS_SSL_RENEGOTIATION)
6698 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6699 {
6700 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6701 ssl->renego_records_seen = 0;
6702 }
6703#endif
6704
6705 /*
6706 * Free the previous session and switch in the current one
6707 */
6708 if( ssl->session )
6709 {
6710#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6711 /* RFC 7366 3.1: keep the EtM state */
6712 ssl->session_negotiate->encrypt_then_mac =
6713 ssl->session->encrypt_then_mac;
6714#endif
6715
6716 mbedtls_ssl_session_free( ssl->session );
6717 mbedtls_free( ssl->session );
6718 }
6719 ssl->session = ssl->session_negotiate;
6720 ssl->session_negotiate = NULL;
6721
6722 /*
6723 * Add cache entry
6724 */
6725 if( ssl->conf->f_set_cache != NULL &&
6726 ssl->session->id_len != 0 &&
6727 resume == 0 )
6728 {
6729 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6730 ssl->session->id,
6731 ssl->session->id_len,
6732 ssl->session ) != 0 )
6733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6734 }
6735
6736#if defined(MBEDTLS_SSL_PROTO_DTLS)
6737 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6738 ssl->handshake->flight != NULL )
6739 {
6740 /* Cancel handshake timer */
6741 mbedtls_ssl_set_timer( ssl, 0 );
6742
6743 /* Keep last flight around in case we need to resend it:
6744 * we need the handshake and transform structures for that */
6745 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6746 }
6747 else
6748#endif
6749 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6750
6751 ssl->state++;
6752
6753 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6754}
6755
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006756int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6757{
6758 int ret, hash_len;
6759
6760 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6761
6762 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6763
6764 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6765
6766 /*
6767 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6768 * may define some other value. Currently (early 2016), no defined
6769 * ciphersuite does this (and this is unlikely to change as activity has
6770 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6771 */
6772 hash_len = 12;
6773
6774#if defined(MBEDTLS_SSL_RENEGOTIATION)
6775 ssl->verify_data_len = hash_len;
6776 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6777#endif
6778
6779 ssl->out_msglen = 4 + hash_len;
6780 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6781 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6782
6783 /*
6784 * In case of session resuming, invert the client and server
6785 * ChangeCipherSpec messages order.
6786 */
6787 if( ssl->handshake->resume != 0 )
6788 {
6789#if defined(MBEDTLS_SSL_CLI_C)
6790 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6791 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6792#endif
6793#if defined(MBEDTLS_SSL_SRV_C)
6794 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6795 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6796#endif
6797 }
6798 else
6799 ssl->state++;
6800
6801 /*
6802 * Switch to our negotiated transform and session parameters for outbound
6803 * data.
6804 */
6805 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6806
6807#if defined(MBEDTLS_SSL_PROTO_DTLS)
6808 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6809 {
6810 unsigned char i;
6811
6812 /* Remember current epoch settings for resending */
6813 ssl->handshake->alt_transform_out = ssl->transform_out;
6814 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6815 sizeof( ssl->handshake->alt_out_ctr ) );
6816
6817 /* Set sequence_number to zero */
6818 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6819
6820
6821 /* Increment epoch */
6822 for( i = 2; i > 0; i-- )
6823 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6824 break;
6825
6826 /* The loop goes to its end iff the counter is wrapping */
6827 if( i == 0 )
6828 {
6829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6830 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6831 }
6832 }
6833 else
6834#endif /* MBEDTLS_SSL_PROTO_DTLS */
6835 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6836
6837 ssl->transform_out = ssl->transform_negotiate;
6838 ssl->session_out = ssl->session_negotiate;
6839
6840#if defined(MBEDTLS_SSL_PROTO_DTLS)
6841 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6842 mbedtls_ssl_send_flight_completed( ssl );
6843#endif
6844
6845 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6846 {
6847 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6848 return( ret );
6849 }
6850
6851#if defined(MBEDTLS_SSL_PROTO_DTLS)
6852 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6853 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6854 {
6855 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6856 return( ret );
6857 }
6858#endif
6859
6860 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6861
6862 return( 0 );
6863}
6864
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006865#define SSL_MAX_HASH_LEN 12
6866
6867int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6868{
6869 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6870 unsigned int hash_len = 12;
6871 unsigned char buf[SSL_MAX_HASH_LEN];
6872
6873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6874
6875 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6876
6877 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6878 {
6879 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6880 goto exit;
6881 }
6882
6883 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6884 {
6885 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6886 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6887 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6888 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6889 goto exit;
6890 }
6891
6892 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6893 {
6894 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6895 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6896 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6897 goto exit;
6898 }
6899
6900 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6901 {
6902 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6903 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6904 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6905 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6906 goto exit;
6907 }
6908
6909 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6910 buf, hash_len ) != 0 )
6911 {
6912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6913 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6914 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6915 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6916 goto exit;
6917 }
6918
6919#if defined(MBEDTLS_SSL_RENEGOTIATION)
6920 ssl->verify_data_len = hash_len;
6921 memcpy( ssl->peer_verify_data, buf, hash_len );
6922#endif
6923
6924 if( ssl->handshake->resume != 0 )
6925 {
6926#if defined(MBEDTLS_SSL_CLI_C)
6927 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6928 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6929#endif
6930#if defined(MBEDTLS_SSL_SRV_C)
6931 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6932 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6933#endif
6934 }
6935 else
6936 ssl->state++;
6937
6938#if defined(MBEDTLS_SSL_PROTO_DTLS)
6939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6940 mbedtls_ssl_recv_flight_completed( ssl );
6941#endif
6942
6943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6944
6945exit:
6946 mbedtls_platform_zeroize( buf, hash_len );
6947 return( ret );
6948}
6949
Jerry Yu392112c2022-02-17 14:34:10 +08006950#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6951/*
6952 * Helper to get TLS 1.2 PRF from ciphersuite
6953 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6954 */
6955static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6956{
6957#if defined(MBEDTLS_SHA384_C)
6958 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6959 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6960
6961 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6962 return( tls_prf_sha384 );
6963#else
6964 (void) ciphersuite_id;
6965#endif
6966 return( tls_prf_sha256 );
6967}
6968#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006969
6970static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6971{
6972 ((void) tls_prf);
6973#if defined(MBEDTLS_SHA384_C)
6974 if( tls_prf == tls_prf_sha384 )
6975 {
6976 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6977 }
6978 else
6979#endif
6980#if defined(MBEDTLS_SHA256_C)
6981 if( tls_prf == tls_prf_sha256 )
6982 {
6983 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6984 }
6985 else
6986#endif
6987 return( MBEDTLS_SSL_TLS_PRF_NONE );
6988}
6989
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006990/*
6991 * Populate a transform structure with session keys and all the other
6992 * necessary information.
6993 *
6994 * Parameters:
6995 * - [in/out]: transform: structure to populate
6996 * [in] must be just initialised with mbedtls_ssl_transform_init()
6997 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6998 * - [in] ciphersuite
6999 * - [in] master
7000 * - [in] encrypt_then_mac
7001 * - [in] compression
7002 * - [in] tls_prf: pointer to PRF to use for key derivation
7003 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
7004 * - [in] minor_ver: SSL/TLS minor version
7005 * - [in] endpoint: client or server
7006 * - [in] ssl: used for:
7007 * - ssl->conf->{f,p}_export_keys
7008 * [in] optionally used for:
7009 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7010 */
7011static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7012 int ciphersuite,
7013 const unsigned char master[48],
7014#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
7015 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7016 int encrypt_then_mac,
7017#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
7018 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7019 ssl_tls_prf_t tls_prf,
7020 const unsigned char randbytes[64],
7021 int minor_ver,
7022 unsigned endpoint,
7023 const mbedtls_ssl_context *ssl )
7024{
7025 int ret = 0;
7026 unsigned char keyblk[256];
7027 unsigned char *key1;
7028 unsigned char *key2;
7029 unsigned char *mac_enc;
7030 unsigned char *mac_dec;
7031 size_t mac_key_len = 0;
7032 size_t iv_copy_len;
7033 size_t keylen;
7034 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
7035 const mbedtls_cipher_info_t *cipher_info;
7036 const mbedtls_md_info_t *md_info;
7037
7038#if defined(MBEDTLS_USE_PSA_CRYPTO)
7039 psa_key_type_t key_type;
7040 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7041 psa_algorithm_t alg;
7042 size_t key_bits;
7043 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7044#endif
7045
7046#if !defined(MBEDTLS_DEBUG_C) && \
7047 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7048 if( ssl->f_export_keys == NULL )
7049 {
7050 ssl = NULL; /* make sure we don't use it except for these cases */
7051 (void) ssl;
7052 }
7053#endif
7054
7055 /*
7056 * Some data just needs copying into the structure
7057 */
7058#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
7059 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7060 transform->encrypt_then_mac = encrypt_then_mac;
7061#endif
7062 transform->minor_ver = minor_ver;
7063
7064#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7065 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7066#endif
7067
7068#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
7069 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
7070 {
7071 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7072 * generation separate. This should never happen. */
7073 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7074 }
7075#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7076
7077 /*
7078 * Get various info structures
7079 */
7080 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7081 if( ciphersuite_info == NULL )
7082 {
7083 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7084 ciphersuite ) );
7085 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7086 }
7087
7088 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7089 if( cipher_info == NULL )
7090 {
7091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7092 ciphersuite_info->cipher ) );
7093 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7094 }
7095
7096 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7097 if( md_info == NULL )
7098 {
7099 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7100 (unsigned) ciphersuite_info->mac ) );
7101 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7102 }
7103
7104#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7105 /* Copy own and peer's CID if the use of the CID
7106 * extension has been negotiated. */
7107 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7108 {
7109 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7110
7111 transform->in_cid_len = ssl->own_cid_len;
7112 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7113 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7114 transform->in_cid_len );
7115
7116 transform->out_cid_len = ssl->handshake->peer_cid_len;
7117 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7118 ssl->handshake->peer_cid_len );
7119 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7120 transform->out_cid_len );
7121 }
7122#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7123
7124 /*
7125 * Compute key block using the PRF
7126 */
7127 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7128 if( ret != 0 )
7129 {
7130 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7131 return( ret );
7132 }
7133
7134 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7135 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7136 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7137 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7138 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7139
7140 /*
7141 * Determine the appropriate key, IV and MAC length.
7142 */
7143
7144 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
7145
7146#if defined(MBEDTLS_GCM_C) || \
7147 defined(MBEDTLS_CCM_C) || \
7148 defined(MBEDTLS_CHACHAPOLY_C)
7149 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
7150 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
7151 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
7152 {
7153 size_t explicit_ivlen;
7154
7155 transform->maclen = 0;
7156 mac_key_len = 0;
7157 transform->taglen =
7158 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7159
7160 /* All modes haves 96-bit IVs, but the length of the static parts vary
7161 * with mode and version:
7162 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7163 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7164 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7165 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7166 * sequence number).
7167 */
7168 transform->ivlen = 12;
7169 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
7170 transform->fixed_ivlen = 12;
7171 else
7172 transform->fixed_ivlen = 4;
7173
7174 /* Minimum length of encrypted record */
7175 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7176 transform->minlen = explicit_ivlen + transform->taglen;
7177 }
7178 else
7179#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7180#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7181 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
7182 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7183 {
7184 /* Initialize HMAC contexts */
7185 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7186 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7187 {
7188 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7189 goto end;
7190 }
7191
7192 /* Get MAC length */
7193 mac_key_len = mbedtls_md_get_size( md_info );
7194 transform->maclen = mac_key_len;
7195
7196 /* IV length */
7197 transform->ivlen = cipher_info->iv_size;
7198
7199 /* Minimum length */
7200 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
7201 transform->minlen = transform->maclen;
7202 else
7203 {
7204 /*
7205 * GenericBlockCipher:
7206 * 1. if EtM is in use: one block plus MAC
7207 * otherwise: * first multiple of blocklen greater than maclen
7208 * 2. IV
7209 */
7210#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7211 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
7212 {
7213 transform->minlen = transform->maclen
7214 + cipher_info->block_size;
7215 }
7216 else
7217#endif
7218 {
7219 transform->minlen = transform->maclen
7220 + cipher_info->block_size
7221 - transform->maclen % cipher_info->block_size;
7222 }
7223
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007224 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
7225 {
7226 transform->minlen += transform->ivlen;
7227 }
7228 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007229 {
7230 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7231 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7232 goto end;
7233 }
7234 }
7235 }
7236 else
7237#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7238 {
7239 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7240 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7241 }
7242
7243 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7244 (unsigned) keylen,
7245 (unsigned) transform->minlen,
7246 (unsigned) transform->ivlen,
7247 (unsigned) transform->maclen ) );
7248
7249 /*
7250 * Finally setup the cipher contexts, IVs and MAC secrets.
7251 */
7252#if defined(MBEDTLS_SSL_CLI_C)
7253 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7254 {
7255 key1 = keyblk + mac_key_len * 2;
7256 key2 = keyblk + mac_key_len * 2 + keylen;
7257
7258 mac_enc = keyblk;
7259 mac_dec = keyblk + mac_key_len;
7260
7261 /*
7262 * This is not used in TLS v1.1.
7263 */
7264 iv_copy_len = ( transform->fixed_ivlen ) ?
7265 transform->fixed_ivlen : transform->ivlen;
7266 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7267 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7268 iv_copy_len );
7269 }
7270 else
7271#endif /* MBEDTLS_SSL_CLI_C */
7272#if defined(MBEDTLS_SSL_SRV_C)
7273 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7274 {
7275 key1 = keyblk + mac_key_len * 2 + keylen;
7276 key2 = keyblk + mac_key_len * 2;
7277
7278 mac_enc = keyblk + mac_key_len;
7279 mac_dec = keyblk;
7280
7281 /*
7282 * This is not used in TLS v1.1.
7283 */
7284 iv_copy_len = ( transform->fixed_ivlen ) ?
7285 transform->fixed_ivlen : transform->ivlen;
7286 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7287 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7288 iv_copy_len );
7289 }
7290 else
7291#endif /* MBEDTLS_SSL_SRV_C */
7292 {
7293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7294 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7295 goto end;
7296 }
7297
7298#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007299 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7300 For AEAD-based ciphersuites, there is nothing to do here. */
7301 if( mac_key_len != 0 )
7302 {
7303 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7304 if( ret != 0 )
7305 goto end;
7306 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7307 if( ret != 0 )
7308 goto end;
7309 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007310#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7311
7312 ((void) mac_dec);
7313 ((void) mac_enc);
7314
7315 if( ssl != NULL && ssl->f_export_keys != NULL )
7316 {
7317 ssl->f_export_keys( ssl->p_export_keys,
7318 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7319 master, 48,
7320 randbytes + 32,
7321 randbytes,
7322 tls_prf_get_type( tls_prf ) );
7323 }
7324
7325#if defined(MBEDTLS_USE_PSA_CRYPTO)
7326 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7327 transform->taglen,
7328 &alg,
7329 &key_type,
7330 &key_bits ) ) != PSA_SUCCESS )
7331 {
7332 ret = psa_ssl_status_to_mbedtls( status );
7333 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7334 goto end;
7335 }
7336
7337 transform->psa_alg = alg;
7338
7339 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7340 {
7341 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7342 psa_set_key_algorithm( &attributes, alg );
7343 psa_set_key_type( &attributes, key_type );
7344
7345 if( ( status = psa_import_key( &attributes,
7346 key1,
7347 PSA_BITS_TO_BYTES( key_bits ),
7348 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7349 {
7350 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7351 ret = psa_ssl_status_to_mbedtls( status );
7352 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7353 goto end;
7354 }
7355
7356 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7357
7358 if( ( status = psa_import_key( &attributes,
7359 key2,
7360 PSA_BITS_TO_BYTES( key_bits ),
7361 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7362 {
7363 ret = psa_ssl_status_to_mbedtls( status );
7364 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7365 goto end;
7366 }
7367 }
7368#else
7369 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7370 cipher_info ) ) != 0 )
7371 {
7372 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7373 goto end;
7374 }
7375
7376 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7377 cipher_info ) ) != 0 )
7378 {
7379 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7380 goto end;
7381 }
7382
7383 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7384 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7385 MBEDTLS_ENCRYPT ) ) != 0 )
7386 {
7387 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7388 goto end;
7389 }
7390
7391 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7392 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7393 MBEDTLS_DECRYPT ) ) != 0 )
7394 {
7395 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7396 goto end;
7397 }
7398
7399#if defined(MBEDTLS_CIPHER_MODE_CBC)
7400 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7401 {
7402 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7403 MBEDTLS_PADDING_NONE ) ) != 0 )
7404 {
7405 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7406 goto end;
7407 }
7408
7409 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7410 MBEDTLS_PADDING_NONE ) ) != 0 )
7411 {
7412 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7413 goto end;
7414 }
7415 }
7416#endif /* MBEDTLS_CIPHER_MODE_CBC */
7417#endif /* MBEDTLS_USE_PSA_CRYPTO */
7418
7419end:
7420 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7421 return( ret );
7422}
7423
Jerry Yuee40f9d2022-02-17 14:55:16 +08007424#if defined(MBEDTLS_USE_PSA_CRYPTO)
7425int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7426 unsigned char *hash, size_t *hashlen,
7427 unsigned char *data, size_t data_len,
7428 mbedtls_md_type_t md_alg )
7429{
7430 psa_status_t status;
7431 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7432 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7433
7434 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7435
7436 if( ( status = psa_hash_setup( &hash_operation,
7437 hash_alg ) ) != PSA_SUCCESS )
7438 {
7439 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7440 goto exit;
7441 }
7442
7443 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7444 64 ) ) != PSA_SUCCESS )
7445 {
7446 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7447 goto exit;
7448 }
7449
7450 if( ( status = psa_hash_update( &hash_operation,
7451 data, data_len ) ) != PSA_SUCCESS )
7452 {
7453 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7454 goto exit;
7455 }
7456
7457 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7458 hashlen ) ) != PSA_SUCCESS )
7459 {
7460 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7461 goto exit;
7462 }
7463
7464exit:
7465 if( status != PSA_SUCCESS )
7466 {
7467 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7468 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7469 switch( status )
7470 {
7471 case PSA_ERROR_NOT_SUPPORTED:
7472 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7473 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7474 case PSA_ERROR_BUFFER_TOO_SMALL:
7475 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7476 case PSA_ERROR_INSUFFICIENT_MEMORY:
7477 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7478 default:
7479 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7480 }
7481 }
7482 return( 0 );
7483}
7484
7485#else
7486
7487int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7488 unsigned char *hash, size_t *hashlen,
7489 unsigned char *data, size_t data_len,
7490 mbedtls_md_type_t md_alg )
7491{
7492 int ret = 0;
7493 mbedtls_md_context_t ctx;
7494 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7495 *hashlen = mbedtls_md_get_size( md_info );
7496
7497 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7498
7499 mbedtls_md_init( &ctx );
7500
7501 /*
7502 * digitally-signed struct {
7503 * opaque client_random[32];
7504 * opaque server_random[32];
7505 * ServerDHParams params;
7506 * };
7507 */
7508 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7509 {
7510 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7511 goto exit;
7512 }
7513 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7514 {
7515 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7516 goto exit;
7517 }
7518 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7519 {
7520 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7521 goto exit;
7522 }
7523 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7524 {
7525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7526 goto exit;
7527 }
7528 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7529 {
7530 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7531 goto exit;
7532 }
7533
7534exit:
7535 mbedtls_md_free( &ctx );
7536
7537 if( ret != 0 )
7538 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7539 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7540
7541 return( ret );
7542}
7543#endif /* MBEDTLS_USE_PSA_CRYPTO */
7544
Jerry Yud9d91da2022-02-17 14:57:06 +08007545#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7546
7547/* Find an entry in a signature-hash set matching a given hash algorithm. */
7548mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7549 mbedtls_pk_type_t sig_alg )
7550{
7551 switch( sig_alg )
7552 {
7553 case MBEDTLS_PK_RSA:
7554 return( set->rsa );
7555 case MBEDTLS_PK_ECDSA:
7556 return( set->ecdsa );
7557 default:
7558 return( MBEDTLS_MD_NONE );
7559 }
7560}
7561
7562/* Add a signature-hash-pair to a signature-hash set */
7563void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7564 mbedtls_pk_type_t sig_alg,
7565 mbedtls_md_type_t md_alg )
7566{
7567 switch( sig_alg )
7568 {
7569 case MBEDTLS_PK_RSA:
7570 if( set->rsa == MBEDTLS_MD_NONE )
7571 set->rsa = md_alg;
7572 break;
7573
7574 case MBEDTLS_PK_ECDSA:
7575 if( set->ecdsa == MBEDTLS_MD_NONE )
7576 set->ecdsa = md_alg;
7577 break;
7578
7579 default:
7580 break;
7581 }
7582}
7583
7584/* Allow exactly one hash algorithm for each signature. */
7585void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7586 mbedtls_md_type_t md_alg )
7587{
7588 set->rsa = md_alg;
7589 set->ecdsa = md_alg;
7590}
7591
7592#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7593
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007594/* Serialization of TLS 1.2 sessions:
7595 *
7596 * struct {
7597 * uint64 start_time;
7598 * uint8 ciphersuite[2]; // defined by the standard
7599 * uint8 compression; // 0 or 1
7600 * uint8 session_id_len; // at most 32
7601 * opaque session_id[32];
7602 * opaque master[48]; // fixed length in the standard
7603 * uint32 verify_result;
7604 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7605 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7606 * uint32 ticket_lifetime;
7607 * uint8 mfl_code; // up to 255 according to standard
7608 * uint8 encrypt_then_mac; // 0 or 1
7609 * } serialized_session_tls12;
7610 *
7611 */
7612static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7613 unsigned char *buf,
7614 size_t buf_len )
7615{
7616 unsigned char *p = buf;
7617 size_t used = 0;
7618
7619#if defined(MBEDTLS_HAVE_TIME)
7620 uint64_t start;
7621#endif
7622#if defined(MBEDTLS_X509_CRT_PARSE_C)
7623#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7624 size_t cert_len;
7625#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7626#endif /* MBEDTLS_X509_CRT_PARSE_C */
7627
7628 /*
7629 * Time
7630 */
7631#if defined(MBEDTLS_HAVE_TIME)
7632 used += 8;
7633
7634 if( used <= buf_len )
7635 {
7636 start = (uint64_t) session->start;
7637
7638 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7639 p += 8;
7640 }
7641#endif /* MBEDTLS_HAVE_TIME */
7642
7643 /*
7644 * Basic mandatory fields
7645 */
7646 used += 2 /* ciphersuite */
7647 + 1 /* compression */
7648 + 1 /* id_len */
7649 + sizeof( session->id )
7650 + sizeof( session->master )
7651 + 4; /* verify_result */
7652
7653 if( used <= buf_len )
7654 {
7655 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7656 p += 2;
7657
7658 *p++ = MBEDTLS_BYTE_0( session->compression );
7659
7660 *p++ = MBEDTLS_BYTE_0( session->id_len );
7661 memcpy( p, session->id, 32 );
7662 p += 32;
7663
7664 memcpy( p, session->master, 48 );
7665 p += 48;
7666
7667 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7668 p += 4;
7669 }
7670
7671 /*
7672 * Peer's end-entity certificate
7673 */
7674#if defined(MBEDTLS_X509_CRT_PARSE_C)
7675#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7676 if( session->peer_cert == NULL )
7677 cert_len = 0;
7678 else
7679 cert_len = session->peer_cert->raw.len;
7680
7681 used += 3 + cert_len;
7682
7683 if( used <= buf_len )
7684 {
7685 *p++ = MBEDTLS_BYTE_2( cert_len );
7686 *p++ = MBEDTLS_BYTE_1( cert_len );
7687 *p++ = MBEDTLS_BYTE_0( cert_len );
7688
7689 if( session->peer_cert != NULL )
7690 {
7691 memcpy( p, session->peer_cert->raw.p, cert_len );
7692 p += cert_len;
7693 }
7694 }
7695#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7696 if( session->peer_cert_digest != NULL )
7697 {
7698 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7699 if( used <= buf_len )
7700 {
7701 *p++ = (unsigned char) session->peer_cert_digest_type;
7702 *p++ = (unsigned char) session->peer_cert_digest_len;
7703 memcpy( p, session->peer_cert_digest,
7704 session->peer_cert_digest_len );
7705 p += session->peer_cert_digest_len;
7706 }
7707 }
7708 else
7709 {
7710 used += 2;
7711 if( used <= buf_len )
7712 {
7713 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7714 *p++ = 0;
7715 }
7716 }
7717#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7718#endif /* MBEDTLS_X509_CRT_PARSE_C */
7719
7720 /*
7721 * Session ticket if any, plus associated data
7722 */
7723#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7724 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7725
7726 if( used <= buf_len )
7727 {
7728 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7729 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7730 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7731
7732 if( session->ticket != NULL )
7733 {
7734 memcpy( p, session->ticket, session->ticket_len );
7735 p += session->ticket_len;
7736 }
7737
7738 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7739 p += 4;
7740 }
7741#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7742
7743 /*
7744 * Misc extension-related info
7745 */
7746#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7747 used += 1;
7748
7749 if( used <= buf_len )
7750 *p++ = session->mfl_code;
7751#endif
7752
7753#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7754 used += 1;
7755
7756 if( used <= buf_len )
7757 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7758#endif
7759
7760 return( used );
7761}
7762
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007763static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7764 const unsigned char *buf,
7765 size_t len )
7766{
7767#if defined(MBEDTLS_HAVE_TIME)
7768 uint64_t start;
7769#endif
7770#if defined(MBEDTLS_X509_CRT_PARSE_C)
7771#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7772 size_t cert_len;
7773#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7774#endif /* MBEDTLS_X509_CRT_PARSE_C */
7775
7776 const unsigned char *p = buf;
7777 const unsigned char * const end = buf + len;
7778
7779 /*
7780 * Time
7781 */
7782#if defined(MBEDTLS_HAVE_TIME)
7783 if( 8 > (size_t)( end - p ) )
7784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7785
7786 start = ( (uint64_t) p[0] << 56 ) |
7787 ( (uint64_t) p[1] << 48 ) |
7788 ( (uint64_t) p[2] << 40 ) |
7789 ( (uint64_t) p[3] << 32 ) |
7790 ( (uint64_t) p[4] << 24 ) |
7791 ( (uint64_t) p[5] << 16 ) |
7792 ( (uint64_t) p[6] << 8 ) |
7793 ( (uint64_t) p[7] );
7794 p += 8;
7795
7796 session->start = (time_t) start;
7797#endif /* MBEDTLS_HAVE_TIME */
7798
7799 /*
7800 * Basic mandatory fields
7801 */
7802 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7803 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7804
7805 session->ciphersuite = ( p[0] << 8 ) | p[1];
7806 p += 2;
7807
7808 session->compression = *p++;
7809
7810 session->id_len = *p++;
7811 memcpy( session->id, p, 32 );
7812 p += 32;
7813
7814 memcpy( session->master, p, 48 );
7815 p += 48;
7816
7817 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7818 ( (uint32_t) p[1] << 16 ) |
7819 ( (uint32_t) p[2] << 8 ) |
7820 ( (uint32_t) p[3] );
7821 p += 4;
7822
7823 /* Immediately clear invalid pointer values that have been read, in case
7824 * we exit early before we replaced them with valid ones. */
7825#if defined(MBEDTLS_X509_CRT_PARSE_C)
7826#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7827 session->peer_cert = NULL;
7828#else
7829 session->peer_cert_digest = NULL;
7830#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7831#endif /* MBEDTLS_X509_CRT_PARSE_C */
7832#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7833 session->ticket = NULL;
7834#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7835
7836 /*
7837 * Peer certificate
7838 */
7839#if defined(MBEDTLS_X509_CRT_PARSE_C)
7840#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7841 /* Deserialize CRT from the end of the ticket. */
7842 if( 3 > (size_t)( end - p ) )
7843 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7844
7845 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7846 p += 3;
7847
7848 if( cert_len != 0 )
7849 {
7850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7851
7852 if( cert_len > (size_t)( end - p ) )
7853 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7854
7855 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7856
7857 if( session->peer_cert == NULL )
7858 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7859
7860 mbedtls_x509_crt_init( session->peer_cert );
7861
7862 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7863 p, cert_len ) ) != 0 )
7864 {
7865 mbedtls_x509_crt_free( session->peer_cert );
7866 mbedtls_free( session->peer_cert );
7867 session->peer_cert = NULL;
7868 return( ret );
7869 }
7870
7871 p += cert_len;
7872 }
7873#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7874 /* Deserialize CRT digest from the end of the ticket. */
7875 if( 2 > (size_t)( end - p ) )
7876 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7877
7878 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7879 session->peer_cert_digest_len = (size_t) *p++;
7880
7881 if( session->peer_cert_digest_len != 0 )
7882 {
7883 const mbedtls_md_info_t *md_info =
7884 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7885 if( md_info == NULL )
7886 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7887 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7888 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7889
7890 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7891 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7892
7893 session->peer_cert_digest =
7894 mbedtls_calloc( 1, session->peer_cert_digest_len );
7895 if( session->peer_cert_digest == NULL )
7896 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7897
7898 memcpy( session->peer_cert_digest, p,
7899 session->peer_cert_digest_len );
7900 p += session->peer_cert_digest_len;
7901 }
7902#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7903#endif /* MBEDTLS_X509_CRT_PARSE_C */
7904
7905 /*
7906 * Session ticket and associated data
7907 */
7908#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7909 if( 3 > (size_t)( end - p ) )
7910 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7911
7912 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7913 p += 3;
7914
7915 if( session->ticket_len != 0 )
7916 {
7917 if( session->ticket_len > (size_t)( end - p ) )
7918 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7919
7920 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7921 if( session->ticket == NULL )
7922 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7923
7924 memcpy( session->ticket, p, session->ticket_len );
7925 p += session->ticket_len;
7926 }
7927
7928 if( 4 > (size_t)( end - p ) )
7929 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7930
7931 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7932 ( (uint32_t) p[1] << 16 ) |
7933 ( (uint32_t) p[2] << 8 ) |
7934 ( (uint32_t) p[3] );
7935 p += 4;
7936#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7937
7938 /*
7939 * Misc extension-related info
7940 */
7941#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7942 if( 1 > (size_t)( end - p ) )
7943 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7944
7945 session->mfl_code = *p++;
7946#endif
7947
7948#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7949 if( 1 > (size_t)( end - p ) )
7950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7951
7952 session->encrypt_then_mac = *p++;
7953#endif
7954
7955 /* Done, should have consumed entire buffer */
7956 if( p != end )
7957 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7958
7959 return( 0 );
7960}
Jerry Yudc7bd172022-02-17 13:44:15 +08007961#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007963#endif /* MBEDTLS_SSL_TLS_C */