blob: cdd56096758d0e0d335935e577ab5168f243592e [file] [log] [blame]
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001/**
Chris Jones84a773f2021-03-05 18:38:47 +00002 * \file ssl_misc.h
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02003 *
4 * \brief Internal functions shared by the SSL modules
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020021 */
Chris Jones84a773f2021-03-05 18:38:47 +000022#ifndef MBEDTLS_SSL_MISC_H
23#define MBEDTLS_SSL_MISC_H
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020024
Bence Szépkútic662b362021-05-27 11:25:03 +020025#include "mbedtls/build_info.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050026
Jaeden Amero6609aef2019-07-04 20:01:14 +010027#include "mbedtls/ssl.h"
28#include "mbedtls/cipher.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020029
Andrzej Kurekeb342242019-01-29 09:14:33 -050030#if defined(MBEDTLS_USE_PSA_CRYPTO)
31#include "psa/crypto.h"
32#endif
33
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020034#if defined(MBEDTLS_MD5_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010035#include "mbedtls/md5.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020036#endif
37
38#if defined(MBEDTLS_SHA1_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010039#include "mbedtls/sha1.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020040#endif
41
42#if defined(MBEDTLS_SHA256_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010043#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020044#endif
45
46#if defined(MBEDTLS_SHA512_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010047#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020048#endif
49
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +020050#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jaeden Amero6609aef2019-07-04 20:01:14 +010051#include "mbedtls/ecjpake.h"
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +020052#endif
53
Hanno Beckerdf51dbe2019-02-18 16:41:55 +000054#if defined(MBEDTLS_USE_PSA_CRYPTO)
55#include "psa/crypto.h"
Jaeden Amero6609aef2019-07-04 20:01:14 +010056#include "mbedtls/psa_util.h"
Hanno Beckerdf51dbe2019-02-18 16:41:55 +000057#endif /* MBEDTLS_USE_PSA_CRYPTO */
58
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010059#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
60 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020061#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020062#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020063
Manuel Pégourié-Gonnardcac90a12021-06-04 11:42:30 +020064/* Legacy minor version numbers as defined by:
65 * - RFC 2246: ProtocolVersion version = { 3, 1 }; // TLS v1.0
66 * - RFC 4346: ProtocolVersion version = { 3, 2 }; // TLS v1.1
67 *
68 * We no longer support these versions, but some code still references those
TRodziewicz458280e2021-07-07 11:33:06 +020069 * constants as part of negotiating with the peer, so keep them available
70 * internally.
Manuel Pégourié-Gonnardcac90a12021-06-04 11:42:30 +020071 */
72#define MBEDTLS_SSL_MINOR_VERSION_1 1
73#define MBEDTLS_SSL_MINOR_VERSION_2 2
74
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020075/* Determine minimum supported version */
76#define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
77
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020078#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
79#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
80#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020081
TRodziewicz4ca18aa2021-05-20 14:46:20 +020082#define MBEDTLS_SSL_MIN_VALID_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
Ron Eldor5e9f14d2017-05-28 10:46:38 +030083#define MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
84
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020085/* Determine maximum supported version */
86#define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
87
88#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
89#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020090#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
91
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +020092/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020093#if defined(MBEDTLS_ECP_RESTARTABLE) && \
94 defined(MBEDTLS_SSL_CLI_C) && \
95 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
96 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +010097#define MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020098#endif
99
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200100#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
101#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
102#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
103#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
104
Jerry Yu8e7ca042021-08-26 15:31:37 +0800105/*
106 * Mask of TLS 1.3 handshake extensions used in extensions_present
107 * of mbedtls_ssl_handshake_params.
108 */
109#define MBEDTLS_SSL_EXT_NONE 0
110
111#define MBEDTLS_SSL_EXT_SERVERNAME ( 1 << 0 )
112#define MBEDTLS_SSL_EXT_MAX_FRAGMENT_LENGTH ( 1 << 1 )
113#define MBEDTLS_SSL_EXT_STATUS_REQUEST ( 1 << 2 )
114#define MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ( 1 << 3 )
115#define MBEDTLS_SSL_EXT_SIG_ALG ( 1 << 4 )
116#define MBEDTLS_SSL_EXT_USE_SRTP ( 1 << 5 )
117#define MBEDTLS_SSL_EXT_HEARTBEAT ( 1 << 6 )
118#define MBEDTLS_SSL_EXT_ALPN ( 1 << 7 )
119#define MBEDTLS_SSL_EXT_SCT ( 1 << 8 )
Jerry Yu995ecd32021-08-30 17:53:49 +0800120#define MBEDTLS_SSL_EXT_CLI_CERT_TYPE ( 1 << 9 )
121#define MBEDTLS_SSL_EXT_SERV_CERT_TYPE ( 1 << 10 )
Jerry Yu8e7ca042021-08-26 15:31:37 +0800122#define MBEDTLS_SSL_EXT_PADDING ( 1 << 11 )
123#define MBEDTLS_SSL_EXT_PRE_SHARED_KEY ( 1 << 12 )
124#define MBEDTLS_SSL_EXT_EARLY_DATA ( 1 << 13 )
125#define MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ( 1 << 14 )
126#define MBEDTLS_SSL_EXT_COOKIE ( 1 << 15 )
127#define MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ( 1 << 16 )
128#define MBEDTLS_SSL_EXT_CERT_AUTH ( 1 << 17 )
129#define MBEDTLS_SSL_EXT_OID_FILTERS ( 1 << 18 )
130#define MBEDTLS_SSL_EXT_POST_HANDSHAKE_AUTH ( 1 << 19 )
131#define MBEDTLS_SSL_EXT_SIG_ALG_CERT ( 1 << 20 )
132#define MBEDTLS_SSL_EXT_KEY_SHARE ( 1 << 21 )
Jerry Yu93bcd612021-08-18 12:47:24 +0800133
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800134/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800135 * Helper macros for function call with return check.
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800136 */
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800137/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800138 * Exit when return non-zero value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800139 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800140#define MBEDTLS_SSL_PROC_CHK( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800141 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800142 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800143 if( ret != 0 ) \
144 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800145 goto cleanup; \
146 } \
147 } while( 0 )
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800148/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800149 * Exit when return negative value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800150 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800151#define MBEDTLS_SSL_PROC_CHK_NEG( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800152 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800153 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800154 if( ret < 0 ) \
155 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800156 goto cleanup; \
157 } \
158 } while( 0 )
159
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200160/*
161 * DTLS retransmission states, see RFC 6347 4.2.4
162 *
163 * The SENDING state is merged in PREPARING for initial sends,
164 * but is distinct for resends.
165 *
166 * Note: initial state is wrong for server, but is not used anyway.
167 */
168#define MBEDTLS_SSL_RETRANS_PREPARING 0
169#define MBEDTLS_SSL_RETRANS_SENDING 1
170#define MBEDTLS_SSL_RETRANS_WAITING 2
171#define MBEDTLS_SSL_RETRANS_FINISHED 3
172
173/*
174 * Allow extra bytes for record, authentication and encryption overhead:
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100175 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256).
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200176 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200177
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200178#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0cc46612020-11-30 08:56:52 +0000179
Manuel Pégourié-Gonnard05579c42020-07-31 12:53:39 +0200180/* This macro determines whether CBC is supported. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200181#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
182 ( defined(MBEDTLS_AES_C) || \
183 defined(MBEDTLS_CAMELLIA_C) || \
184 defined(MBEDTLS_ARIA_C) || \
185 defined(MBEDTLS_DES_C) )
186#define MBEDTLS_SSL_SOME_SUITES_USE_CBC
187#endif
188
Hanno Becker0cc46612020-11-30 08:56:52 +0000189/* This macro determines whether a ciphersuite using a
190 * stream cipher can be used. */
191#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
192#define MBEDTLS_SSL_SOME_SUITES_USE_STREAM
193#endif
194
TRodziewicz0f82ec62021-05-12 17:49:18 +0200195/* This macro determines whether the CBC construct used in TLS 1.2 is supported. */
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200197 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200198#define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC
199#endif
200
Hanno Becker31351ce2021-03-22 11:05:58 +0000201#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200202 defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000203#define MBEDTLS_SSL_SOME_SUITES_USE_MAC
Hanno Becker52344c22018-01-03 15:24:20 +0000204#endif
205
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200206#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker0cc46612020-11-30 08:56:52 +0000207
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000208#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200209/* Ciphersuites using HMAC */
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200210#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200211#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
212#elif defined(MBEDTLS_SHA256_C)
213#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
214#else
215#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
216#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000217#else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200218/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
219#define MBEDTLS_SSL_MAC_ADD 16
220#endif
221
222#if defined(MBEDTLS_CIPHER_MODE_CBC)
223#define MBEDTLS_SSL_PADDING_ADD 256
224#else
225#define MBEDTLS_SSL_PADDING_ADD 0
226#endif
227
Hanno Beckera0e20d02019-05-15 14:03:01 +0100228#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
TRodziewicze8dd7092021-05-12 14:19:11 +0200229#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Hanno Becker6cbad552019-05-08 15:40:11 +0100230#else
231#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
232#endif
233
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100234#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_MAX_IV_LENGTH + \
Angus Grattond8213d02016-05-25 20:56:48 +1000235 MBEDTLS_SSL_MAC_ADD + \
Hanno Becker6cbad552019-05-08 15:40:11 +0100236 MBEDTLS_SSL_PADDING_ADD + \
237 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000238 )
239
240#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
241 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
242
243#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
244 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
245
Hanno Becker0271f962018-08-16 13:23:47 +0100246/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100247#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100248
Angus Grattond8213d02016-05-25 20:56:48 +1000249/* Maximum length we can advertise as our max content length for
250 RFC 6066 max_fragment_length extension negotiation purposes
251 (the lesser of both sizes, if they are unequal.)
252 */
253#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
254 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
255 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
256 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
257 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200258
Hanno Beckere131bfe2017-04-12 14:54:42 +0100259/* Maximum size in bytes of list in sig-hash algorithm ext., RFC 5246 */
260#define MBEDTLS_SSL_MAX_SIG_HASH_ALG_LIST_LEN 65534
261
262/* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */
263#define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535
264
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200265/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100266 * Check that we obey the standard's message size bounds
267 */
268
David Horstmann95d516f2021-05-04 18:36:56 +0100269#if MBEDTLS_SSL_IN_CONTENT_LEN > 16384
270#error "Bad configuration - incoming record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100271#endif
272
David Horstmann95d516f2021-05-04 18:36:56 +0100273#if MBEDTLS_SSL_OUT_CONTENT_LEN > 16384
274#error "Bad configuration - outgoing record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100275#endif
276
David Horstmann95d516f2021-05-04 18:36:56 +0100277#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000278#error "Bad configuration - incoming protected record payload too large."
279#endif
280
David Horstmann95d516f2021-05-04 18:36:56 +0100281#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000282#error "Bad configuration - outgoing protected record payload too large."
283#endif
284
285/* Calculate buffer sizes */
286
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000287/* Note: Even though the TLS record header is only 5 bytes
288 long, we're internally using 8 bytes to store the
289 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100290#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100291
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500292#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000293#define MBEDTLS_SSL_IN_BUFFER_LEN \
294 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100295#else
296#define MBEDTLS_SSL_IN_BUFFER_LEN \
297 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
298 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
299#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000300
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500301#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000302#define MBEDTLS_SSL_OUT_BUFFER_LEN \
303 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100304#else
305#define MBEDTLS_SSL_OUT_BUFFER_LEN \
306 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
307 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
308#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000309
Hanno Becker9752aad2021-04-21 05:54:33 +0100310#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
311/**
312 * \brief Return the maximum fragment length (payload, in bytes) for
313 * the output buffer. For the client, this is the configured
314 * value. For the server, it is the minimum of two - the
315 * configured value and the negotiated one.
316 *
317 * \sa mbedtls_ssl_conf_max_frag_len()
318 * \sa mbedtls_ssl_get_max_out_record_payload()
319 *
320 * \param ssl SSL context
321 *
322 * \return Current maximum fragment length for the output buffer.
323 */
324size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl );
325
326/**
327 * \brief Return the maximum fragment length (payload, in bytes) for
328 * the input buffer. This is the negotiated maximum fragment
Hanno Beckerdf3b8632021-06-08 05:30:45 +0100329 * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN.
Hanno Becker9752aad2021-04-21 05:54:33 +0100330 * If it is not defined either, the value is 2^14. This function
331 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
332 *
333 * \sa mbedtls_ssl_conf_max_frag_len()
334 * \sa mbedtls_ssl_get_max_in_record_payload()
335 *
336 * \param ssl SSL context
337 *
338 * \return Current maximum fragment length for the output buffer.
339 */
340size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl );
341#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
342
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500343#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500344static inline size_t mbedtls_ssl_get_output_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500345{
346#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500347 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500348 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
349 + MBEDTLS_SSL_CID_OUT_LEN_MAX;
350#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500351 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500352 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
353#endif
354}
355
Andrzej Kurek069fa962021-01-07 08:02:15 -0500356static inline size_t mbedtls_ssl_get_input_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500357{
358#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500359 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500360 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
361 + MBEDTLS_SSL_CID_IN_LEN_MAX;
362#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500363 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
365#endif
366}
367#endif
368
Hanno Beckera8434e82017-09-18 10:54:39 +0100369/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200370 * TLS extension flags (for extensions with outgoing ServerHello content
371 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
372 * of state of the renegotiation flag, so no indicator is required)
373 */
374#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200375#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200376
Hanno Becker51018aa2017-04-12 14:54:42 +0100377/**
378 * \brief This function checks if the remaining size in a buffer is
379 * greater or equal than a needed space.
380 *
381 * \param cur Pointer to the current position in the buffer.
382 * \param end Pointer to one past the end of the buffer.
383 * \param need Needed space in bytes.
384 *
Ronald Cronb7b35e12020-06-11 09:50:51 +0200385 * \return Zero if the needed space is available in the buffer, non-zero
Hanno Becker51018aa2017-04-12 14:54:42 +0100386 * otherwise.
387 */
388static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
389 const uint8_t *end, size_t need )
390{
Ronald Cronb7b35e12020-06-11 09:50:51 +0200391 return( ( cur > end ) || ( need > (size_t)( end - cur ) ) );
Hanno Becker51018aa2017-04-12 14:54:42 +0100392}
393
394/**
395 * \brief This macro checks if the remaining size in a buffer is
396 * greater or equal than a needed space. If it is not the case,
397 * it returns an SSL_BUFFER_TOO_SMALL error.
398 *
399 * \param cur Pointer to the current position in the buffer.
400 * \param end Pointer to one past the end of the buffer.
401 * \param need Needed space in bytes.
402 *
403 */
404#define MBEDTLS_SSL_CHK_BUF_PTR( cur, end, need ) \
405 do { \
Ronald Cronb7b35e12020-06-11 09:50:51 +0200406 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100407 { \
408 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); \
409 } \
410 } while( 0 )
411
Jerry Yu34da3722021-09-19 18:05:08 +0800412/**
Jerry Yue15e6652021-09-28 21:06:07 +0800413 * \brief This macro checks if the remaining length in an input buffer is
414 * greater or equal than a needed length. If it is not the case, it
Jerry Yudca3d5d2021-10-08 14:19:29 +0800415 * returns #MBEDTLS_SSL_DECODE_ERROR error and pends a
416 * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message.
417 * It is used to guaranteed remaining length.
Jerry Yu34da3722021-09-19 18:05:08 +0800418 *
419 * \param cur Pointer to the current position in the buffer.
420 * \param end Pointer to one past the end of the buffer.
Jerry Yue15e6652021-09-28 21:06:07 +0800421 * \param need Needed length in bytes.
Jerry Yu34da3722021-09-19 18:05:08 +0800422 *
423 */
424#define MBEDTLS_SSL_CHK_BUF_READ_PTR( cur, end, need ) \
425 do { \
426 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
427 { \
428 MBEDTLS_SSL_DEBUG_MSG( 1, \
429 ( "missing input data in %s", __func__ ) ); \
430 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \
431 MBEDTLS_ERR_SSL_DECODE_ERROR ); \
432 return( MBEDTLS_ERR_SSL_DECODE_ERROR ); \
433 } \
434 } while( 0 )
435
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200436#ifdef __cplusplus
437extern "C" {
438#endif
439
Hanno Becker7e5437a2017-04-28 17:15:26 +0100440#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100441 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100442/*
443 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
444 */
445struct mbedtls_ssl_sig_hash_set_t
446{
447 /* At the moment, we only need to remember a single suitable
448 * hash algorithm per signature algorithm. As long as that's
449 * the case - and we don't need a general lookup function -
450 * we can implement the sig-hash-set as a map from signatures
451 * to hash algorithms. */
452 mbedtls_md_type_t rsa;
453 mbedtls_md_type_t ecdsa;
454};
455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
Gilles Peskineeccd8882020-03-10 12:19:08 +0100456 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100457
Ron Eldor51d3ab52019-05-12 14:54:30 +0300458typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen,
459 const char *label,
460 const unsigned char *random, size_t rlen,
461 unsigned char *dstbuf, size_t dlen );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100462
Hanno Becker61baae72020-09-16 09:24:14 +0100463/* cipher.h exports the maximum IV, key and block length from
Hanno Becker15889832020-09-08 11:29:11 +0100464 * all ciphers enabled in the config, regardless of whether those
465 * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled
466 * in the default configuration and uses 64 Byte keys, but it is
467 * not used for record protection in SSL/TLS.
468 *
469 * In order to prevent unnecessary inflation of key structures,
470 * we introduce SSL-specific variants of the max-{key,block,IV}
471 * macros here which are meant to only take those ciphers into
472 * account which can be negotiated in SSL/TLS.
473 *
474 * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH
475 * in cipher.h are rough overapproximations of the real maxima, here
Hanno Becker9a7a2ac2020-09-09 09:24:54 +0100476 * we content ourselves with replicating those overapproximations
Hanno Becker15889832020-09-08 11:29:11 +0100477 * for the maximum block and IV length, and excluding XTS from the
478 * computation of the maximum key length. */
479#define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16
480#define MBEDTLS_SSL_MAX_IV_LENGTH 16
481#define MBEDTLS_SSL_MAX_KEY_LENGTH 32
482
Hanno Becker3385a4d2020-08-21 13:03:34 +0100483/**
484 * \brief The data structure holding the cryptographic material (key and IV)
485 * used for record protection in TLS 1.3.
486 */
487struct mbedtls_ssl_key_set
488{
489 /*! The key for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100490 unsigned char client_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100491 /*! The key for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100492 unsigned char server_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100493 /*! The IV for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100494 unsigned char client_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100495 /*! The IV for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100496 unsigned char server_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100497
Hanno Becker493ea7f2020-09-08 11:01:00 +0100498 size_t key_len; /*!< The length of client_write_key and
499 * server_write_key, in Bytes. */
500 size_t iv_len; /*!< The length of client_write_iv and
501 * server_write_iv, in Bytes. */
Hanno Becker3385a4d2020-08-21 13:03:34 +0100502};
503typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100504
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200505/*
506 * This structure contains the parameters only needed during handshake.
507 */
508struct mbedtls_ssl_handshake_params
509{
510 /*
511 * Handshake specific crypto variables
512 */
Jerry Yu1b7c4a42021-09-09 17:09:12 +0800513#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
514 int tls1_3_kex_modes; /*!< key exchange modes for TLS 1.3 */
515#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100516
517#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100518 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100519 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
520#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200521#if defined(MBEDTLS_DHM_C)
522 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
523#endif
John Durkop07cc04a2020-11-16 22:08:34 -0800524/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
525 * to guards also being in ssl_srv.c and ssl_cli.c. There is a gap
526 * in functionality that access to ecdh_ctx structure is needed for
527 * MBEDTLS_ECDSA_C which does not seem correct.
528 */
529#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200530 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000531
532#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine42459802019-12-19 13:31:53 +0100533 psa_key_type_t ecdh_psa_type;
534 uint16_t ecdh_bits;
Ronald Croncf56a0a2020-08-04 09:51:30 +0200535 psa_key_id_t ecdh_psa_privkey;
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000536 unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH];
537 size_t ecdh_psa_peerkey_len;
538#endif /* MBEDTLS_USE_PSA_CRYPTO */
John Durkop07cc04a2020-11-16 22:08:34 -0800539#endif /* MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000540
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200541#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200542 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200543#if defined(MBEDTLS_SSL_CLI_C)
544 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
545 size_t ecjpake_cache_len; /*!< Length of cached data */
546#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100547#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnardf4721792015-09-15 10:53:51 +0200548#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200549 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200550 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
551#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +0100552#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100553#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +0200554 psa_key_id_t psk_opaque; /*!< Opaque PSK from the callback */
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100555#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200556 unsigned char *psk; /*!< PSK from the callback */
557 size_t psk_len; /*!< Length of PSK from callback */
Gilles Peskineeccd8882020-03-10 12:19:08 +0100558#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200559#if defined(MBEDTLS_X509_CRT_PARSE_C)
560 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
561#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200562 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200563 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
564 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
565 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100566#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200567#endif /* MBEDTLS_X509_CRT_PARSE_C */
Gilles Peskineeccd8882020-03-10 12:19:08 +0100568#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnardd27d1a52017-08-15 11:49:08 +0200569 int ecrs_enabled; /*!< Handshake supports EC restart? */
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200570 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200571 enum { /* this complements ssl->state with info on intra-state operations */
572 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
573 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
Manuel Pégourié-Gonnardc37423f2018-10-16 10:28:17 +0200574 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
575 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200576 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
577 } ecrs_state; /*!< current (or last) operation */
Hanno Becker3fd3f5e2019-02-25 10:08:06 +0000578 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200579 size_t ecrs_n; /*!< place for saving a length */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200580#endif
Hanno Becker75173122019-02-06 16:18:31 +0000581#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
582 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
583 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
584#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200585#if defined(MBEDTLS_SSL_PROTO_DTLS)
586 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
587 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
588
589 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
590 Srv: unused */
591 unsigned char verify_cookie_len; /*!< Cli: cookie length
592 Srv: flag for sending a cookie */
593
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200594 uint32_t retransmit_timeout; /*!< Current value of timeout */
595 unsigned char retransmit_state; /*!< Retransmission state */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200596 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
597 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
598 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200599 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
600 flight being received */
601 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
602 resending messages */
603 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
604 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100605
Hanno Beckera0e20d02019-05-15 14:03:01 +0100606#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +0100607 /* The state of CID configuration in this handshake. */
608
609 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
Hanno Beckerf1a28082019-05-15 10:17:48 +0100610 * has been negotiated. Possible values are
Hanno Becker2f28c102019-04-25 15:46:59 +0100611 * #MBEDTLS_SSL_CID_ENABLED and
612 * #MBEDTLS_SSL_CID_DISABLED. */
613 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
614 uint8_t peer_cid_len; /*!< The length of
615 * \c peer_cid. */
Hanno Beckera0e20d02019-05-15 14:03:01 +0100616#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker2f28c102019-04-25 15:46:59 +0100617
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100618 struct
619 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100620 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
621 * buffers used for message buffering. */
622
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100623 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100624 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100625
Hanno Becker0271f962018-08-16 13:23:47 +0100626 struct mbedtls_ssl_hs_buffer
627 {
Hanno Becker98081a02018-08-22 13:32:50 +0100628 unsigned is_valid : 1;
629 unsigned is_fragmented : 1;
630 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100631 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100632 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100633 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
634
Hanno Becker5f066e72018-08-16 14:56:31 +0100635 struct
636 {
637 unsigned char *data;
638 size_t len;
639 unsigned epoch;
640 } future_record;
641
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100642 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100643
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200644 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100645#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200646
Hanno Becker3aa186f2021-08-10 09:24:19 +0100647#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Beckere043d152021-08-12 06:22:32 +0100648 /*! TLS 1.3 transforms for 0-RTT and encrypted handshake messages.
649 * Those pointers own the transforms they reference. */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100650 mbedtls_ssl_transform *transform_handshake;
651 mbedtls_ssl_transform *transform_earlydata;
652#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
653
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200654 /*
655 * Checksum contexts
656 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200657#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
658#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500659#if defined(MBEDTLS_USE_PSA_CRYPTO)
660 psa_hash_operation_t fin_sha256_psa;
661#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200662 mbedtls_sha256_context fin_sha256;
663#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500664#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200665#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500666#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500667 psa_hash_operation_t fin_sha384_psa;
Andrzej Kurekeb342242019-01-29 09:14:33 -0500668#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200669 mbedtls_sha512_context fin_sha512;
670#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500671#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200672#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
673
674 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardde718b92019-05-03 11:43:28 +0200675 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200676 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300677 mbedtls_ssl_tls_prf_cb *tls_prf;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200678
Jerry Yu56fc07f2021-09-01 17:48:49 +0800679#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
680 uint16_t offered_group_id; /* The NamedGroup value for the group
681 * that is being used for ephemeral
682 * key exchange.
683 *
684 * On the client: Defaults to the first
685 * entry in the client's group list,
686 * but can be overwritten by the HRR. */
687#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
688
Hanno Beckere694c3e2017-12-27 21:34:08 +0000689 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
690
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200691 size_t pmslen; /*!< premaster length */
692
693 unsigned char randbytes[64]; /*!< random bytes */
694 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
695 /*!< premaster secret */
696
697 int resume; /*!< session resume indicator*/
698 int max_major_ver; /*!< max. major version client*/
699 int max_minor_ver; /*!< max. minor version client*/
700 int cli_exts; /*!< client extension presence*/
Jerry Yu93bcd612021-08-18 12:47:24 +0800701#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Jerry Yu8e7ca042021-08-26 15:31:37 +0800702 int extensions_present; /*!< extension presence; Each bitfield
703 represents an extension and defined
704 as \c MBEDTLS_SSL_EXT_XXX */
Jerry Yu93bcd612021-08-18 12:47:24 +0800705#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200706
707#if defined(MBEDTLS_SSL_SESSION_TICKETS)
708 int new_session_ticket; /*!< use NewSessionTicket? */
709#endif /* MBEDTLS_SSL_SESSION_TICKETS */
710#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
711 int extended_ms; /*!< use Extended Master Secret? */
712#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200713
714#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200715 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200716#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
717
718#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
719 /** Asynchronous operation context. This field is meant for use by the
720 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
721 * mbedtls_ssl_config::f_async_decrypt_start,
722 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
723 * The library does not use it internally. */
724 void *user_async_ctx;
725#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200726};
727
Hanno Becker0271f962018-08-16 13:23:47 +0100728typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
729
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200730/*
Hanno Beckerd362dc52018-01-03 15:23:11 +0000731 * Representation of decryption/encryption transformations on records
732 *
733 * There are the following general types of record transformations:
TRodziewicz2abf03c2021-06-25 14:40:09 +0200734 * - Stream transformations (TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +0000735 * Transformation adding a MAC and applying a stream-cipher
736 * to the authenticated message.
TRodziewicz2abf03c2021-06-25 14:40:09 +0200737 * - CBC block cipher transformations ([D]TLS versions == 1.2 only)
738 * For TLS 1.2, no IV is generated at key extraction time, but every
739 * encrypted record is explicitly prefixed by the IV with which it was
740 * encrypted.
741 * - AEAD transformations ([D]TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +0000742 * These come in two fundamentally different versions, the first one
743 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
744 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
745 * In the first transformation, the IV to be used for a record is obtained
746 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
747 * record sequence number, and explicitly prepending this sequence number
748 * to the encrypted record. In contrast, in the second transformation
749 * the IV is obtained by XOR'ing a static IV obtained at key extraction
750 * time with the 8-byte record sequence number, without prepending the
751 * latter to the encrypted record.
752 *
Hanno Becker7d343ec2020-05-04 12:29:05 +0100753 * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext
754 * which allows to add flexible length padding and to hide a record's true
755 * content type.
756 *
Hanno Beckerd362dc52018-01-03 15:23:11 +0000757 * In addition to type and version, the following parameters are relevant:
758 * - The symmetric cipher algorithm to be used.
759 * - The (static) encryption/decryption keys for the cipher.
760 * - For stream/CBC, the type of message digest to be used.
761 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Becker0db7e0c2018-10-18 15:39:53 +0100762 * - For AEAD transformations, the size (potentially 0) of an explicit,
763 * random initialization vector placed in encrypted records.
TRodziewicz299510e2021-07-09 16:55:11 +0200764 * - For some transformations (currently AEAD) an implicit IV. It is static
Hanno Beckerd362dc52018-01-03 15:23:11 +0000765 * and (if present) is combined with the explicit IV in a transformation-
TRodziewicz299510e2021-07-09 16:55:11 +0200766 * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
Hanno Beckerd362dc52018-01-03 15:23:11 +0000767 * - For stream/CBC, a flag determining the order of encryption and MAC.
768 * - The details of the transformation depend on the SSL/TLS version.
769 * - The length of the authentication tag.
770 *
771 * The struct below refines this abstract view as follows:
772 * - The cipher underlying the transformation is managed in
773 * cipher contexts cipher_ctx_{enc/dec}, which must have the
774 * same cipher type. The mode of these cipher contexts determines
775 * the type of the transformation in the sense above: e.g., if
776 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
777 * then the transformation has type CBC resp. AEAD.
778 * - The cipher keys are never stored explicitly but
779 * are maintained within cipher_ctx_{enc/dec}.
780 * - For stream/CBC transformations, the message digest contexts
781 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
782 * are unused for AEAD transformations.
TRodziewicz2abf03c2021-06-25 14:40:09 +0200783 * - For stream/CBC transformations, the MAC keys are not stored explicitly
784 * but maintained within md_ctx_{enc/dec}.
785 * - The mac_enc and mac_dec fields are unused for EAD transformations.
Hanno Beckerd362dc52018-01-03 15:23:11 +0000786 * - For transformations using an implicit IV maintained within
787 * the transformation context, its contents are stored within
788 * iv_{enc/dec}.
789 * - The value of ivlen indicates the length of the IV.
790 * This is redundant in case of stream/CBC transformations
791 * which always use 0 resp. the cipher's block length as the
792 * IV length, but is needed for AEAD ciphers and may be
793 * different from the underlying cipher's block length
794 * in this case.
795 * - The field fixed_ivlen is nonzero for AEAD transformations only
796 * and indicates the length of the static part of the IV which is
797 * constant throughout the communication, and which is stored in
798 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
Hanno Beckerd362dc52018-01-03 15:23:11 +0000799 * - minor_ver denotes the SSL/TLS version
800 * - For stream/CBC transformations, maclen denotes the length of the
801 * authentication tag, while taglen is unused and 0.
802 * - For AEAD transformations, taglen denotes the length of the
803 * authentication tag, while maclen is unused and 0.
804 * - For CBC transformations, encrypt_then_mac determines the
805 * order of encryption and authentication. This field is unused
806 * in other transformations.
807 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200808 */
809struct mbedtls_ssl_transform
810{
811 /*
812 * Session specific crypto layer
813 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200814 size_t minlen; /*!< min. ciphertext length */
815 size_t ivlen; /*!< IV length */
816 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Beckere694c3e2017-12-27 21:34:08 +0000817 size_t maclen; /*!< MAC(CBC) len */
818 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200819
820 unsigned char iv_enc[16]; /*!< IV (encryption) */
821 unsigned char iv_dec[16]; /*!< IV (decryption) */
822
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000823#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Hanno Beckerd56ed242018-01-03 15:32:51 +0000824
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200825 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
826 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
827
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
829 int encrypt_then_mac; /*!< flag for EtM activation */
830#endif
831
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000832#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Beckerd56ed242018-01-03 15:32:51 +0000833
834 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
835 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000836 int minor_ver;
837
Hanno Beckera0e20d02019-05-15 14:03:01 +0100838#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker1327fa72019-04-25 15:54:02 +0100839 uint8_t in_cid_len;
840 uint8_t out_cid_len;
841 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
842 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera0e20d02019-05-15 14:03:01 +0100843#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1327fa72019-04-25 15:54:02 +0100844
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +0200845#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
846 /* We need the Hello random bytes in order to re-derive keys from the
Hanno Beckerbd257552021-03-22 06:59:27 +0000847 * Master Secret and other session info,
848 * see ssl_tls12_populate_transform() */
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +0200849 unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */
850#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200851};
852
Hanno Becker12a3a862018-01-05 15:42:50 +0000853/*
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +0200854 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
855 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
856 */
857static inline int mbedtls_ssl_transform_uses_aead(
858 const mbedtls_ssl_transform *transform )
859{
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000860#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +0200861 return( transform->maclen == 0 && transform->taglen != 0 );
862#else
863 (void) transform;
864 return( 1 );
865#endif
866}
867
868/*
Hanno Becker12a3a862018-01-05 15:42:50 +0000869 * Internal representation of record frames
870 *
Hanno Becker12a3a862018-01-05 15:42:50 +0000871 * Instances come in two flavors:
872 * (1) Encrypted
873 * These always have data_offset = 0
874 * (2) Unencrypted
Hanno Beckercd430bc2019-04-04 16:29:48 +0100875 * These have data_offset set to the amount of
876 * pre-expansion during record protection. Concretely,
877 * this is the length of the fixed part of the explicit IV
878 * used for encryption, or 0 if no explicit IV is used
TRodziewicz2abf03c2021-06-25 14:40:09 +0200879 * (e.g. for stream ciphers).
Hanno Becker12a3a862018-01-05 15:42:50 +0000880 *
881 * The reason for the data_offset in the unencrypted case
882 * is to allow for in-place conversion of an unencrypted to
883 * an encrypted record. If the offset wasn't included, the
884 * encrypted content would need to be shifted afterwards to
885 * make space for the fixed IV.
886 *
887 */
Hanno Beckerf2ed4482019-04-29 13:45:54 +0100888#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker75f080f2019-04-30 15:01:51 +0100889#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +0100890#else
Hanno Becker75f080f2019-04-30 15:01:51 +0100891#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +0100892#endif
893
Hanno Becker12a3a862018-01-05 15:42:50 +0000894typedef struct
895{
Hanno Beckerd840cea2019-07-11 09:24:36 +0100896 uint8_t ctr[8]; /* In TLS: The implicit record sequence number.
897 * In DTLS: The 2-byte epoch followed by
898 * the 6-byte sequence number.
899 * This is stored as a raw big endian byte array
900 * as opposed to a uint64_t because we rarely
901 * need to perform arithmetic on this, but do
902 * need it as a Byte array for the purpose of
903 * MAC computations. */
904 uint8_t type; /* The record content type. */
905 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
906 * Convert to internal presentation of versions
907 * using mbedtls_ssl_read_version() and
908 * mbedtls_ssl_write_version().
909 * Keep wire-format for MAC computations. */
Hanno Becker12a3a862018-01-05 15:42:50 +0000910
Hanno Beckerd840cea2019-07-11 09:24:36 +0100911 unsigned char *buf; /* Memory buffer enclosing the record content */
912 size_t buf_len; /* Buffer length */
913 size_t data_offset; /* Offset of record content */
914 size_t data_len; /* Length of record content */
Hanno Becker12a3a862018-01-05 15:42:50 +0000915
Hanno Beckera0e20d02019-05-15 14:03:01 +0100916#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd840cea2019-07-11 09:24:36 +0100917 uint8_t cid_len; /* Length of the CID (0 if not present) */
918 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +0100919#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker12a3a862018-01-05 15:42:50 +0000920} mbedtls_record;
921
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200922#if defined(MBEDTLS_X509_CRT_PARSE_C)
923/*
924 * List of certificate + private key pairs
925 */
926struct mbedtls_ssl_key_cert
927{
928 mbedtls_x509_crt *cert; /*!< cert */
929 mbedtls_pk_context *key; /*!< private key */
930 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
931};
932#endif /* MBEDTLS_X509_CRT_PARSE_C */
933
934#if defined(MBEDTLS_SSL_PROTO_DTLS)
935/*
936 * List of handshake messages kept around for resending
937 */
938struct mbedtls_ssl_flight_item
939{
940 unsigned char *p; /*!< message, including handshake headers */
941 size_t len; /*!< length of p */
942 unsigned char type; /*!< type of the message: handshake or CCS */
943 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
944};
945#endif /* MBEDTLS_SSL_PROTO_DTLS */
946
Hanno Becker7e5437a2017-04-28 17:15:26 +0100947#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100948 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100949
950/* Find an entry in a signature-hash set matching a given hash algorithm. */
951mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
952 mbedtls_pk_type_t sig_alg );
953/* Add a signature-hash-pair to a signature-hash set */
954void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
955 mbedtls_pk_type_t sig_alg,
956 mbedtls_md_type_t md_alg );
957/* Allow exactly one hash algorithm for each signature. */
958void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
959 mbedtls_md_type_t md_alg );
960
961/* Setup an empty signature-hash set */
962static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
963{
964 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
965}
966
967#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
Gilles Peskineeccd8882020-03-10 12:19:08 +0100968 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200969
970/**
971 * \brief Free referenced items in an SSL transform context and clear
972 * memory
973 *
974 * \param transform SSL transform context
975 */
976void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
977
978/**
979 * \brief Free referenced items in an SSL handshake context and clear
980 * memory
981 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200982 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200983 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200984void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200985
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200986int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
987int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
988void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
Jerry Yub9930e72021-08-06 17:11:51 +0800989#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800990/**
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800991 * \brief TLS 1.3 client side state machine entry
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800992 *
993 * \param ssl SSL context
994 */
Jerry Yuf4436812021-08-26 22:59:56 +0800995int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl );
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800996
997/**
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800998 * \brief TLS 1.3 server side state machine entry
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800999 *
1000 * \param ssl SSL context
1001 */
Jerry Yu27561932021-08-27 17:07:38 +08001002int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl );
Jerry Yub9930e72021-08-06 17:11:51 +08001003#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001004
1005int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
1006
1007void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
1008int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
1009
Simon Butcher99000142016-10-13 17:21:01 +01001010int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
1011int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
1012void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
1013
Hanno Becker4a810fb2017-05-24 16:27:30 +01001014/**
1015 * \brief Update record layer
1016 *
1017 * This function roughly separates the implementation
1018 * of the logic of (D)TLS from the implementation
1019 * of the secure transport.
1020 *
Hanno Becker3a0aad12018-08-20 09:44:02 +01001021 * \param ssl The SSL context to use.
1022 * \param update_hs_digest This indicates if the handshake digest
1023 * should be automatically updated in case
1024 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +01001025 *
1026 * \return 0 or non-zero error code.
1027 *
1028 * \note A clarification on what is called 'record layer' here
1029 * is in order, as many sensible definitions are possible:
1030 *
1031 * The record layer takes as input an untrusted underlying
1032 * transport (stream or datagram) and transforms it into
1033 * a serially multiplexed, secure transport, which
1034 * conceptually provides the following:
1035 *
1036 * (1) Three datagram based, content-agnostic transports
1037 * for handshake, alert and CCS messages.
1038 * (2) One stream- or datagram-based transport
1039 * for application data.
1040 * (3) Functionality for changing the underlying transform
1041 * securing the contents.
1042 *
1043 * The interface to this functionality is given as follows:
1044 *
1045 * a Updating
1046 * [Currently implemented by mbedtls_ssl_read_record]
1047 *
1048 * Check if and on which of the four 'ports' data is pending:
1049 * Nothing, a controlling datagram of type (1), or application
1050 * data (2). In any case data is present, internal buffers
1051 * provide access to the data for the user to process it.
1052 * Consumption of type (1) datagrams is done automatically
1053 * on the next update, invalidating that the internal buffers
1054 * for previous datagrams, while consumption of application
1055 * data (2) is user-controlled.
1056 *
1057 * b Reading of application data
1058 * [Currently manual adaption of ssl->in_offt pointer]
1059 *
1060 * As mentioned in the last paragraph, consumption of data
1061 * is different from the automatic consumption of control
1062 * datagrams (1) because application data is treated as a stream.
1063 *
1064 * c Tracking availability of application data
1065 * [Currently manually through decreasing ssl->in_msglen]
1066 *
1067 * For efficiency and to retain datagram semantics for
1068 * application data in case of DTLS, the record layer
1069 * provides functionality for checking how much application
1070 * data is still available in the internal buffer.
1071 *
1072 * d Changing the transformation securing the communication.
1073 *
1074 * Given an opaque implementation of the record layer in the
1075 * above sense, it should be possible to implement the logic
1076 * of (D)TLS on top of it without the need to know anything
1077 * about the record layer's internals. This is done e.g.
1078 * in all the handshake handling functions, and in the
1079 * application data reading function mbedtls_ssl_read.
1080 *
1081 * \note The above tries to give a conceptual picture of the
1082 * record layer, but the current implementation deviates
1083 * from it in some places. For example, our implementation of
1084 * the update functionality through mbedtls_ssl_read_record
1085 * discards datagrams depending on the current state, which
1086 * wouldn't fall under the record layer's responsibility
1087 * following the above definition.
1088 *
1089 */
Hanno Becker3a0aad12018-08-20 09:44:02 +01001090int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
1091 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001092int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
1093
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001094int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
1095 int update_checksum );
1096static inline int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
1097{
1098 return( mbedtls_ssl_write_handshake_msg_ext( ssl, 1 /* update checksum */ ) );
1099}
1100
Hanno Becker67bc7c32018-08-06 11:33:50 +01001101int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001102int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
1103
1104int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
1105int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
1106
1107int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
1108int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1109
1110int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
1111int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1112
1113void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
1114 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
1115
Gilles Peskineeccd8882020-03-10 12:19:08 +01001116#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001117int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001118
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001119/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001120 * Get the first defined PSK by order of precedence:
1121 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
1122 * 2. static PSK configured by \c mbedtls_ssl_conf_psk()
1123 * Return a code and update the pair (PSK, PSK length) passed to this function
1124 */
1125static inline int mbedtls_ssl_get_psk( const mbedtls_ssl_context *ssl,
1126 const unsigned char **psk, size_t *psk_len )
1127{
1128 if( ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0 )
1129 {
1130 *psk = ssl->handshake->psk;
1131 *psk_len = ssl->handshake->psk_len;
1132 }
1133
1134 else if( ssl->conf->psk != NULL && ssl->conf->psk_len > 0 )
1135 {
1136 *psk = ssl->conf->psk;
1137 *psk_len = ssl->conf->psk_len;
1138 }
1139
1140 else
1141 {
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001142 *psk = NULL;
1143 *psk_len = 0;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001144 return( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED );
1145 }
1146
1147 return( 0 );
1148}
1149
1150#if defined(MBEDTLS_USE_PSA_CRYPTO)
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001151/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001152 * Get the first defined opaque PSK by order of precedence:
1153 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK
1154 * callback
1155 * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque()
1156 * Return an opaque PSK
1157 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001158static inline psa_key_id_t mbedtls_ssl_get_opaque_psk(
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001159 const mbedtls_ssl_context *ssl )
1160{
Ronald Croncf56a0a2020-08-04 09:51:30 +02001161 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001162 return( ssl->handshake->psk_opaque );
1163
Ronald Croncf56a0a2020-08-04 09:51:30 +02001164 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001165 return( ssl->conf->psk_opaque );
1166
Ronald Croncf56a0a2020-08-04 09:51:30 +02001167 return( MBEDTLS_SVC_KEY_ID_INIT );
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001168}
1169#endif /* MBEDTLS_USE_PSA_CRYPTO */
1170
1171#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001172
1173#if defined(MBEDTLS_PK_C)
1174unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001175unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001176mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1177#endif
1178
1179mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001180unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Simon Butcher99000142016-10-13 17:21:01 +01001181int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001182
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001183#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001184int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001185#endif
1186
Gilles Peskineeccd8882020-03-10 12:19:08 +01001187#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001188int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
1189 mbedtls_md_type_t md );
1190#endif
1191
Ron Eldor089c9fe2018-12-06 17:12:49 +02001192#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascal43f94902020-09-22 12:25:52 +02001193static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value
1194 ( const uint16_t srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001195{
Johan Pascal43f94902020-09-22 12:25:52 +02001196 switch( srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001197 {
Johan Pascal85269572020-08-25 10:01:54 +02001198 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001199 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascal85269572020-08-25 10:01:54 +02001200 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001201 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascal43f94902020-09-22 12:25:52 +02001202 return srtp_profile_value;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001203 default: break;
1204 }
Johan Pascal43f94902020-09-22 12:25:52 +02001205 return( MBEDTLS_TLS_SRTP_UNSET );
Ron Eldor089c9fe2018-12-06 17:12:49 +02001206}
1207#endif
1208
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001209#if defined(MBEDTLS_X509_CRT_PARSE_C)
1210static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1211{
1212 mbedtls_ssl_key_cert *key_cert;
1213
1214 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1215 key_cert = ssl->handshake->key_cert;
1216 else
1217 key_cert = ssl->conf->key_cert;
1218
1219 return( key_cert == NULL ? NULL : key_cert->key );
1220}
1221
1222static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1223{
1224 mbedtls_ssl_key_cert *key_cert;
1225
1226 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1227 key_cert = ssl->handshake->key_cert;
1228 else
1229 key_cert = ssl->conf->key_cert;
1230
1231 return( key_cert == NULL ? NULL : key_cert->cert );
1232}
1233
1234/*
1235 * Check usage of a certificate wrt extensions:
1236 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1237 *
1238 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1239 * check a cert we received from them)!
1240 *
1241 * Return 0 if everything is OK, -1 if not.
1242 */
1243int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
1244 const mbedtls_ssl_ciphersuite_t *ciphersuite,
1245 int cert_endpoint,
1246 uint32_t *flags );
1247#endif /* MBEDTLS_X509_CRT_PARSE_C */
1248
1249void mbedtls_ssl_write_version( int major, int minor, int transport,
1250 unsigned char ver[2] );
1251void mbedtls_ssl_read_version( int *major, int *minor, int transport,
1252 const unsigned char ver[2] );
1253
Hanno Becker5903de42019-05-03 14:46:38 +01001254static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001255{
Hanno Becker47be7682019-07-12 09:55:46 +01001256#if !defined(MBEDTLS_SSL_PROTO_DTLS)
1257 ((void) ssl);
1258#endif
1259
1260#if defined(MBEDTLS_SSL_PROTO_DTLS)
1261 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1262 {
1263 return( 13 );
1264 }
1265 else
1266#endif /* MBEDTLS_SSL_PROTO_DTLS */
1267 {
1268 return( 5 );
1269 }
Hanno Becker5903de42019-05-03 14:46:38 +01001270}
1271
1272static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1273{
Hanno Becker3b154c12019-05-03 15:05:27 +01001274 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001275}
1276
1277static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1278{
1279#if defined(MBEDTLS_SSL_PROTO_DTLS)
1280 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1281 return( 12 );
1282#else
1283 ((void) ssl);
1284#endif
1285 return( 4 );
1286}
1287
1288#if defined(MBEDTLS_SSL_PROTO_DTLS)
1289void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1290void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1291int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001292int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001293#endif
1294
1295/* Visible for testing purposes only */
1296#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker0183d692019-07-12 08:50:37 +01001297int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001298void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1299#endif
1300
Hanno Becker52055ae2019-02-06 14:30:46 +00001301int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1302 const mbedtls_ssl_session *src );
1303
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001304/* constant-time buffer comparison */
1305static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
1306{
1307 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +01001308 volatile const unsigned char *A = (volatile const unsigned char *) a;
1309 volatile const unsigned char *B = (volatile const unsigned char *) b;
1310 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001311
1312 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001313 {
1314 /* Read volatile data in order before computing diff.
1315 * This avoids IAR compiler warning:
1316 * 'the order of volatile accesses is undefined ..' */
1317 unsigned char x = A[i], y = B[i];
1318 diff |= x ^ y;
1319 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001320
1321 return( diff );
1322}
1323
TRodziewicz0f82ec62021-05-12 17:49:18 +02001324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek814feff2019-01-14 04:35:19 -05001325/* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001326int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001327 unsigned char *hash, size_t *hashlen,
1328 unsigned char *data, size_t data_len,
1329 mbedtls_md_type_t md_alg );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001330#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001331
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001332#ifdef __cplusplus
1333}
1334#endif
1335
Hanno Beckera18d1322018-01-03 14:27:32 +00001336void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1337int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1338 mbedtls_ssl_transform *transform,
1339 mbedtls_record *rec,
1340 int (*f_rng)(void *, unsigned char *, size_t),
1341 void *p_rng );
Hanno Becker605949f2019-07-12 08:23:59 +01001342int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001343 mbedtls_ssl_transform *transform,
1344 mbedtls_record *rec );
1345
Hanno Beckerdd772292020-02-05 10:38:31 +00001346/* Length of the "epoch" field in the record header */
1347static inline size_t mbedtls_ssl_ep_len( const mbedtls_ssl_context *ssl )
1348{
1349#if defined(MBEDTLS_SSL_PROTO_DTLS)
1350 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1351 return( 2 );
1352#else
1353 ((void) ssl);
1354#endif
1355 return( 0 );
1356}
1357
Hanno Becker08f09132020-02-11 15:40:07 +00001358#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker786300f2020-02-05 10:46:40 +00001359int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001360#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker0f57a652020-02-05 10:37:26 +00001361
1362void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs );
Hanno Becker7876d122020-02-05 10:39:31 +00001363int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl );
1364
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001365void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl );
1366void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
1367 mbedtls_ssl_transform *transform );
1368void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl );
1369
Hanno Becker43aefe22020-02-05 10:44:56 +00001370int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial );
1371
Jerry Yue7047812021-09-13 19:26:39 +08001372/*
Jerry Yu394ece62021-09-14 22:17:21 +08001373 * Send pending alert
Jerry Yue7047812021-09-13 19:26:39 +08001374 */
1375int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl );
1376
Jerry Yu394ece62021-09-14 22:17:21 +08001377/*
1378 * Set pending fatal alert flag.
1379 */
1380void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
1381 unsigned char alert_type,
1382 int alert_reason );
1383
1384/* Alias of mbedtls_ssl_pend_fatal_alert */
1385#define MBEDTLS_SSL_PEND_FATAL_ALERT( type, user_return_value ) \
1386 mbedtls_ssl_pend_fatal_alert( ssl, type, user_return_value )
1387
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001388#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1389void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl );
1390#endif
1391
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001392void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl );
1393
Hanno Becker08f09132020-02-11 15:40:07 +00001394#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker40cdaa12020-02-05 10:48:27 +00001395int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001396#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker89490712020-02-05 10:50:12 +00001397
Hanno Becker533ab5f2020-02-05 10:49:13 +00001398#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker08f09132020-02-11 15:40:07 +00001399size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl );
Hanno Becker533ab5f2020-02-05 10:49:13 +00001400void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl );
1401void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight );
1402#endif /* MBEDTLS_SSL_PROTO_DTLS */
1403
Jerry Yu26f4d152021-08-23 17:42:37 +08001404#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1405
1406/*
1407 * Helper functions around key exchange modes.
1408 */
Jerry Yub60e3cf2021-09-08 16:41:02 +08001409static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001410 int kex_mode_mask )
1411{
1412 return( ( ssl->conf->tls13_kex_modes & kex_mode_mask ) != 0 );
1413}
1414
Jerry Yub60e3cf2021-09-08 16:41:02 +08001415static inline int mbedtls_ssl_conf_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001416{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001417 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001418 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK ) );
1419}
1420
1421static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( mbedtls_ssl_context *ssl )
1422{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001423 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001424 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
1425}
1426
Jerry Yub60e3cf2021-09-08 16:41:02 +08001427static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001428{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001429 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001430 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL ) );
1431}
1432
1433static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
1434{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001435 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001436 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
1437}
1438
1439static inline int mbedtls_ssl_conf_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
1440{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001441 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001442 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_ALL ) );
1443}
1444
Jerry Yuadf861a2021-09-29 21:22:08 +08001445/**
1446 * Given a list of key exchange modes, check if at least one of them is
1447 * supported.
1448 *
1449 * \param[in] ssl SSL context
Jerry Yu0cabad32021-09-30 09:52:35 +08001450 * \param kex_modes_mask Mask of the key exchange modes to check
Jerry Yuadf861a2021-09-29 21:22:08 +08001451 *
1452 * \return 0 if at least one of the key exchange modes is supported,
Jerry Yudca3d5d2021-10-08 14:19:29 +08001453 * !=0 otherwise.
Jerry Yuadf861a2021-09-29 21:22:08 +08001454 */
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001455static inline unsigned mbedtls_ssl_tls1_3_check_kex_modes( mbedtls_ssl_context *ssl,
Jerry Yue15e6652021-09-28 21:06:07 +08001456 int kex_modes_mask )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001457{
Jerry Yue15e6652021-09-28 21:06:07 +08001458 return( ( ssl->handshake->tls1_3_kex_modes & kex_modes_mask ) == 0 );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001459}
1460
1461static inline int mbedtls_ssl_tls1_3_psk_enabled( mbedtls_ssl_context *ssl )
1462{
Jerry Yuadf861a2021-09-29 21:22:08 +08001463 return( ! mbedtls_ssl_tls1_3_check_kex_modes( ssl,
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001464 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK ) );
1465}
1466
1467static inline int mbedtls_ssl_tls1_3_psk_ephemeral_enabled(
1468 mbedtls_ssl_context *ssl )
1469{
Jerry Yuadf861a2021-09-29 21:22:08 +08001470 return( ! mbedtls_ssl_tls1_3_check_kex_modes( ssl,
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001471 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
1472}
1473
1474static inline int mbedtls_ssl_tls1_3_ephemeral_enabled( mbedtls_ssl_context *ssl )
1475{
Jerry Yuadf861a2021-09-29 21:22:08 +08001476 return( ! mbedtls_ssl_tls1_3_check_kex_modes( ssl,
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001477 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL ) );
1478}
1479
1480static inline int mbedtls_ssl_tls1_3_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
1481{
Jerry Yuadf861a2021-09-29 21:22:08 +08001482 return( ! mbedtls_ssl_tls1_3_check_kex_modes( ssl,
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001483 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
1484}
1485
1486static inline int mbedtls_ssl_tls1_3_some_psk_enabled( mbedtls_ssl_context *ssl )
1487{
Jerry Yuadf861a2021-09-29 21:22:08 +08001488 return( ! mbedtls_ssl_tls1_3_check_kex_modes( ssl,
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001489 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_ALL ) );
1490}
1491
Jerry Yu26f4d152021-08-23 17:42:37 +08001492#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1493
Jerry Yu60835a82021-08-04 10:13:52 +08001494/**
1495 * ssl utils functions for checking configuration.
1496 */
1497
1498#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1499static inline int mbedtls_ssl_conf_is_tls13_only( const mbedtls_ssl_config *conf )
1500{
1501 if( conf->min_major_ver == MBEDTLS_SSL_MAJOR_VERSION_3 &&
1502 conf->max_major_ver == MBEDTLS_SSL_MAJOR_VERSION_3 &&
1503 conf->min_minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 &&
1504 conf->max_minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1505 {
1506 return( 1 );
1507 }
1508 return( 0 );
1509}
1510#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1511
1512#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1513static inline int mbedtls_ssl_conf_is_tls12_only( const mbedtls_ssl_config *conf )
1514{
1515 if( conf->min_major_ver == MBEDTLS_SSL_MAJOR_VERSION_3 &&
1516 conf->max_major_ver == MBEDTLS_SSL_MAJOR_VERSION_3 &&
1517 conf->min_minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
1518 conf->max_minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 )
1519 {
1520 return( 1 );
1521 }
1522 return( 0 );
1523}
1524#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1525
1526#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1527static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13( const mbedtls_ssl_config *conf )
1528{
1529 if( conf->min_major_ver == MBEDTLS_SSL_MAJOR_VERSION_3 &&
1530 conf->max_major_ver == MBEDTLS_SSL_MAJOR_VERSION_3 &&
1531 conf->min_minor_ver == MBEDTLS_SSL_MINOR_VERSION_3 &&
1532 conf->max_minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1533 {
1534 return( 1 );
1535 }
1536 return( 0 );
1537}
1538#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL*/
1539
Jerry Yubeb3f412021-08-16 15:00:55 +08001540#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1541
Jerry Yue226cef2021-08-27 22:06:20 +08001542/*
1543 * Helper functions for NamedGroup.
1544 */
Jerry Yub60e3cf2021-09-08 16:41:02 +08001545static inline int mbedtls_ssl_tls13_named_group_is_ecdhe( uint16_t named_group )
Jerry Yue226cef2021-08-27 22:06:20 +08001546{
1547 return( named_group == MBEDTLS_SSL_TLS13_NAMED_GROUP_SECP256R1 ||
1548 named_group == MBEDTLS_SSL_TLS13_NAMED_GROUP_SECP384R1 ||
1549 named_group == MBEDTLS_SSL_TLS13_NAMED_GROUP_SECP521R1 ||
1550 named_group == MBEDTLS_SSL_TLS13_NAMED_GROUP_X25519 ||
1551 named_group == MBEDTLS_SSL_TLS13_NAMED_GROUP_X448 );
1552}
1553
Jerry Yub60e3cf2021-09-08 16:41:02 +08001554static inline int mbedtls_ssl_tls13_named_group_is_dhe( uint16_t named_group )
Jerry Yue226cef2021-08-27 22:06:20 +08001555{
1556 return( named_group >= MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE2048 &&
1557 named_group <= MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE8192 );
1558}
1559
Jerry Yueecfbf02021-08-30 18:32:07 +08001560static inline void mbedtls_ssl_handshake_set_state( mbedtls_ssl_context *ssl,
1561 mbedtls_ssl_states state )
Jerry Yubeb3f412021-08-16 15:00:55 +08001562{
Jerry Yu67d4ed52021-08-31 13:12:43 +08001563 ssl->state = ( int ) state;
Jerry Yubeb3f412021-08-16 15:00:55 +08001564}
1565
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001566/*
XiaokangQian6b226b02021-09-24 07:51:16 +00001567 * Fetch TLS 1.3 handshake message header
1568 */
1569int mbedtls_ssl_tls1_3_fetch_handshake_msg( mbedtls_ssl_context *ssl,
XiaokangQian16c61aa2021-09-27 09:30:17 +00001570 unsigned hs_type,
1571 unsigned char **buf,
1572 size_t *buf_len );
XiaokangQian6b226b02021-09-24 07:51:16 +00001573
1574/*
Jerry Yu159c5a02021-08-31 12:51:25 +08001575 * Write TLS 1.3 handshake message header
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001576 */
Jerry Yuf4436812021-08-26 22:59:56 +08001577int mbedtls_ssl_tls13_start_handshake_msg( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +08001578 unsigned hs_type,
1579 unsigned char **buf,
1580 size_t *buflen );
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001581/*
Jerry Yu159c5a02021-08-31 12:51:25 +08001582 * Write TLS 1.3 handshake message tail
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001583 */
Jerry Yuf4436812021-08-26 22:59:56 +08001584int mbedtls_ssl_tls13_finish_handshake_msg( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +08001585 size_t buf_len,
1586 size_t msg_len );
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001587/*
1588 * Update checksum with handshake header
1589 */
Jerry Yuf4436812021-08-26 22:59:56 +08001590void mbedtls_ssl_tls13_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +08001591 unsigned hs_type,
1592 size_t total_hs_len );
Jerry Yu65dd2cc2021-08-18 16:38:40 +08001593
Jerry Yubc20bdd2021-08-24 15:59:48 +08001594#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001595/*
Jerry Yu159c5a02021-08-31 12:51:25 +08001596 * Write TLS 1.3 Signature Algorithm extension
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001597 */
Jerry Yue41dec02021-08-31 10:57:07 +08001598int mbedtls_ssl_tls13_write_sig_alg_ext( mbedtls_ssl_context *ssl,
1599 unsigned char *buf,
1600 unsigned char *end,
1601 size_t *olen);
Jerry Yu56fc07f2021-09-01 17:48:49 +08001602
Jerry Yubc20bdd2021-08-24 15:59:48 +08001603#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu65dd2cc2021-08-18 16:38:40 +08001604
Jerry Yubeb3f412021-08-16 15:00:55 +08001605#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1606
Chris Jones84a773f2021-03-05 18:38:47 +00001607#endif /* ssl_misc.h */